# Table of Contents - [applesauce](#applesauce) - [AppleSauce](#applesauce) - [Getting Started | applesauce](#getting-started-applesauce) - [Migration Guide: v1 to v2 | applesauce](#migration-guide-v1-to-v2-applesauce) - [Beginner's Tutorial | applesauce](#beginner-s-tutorial-applesauce) - [Glossary | applesauce](#glossary-applesauce) - [1. Introduction to EventStore | applesauce](#1-introduction-to-eventstore-applesauce) - [2. Using Helper Methods | applesauce](#2-using-helper-methods-applesauce) - [5. Loading Specific Events with Loaders | applesauce](#5-loading-specific-events-with-loaders-applesauce) - [7. Publishing Events | applesauce](#7-publishing-events-applesauce) - [4. Connecting to Relays | applesauce](#4-connecting-to-relays-applesauce) - [3. Building Reactive UI with Models | applesauce](#3-building-reactive-ui-with-models-applesauce) - [Relays | applesauce](#relays-applesauce) - [Relay Pool | applesauce](#relay-pool-applesauce) - [Loaders | applesauce](#loaders-applesauce) - [Factory | applesauce](#factory-applesauce) - [Accounts | applesauce](#accounts-applesauce) - [Zaps Loader | applesauce](#zaps-loader-applesauce) - [Event Loader | applesauce](#event-loader-applesauce) - [Address Loader | applesauce](#address-loader-applesauce) - [RxJS Operators | applesauce](#rxjs-operators-applesauce) - [Signers | applesauce](#signers-applesauce) - [Timeline Loader | applesauce](#timeline-loader-applesauce) - [Reactions Loader | applesauce](#reactions-loader-applesauce) - [6. Creating Events with EventFactory | applesauce](#6-creating-events-with-eventfactory-applesauce) - [Actions | applesauce](#actions-applesauce) - [Text content | applesauce](#text-content-applesauce) - [Tag Value Loader | applesauce](#tag-value-loader-applesauce) - [EventFactory | applesauce](#eventfactory-applesauce) - [Event Blueprints | applesauce](#event-blueprints-applesauce) - [8. Running Actions with ActionHub | applesauce](#8-running-actions-with-actionhub-applesauce) - [Wallet | applesauce](#wallet-applesauce) - [Models | applesauce](#models-applesauce) - [Managing events | applesauce](#managing-events-applesauce) - [Wallet Connect | applesauce](#wallet-connect-applesauce) - [Migration Guide: v2 to v3 | applesauce](#migration-guide-v2-to-v3-applesauce) - [Relay Class | applesauce](#relay-class-applesauce) - [AppleSauce](#applesauce) - [Markdown | applesauce](#markdown-applesauce) - [WalletService Class | applesauce](#walletservice-class-applesauce) - [Applesauce packages | applesauce](#applesauce-packages-applesauce) - [Wallet Actions | applesauce](#wallet-actions-applesauce) - [Nostr Connect | applesauce](#nostr-connect-applesauce) - [Nostr Connect Provider | applesauce](#nostr-connect-provider-applesauce) - [Action Hub | applesauce](#action-hub-applesauce) - [Actions | applesauce](#actions-applesauce) - [Event Operations | applesauce](#event-operations-applesauce) - [WalletConnect Class | applesauce](#walletconnect-class-applesauce) - [Account Manager | applesauce](#account-manager-applesauce) - [Applesauce-react | applesauce](#applesauce-react-applesauce) - [Tag Operations | applesauce](#tag-operations-applesauce) - [applesauce](#applesauce) - [Models | applesauce](#models-applesauce) - [React Hooks | applesauce](#react-hooks-applesauce) - [Accounts | applesauce](#accounts-applesauce) - [Text Content | applesauce](#text-content-applesauce) - [Helpers | applesauce](#helpers-applesauce) - [applesauce-accounts | AppleSauce](#applesauce-accounts-applesauce) - [applesauce-actions | AppleSauce](#applesauce-actions-applesauce) - [applesauce-content | AppleSauce](#applesauce-content-applesauce) - [applesauce-dvm | AppleSauce](#applesauce-dvm-applesauce) - [applesauce-solidjs | AppleSauce](#applesauce-solidjs-applesauce) - [applesauce-core | AppleSauce](#applesauce-core-applesauce) - [applesauce-loaders | AppleSauce](#applesauce-loaders-applesauce) - [applesauce-factory | AppleSauce](#applesauce-factory-applesauce) - [applesauce-react | AppleSauce](#applesauce-react-applesauce) - [SerialPortSigner | AppleSauce](#serialportsigner-applesauce) - [isFromCache | AppleSauce](#isfromcache-applesauce) - [AccountsProvider | AppleSauce](#accountsprovider-applesauce) - [ExtensionSigner | AppleSauce](#extensionsigner-applesauce) - [ensureSingletonTag | AppleSauce](#ensuresingletontag-applesauce) - [Model | AppleSauce](#model-applesauce) - [getTagValue | AppleSauce](#gettagvalue-applesauce) - [getIndexableTags | AppleSauce](#getindexabletags-applesauce) - [AmberClipboardSigner | AppleSauce](#amberclipboardsigner-applesauce) - [links | AppleSauce](#links-applesauce) - [nostrMentions | AppleSauce](#nostrmentions-applesauce) - [useEventFactory | AppleSauce](#useeventfactory-applesauce) - [useActiveAccount | AppleSauce](#useactiveaccount-applesauce) - [useAccountManager | AppleSauce](#useaccountmanager-applesauce) - [isValidProfile | AppleSauce](#isvalidprofile-applesauce) - [hashtags | AppleSauce](#hashtags-applesauce) - [emojis | AppleSauce](#emojis-applesauce) - [addSeenRelay | AppleSauce](#addseenrelay-applesauce) - [Link | AppleSauce](#link-applesauce) - [Hashtag | AppleSauce](#hashtag-applesauce) - [Nip07Interface | AppleSauce](#nip07interface-applesauce) - [ReadonlySigner | AppleSauce](#readonlysigner-applesauce) - [getCommentReplyPointer | AppleSauce](#getcommentreplypointer-applesauce) - [galleries | AppleSauce](#galleries-applesauce) - [getSeenRelays | AppleSauce](#getseenrelays-applesauce) - [getProfileContent | AppleSauce](#getprofilecontent-applesauce) - [lightningInvoices | AppleSauce](#lightninginvoices-applesauce) - [getZapRecipient | AppleSauce](#getzaprecipient-applesauce) - [isValidZap | AppleSauce](#isvalidzap-applesauce) - [Emoji | AppleSauce](#emoji-applesauce) - [getZapAddressPointer | AppleSauce](#getzapaddresspointer-applesauce) - [getZapSender | AppleSauce](#getzapsender-applesauce) - [getZapEventPointer | AppleSauce](#getzapeventpointer-applesauce) - [getZapRequest | AppleSauce](#getzaprequest-applesauce) - [Gallery | AppleSauce](#gallery-applesauce) - [cashuTokens | AppleSauce](#cashutokens-applesauce) - [getProfilePointerFromPTag | AppleSauce](#getprofilepointerfromptag-applesauce) - [getAddressPointerFromATag | AppleSauce](#getaddresspointerfromatag-applesauce) - [getEventPointerFromETag | AppleSauce](#geteventpointerfrometag-applesauce) - [getEventPointerFromQTag | AppleSauce](#geteventpointerfromqtag-applesauce) - [parseLNURLOrAddress | AppleSauce](#parselnurloraddress-applesauce) - [getDeleteIds | AppleSauce](#getdeleteids-applesauce) - [getAddressPointerForEvent | AppleSauce](#getaddresspointerforevent-applesauce) - [getDeleteCoordinates | AppleSauce](#getdeletecoordinates-applesauce) - [Mention | AppleSauce](#mention-applesauce) - [getPackName | AppleSauce](#getpackname-applesauce) - [parseBolt11 | AppleSauce](#parsebolt11-applesauce) - [getEmojiTag | AppleSauce](#getemojitag-applesauce) - [getInboxes | AppleSauce](#getinboxes-applesauce) - [useRenderedContent | AppleSauce](#userenderedcontent-applesauce) - [getURLFilename | AppleSauce](#geturlfilename-applesauce) - [isAudioURL | AppleSauce](#isaudiourl-applesauce) - [isImageURL | AppleSauce](#isimageurl-applesauce) - [isVideoURL | AppleSauce](#isvideourl-applesauce) - [applesauce-wallet | AppleSauce](#applesauce-wallet-applesauce) - [applesauce-signers | AppleSauce](#applesauce-signers-applesauce) - [getOutboxes | AppleSauce](#getoutboxes-applesauce) - [getCommentRootPointer | AppleSauce](#getcommentrootpointer-applesauce) - [isStreamURL | AppleSauce](#isstreamurl-applesauce) - [isETag | AppleSauce](#isetag-applesauce) - [canHaveHiddenTags | AppleSauce](#canhavehiddentags-applesauce) - [isRTag | AppleSauce](#isrtag-applesauce) - [isPTag | AppleSauce](#isptag-applesauce) - [isTTag | AppleSauce](#isttag-applesauce) - [isATag | AppleSauce](#isatag-applesauce) - [isDTag | AppleSauce](#isdtag-applesauce) - [getHiddenTags | AppleSauce](#gethiddentags-applesauce) - [hasHiddenTags | AppleSauce](#hashiddentags-applesauce) - [isHiddenTagsLocked | AppleSauce](#ishiddentagslocked-applesauce) - [SerialPortAccount | AppleSauce](#serialportaccount-applesauce) - [isFilterEqual | AppleSauce](#isfilterequal-applesauce) - [unixNow | AppleSauce](#unixnow-applesauce) - [createQTagFromEventPointer | AppleSauce](#createqtagfromeventpointer-applesauce) - [fillAndTrimTag | AppleSauce](#fillandtrimtag-applesauce) - [getZapPayment | AppleSauce](#getzappayment-applesauce) - [ReadonlyAccount | AppleSauce](#readonlyaccount-applesauce) - [TextNoteContentSymbol | AppleSauce](#textnotecontentsymbol-applesauce) - [getEmojis | AppleSauce](#getemojis-applesauce) - [AmberClipboardAccount | AppleSauce](#amberclipboardaccount-applesauce) - [SimpleSigner | AppleSauce](#simplesigner-applesauce) - [markFromCache | AppleSauce](#markfromcache-applesauce) - [NostrConnectAccount | AppleSauce](#nostrconnectaccount-applesauce) - [PasswordAccount | AppleSauce](#passwordaccount-applesauce) - [FactoryProvider | AppleSauce](#factoryprovider-applesauce) - [isEvent | AppleSauce](#isevent-applesauce) - [useEventStore | AppleSauce](#useeventstore-applesauce) - [SimpleAccount | AppleSauce](#simpleaccount-applesauce) - [useObservableMemo | AppleSauce](#useobservablememo-applesauce) - [Action | AppleSauce](#action-applesauce) - [createPTagFromProfilePointer | AppleSauce](#createptagfromprofilepointer-applesauce) - [EventStoreProvider | AppleSauce](#eventstoreprovider-applesauce) - [remarkNostrMentions | AppleSauce](#remarknostrmentions-applesauce) - [getParsedContent | AppleSauce](#getparsedcontent-applesauce) - [PasswordSigner | AppleSauce](#passwordsigner-applesauce) - [unlockHiddenTags | AppleSauce](#unlockhiddentags-applesauce) - [ExtensionAccount | AppleSauce](#extensionaccount-applesauce) - [AccountManager | AppleSauce](#accountmanager-applesauce) - [ActionHub | AppleSauce](#actionhub-applesauce) - [Accounts | AppleSauce](#accounts-applesauce) - [NostrConnectSigner | AppleSauce](#nostrconnectsigner-applesauce) - [Relay | AppleSauce](#relay-applesauce) - [NostrConnectProvider | AppleSauce](#nostrconnectprovider-applesauce) - [applesauce-relay | AppleSauce](#applesauce-relay-applesauce) - [Actions | AppleSauce](#actions-applesauce) - [applesauce-wallet-connect | AppleSauce](#applesauce-wallet-connect-applesauce) - [WalletConnect | AppleSauce](#walletconnect-applesauce) - [Helpers | AppleSauce](#helpers-applesauce) - [TagOperations | AppleSauce](#tagoperations-applesauce) - [Blueprints | AppleSauce](#blueprints-applesauce) - [Models | AppleSauce](#models-applesauce) - [Operations | AppleSauce](#operations-applesauce) - [Actions | AppleSauce](#actions-applesauce) - [Helpers | AppleSauce](#helpers-applesauce) - [ProxySigner | AppleSauce](#proxysigner-applesauce) - [SignerMismatchError | AppleSauce](#signermismatcherror-applesauce) - [DecryptionCache | AppleSauce](#decryptioncache-applesauce) - [SerializedAccount | AppleSauce](#serializedaccount-applesauce) - [EventTemplate | AppleSauce](#eventtemplate-applesauce) - [IAccountConstructor | AppleSauce](#iaccountconstructor-applesauce) - [BaseAccount | AppleSauce](#baseaccount-applesauce) - [IAccount | AppleSauce](#iaccount-applesauce) - [ActionConstructor | AppleSauce](#actionconstructor-applesauce) - [ActionContext | AppleSauce](#actioncontext-applesauce) - [PublishMethod | AppleSauce](#publishmethod-applesauce) - [Helpers | AppleSauce](#helpers-applesauce) - [Markdown | AppleSauce](#markdown-applesauce) - [Nast | AppleSauce](#nast-applesauce) - [Text | AppleSauce](#text-applesauce) - [TimeoutError | AppleSauce](#timeouterror-applesauce) - [EventSet | AppleSauce](#eventset-applesauce) - [IEventClaims | AppleSauce](#ieventclaims-applesauce) - [IEventStoreActions | AppleSauce](#ieventstoreactions-applesauce) - [IEventSet | AppleSauce](#ieventset-applesauce) - [EventStore | AppleSauce](#eventstore-applesauce) - [IEventStoreModels | AppleSauce](#ieventstoremodels-applesauce) - [PublishMethod | AppleSauce](#publishmethod-applesauce) - [DVMClient | AppleSauce](#dvmclient-applesauce) - [IEventStoreRead | AppleSauce](#ieventstoreread-applesauce) - [IEventStore | AppleSauce](#ieventstore-applesauce) - [ClientPointerContext | AppleSauce](#clientpointercontext-applesauce) - [EventFactory | AppleSauce](#eventfactory-applesauce) - [Getting Started | applesauce](#getting-started-applesauce) - [Blueprints | AppleSauce](#blueprints-applesauce) - [Helpers | AppleSauce](#helpers-applesauce) - [SubscriptionMethod | AppleSauce](#subscriptionmethod-applesauce) - [IEventStoreStreams | AppleSauce](#ieventstorestreams-applesauce) - [EmojiContext | AppleSauce](#emojicontext-applesauce) - [IEventStoreSubscriptions | AppleSauce](#ieventstoresubscriptions-applesauce) - [EventFactoryClient | AppleSauce](#eventfactoryclient-applesauce) - [EventFactoryContext | AppleSauce](#eventfactorycontext-applesauce) - [ModelConstructor | AppleSauce](#modelconstructor-applesauce) - [EventSigner | AppleSauce](#eventsigner-applesauce) - [Emoji | AppleSauce](#emoji-applesauce) - [PublishOptions | AppleSauce](#publishoptions-applesauce) - [NameValueTag | AppleSauce](#namevaluetag-applesauce) - [PublishResponse | AppleSauce](#publishresponse-applesauce) - [AddNutzapInfoMint | AppleSauce](#addnutzapinfomint-applesauce) - [createATagFromAddressPointer | AppleSauce](#createatagfromaddresspointer-applesauce) - [ChannelHiddenModel | AppleSauce](#channelhiddenmodel-applesauce) - [createCommentTagsFromCommentPointer | AppleSauce](#createcommenttagsfromcommentpointer-applesauce) - [WalletConnectEncryptionMethod | AppleSauce](#walletconnectencryptionmethod-applesauce) - [SubscriptionOptions | AppleSauce](#subscriptionoptions-applesauce) - [BunkerURI | AppleSauce](#bunkeruri-applesauce) - [PicturePostBlueprintOptions | AppleSauce](#picturepostblueprintoptions-applesauce) - [AddBlossomServer | AppleSauce](#addblossomserver-applesauce) - [ConsolidateTokens | AppleSauce](#consolidatetokens-applesauce) - [addBlossomServerTag | AppleSauce](#addblossomservertag-applesauce) - [NostrConnectResponse | AppleSauce](#nostrconnectresponse-applesauce) - [ChannelMessagesModel | AppleSauce](#channelmessagesmodel-applesauce) - [createETagFromEventPointer | AppleSauce](#createetagfromeventpointer-applesauce) - [ReportReason | AppleSauce](#reportreason-applesauce) - [CalendarRsvp | AppleSauce](#calendarrsvp-applesauce) - [SubscriptionResponse | AppleSauce](#subscriptionresponse-applesauce) - [PollBlueprintOptions | AppleSauce](#pollblueprintoptions-applesauce) - [WalletNotification | AppleSauce](#walletnotification-applesauce) - [AddDMRelay | AppleSauce](#adddmrelay-applesauce) - [WalletService | AppleSauce](#walletservice-applesauce) - [CreateWallet | AppleSauce](#createwallet-applesauce) - [Channel | AppleSauce](#channel-applesauce) - [addEventBookmarkTag | AppleSauce](#addeventbookmarktag-applesauce) - [NostrConnectMethod | AppleSauce](#nostrconnectmethod-applesauce) - [ChannelMetadataModel | AppleSauce](#channelmetadatamodel-applesauce) - [createETagWithMarkerFromEventPointer | AppleSauce](#createetagwithmarkerfromeventpointer-applesauce) - [NostrPublishMethod | AppleSauce](#nostrpublishmethod-applesauce) - [LRU | AppleSauce](#lru-applesauce) - [PollResponseBlueprintOptions | AppleSauce](#pollresponseblueprintoptions-applesauce) - [completeOnEose | AppleSauce](#completeoneose-applesauce) - [WalletServiceHandlers | AppleSauce](#walletservicehandlers-applesauce) - [AddEventToCalendar | AppleSauce](#addeventtocalendar-applesauce) - [NutzapEvent | AppleSauce](#nutzapevent-applesauce) - [Client | AppleSauce](#client-applesauce) - [addEventTag | AppleSauce](#addeventtag-applesauce) - [ConnectResponseResults | AppleSauce](#connectresponseresults-applesauce) - [ChannelMutedModel | AppleSauce](#channelmutedmodel-applesauce) - [createGroupHTagFromGroupPointer | AppleSauce](#creategrouphtagfromgrouppointer-applesauce) - [EncryptedContentCache | AppleSauce](#encryptedcontentcache-applesauce) - [NostrSubscriptionMethod | AppleSauce](#nostrsubscriptionmethod-applesauce) - [markFromRelay | AppleSauce](#markfromrelay-applesauce) - [WalletServiceOptions | AppleSauce](#walletserviceoptions-applesauce) - [ShareBlueprintOptions | AppleSauce](#shareblueprintoptions-applesauce) - [Helpers | AppleSauce](#helpers-applesauce) - [AddFavoriteRelay | AppleSauce](#addfavoriterelay-applesauce) - [NutzapProfile | AppleSauce](#nutzapprofile-applesauce) - [Comment | AppleSauce](#comment-applesauce) - [addGroupTag | AppleSauce](#addgrouptag-applesauce) - [CommentsModel | AppleSauce](#commentsmodel-applesauce) - [createGroupTagFromGroupPointer | AppleSauce](#creategrouptagfromgrouppointer-applesauce) - [EncryptedContentSigner | AppleSauce](#encryptedcontentsigner-applesauce) - [WalletSupport | AppleSauce](#walletsupport-applesauce) - [GetBalanceHandler | AppleSauce](#getbalancehandler-applesauce) - [onlyEvents | AppleSauce](#onlyevents-applesauce) - [WrappedMessageBlueprintOptions | AppleSauce](#wrappedmessageblueprintoptions-applesauce) - [AddFavoriteRelaySet | AppleSauce](#addfavoriterelayset-applesauce) - [ReceiveToken | AppleSauce](#receivetoken-applesauce) - [Content | AppleSauce](#content-applesauce) - [addHashtag | AppleSauce](#addhashtag-applesauce) - [ContactsModel | AppleSauce](#contactsmodel-applesauce) - [EncryptionMethods | AppleSauce](#encryptionmethods-applesauce) - [NostrPool | AppleSauce](#nostrpool-applesauce) - [GetInfoHandler | AppleSauce](#getinfohandler-applesauce) - [ensureAddressPointerTag | AppleSauce](#ensureaddresspointertag-applesauce) - [CalendarBlueprint | AppleSauce](#calendarblueprint-applesauce) - [storeEvents | AppleSauce](#storeevents-applesauce) - [AddInboxRelay | AppleSauce](#addinboxrelay-applesauce) - [Delete | AppleSauce](#delete-applesauce) - [RemoveNutzapInfoMint | AppleSauce](#removenutzapinfomint-applesauce) - [addInboxRelay | AppleSauce](#addinboxrelay-applesauce) - [EncryptedContentModel | AppleSauce](#encryptedcontentmodel-applesauce) - [PollOption | AppleSauce](#polloption-applesauce) - [ListTransactionsHandler | AppleSauce](#listtransactionshandler-applesauce) - [ensureEventPointerTag | AppleSauce](#ensureeventpointertag-applesauce) - [WalletAuthURI | AppleSauce](#walletauthuri-applesauce) - [ChannelMessageBlueprint | AppleSauce](#channelmessageblueprint-applesauce) - [RemoveNutzapInfoRelay | AppleSauce](#removenutzapinforelay-applesauce) - [toEventStore | AppleSauce](#toeventstore-applesauce) - [AddOutboxRelay | AppleSauce](#addoutboxrelay-applesauce) - [Geohash | AppleSauce](#geohash-applesauce) - [addMailboxRelay | AppleSauce](#addmailboxrelay-applesauce) - [EventModel | AppleSauce](#eventmodel-applesauce) - [AddressPointerWithoutD | AppleSauce](#addresspointerwithoutd-applesauce) - [GetBalanceResult | AppleSauce](#getbalanceresult-applesauce) - [ensureKTag | AppleSauce](#ensurektag-applesauce) - [ChannelMessageReplyBlueprint | AppleSauce](#channelmessagereplyblueprint-applesauce) - [LookupInvoiceHandler | AppleSauce](#lookupinvoicehandler-applesauce) - [AddRelayToRelaySet | AppleSauce](#addrelaytorelayset-applesauce) - [RolloverTokens | AppleSauce](#rollovertokens-applesauce) - [GiftWrap | AppleSauce](#giftwrap-applesauce) - [addNameValueTag | AppleSauce](#addnamevaluetag-applesauce) - [MakeInvoiceHandler | AppleSauce](#makeinvoicehandler-applesauce) - [ensureMarkedAddressPointerTag | AppleSauce](#ensuremarkedaddresspointertag-applesauce) - [CommentBlueprint | AppleSauce](#commentblueprint-applesauce) - [AddSearchRelay | AppleSauce](#addsearchrelay-applesauce) - [SetNutzapInfoPubkey | AppleSauce](#setnutzapinfopubkey-applesauce) - [Groups | AppleSauce](#groups-applesauce) - [addOutboxRelay | AppleSauce](#addoutboxrelay-applesauce) - [EventZapsModel | AppleSauce](#eventzapsmodel-applesauce) - [CalendarEventParticipant | AppleSauce](#calendareventparticipant-applesauce) - [MultiPayInvoiceHandler | AppleSauce](#multipayinvoicehandler-applesauce) - [ensureMarkedEventPointerTag | AppleSauce](#ensuremarkedeventpointertag-applesauce) - [WalletResponse | AppleSauce](#walletresponse-applesauce) - [DeleteBlueprint | AppleSauce](#deleteblueprint-applesauce) - [AddUserToFollowSet | AppleSauce](#addusertofollowset-applesauce) - [LiveChatMessageBlueprintOptions | AppleSauce](#livechatmessageblueprintoptions-applesauce) - [RelayOptions | AppleSauce](#relayoptions-applesauce) - [ALLOWED_PIN_KINDS | AppleSauce](#allowed-pin-kinds-applesauce) - [AddNutzapInfoRelay | AppleSauce](#addnutzapinforelay-applesauce) - [Calendar | AppleSauce](#calendar-applesauce) - [removeCoordinateTag | AppleSauce](#removecoordinatetag-applesauce) - [CalendarEventsModel | AppleSauce](#calendareventsmodel-applesauce) - [Blueprints | AppleSauce](#blueprints-applesauce) - [createCommentTagsForEvent | AppleSauce](#createcommenttagsforevent-applesauce) - [WalletConnectOptions | AppleSauce](#walletconnectoptions-applesauce) - [NoteBlueprintOptions | AppleSauce](#noteblueprintoptions-applesauce) - [registerCommonAccountTypes | AppleSauce](#registercommonaccounttypes-applesauce) - [RequestOptions | AppleSauce](#requestoptions-applesauce) - [NostrConnectAppMetadata | AppleSauce](#nostrconnectappmetadata-applesauce) - [AddBlockedRelay | AppleSauce](#addblockedrelay-applesauce) - [CompleteSpend | AppleSauce](#completespend-applesauce) - [addAddressTag | AppleSauce](#addaddresstag-applesauce) - [NostrConnectURI | AppleSauce](#nostrconnecturi-applesauce) - [CalendarEvent | AppleSauce](#calendarevent-applesauce) - [EventsModel | AppleSauce](#eventsmodel-applesauce) - [Bookmarks | AppleSauce](#bookmarks-applesauce) - [GetInfoResult | AppleSauce](#getinforesult-applesauce) - [UnlockWallet | AppleSauce](#unlockwallet-applesauce) - [addPubkeyTag | AppleSauce](#addpubkeytag-applesauce) - [FavoriteRelaySetsModel | AppleSauce](#favoriterelaysetsmodel-applesauce) - [ChannelMetadataContent | AppleSauce](#channelmetadatacontent-applesauce) - [Hashtags | AppleSauce](#hashtags-applesauce) - [MultiPayKeysendHandler | AppleSauce](#multipaykeysendhandler-applesauce) - [ensureMarkedProfilePointerTag | AppleSauce](#ensuremarkedprofilepointertag-applesauce) - [ListTransactionsResult | AppleSauce](#listtransactionsresult-applesauce) - [FileMetadataBlueprint | AppleSauce](#filemetadatablueprint-applesauce) - [BookmarkEvent | AppleSauce](#bookmarkevent-applesauce) - [UpdateNutzapInfo | AppleSauce](#updatenutzapinfo-applesauce) - [Highlight | AppleSauce](#highlight-applesauce) - [addRelayTag | AppleSauce](#addrelaytag-applesauce) - [FavoriteRelaysModel | AppleSauce](#favoriterelaysmodel-applesauce) - [CommentAddressPointer | AppleSauce](#commentaddresspointer-applesauce) - [ensureNamedValueTag | AppleSauce](#ensurenamedvaluetag-applesauce) - [Transaction | AppleSauce](#transaction-applesauce) - [FollowSetBlueprint | AppleSauce](#followsetblueprint-applesauce) - [PayInvoiceHandler | AppleSauce](#payinvoicehandler-applesauce) - [CreateBookmarkList | AppleSauce](#createbookmarklist-applesauce) - [WalletAddPrivateKey | AppleSauce](#walletaddprivatekey-applesauce) - [LegacyMessage | AppleSauce](#legacymessage-applesauce) - [removeAddressTag | AppleSauce](#removeaddresstag-applesauce) - [GiftWrapRumorModel | AppleSauce](#giftwraprumormodel-applesauce) - [CommentEventPointer | AppleSauce](#commenteventpointer-applesauce) - [ensureProfilePointerTag | AppleSauce](#ensureprofilepointertag-applesauce) - [MakeInvoiceParams | AppleSauce](#makeinvoiceparams-applesauce) - [GiftWrapBlueprint | AppleSauce](#giftwrapblueprint-applesauce) - [PayKeysendHandler | AppleSauce](#paykeysendhandler-applesauce) - [CreateBookmarkSet | AppleSauce](#createbookmarkset-applesauce) - [List | AppleSauce](#list-applesauce) - [removeBlossomServerTag | AppleSauce](#removeblossomservertag-applesauce) - [GiftWrapsModel | AppleSauce](#giftwrapsmodel-applesauce) - [CommentExternalPointer | AppleSauce](#commentexternalpointer-applesauce) - [ensureQuoteEventPointerTag | AppleSauce](#ensurequoteeventpointertag-applesauce) - [PayInvoiceResult | AppleSauce](#payinvoiceresult-applesauce) - [SerializedWalletConnect | AppleSauce](#serializedwalletconnect-applesauce) - [GroupMessageBlueprint | AppleSauce](#groupmessageblueprint-applesauce) - [CreateFollowSet | AppleSauce](#createfollowset-applesauce) - [LiveStream | AppleSauce](#livestream-applesauce) - [removeEventBookmarkTag | AppleSauce](#removeeventbookmarktag-applesauce) - [HiddenContactsModel | AppleSauce](#hiddencontactsmodel-applesauce) - [DecodeResult | AppleSauce](#decoderesult-applesauce) - [PayKeysendResult | AppleSauce](#paykeysendresult-applesauce) - [eventPipe | AppleSauce](#eventpipe-applesauce) - [HighlightBlueprint | AppleSauce](#highlightblueprint-applesauce) - [SerializedWalletService | AppleSauce](#serializedwalletservice-applesauce) - [CreateMailboxes | AppleSauce](#createmailboxes-applesauce) - [Mailboxes | AppleSauce](#mailboxes-applesauce) - [removeEventTag | AppleSauce](#removeeventtag-applesauce) - [HiddenMuteModel | AppleSauce](#hiddenmutemodel-applesauce) - [WalletRequest | AppleSauce](#walletrequest-applesauce) - [getContentPointers | AppleSauce](#getcontentpointers-applesauce) - [ExternalIdentifiers | AppleSauce](#externalidentifiers-applesauce) - [LegacyMessageBlueprint | AppleSauce](#legacymessageblueprint-applesauce) - [CreatePinList | AppleSauce](#createpinlist-applesauce) - [Note | AppleSauce](#note-applesauce) - [removeGroupTag | AppleSauce](#removegrouptag-applesauce) - [LegacyMessageReplies | AppleSauce](#legacymessagereplies-applesauce) - [WalletMethod | AppleSauce](#walletmethod-applesauce) - [identity | AppleSauce](#identity-applesauce) - [ExternalPointer | AppleSauce](#externalpointer-applesauce) - [LegacyMessageReplyBlueprint | AppleSauce](#legacymessagereplyblueprint-applesauce) - [CreateProfile | AppleSauce](#createprofile-applesauce) - [PicturePost | AppleSauce](#picturepost-applesauce) - [removeHashtag | AppleSauce](#removehashtag-applesauce) - [LegacyMessagesGroup | AppleSauce](#legacymessagesgroup-applesauce) - [NotificationType | AppleSauce](#notificationtype-applesauce) - [FileMetadata | AppleSauce](#filemetadata-applesauce) - [pipeFromAsyncArray | AppleSauce](#pipefromasyncarray-applesauce) - [CreateRelaySet | AppleSauce](#createrelayset-applesauce) - [LiveChatMessageBlueprint | AppleSauce](#livechatmessageblueprint-applesauce) - [skip | AppleSauce](#skip-applesauce) - [removeInboxRelay | AppleSauce](#removeinboxrelay-applesauce) - [LegacyMessagesGroups | AppleSauce](#legacymessagesgroups-applesauce) - [WalletConnectURI | AppleSauce](#walletconnecturi-applesauce) - [GroupPointer | AppleSauce](#grouppointer-applesauce) - [NoteBlueprint | AppleSauce](#noteblueprint-applesauce) - [FollowUser | AppleSauce](#followuser-applesauce) - [Poll | AppleSauce](#poll-applesauce) - [PollResponse | AppleSauce](#pollresponse-applesauce) - [removeMailboxRelay | AppleSauce](#removemailboxrelay-applesauce) - [LegacyMessageThreads | AppleSauce](#legacymessagethreads-applesauce) - [HandlerLinkPlatform | AppleSauce](#handlerlinkplatform-applesauce) - [tagPipe | AppleSauce](#tagpipe-applesauce) - [NoteReplyBlueprint | AppleSauce](#notereplyblueprint-applesauce) - [MuteHashtag | AppleSauce](#mutehashtag-applesauce) - [Profile | AppleSauce](#profile-applesauce) - [removeNameValueTag | AppleSauce](#removenamevaluetag-applesauce) - [HandlerLinkType | AppleSauce](#handlerlinktype-applesauce) - [MailboxesModel | AppleSauce](#mailboxesmodel-applesauce) - [PicturePostBlueprint | AppleSauce](#picturepostblueprint-applesauce) - [MuteThread | AppleSauce](#mutethread-applesauce) - [Reaction | AppleSauce](#reaction-applesauce) - [removeOutboxRelay | AppleSauce](#removeoutboxrelay-applesauce) - [MuteModel | AppleSauce](#mutemodel-applesauce) - [HighlightAttribution | AppleSauce](#highlightattribution-applesauce) - [PollBlueprint | AppleSauce](#pollblueprint-applesauce) - [MuteUser | AppleSauce](#muteuser-applesauce) - [removePubkeyTag | AppleSauce](#removepubkeytag-applesauce) - [ProfileModel | AppleSauce](#profilemodel-applesauce) - [HighlightAttributionRole | AppleSauce](#highlightattributionrole-applesauce) - [PollResponseBlueprint | AppleSauce](#pollresponseblueprint-applesauce) - [Stream | AppleSauce](#stream-applesauce) - [MuteWord | AppleSauce](#muteword-applesauce) - [StreamChat | AppleSauce](#streamchat-applesauce) - [removeRelayTag | AppleSauce](#removerelaytag-applesauce) - [PublicContactsModel | AppleSauce](#publiccontactsmodel-applesauce) - [MediaAttachment | AppleSauce](#mediaattachment-applesauce) - [ReactionBlueprint | AppleSauce](#reactionblueprint-applesauce) - [NewBlockedRelays | AppleSauce](#newblockedrelays-applesauce) - [removeSingletonTag | AppleSauce](#removesingletontag-applesauce) - [PublicMuteModel | AppleSauce](#publicmutemodel-applesauce) - [Mutes | AppleSauce](#mutes-applesauce) - [WrappedMessage | AppleSauce](#wrappedmessage-applesauce) - [ShareBlueprint | AppleSauce](#shareblueprint-applesauce) - [NewBlossomServers | AppleSauce](#newblossomservers-applesauce) - [setSingletonTag | AppleSauce](#setsingletontag-applesauce) - [ReactionsModel | AppleSauce](#reactionsmodel-applesauce) - [Zap | AppleSauce](#zap-applesauce) - [SingleChoicePollResponseBlueprint | AppleSauce](#singlechoicepollresponseblueprint-applesauce) - [NewContacts | AppleSauce](#newcontacts-applesauce) - [ReceivedZapsModel | AppleSauce](#receivedzapsmodel-applesauce) - [MetaTagOptions | AppleSauce](#metatagoptions-applesauce) - [ParseResult | AppleSauce](#parseresult-applesauce) - [StreamChatMessage | AppleSauce](#streamchatmessage-applesauce) - [NewDMRelays | AppleSauce](#newdmrelays-applesauce) - [ReplaceableModel | AppleSauce](#replaceablemodel-applesauce) - [PollType | AppleSauce](#polltype-applesauce) - [ModifyTagsOptions | AppleSauce](#modifytagsoptions-applesauce) - [WrappedMessageBlueprint | AppleSauce](#wrappedmessageblueprint-applesauce) - [NewFavoriteRelays | AppleSauce](#newfavoriterelays-applesauce) - [ReplaceableSetModel | AppleSauce](#replaceablesetmodel-applesauce) - [includeAltTag | AppleSauce](#includealttag-applesauce) - [ReadListTags | AppleSauce](#readlisttags-applesauce) - [WrappedMessageReplyBlueprint | AppleSauce](#wrappedmessagereplyblueprint-applesauce) - [NewSearchRelays | AppleSauce](#newsearchrelays-applesauce) - [RepliesModel | AppleSauce](#repliesmodel-applesauce) - [includeNameValueTag | AppleSauce](#includenamevaluetag-applesauce) - [ReportedEvent | AppleSauce](#reportedevent-applesauce) - [PinNote | AppleSauce](#pinnote-applesauce) - [SearchRelaysModel | AppleSauce](#searchrelaysmodel-applesauce) - [includeReplaceableIdentifier | AppleSauce](#includereplaceableidentifier-applesauce) --- # applesauce [Skip to content](https://hzrd149.github.io/applesauce/#VPContent) AppleSauceModular SDK for Nostr =============================== Build reactive nostr UI with less code [Getting Started](https://hzrd149.github.io/applesauce/introduction/getting-started.html) [Reference](https://hzrd149.github.io/applesauce/typedoc/index.html) [Examples](https://hzrd149.github.io/applesauce/examples/) [Migrations](https://hzrd149.github.io/applesauce/migration/v1-v2.html) Utilities --------- At its core AppleSauce is packages of helper methods to help parse and understand nostr events. Reactive -------- AppleSauce is built using RxJS observables, which makes subscribing to events and filters simple. Modular ------- Every piece of the packages can be used independently, helpers, event store, and signers. Flexible -------- Easily request events from relays without making connection state. or use any other nostr library to talk to relays. --- # AppleSauce AppleSauce ========== AppleSauce[](https://hzrd149.github.io/applesauce/typedoc/index.html#applesauce) ================================================================================= AppleSauce is a collection typescript libraries to make building nostr web clients easier and is used in [noStrudel](https://github.com/hzrd149/nostrudel) The full documentation can be found on the [documentation](https://hzrd149.github.io/applesauce) site. Installation[](https://hzrd149.github.io/applesauce/typedoc/index.html#installation) ------------------------------------------------------------------------------------- # using npmnpm install applesauce-core# using pnpmpnpm install applesauce-core# using yarnyarn add applesauce-core Development Setup[](https://hzrd149.github.io/applesauce/typedoc/index.html#development-setup) ----------------------------------------------------------------------------------------------- Clone the repository: git clone https://github.com/hzrd149/applesauce.gitcd applesauce Install dependencies: pnpm install Build the project: pnpm build Running tests[](https://hzrd149.github.io/applesauce/typedoc/index.html#running-tests) --------------------------------------------------------------------------------------- This repo uses [vitest](https://vitest.dev/) for all tests # Run all testspnpm test# Run coverage testspnpm coverage# Run the tests in dev modepnpm vitest Running documentation[](https://hzrd149.github.io/applesauce/typedoc/index.html#running-documentation) ------------------------------------------------------------------------------------------------------- This repo is setup with [typedoc](https://typedoc.org/) for the typescript documentation and [vitepress](https://vitepress.dev/) for the documentation site # Build the typedocspnpm typedoc The `packages/docs` is the package for the docs site cd packages/docs# Run vitepress devpnpm dev# Build vitepresspnpm build React[](https://hzrd149.github.io/applesauce/typedoc/index.html#react) ----------------------------------------------------------------------- The `applesauce-react` package contains various hooks and providers for using applesauce in react components, [Docs](https://hzrd149.github.io/applesauce/react/getting-started.html) Contributing[](https://hzrd149.github.io/applesauce/typedoc/index.html#contributing) ------------------------------------------------------------------------------------- 1. Fork the repository 2. Create your feature branch: `git checkout -b feature/my-new-feature` 3. Install dependencies: `pnpm install` 4. Make your changes 5. Run tests: `pnpm test` 6. Build the project: `pnpm build` 7. Format code: `pnpm format` 8. Commit your changes: `git commit -am 'Add some feature'` 9. Push to the branch: `git push origin feature/my-new-feature` 10. Submit a pull request ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page [AppleSauce](https://hzrd149.github.io/applesauce/typedoc/index.html#applesauce) * [Installation](https://hzrd149.github.io/applesauce/typedoc/index.html#installation) * [Development Setup](https://hzrd149.github.io/applesauce/typedoc/index.html#development-setup) * [Running tests](https://hzrd149.github.io/applesauce/typedoc/index.html#running-tests) * [Running documentation](https://hzrd149.github.io/applesauce/typedoc/index.html#running-documentation) * [React](https://hzrd149.github.io/applesauce/typedoc/index.html#react) * [Contributing](https://hzrd149.github.io/applesauce/typedoc/index.html#contributing) --- # Getting Started | applesauce [Skip to content](https://hzrd149.github.io/applesauce/introduction/getting-started.html#VPContent) Return to top Getting Started [​](https://hzrd149.github.io/applesauce/introduction/getting-started.html#getting-started) ============================================================================================================ Ready to build reactive Nostr applications with applesauce? Follow our step-by-step tutorial that will teach you everything you need to know. 📚 [Complete Tutorial](https://hzrd149.github.io/applesauce/tutorial/00-introduction.html) [​](https://hzrd149.github.io/applesauce/introduction/getting-started.html#%F0%9F%93%9A-complete-tutorial) ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Our beginner-friendly tutorial covers: 1. **[Event Store](https://hzrd149.github.io/applesauce/tutorial/01-event-store.html) ** - The reactive database at the heart of applesauce 2. **[Helpers](https://hzrd149.github.io/applesauce/tutorial/02-helpers.html) ** - Extract and parse data from Nostr events 3. **[Models](https://hzrd149.github.io/applesauce/tutorial/03-models.html) ** - Build reactive UI components 4. **[Relay Pool](https://hzrd149.github.io/applesauce/tutorial/04-relays.html) ** - Connect to Nostr relays and receive events 5. **[Loaders](https://hzrd149.github.io/applesauce/tutorial/05-loaders.html) ** - Load specific events on-demand 6. **[Event Factory](https://hzrd149.github.io/applesauce/tutorial/06-event-factory.html) ** - Create and sign events 7. **[Publishing](https://hzrd149.github.io/applesauce/tutorial/07-publishing.html) ** - Publish events to relays 8. **[Actions](https://hzrd149.github.io/applesauce/tutorial/08-actions.html) ** - Run complex actions like following users Each section includes complete code examples and builds toward a working social media application. Quick Overview [​](https://hzrd149.github.io/applesauce/introduction/getting-started.html#quick-overview) ---------------------------------------------------------------------------------------------------------- Applesauce consists of several key components that work together: ### EventStore [​](https://hzrd149.github.io/applesauce/introduction/getting-started.html#eventstore) A reactive in-memory database that stores Nostr events and notifies your UI when data changes. ts import { EventStore } from "applesauce-core"; const eventStore = new EventStore(); // Subscribe to timeline updates eventStore.timeline({ kinds: [1] }).subscribe((notes) => { console.log(`Timeline updated with ${notes.length} notes`); }); ### Helpers [​](https://hzrd149.github.io/applesauce/introduction/getting-started.html#helpers) Utility functions that extract useful data from raw Nostr events. ts import { getProfileContent, getDisplayName } from "applesauce-core/helpers"; const profile = getProfileContent(profileEvent); const name = getDisplayName(profile); ### Models [​](https://hzrd149.github.io/applesauce/introduction/getting-started.html#models) Pre-built subscriptions that combine EventStore with helpers for reactive UI components. ts import { ProfileModel } from "applesauce-core/models"; // Automatically parses and updates when profile changes eventStore.model(ProfileModel, pubkey).subscribe((profile) => { console.log("Profile updated:", profile); }); ### RelayPool [​](https://hzrd149.github.io/applesauce/introduction/getting-started.html#relaypool) Manages connections to Nostr relays and provides reactive subscriptions. ts import { RelayPool, onlyEvents } from "applesauce-relay"; const pool = new RelayPool(); pool .relay("wss://relay.damus.io") .subscription({ kinds: [1] }) .pipe(onlyEvents()) .subscribe((event) => { eventStore.add(event); }); ### EventFactory [​](https://hzrd149.github.io/applesauce/introduction/getting-started.html#eventfactory) Creates and signs Nostr events using pre-built blueprints. ts import { EventFactory } from "applesauce-factory"; import { NoteBlueprint } from "applesauce-factory/blueprints"; const factory = new EventFactory({ signer }); const note = await factory.create(NoteBlueprint, "Hello Nostr!"); const signed = await factory.sign(note); Next Steps [​](https://hzrd149.github.io/applesauce/introduction/getting-started.html#next-steps) -------------------------------------------------------------------------------------------------- * **Start with the [tutorial](https://hzrd149.github.io/applesauce/tutorial/00-introduction.html) ** to learn step-by-step * **Browse the [examples](https://hzrd149.github.io/applesauce/examples) ** to see whats possible * **Check the [API documentation](https://hzrd149.github.io/applesauce/typedoc/) ** for detailed reference --- # Migration Guide: v1 to v2 | applesauce [Skip to content](https://hzrd149.github.io/applesauce/migration/v1-v2.html#VPContent) Return to top Migration Guide: v1 to v2 [​](https://hzrd149.github.io/applesauce/migration/v1-v2.html#migration-guide-v1-to-v2) ================================================================================================================== This guide will help you migrate your existing applesauce v1 applications to v2. Applesauce v2 introduces several breaking changes that improve the API consistency and performance, but require some code updates. Overview of Major Changes [​](https://hzrd149.github.io/applesauce/migration/v1-v2.html#overview-of-major-changes) ------------------------------------------------------------------------------------------------------------------- * **Loaders**: All loader classes have been removed and replaced with functional loaders that return observables * **Queries → Models**: The "Queries" namespace has been renamed to "Models" throughout the codebase * **QueryStore Removal**: QueryStore has been merged into EventStore - use `eventStore.model()` instead * **React Hooks**: `useStoreQuery` has been renamed to `useEventModel` * **EventStore API**: Methods now return synchronous observables that emit `undefined` for missing events 1\. Loader Changes [​](https://hzrd149.github.io/applesauce/migration/v1-v2.html#_1-loader-changes) ---------------------------------------------------------------------------------------------------- ### The Problem [​](https://hzrd149.github.io/applesauce/migration/v1-v2.html#the-problem) In v1, loaders were classes that extended RxJS Subjects, making them stateful and harder to work with: ts // v1 - Class-based loaders import { TimelineLoader, SingleEventLoader, ReplaceableLoader } from "applesauce-loaders/loaders"; const timelineLoader = new TimelineLoader(rxNostr, ...args); const eventLoader = new SingleEventLoader(rxNostr, ...args); const replaceableLoader = new ReplaceableLoader(rxNostr, ...args); // The loaders had to be subscribe to globaly to work replaceableLoader.subscribe((event) => eventStore.add(event)); // Request a profile replaceableLoader.next({ kind: 0, pubkey }); // Then wait for the result replaceableLoader.subscribe((event) => { if (event.kind === 0 && event.pubkey === pubkey) console.log(event); }); This was difficult to work with since passing the request to the loader and subscribing to the results were two separate steps. ### The Solution [​](https://hzrd149.github.io/applesauce/migration/v1-v2.html#the-solution) In v2, loaders are functions that return observables, making them stateless and more functional: ts // v2 - Functional loaders import { createTimelineLoader, createEventLoader, createAddressLoader } from "applesauce-loaders/loaders"; // Create loader functions const timeline = createTimelineLoader(pool, { eventStore }); const eventLoader = createEventLoader(pool, { eventStore }); const addressLoader = createAddressLoader(pool, { eventStore }); // Request a single event const event = await eventLoader({ id: "event-id" }).subscribe((evetn) => { console.log(event); }); // Request a profile const profile = await addressLoader({ kind: 0, pubkey }).subscribe((events) => { console.log(events); }); // Load next page on a timeline const timeline = await timeline().subscribe((events) => { This allows the loaders to be used in a more functional way, since each request returns an observable and only returns the data for that single request. ### Migration Steps [​](https://hzrd149.github.io/applesauce/migration/v1-v2.html#migration-steps) 1. **Replace TimelineLoader**: For code that is using the `TimelineLoader` class, you can replace it with the `createTimelineLoader` function: ts // v1 const loader = new TimelineLoader(rxNostr, ...opts); // Start the loader loader.subscribe((events) => { // Handle events }); // Request the next page of the timeline loader.next(); // v2 const timelineLoader = createTimelineLoader( // A RelayPool instance or request method pool, // Relays to load from ["wss://relay.example.com"], // Filters for the timeline [{ kinds: [1], limit: 20 }], { // EventStore instance for deduplication eventStore, // Any other options ...opts, }, ); // Request the next page of the timeline timelineLoader().subscribe((events) => { // Handle events }); 2. **Replace SingleEventLoader**: For code that is using the `SingleEventLoader` class, you can replace it with the `createEventLoader` function: ts // v1 const loader = new SingleEventLoader(rxNostr, ...opts); loader.subscribe((event) => { // Handle event }); loader.next("event-id"); // v2 const eventLoader = createEventLoader(pool, { eventStore }); eventLoader({ id: "event-id", relays: ["wss://relay.example.com"] }).subscribe((event) => { // Handle event }); 3. **Replace ReplaceableLoader**: For code that is using the `ReplaceableLoader` class, you can replace it with the `createAddressLoader` function: ts // v1 const loader = new ReplaceableLoader(rxNostr, ...opts); loader.subscribe((event) => { // Handle event }); loader.next({ kind: 0, pubkey }); // v2 const addressLoader = createAddressLoader(pool, { eventStore }); addressLoader({ kind: 0, pubkey, relays: ["wss://relay.example.com"] }).subscribe((events) => { // Handle events }); ### New Loader Namespace [​](https://hzrd149.github.io/applesauce/migration/v1-v2.html#new-loader-namespace) All loaders are now exported under the `Loaders` namespace: ts // v2 - Import from namespace import { Loaders } from "applesauce-loaders"; const timelineLoader = Loaders.timelineLoader(pool, options); const eventLoader = Loaders.eventPointerLoader(pool, options); const addressLoader = Loaders.addressPointerLoader(pool, options); 2\. Queries to Models [​](https://hzrd149.github.io/applesauce/migration/v1-v2.html#_2-queries-to-models) ---------------------------------------------------------------------------------------------------------- In v2, the `Queries` namespace has been renamed to `Models` throughout the codebase. They are still functionally the same, but the names have been changed for clarity. and to allow the query store to be removed. ts // v1 import { Queries } from "applesauce-core"; // or import individual models import { ProfileQuery, TimelineQuery } from "applesauce-core/queries"; const query = queryStore.createQuery(Queries.ProfileQuery, pubkey); const timeline = queryStore.createQuery(Queries.TimelineQuery, { kinds: [1] }); // v2 import { Models } from "applesauce-core"; // or import individual models import { ProfileModel, TimelineModel } from "applesauce-core/models"; const profile = eventStore.model(Models.ProfileModel, pubkey); const timeline = eventStore.model(Models.TimelineModel, { kinds: [1] }); 3\. QueryStore Removal [​](https://hzrd149.github.io/applesauce/migration/v1-v2.html#_3-querystore-removal) ------------------------------------------------------------------------------------------------------------ ### The Problem [​](https://hzrd149.github.io/applesauce/migration/v1-v2.html#the-problem-1) In v1, the QueryStore was seperate from the EventStore. This made things difficult since apps would need to manage two separate stores. ts // v1 import { EventStore, QueryStore, Queries } from "applesauce-core"; const eventStore = new EventStore(); const queryStore = new QueryStore(eventStore); const profile = queryStore.createQuery(Queries.ProfileQuery, pubkey); ### The Solution [​](https://hzrd149.github.io/applesauce/migration/v1-v2.html#the-solution-1) In v2, QueryStore has been merged into EventStore. Use `eventStore.model()` directly: ts // v2 import { EventStore, Models } from "applesauce-core"; const eventStore = new EventStore(); const profile = eventStore.model(Models.ProfileModel, pubkey); 4\. React Integration Changes [​](https://hzrd149.github.io/applesauce/migration/v1-v2.html#_4-react-integration-changes) -------------------------------------------------------------------------------------------------------------------------- ### The Problem [​](https://hzrd149.github.io/applesauce/migration/v1-v2.html#the-problem-2) In v1, React integration required QueryStore providers and specific hooks: tsx // v1 import { QueryStoreProvider } from "applesauce-react/providers"; import { useStoreQuery } from "applesauce-react/hooks"; import { Queries } from "applesauce-core"; function App() { const queryStore = new QueryStore(eventStore); return ( ); } function Profile({ pubkey }) { const profile = useStoreQuery(Queries.ProfileQuery, [pubkey]); return
{profile?.name}
; } ### The Solution [​](https://hzrd149.github.io/applesauce/migration/v1-v2.html#the-solution-2) In v2, use EventStore directly with the renamed hook: tsx // v2 import { EventStoreProvider } from "applesauce-react/providers"; import { useEventModel } from "applesauce-react/hooks"; import { Models } from "applesauce-core"; function App() { return ( ); } function Profile({ pubkey }) { const profile = useEventModel(Models.ProfileModel, [pubkey]); return
{profile?.name}
; } ### Migration Steps [​](https://hzrd149.github.io/applesauce/migration/v1-v2.html#migration-steps-1) 1. **Remove QueryStoreProvider**: tsx // v1 - Remove // v2 - Use EventStoreProvider 2. **Update hook imports and usage**: tsx // v1 import { useStoreQuery } from "applesauce-react/hooks"; const profile = useStoreQuery(Queries.ProfileQuery, pubkey); // v2 import { useEventModel } from "applesauce-react/hooks"; const profile = useEventModel(Models.ProfileModel, pubkey); 5\. EventStore Stream Changes [​](https://hzrd149.github.io/applesauce/migration/v1-v2.html#_5-eventstore-stream-changes) -------------------------------------------------------------------------------------------------------------------------- ### The Problem [​](https://hzrd149.github.io/applesauce/migration/v1-v2.html#the-problem-3) In v1, EventStore streams used inconsistent naming without the RxJS convention. In v2, all EventStore streams follow RxJS naming conventions with `$` suffix: ts // v1 - Inconsistent stream naming eventStore.inserts.subscribe((event) => { console.log("New event:", event); }); eventStore.updates.subscribe((event) => { console.log("Updated event:", event); }); eventStore.removes.subscribe((event) => { console.log("Removed event:", event); }); // v2 - Consistent stream naming with $ suffix eventStore.insert$.subscribe((event) => { console.log("New event:", event); }); eventStore.update$.subscribe((event) => { console.log("Updated event:", event); }); eventStore.remove$.subscribe((event) => { console.log("Removed event:", event); }); ### Migration Steps [​](https://hzrd149.github.io/applesauce/migration/v1-v2.html#migration-steps-2) 1. **Update stream subscriptions**: ts // v1 eventStore.inserts.subscribe(handler); eventStore.updates.subscribe(handler); eventStore.removes.subscribe(handler); // v2 eventStore.insert$.subscribe(handler); eventStore.update$.subscribe(handler); eventStore.remove$.subscribe(handler); 6\. Removed APIs [​](https://hzrd149.github.io/applesauce/migration/v1-v2.html#_6-removed-apis) ------------------------------------------------------------------------------------------------ Several APIs have been removed in v2. Here's how to handle them: ### Removed Methods [​](https://hzrd149.github.io/applesauce/migration/v1-v2.html#removed-methods) * **`getPointerFromTag`**: This method has been removed. Use the individual pointer helper functions instead: ts // v1 import { getPointerFromTag } from "applesauce-core"; const pointer = getPointerFromTag(tag); // v2 - Use specific pointer helpers import { getEventPointerFromTag, getAddressPointerFromTag, getPubkeyPointerFromTag } from "applesauce-core/helpers"; const eventPointer = getEventPointerFromTag(tag); const addressPointer = getAddressPointerFromTag(tag); const pubkeyPointer = getPubkeyPointerFromTag(tag); ### Renamed Methods [​](https://hzrd149.github.io/applesauce/migration/v1-v2.html#renamed-methods) * **`setEventContentEncryptionMethod`** → **`setEncryptedContentEncryptionMethod`**: ts // v1 import { setEventContentEncryptionMethod } from "applesauce-core"; setEventContentEncryptionMethod(kind, "nip04"); // v2 import { setEncryptedContentEncryptionMethod } from "applesauce-core"; setEncryptedContentEncryptionMethod(kind, "nip04"); 7\. EventStore Return Value Changes [​](https://hzrd149.github.io/applesauce/migration/v1-v2.html#_7-eventstore-return-value-changes) -------------------------------------------------------------------------------------------------------------------------------------- ### EventStore.add() Changes [​](https://hzrd149.github.io/applesauce/migration/v1-v2.html#eventstore-add-changes) The `EventStore.add()` method now has more specific return behavior: ts // v2 - Updated return values const result = eventStore.add(event); if (result === null) { // Event was ignored by verifyEvent function console.log("Event was rejected"); } else if (result === event) { // Event was successfully added as new console.log("New event added"); } else { // Event was a duplicate, existing event returned console.log("Duplicate event, existing instance returned"); } ### EventStore.update() Changes [​](https://hzrd149.github.io/applesauce/migration/v1-v2.html#eventstore-update-changes) The `EventStore.update()` method now returns a boolean: ts // v2 - Returns boolean const wasUpdated = eventStore.update(event); if (wasUpdated) { console.log("Event was updated successfully"); } else { console.log("Event update failed"); } ### Migration Steps [​](https://hzrd149.github.io/applesauce/migration/v1-v2.html#migration-steps-3) 1. **Handle null returns from add()**: ts // v1 const addedEvent = eventStore.add(event); // addedEvent was always the event or existing event // v2 const result = eventStore.add(event); if (result === null) { // Handle rejected event console.warn("Event was rejected by verification"); } else { // Use the returned event (could be existing duplicate) const addedEvent = result; } 2. **Handle boolean returns from update()**: ts // v1 eventStore.update(event); // void return // v2 const success = eventStore.update(event); if (!success) { console.warn("Failed to update event"); } 8\. Additional Changes [​](https://hzrd149.github.io/applesauce/migration/v1-v2.html#_8-additional-changes) ------------------------------------------------------------------------------------------------------------ Summary of Required Changes [​](https://hzrd149.github.io/applesauce/migration/v1-v2.html#summary-of-required-changes) ----------------------------------------------------------------------------------------------------------------------- 1. **Replace all loader classes** with functional loaders 2. **Rename all `Queries` to `Models`** in imports and usage 3. **Remove QueryStore** and use `eventStore.model()` directly 4. **Update React hooks** from `useStoreQuery` to `useEventModel` 5. **Replace QueryStoreProvider** with `EventStoreProvider` 6. **Update EventStore stream names** from `inserts`/`updates`/`removes` to `insert$`/`update$`/`remove$` 7. **Replace removed APIs** like `getPointerFromTag` with specific pointer helpers 8. **Rename methods** like `setEventContentEncryptionMethod` → `setEncryptedContentEncryptionMethod` 9. **Handle new return values** from `EventStore.add()` (can return `null`) and `EventStore.update()` (returns boolean) --- # Beginner's Tutorial | applesauce [Skip to content](https://hzrd149.github.io/applesauce/tutorial/00-introduction.html#VPContent) Return to top Beginner's Tutorial [​](https://hzrd149.github.io/applesauce/tutorial/00-introduction.html#beginner-s-tutorial) ================================================================================================================ Welcome to the Applesauce tutorial! This step-by-step guide will teach you how to build reactive Nostr applications using the applesauce library ecosystem. What You'll Learn [​](https://hzrd149.github.io/applesauce/tutorial/00-introduction.html#what-you-ll-learn) ------------------------------------------------------------------------------------------------------------ By the end of this tutorial, you'll understand how to: * Set up an in-memory reactive database for Nostr events * Parse and display user profiles and content * Create reactive UI components that respond to data changes * Connect to Nostr relays and subscribe to events * Create and publish new Nostr events Tutorial Structure [​](https://hzrd149.github.io/applesauce/tutorial/00-introduction.html#tutorial-structure) -------------------------------------------------------------------------------------------------------------- This tutorial is broken down into digestible sections: 1. **[Introduction to EventStore](https://hzrd149.github.io/applesauce/tutorial/01-event-store.html) ** - Learn about the reactive database at the heart of applesauce 2. **[Working with Helpers](https://hzrd149.github.io/applesauce/tutorial/02-helpers.html) ** - Parse profiles and extract data from events 3. **[Building Reactive UI with Models](https://hzrd149.github.io/applesauce/tutorial/03-models.html) ** - Create React components that respond to data changes 4. **[Connecting to Relays](https://hzrd149.github.io/applesauce/tutorial/04-relays.html) ** - Subscribe to Nostr relays and receive events 5. **[Loading Specific Events with Loaders](https://hzrd149.github.io/applesauce/tutorial/05-loaders.html) ** - Load specific events from relays 6. **[Creating Events with EventFactory](https://hzrd149.github.io/applesauce/tutorial/06-event-factory.html) ** - Set up event creation and signing 7. **[Publishing Events](https://hzrd149.github.io/applesauce/tutorial/07-publishing.html) ** - Publish events to relays and handle responses 8. **[Using Actions](https://hzrd149.github.io/applesauce/tutorial/08-actions.html) ** - Run complex actions like following users Prerequisites [​](https://hzrd149.github.io/applesauce/tutorial/00-introduction.html#prerequisites) ---------------------------------------------------------------------------------------------------- * Basic knowledge of JavaScript/TypeScript * Familiarity with React hooks (`useState`, `useEffect`) * Understanding of RxJS observables (helpful but not required) * A Nostr extension wallet (like [Alby](https://getalby.com/) or [nos2x](https://github.com/fiatjaf/nos2x) ) Getting Started [​](https://hzrd149.github.io/applesauce/tutorial/00-introduction.html#getting-started) -------------------------------------------------------------------------------------------------------- Let's begin with [Introduction to EventStore](https://hzrd149.github.io/applesauce/tutorial/01-event-store.html) to learn about the foundation of applesauce applications. --- # Glossary | applesauce [Skip to content](https://hzrd149.github.io/applesauce/introduction/glossary.html#VPContent) Return to top Glossary [​](https://hzrd149.github.io/applesauce/introduction/glossary.html#glossary) ======================================================================================= Event [​](https://hzrd149.github.io/applesauce/introduction/glossary.html#event) --------------------------------------------------------------------------------- A nostr event defined in [NIP-01](https://github.com/nostr-protocol/nips/blob/master/01.md) Signer [​](https://hzrd149.github.io/applesauce/introduction/glossary.html#signer) ----------------------------------------------------------------------------------- A class that follows the [NIP-07](https://github.com/nostr-protocol/nips/blob/master/07.md) API Helper method [​](https://hzrd149.github.io/applesauce/introduction/glossary.html#helper-method) ------------------------------------------------------------------------------------------------- A function that takes an event and returns some computed value from it. Event store [​](https://hzrd149.github.io/applesauce/introduction/glossary.html#event-store) --------------------------------------------------------------------------------------------- A in-memory database of events that can be subscribed to. (see [Event Store](https://hzrd149.github.io/applesauce/core/event-store.html) ) Observable [​](https://hzrd149.github.io/applesauce/introduction/glossary.html#observable) ------------------------------------------------------------------------------------------- A lazy stream of values that is active when subscribed to. (see [Observables](https://rxjs.dev/guide/observable) ) Model [​](https://hzrd149.github.io/applesauce/introduction/glossary.html#model) --------------------------------------------------------------------------------- Computed state from the event store that can be subscribed to. (see [Models](https://hzrd149.github.io/applesauce/core/models.html) ) Encrypted content [​](https://hzrd149.github.io/applesauce/introduction/glossary.html#encrypted-content) --------------------------------------------------------------------------------------------------------- The `content` field of an event that is encrypted using NIP-04 or NIP-44. Hidden content [​](https://hzrd149.github.io/applesauce/introduction/glossary.html#hidden-content) --------------------------------------------------------------------------------------------------- The `content` field that is encrypted by the signer to its own pubkey. primary used in NIP-51 lists. Hidden tags [​](https://hzrd149.github.io/applesauce/introduction/glossary.html#hidden-tags) --------------------------------------------------------------------------------------------- An array of event tags that is in the **hidden content** --- # 1. Introduction to EventStore | applesauce [Skip to content](https://hzrd149.github.io/applesauce/tutorial/01-event-store.html#VPContent) Return to top 1\. Introduction to EventStore [​](https://hzrd149.github.io/applesauce/tutorial/01-event-store.html#_1-introduction-to-eventstore) ==================================================================================================================================== The `EventStore` is the heart of every applesauce application. Its a reactive in-memory database specifically designed for Nostr events. Instead of constantly fetching data from relays, your UI components subscribe to the EventStore and automatically update when new events arrive. What is the EventStore? [​](https://hzrd149.github.io/applesauce/tutorial/01-event-store.html#what-is-the-eventstore) ---------------------------------------------------------------------------------------------------------------------- The EventStore is a reactive database that: * **Stores events in memory** for fast access * **Deduplicates events** automatically * **Handles replaceable events** (like profiles) by keeping only the latest version * **Notifies subscribers** when relevant events are added, updated, or removed * **Works with RxJS observables** for reactive programming Creating an EventStore [​](https://hzrd149.github.io/applesauce/tutorial/01-event-store.html#creating-an-eventstore) --------------------------------------------------------------------------------------------------------------------- Creating an EventStore is simple: typescript import { EventStore } from "applesauce-core"; // Create a single event store for your entire app const eventStore = new EventStore(); > 💡 **Best Practice**: Create only one EventStore instance for your entire application and share it across components. Adding Events [​](https://hzrd149.github.io/applesauce/tutorial/01-event-store.html#adding-events) --------------------------------------------------------------------------------------------------- You can add events to the store using the `add()` method: typescript const event = { content: "These numbers are so kind.", created_at: 1745847253, id: "621233a1ad1b91620f0b4a308c2113243a98925909cdb7b26284cbb4d835a18c", kind: 1, pubkey: "3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d", sig: "eb8f30f7c44d031bfe315d476165f5cf29c21f1eaf07128f5a673cdb3b69ebf7902dacc06987f8d764b17225aefecdbc91992165e03372e40f57639a41203a1c", tags: [], }; // Add the event to the store eventStore.add(event); The EventStore automatically: * **Deduplicates** - Won't add the same event twice * **Replaces** - Updates replaceable events (kind 0 profiles, kind 3 contacts, etc.) with newer versions * **Notifies** - Triggers updates for any components subscribed to this event Checking for Events [​](https://hzrd149.github.io/applesauce/tutorial/01-event-store.html#checking-for-events) --------------------------------------------------------------------------------------------------------------- You can check if events exist in the store: typescript // Check if a specific event exists const hasEvent = eventStore.hasEvent("abc123..."); // Check if a user has a profile const hasProfile = eventStore.hasReplaceable(0, "userPubkey"); // Get an event directly const event = eventStore.getEvent("abc123..."); // Get a user's latest profile const profile = eventStore.getReplaceable(0, "userPubkey"); Subscribing to Events [​](https://hzrd149.github.io/applesauce/tutorial/01-event-store.html#subscribing-to-events) ------------------------------------------------------------------------------------------------------------------- The real power of the EventStore comes from its reactive subscriptions. Here are the main subscription types: ### Single Event Subscription [​](https://hzrd149.github.io/applesauce/tutorial/01-event-store.html#single-event-subscription) typescript // Subscribe to a specific event eventStore.event("abc123...").subscribe((event) => { if (event) { console.log("Event found:", event); } else { console.log("Event not in store or was deleted"); } }); ### Replaceable Event Subscription [​](https://hzrd149.github.io/applesauce/tutorial/01-event-store.html#replaceable-event-subscription) typescript // Subscribe to a user's profile (kind 0) eventStore.replaceable(0, "userPubkey").subscribe((profile) => { if (profile) { console.log("User profile:", profile); } }); ### Stream Subscription [​](https://hzrd149.github.io/applesauce/tutorial/01-event-store.html#stream-subscription) typescript // Subscribe to all text notes as they're added eventStore.stream({ kinds: [1] }).subscribe((event) => { console.log("New text note:", event); }); ### Timeline Subscription [​](https://hzrd149.github.io/applesauce/tutorial/01-event-store.html#timeline-subscription) typescript // Subscribe to a sorted timeline of text notes eventStore.timeline({ kinds: [1] }).subscribe((events) => { console.log(`Timeline updated with ${events.length} notes`); // events is a sorted array (newest first) }); A Simple Example [​](https://hzrd149.github.io/applesauce/tutorial/01-event-store.html#a-simple-example) --------------------------------------------------------------------------------------------------------- Let's see how this works in practice: typescript import { EventStore } from "applesauce-core"; // Create the store const eventStore = new EventStore(); // Subscribe to all text notes eventStore.timeline({ kinds: [1] }).subscribe((timeline) => { console.log(`Timeline has ${timeline.length} notes`); }); // Add some events eventStore.add({ content: 'I just wish LLMs would stop saying their solutions are "comprehensive" or "powerful"', created_at: 1749596768, id: "77941979d4c04283fd9b2f0a280749248cbd41babe3a0731c1597a6d54ae7874", kind: 1, pubkey: "97c70a44366a6535c145b333f973ea86dfdc2d7a99da618c40c64705ad98e322", sig: "a0884549f09ef805d3ffa917c3d9e189882295f1b819c038e5d28ea1a668f4455f66ada40749dbdb6dfd48c323f507889330a2a4742b0cb66d8997afb31ff47e", tags: [["client", "Coracle", "31990:97c70a44366a6535c145b333f973ea86dfdc2d7a99da618c40c64705ad98e322:1685968093690"]], }); eventStore.add({ content: "These numbers are so kind.", created_at: 1745847253, id: "621233a1ad1b91620f0b4a308c2113243a98925909cdb7b26284cbb4d835a18c", kind: 1, pubkey: "3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d", sig: "eb8f30f7c44d031bfe315d476165f5cf29c21f1eaf07128f5a673cdb3b69ebf7902dacc06987f8d764b17225aefecdbc91992165e03372e40f57639a41203a1c", tags: [], }); // The timeline subscription will fire twice: // First: "Timeline has 1 notes" // Then: "Timeline has 2 notes" Key Concepts [​](https://hzrd149.github.io/applesauce/tutorial/01-event-store.html#key-concepts) ------------------------------------------------------------------------------------------------- * **Reactive**: Changes to the EventStore automatically update your UI * **In-memory**: Events are stored in RAM for fast access (not persisted) * **Deduplication**: The same event won't be added twice * **Replaceable events**: Newer versions replace older ones automatically * **Filters**: Use Nostr filters to subscribe to specific types of events Why Use EventStore? [​](https://hzrd149.github.io/applesauce/tutorial/01-event-store.html#why-use-eventstore) -------------------------------------------------------------------------------------------------------------- Without EventStore, you'd need to: * Manually track which events you've already received * Handle event deduplication yourself * Manually update UI components when new events arrive * Deal with replaceable event logic With EventStore, all of this is handled automatically, letting you focus on building your application logic. --- # 2. Using Helper Methods | applesauce [Skip to content](https://hzrd149.github.io/applesauce/tutorial/02-helpers.html#VPContent) Return to top 2\. Using Helper Methods [​](https://hzrd149.github.io/applesauce/tutorial/02-helpers.html#_2-using-helper-methods) ==================================================================================================================== Helper methods are the Swiss Army knife of applesauce. They extract useful information from raw Nostr events, making it easy to display user profiles, parse content, and work with different event types. What are Helpers? [​](https://hzrd149.github.io/applesauce/tutorial/02-helpers.html#what-are-helpers) ------------------------------------------------------------------------------------------------------ Helpers are utility functions that: * **Parse event content** - Extract structured data from JSON or text * **Handle different event types** - Kind 0 profiles, kind 1 notes, kind 3 contacts, etc. * **Provide fallbacks** - Return sensible defaults when data is missing * **Validate data** - Ensure the extracted data is properly formatted Essential Profile Helpers [​](https://hzrd149.github.io/applesauce/tutorial/02-helpers.html#essential-profile-helpers) ----------------------------------------------------------------------------------------------------------------------- Let's start with the most commonly used helpers for working with user profiles. ### Getting Profile Content [​](https://hzrd149.github.io/applesauce/tutorial/02-helpers.html#getting-profile-content) The `getProfileContent` helper extracts and parses a user's profile from a kind 0 event: typescript import { getProfileContent } from "applesauce-core/helpers"; // A raw kind 0 profile event const profileEvent = { content: '{"name":"fiatjaf","about":"~","picture":"https://fiatjaf.com/static/favicon.jpg","nip05":"_@fiatjaf.com","lud16":"fiatjaf@zbd.gg","website":"https://nostr.technology"}', created_at: 1738588530, id: "c43be8b4634298e97dde3020a5e6aeec37d7f5a4b0259705f496e81a550c8f8b", kind: 0, pubkey: "3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d", relays: [""], sig: "202a1bf6a58943d660c1891662dbdda142aa8e5bca9d4a3cb03cde816ad3bdda6f4ec3b880671506c2820285b32218a0afdec2d172de9694d83972190ab4f9da", tags: [], }; // Extract the profile content const profile = getProfileContent(profileEvent); console.log(profile); // Output: // { // name: "fiatjaf", // about: "~", // picture: "https://fiatjaf.com/static/favicon.jpg", // nip05: "_@fiatjaf.com", // lud16: "fiatjaf@zbd.gg", // website: "https://nostr.technology", // } If the profile content is invalid JSON or missing, `getProfileContent` returns `undefined` rather than throwing an error. ### Getting Display Names [​](https://hzrd149.github.io/applesauce/tutorial/02-helpers.html#getting-display-names) The `getDisplayName` helper provides a user-friendly name with intelligent fallbacks: typescript import { getDisplayName } from "applesauce-core/helpers"; // Profile with a name const profile1 = { name: "Alice", display_name: "Alice in Nostrland" }; console.log(getDisplayName(profile1)); // "Alice in Nostrland" // Profile with only a name const profile2 = { name: "Bob" }; console.log(getDisplayName(profile2)); // "Bob" // Profile with no name const profile3 = { about: "Just a user" }; console.log(getDisplayName(profile3)); // "Unknown" // Can also pass a pubkey as fallback console.log(getDisplayName(profile3, "npub1...")); // "npub1..." The helper checks for names in this order: 1. `display_name` field 2. `name` field 3. Provided fallback 4. "Unknown" ### Getting Profile Pictures [​](https://hzrd149.github.io/applesauce/tutorial/02-helpers.html#getting-profile-pictures) Similar to display names, `getProfilePicture` provides intelligent fallbacks for profile images: typescript import { getProfilePicture } from "applesauce-core/helpers"; // Profile with picture const profile1 = { picture: "https://example.com/alice.jpg" }; console.log(getProfilePicture(profile1)); // "https://example.com/alice.jpg" // Profile without picture - provide fallback const profile2 = { name: "Bob" }; const fallbackUrl = "https://robohash.org/bob.png"; console.log(getProfilePicture(profile2, fallbackUrl)); // "https://robohash.org/bob.png" Putting It Together: Profile Component [​](https://hzrd149.github.io/applesauce/tutorial/02-helpers.html#putting-it-together-profile-component) ------------------------------------------------------------------------------------------------------------------------------------------------ Let's create a React component that uses these helpers: tsx import React from "react"; import { getDisplayName, getProfilePicture } from "applesauce-core/helpers"; function ProfileCard({ profile }: { profile: NostrEvent }) { // Get the profile content const content = getProfileContent(profile); // Get display name with pubkey fallback const displayName = getDisplayName(content, profile.pubkey.slice(0, 8) + "..."); // Get profile picture with robohash fallback const profilePicture = getProfilePicture(content, `https://robohash.org/${profile.pubkey}.png`); return (
{displayName}

{displayName}

{content?.about &&

{content.about}

}
); } Other Useful Helpers [​](https://hzrd149.github.io/applesauce/tutorial/02-helpers.html#other-useful-helpers) ------------------------------------------------------------------------------------------------------------- There are many more helpers available. Checkout the [typedocs](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#addrelayhintstopointer) to see all the helpers. Here are some commonly used ones: ### Content Helpers [​](https://hzrd149.github.io/applesauce/tutorial/02-helpers.html#content-helpers) typescript import { getArticleTitle, getArticleSummary, getHashtags, getMentions } from "applesauce-core/helpers"; // Extract article title from long-form content (kind 30023) const title = getArticleTitle(articleEvent); // Get the users in a NIP-51 user list const people = getEventPointersFromList(listEvent); // [{pubkey: "pubkey1"}, {pubkey: "pubkey2"}] // Get outbox relays from a kind 10002 relay list event const outboxes = getOutboxes(relayListEvent); // ["wss://relay1.com", "wss://relay2.com"] // Get inbox relays const inboxes = getInboxes(relayListEvent); // ["wss://inbox1.com", "wss://inbox2.com"] Key Concepts [​](https://hzrd149.github.io/applesauce/tutorial/02-helpers.html#key-concepts) --------------------------------------------------------------------------------------------- * **Helpers parse raw events** into usable data * **Fallbacks** prevent your UI from breaking * **Composable** - combine helpers with EventStore subscriptions * **Type-safe** - TypeScript definitions help catch errors Real-World Example [​](https://hzrd149.github.io/applesauce/tutorial/02-helpers.html#real-world-example) --------------------------------------------------------------------------------------------------------- Here's a complete example showing helpers in action: typescript import { EventStore } from "applesauce-core"; import { getProfileContent, getDisplayName, getProfilePicture } from "applesauce-core/helpers"; const eventStore = new EventStore(); function displayUserInfo(pubkey: string) { // Get the user's profile from the store const profileEvent = eventStore.getReplaceable(0, pubkey); if (profileEvent) { const profile = getProfileContent(profileEvent); const name = getDisplayName(profile, pubkey.slice(0, 8) + "..."); const picture = getProfilePicture(profile, `https://robohash.org/${pubkey}.png`); console.log(`Name: ${name}`); console.log(`Picture: ${picture}`); console.log(`About: ${profile?.about || "No bio available"}`); } else { console.log("Profile not found in store"); } } --- # 5. Loading Specific Events with Loaders | applesauce [Skip to content](https://hzrd149.github.io/applesauce/tutorial/05-loaders.html#VPContent) Return to top 5\. Loading Specific Events with Loaders [​](https://hzrd149.github.io/applesauce/tutorial/05-loaders.html#_5-loading-specific-events-with-loaders) ==================================================================================================================================================== Loaders are specialized utilities that help you fetch specific events from relays efficiently. While RelayPool subscriptions are great for real-time feeds, loaders are perfect for loading individual events, user profiles, or addressable events on-demand. What are Loaders? [​](https://hzrd149.github.io/applesauce/tutorial/05-loaders.html#what-are-loaders) ------------------------------------------------------------------------------------------------------ Loaders are functions that: * **Use the relay pool** to fetch events from multiple relays * **Load specific events** by ID, address, or other criteria * **Handle multiple relays** automatically for better reliability * **Return observables** that complete when the request is complete * **Integrate with EventStore** to automatically store loaded events Event Loader [​](https://hzrd149.github.io/applesauce/tutorial/05-loaders.html#event-loader) --------------------------------------------------------------------------------------------- The `createEventLoader` function creates a loader for fetching events by their IDs. ### Setting up Event Loader [​](https://hzrd149.github.io/applesauce/tutorial/05-loaders.html#setting-up-event-loader) typescript import { createEventLoader } from "applesauce-loaders/loaders"; import { RelayPool } from "applesauce-relay"; import { EventStore } from "applesauce-core"; const pool = new RelayPool(); const eventStore = new EventStore(); // Create an event loader const eventLoader = createEventLoader(pool, { // Add events to the EventStore and deduplicate them eventStore, // Always check these relays for events extraRelays: ["wss://relay.damus.io", "wss://nos.lol", "wss://relay.nostr.band"], }); ### Loading Events by ID [​](https://hzrd149.github.io/applesauce/tutorial/05-loaders.html#loading-events-by-id) typescript // Make a request and subscribe to the result eventLoader({ id: "621233a1ad1b91620f0b4a308c2113243a98925909cdb7b26284cbb4d835a18c", relays: ["wss://relay.damus.io"], }).subscribe((event) => { console.log("Loaded event:", event.id); console.log("Content:", event.content); // Event is automatically added to EventStore }); ### Loading Multiple Events [​](https://hzrd149.github.io/applesauce/tutorial/05-loaders.html#loading-multiple-events) Since the event loader returns an observable, you can use the `merge` operator from RxJS to make multiple requests at once. typescript // Make two requests at once and subscribe to the results merge( eventLoader({ id: "621233a1ad1b91620f0b4a308c2113243a98925909cdb7b26284cbb4d835a18c" }), eventLoader({ id: "77941979d4c04283fd9b2f0a280749248cbd41babe3a0731c1597a6d54ae7874" }), ).subscribe({ next: (event) => { console.log("Loaded event:", event.id); }, complete: () => { console.log("Both requested completed"); }, }); Address Loader [​](https://hzrd149.github.io/applesauce/tutorial/05-loaders.html#address-loader) ------------------------------------------------------------------------------------------------- The `createAddressLoader` function creates a loader for fetching addressable events (kinds 30000-39999) by their `kind`, `pubkey` and optional `identifier`. ### Setting up Address Loader [​](https://hzrd149.github.io/applesauce/tutorial/05-loaders.html#setting-up-address-loader) typescript import { createAddressLoader } from "applesauce-loaders/loaders"; // Create an address loader const addressLoader = createAddressLoader(pool, { eventStore }); ### Loading Addressable Events [​](https://hzrd149.github.io/applesauce/tutorial/05-loaders.html#loading-addressable-events) typescript // Load a specific addressable event const pointer = { kind: 30023, // Long-form content pubkey: "3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d", identifier: "my-article", relays: ["wss://relay.damus.io", "wss://nos.lol"], }; // Create the request and subscribe to the result addressLoader(pointer).subscribe((event) => { console.log("Loaded article:", event.id); console.log("Title:", getArticleTitle(event)); }); ### Loading Multiple [​](https://hzrd149.github.io/applesauce/tutorial/05-loaders.html#loading-multiple) Again, same as the event loader. the address loader returns an observable, so you can use the `merge` operator from RxJS to make multiple requests at once. typescript // Make two requests at once and subscribe to the results merge( addressLoader({ kind: 30023, pubkey: "pubkey1", identifier: "article-1" }), addressLoader({ kind: 30023, pubkey: "pubkey2", identifier: "article-2" }), ).subscribe({ next: (event) => { console.log("Loaded addressable event:", event.id); }, complete: () => { console.log("All addressable events loaded"); }, }); Practical Examples [​](https://hzrd149.github.io/applesauce/tutorial/05-loaders.html#practical-examples) --------------------------------------------------------------------------------------------------------- ### Loading a User's Profile [​](https://hzrd149.github.io/applesauce/tutorial/05-loaders.html#loading-a-user-s-profile) typescript const addressLoader = createAddressLoader(pool, { eventStore }); function loadUserProfile(pubkey: string, relays: string[]) { return addressLoader({ kind: 0, pubkey, relays }).pipe( // Take only the first (most recent) profile take(1), map((event) => getProfileContent(event)), ); } // Usage loadUserProfile( // Pass pubkey "3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d", // And the relays to load from ["wss://relay.damus.io", "wss://nos.lol"], ).subscribe((profile) => { if (profile) { console.log("Profile loaded:", profile.name); } }); Loader Configuration [​](https://hzrd149.github.io/applesauce/tutorial/05-loaders.html#loader-configuration) ------------------------------------------------------------------------------------------------------------- ### Custom Relays [​](https://hzrd149.github.io/applesauce/tutorial/05-loaders.html#custom-relays) The event loader and address loader both take an `extraRelays` option. This is an array of relays that will always be checked for events. typescript const addressLoader = createEventLoader(pool, { eventStore, extraRelays: ["wss://relay.damus.io", "wss://nos.lol"], }); const articleLoader = createAddressLoader(pool, { eventStore, extraRelays: ["wss://relay.nostr.band", "wss://relay.damus.io"], }); ### Timeout Configuration [​](https://hzrd149.github.io/applesauce/tutorial/05-loaders.html#timeout-configuration) The event loader and address loader both take a `timeout` option which can be used to configure the timeout for the requests. typescript // Create loader with custom timeout const eventLoader = createEventLoader(pool, { eventStore, extraRelays: ["wss://relay.damus.io"], timeout: 10000, // 10 second timeout }); ### Cache Configuration [​](https://hzrd149.github.io/applesauce/tutorial/05-loaders.html#cache-configuration) The event loader and address loader both take a `cacheRequest` option which is used to load events from a local cache first. typescript // A method to load events from a local cache async function cacheRequest(filters: Filter[]) { // Make a request to your custom local cache const events = await localCache.getEventsForFilters(filters); // Return the events as an array of events return events; } // Create the loader with the cache request option const eventLoader = createEventLoader(pool, { eventStore, cacheRequest }); Key Concepts [​](https://hzrd149.github.io/applesauce/tutorial/05-loaders.html#key-concepts) --------------------------------------------------------------------------------------------- * **Loaders fetch specific events** on-demand, unlike subscriptions * **Results are added to the EventStore** automatically * **Observables complete** when the request is complete Best Practices [​](https://hzrd149.github.io/applesauce/tutorial/05-loaders.html#best-practices) ------------------------------------------------------------------------------------------------- ### 1\. Check EventStore First [​](https://hzrd149.github.io/applesauce/tutorial/05-loaders.html#_1-check-eventstore-first) typescript // Always check if the event is already loaded const existingEvent = eventStore.getEvent(eventId); if (existingEvent) { // Use existing event console.log("Event already loaded:", existingEvent.content); } else { // Load from relays eventLoader({ ids: [eventId] }).subscribe(/* ... */); } ### 2\. Use Relays in requests [​](https://hzrd149.github.io/applesauce/tutorial/05-loaders.html#_2-use-relays-in-requests) Its better to pass the relays to the request than to use the `extraRelays` option. typescript // Use multiple relays for better reliability const eventLoader = createEventLoader(pool, { eventStore }); eventLoader({ id: eventId, relays: ["wss://relay.damus.io", "wss://nos.lol"] }).subscribe((event) => { console.log("Loaded event:", event.id); }); --- # 7. Publishing Events | applesauce [Skip to content](https://hzrd149.github.io/applesauce/tutorial/07-publishing.html#VPContent) Return to top 7\. Publishing Events [​](https://hzrd149.github.io/applesauce/tutorial/07-publishing.html#_7-publishing-events) ================================================================================================================= The final step in building a Nostr app is publishing your events to relays so other users can see them. The `RelayPool` provides methods for publishing events and handling the responses from relays. What is Publishing? [​](https://hzrd149.github.io/applesauce/tutorial/07-publishing.html#what-is-publishing) ------------------------------------------------------------------------------------------------------------- Publishing is the process of: * **Sending signed events to relays** - Broadcasting your content to the network * **Handling relay responses** - Success, errors, or rejection messages * **Managing multiple relays** - Publishing to several relays for redundancy * **Providing user feedback** - Showing publication status to users Basic Event Publishing [​](https://hzrd149.github.io/applesauce/tutorial/07-publishing.html#basic-event-publishing) -------------------------------------------------------------------------------------------------------------------- Here's how to publish a single event to a relay using the `pool.relay` method to select a single relay and the `publish` method to publish the event. typescript const pool = new RelayPool(); const event: NostrEvent = { // ...signed nostr event }; try { const response = await pool.relay("wss://relay.damus.io").publish(event); if (response.ok) { console.log(`Event published successfully to ${response.from}`); } else { console.log(`Failed to publish event to ${response.from}: ${response.message}`); } } catch (error) { console.error("Error publishing event:", error); } INFO The `publish` method now returns a `Promise` directly, so you can use `await` or `.then()` instead of subscribing to an Observable. Publishing to Multiple Relays [​](https://hzrd149.github.io/applesauce/tutorial/07-publishing.html#publishing-to-multiple-relays) ---------------------------------------------------------------------------------------------------------------------------------- For better reach and redundancy the `pool.publish` method can be used with multiple relays. typescript const relays = ["wss://relay.damus.io", "wss://nos.lol", "wss://relay.nostr.band"]; const event: NostrEvent = { // ...signed nostr event }; try { const responses = await pool.publish(relays, event); responses.forEach((response) => { if (response.ok) { console.log(`Event published successfully to ${response.from}`); } else { console.log(`Failed to publish event to ${response.from}: ${response.message}`); } }); } catch (error) { console.error("Error publishing to relays:", error); } Adding Events to the EventStore [​](https://hzrd149.github.io/applesauce/tutorial/07-publishing.html#adding-events-to-the-eventstore) -------------------------------------------------------------------------------------------------------------------------------------- Once the event is published to relays, its good to add it to the event store so your UI can see it without needing to load it from the relay again. typescript try { const response = await pool.relay("wss://relay.damus.io").publish(event); if (response.ok) { eventStore.add(event); } } catch (error) { console.error("Error publishing event:", error); } Using with .then() instead of async/await [​](https://hzrd149.github.io/applesauce/tutorial/07-publishing.html#using-with-then-instead-of-async-await) ------------------------------------------------------------------------------------------------------------------------------------------------------- If you prefer using `.then()` instead of async/await: typescript pool .relay("wss://relay.damus.io") .publish(event) .then((response) => { if (response.ok) { console.log(`Event published successfully to ${response.from}`); eventStore.add(event); } else { console.log(`Failed to publish event to ${response.from}: ${response.message}`); } }) .catch((error) => { console.error("Error publishing event:", error); }); Key Concepts [​](https://hzrd149.github.io/applesauce/tutorial/07-publishing.html#key-concepts) ------------------------------------------------------------------------------------------------ * **Publishing sends events to relays** so others can see them * **Handle relay responses** - success, errors, or rejections * **Publish to multiple relays** for better reach and redundancy * **Add published events to EventStore** to see them in your UI * **Provide user feedback** about publishing status * **Handle errors gracefully** with try/catch or .catch() Best Practices [​](https://hzrd149.github.io/applesauce/tutorial/07-publishing.html#best-practices) ---------------------------------------------------------------------------------------------------- 1. **Always publish to multiple relays** for redundancy 2. **Handle rate limiting** with delays and retries 3. **Provide clear user feedback** about publishing status 4. **Add published events to EventStore** after successful publish 5. **Don't spam relays** - use reasonable delays between publishes 6. **Use try/catch blocks** to handle errors gracefully --- # 4. Connecting to Relays | applesauce [Skip to content](https://hzrd149.github.io/applesauce/tutorial/04-relays.html#VPContent) Return to top 4\. Connecting to Relays [​](https://hzrd149.github.io/applesauce/tutorial/04-relays.html#_4-connecting-to-relays) =================================================================================================================== The `RelayPool` class is your gateway to the Nostr network. It manages connections to multiple relays and provides a reactive interface for subscribing to events and publishing. Let's learn how to connect to relays and feed real events into your EventStore. What is RelayPool? [​](https://hzrd149.github.io/applesauce/tutorial/04-relays.html#what-is-relaypool) ------------------------------------------------------------------------------------------------------- RelayPool is a connection manager that: * **Manages WebSocket connections** to multiple Nostr relays * **Handles reconnection** automatically when connections drop * **Provides subscription methods** that return RxJS observables * **Deduplicates subscriptions** across multiple relays * **Handles relay-specific logic** like authentication and rate limiting Creating a RelayPool [​](https://hzrd149.github.io/applesauce/tutorial/04-relays.html#creating-a-relaypool) ------------------------------------------------------------------------------------------------------------ typescript import { RelayPool } from "applesauce-relay"; // Create a relay pool const pool = new RelayPool(); > 💡 **Best Practice**: Create one RelayPool instance for your entire application, just like EventStore. Basic Relay Subscription [​](https://hzrd149.github.io/applesauce/tutorial/04-relays.html#basic-relay-subscription) -------------------------------------------------------------------------------------------------------------------- Here's how to subscribe to events from a single relay: typescript import { RelayPool, onlyEvents } from "applesauce-relay"; import { EventStore, mapEventsToStore } from "applesauce-core"; const pool = new RelayPool(); const eventStore = new EventStore(); // Subscribe to text notes from a specific relay pool .relay("wss://relay.damus.io") .subscription({ kinds: [1], limit: 20 }) .pipe( // Filter out non-event messages (EOSE, NOTICE, etc.) onlyEvents(), // Add events to the EventStore (deduplicates automatically) mapEventsToStore(eventStore), ) .subscribe((event) => { console.log("New event added to store:", event.id); }); Multiple Relays [​](https://hzrd149.github.io/applesauce/tutorial/04-relays.html#multiple-relays) -------------------------------------------------------------------------------------------------- The relay pool also provides a `subscription` method that can take an array of relays and opens the same subscription on all relays. typescript const relays = ["wss://relay.damus.io", "wss://nos.lol", "wss://relay.nostr.band"]; // Subscribe to all relays simultaneously pool .subscription(relays, { kinds: [1], limit: 20 }) .pipe(onlyEvents(), mapEventsToStore(eventStore)) .subscribe((event) => { console.log(event); }); Duplicate Event Handling [​](https://hzrd149.github.io/applesauce/tutorial/04-relays.html#duplicate-event-handling) -------------------------------------------------------------------------------------------------------------------- The relay pool will return all events from all relays. this means that you get some duplicate events. to solve this you can use the `mapEventsToStore` operator. typescript const eventStore = new EventStore(); const relays = ["wss://relay.damus.io", "wss://nos.lol", "wss://relay.nostr.band"]; pool .subscription(relays, { kinds: [1], limit: 20 }) .pipe(onlyEvents(), mapEventsToStore(eventStore)) .subscribe((event) => { console.log(event); // Only logs unique events }); Handling Relay Responses [​](https://hzrd149.github.io/applesauce/tutorial/04-relays.html#handling-relay-responses) -------------------------------------------------------------------------------------------------------------------- RelayPool subscriptions will emit events and the `"EOSE"` message when the relay has sent all events. Use the `onlyEvents()` operator to ignore the `"EOSE"` message: typescript pool .relay("wss://relay.damus.io") .subscription({ kinds: [1] }) .subscribe((message) => { console.log(message); // Logs: [event1, event2, event3, "EOSE"] }); // vs with onlyEvents() pool .relay("wss://relay.damus.io") .subscription({ kinds: [1] }) .pipe(onlyEvents()) .subscribe((event) => { console.log("Event only:", event); // Logs: [event1, event2, event3] }); Error Handling [​](https://hzrd149.github.io/applesauce/tutorial/04-relays.html#error-handling) ------------------------------------------------------------------------------------------------ The returned observable will error if the relay connection fails. make sure to handle errors gracefully. typescript pool .relay("wss://relay.damus.io") .subscription({ kinds: [1] }) .pipe(onlyEvents()) .subscribe({ next: (event) => { // Handle successful event eventStore.add(event); }, error: (error) => { console.error("Relay subscription error:", error); // Maybe try connecting to a different relay }, }); Key Concepts [​](https://hzrd149.github.io/applesauce/tutorial/04-relays.html#key-concepts) -------------------------------------------------------------------------------------------- * **RelayPool manages connections** to multiple Nostr relays * **Use onlyEvents()** to filter subscription messages * **mapEventsToStore()** automatically adds events to EventStore * **Subscriptions are reactive** - they automatically update your UI * **Handle errors gracefully** - relay connections can fail * **Deduplicate across relays** - same event from multiple relays is only added once Common Patterns [​](https://hzrd149.github.io/applesauce/tutorial/04-relays.html#common-patterns) -------------------------------------------------------------------------------------------------- ### Auto-reconnecting Timeline [​](https://hzrd149.github.io/applesauce/tutorial/04-relays.html#auto-reconnecting-timeline) typescript function createAutoReconnectingSubscription(relayUrl: string) { return pool .relay(relayUrl) .subscription({ kinds: [1], limit: 100 }) .pipe( onlyEvents(), mapEventsToStore(eventStore), // Retry on error retry({ count: 3, delay: 1000 }), ); } Example: React Timeline [​](https://hzrd149.github.io/applesauce/tutorial/04-relays.html#example-react-timeline) ----------------------------------------------------------------------------------------------------------------- Here's a complete react example using the RelayPool and EventStore to display a live timeline: tsx import React, { useEffect } from "react"; import { RelayPool, onlyEvents } from "applesauce-relay"; import { EventStore, mapEventsToStore, mapEventsToTimeline } from "applesauce-core"; import { ProfileModel, TimelineModel } from "applesauce-core/models"; import { getDisplayName, getProfilePicture } from "applesauce-core/helpers"; import { useObservableMemo } from "applesauce-react/hooks"; // Create global instances const eventStore = new EventStore(); const pool = new RelayPool(); function NoteCard({ note }: { note: any }) { const profile = useObservableMemo(() => eventStore.model(ProfileModel, note.pubkey), [note.pubkey]); const name = getDisplayName(profile, note.pubkey.slice(0, 8) + "..."); const avatar = getProfilePicture(profile, `https://robohash.org/${note.pubkey}.png`); return (
{name} {name} {new Date(note.created_at * 1000).toLocaleString()}

{note.content}

); } function LiveFeed() { // This timeline will automatically update as new events arrive const timeline = useObservableMemo(() => eventStore.model(TimelineModel, { kinds: [1] }), []); return (

Latest Notes ({timeline?.length || 0})

{timeline?.map((note) => )}
); } function App() { useEffect(() => { // Start subscription when component mounts const subscription = pool .relay("wss://relay.damus.io") .subscription({ kinds: [1], limit: 50 }) .pipe( // Filter out non-event messages (EOSE, NOTICE, etc.) onlyEvents(), // Add events to the EventStore and deduplicate them mapEventsToStore(eventStore), ) .subscribe({ next: (event) => console.log("Added event:", event.id), error: (err) => console.error("Relay error:", err), complete: () => console.log("Subscription complete"), }); // Cleanup subscription on unmount return () => subscription.unsubscribe(); }, []); return (

Live Nostr Feed

); } export default App; --- # 3. Building Reactive UI with Models | applesauce [Skip to content](https://hzrd149.github.io/applesauce/tutorial/03-models.html#VPContent) Return to top 3\. Building Reactive UI with Models [​](https://hzrd149.github.io/applesauce/tutorial/03-models.html#_3-building-reactive-ui-with-models) =========================================================================================================================================== Models are pre-built subscriptions that combine the EventStore with helpers to provide computed state. Instead of manually subscribing to events and parsing them, models give you clean, reactive data that automatically updates when relevant events change. What are Models? [​](https://hzrd149.github.io/applesauce/tutorial/03-models.html#what-are-models) --------------------------------------------------------------------------------------------------- Models are functions that: * **Combine EventStore subscriptions with helpers** - No manual parsing needed * **Provide computed state** - Transform raw events into useful data structures * **Cache results** - Same model with same parameters reuses the same observable * **Handle complex logic** - Like loading missing data or combining multiple event types * **Return RxJS observables** - Can be subscribed to or used with operators Using Models with EventStore [​](https://hzrd149.github.io/applesauce/tutorial/03-models.html#using-models-with-eventstore) ---------------------------------------------------------------------------------------------------------------------------- The `eventStore.model()` method is how you create and subscribe to models: typescript import { ProfileModel } from "applesauce-core/models"; // Create a model subscription const profileSubscription = eventStore .model(ProfileModel, "3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d") .subscribe((profile) => { if (profile) { console.log("Profile:", profile); // Profile is already parsed and ready to use console.log("Name:", profile.name); console.log("About:", profile.about); } else { console.log("Profile not found"); } }); // Don't forget to unsubscribe when done // profileSubscription.unsubscribe(); ProfileModel Example [​](https://hzrd149.github.io/applesauce/tutorial/03-models.html#profilemodel-example) ------------------------------------------------------------------------------------------------------------ The `ProfileModel` automatically handles profile events (kind 0) and parses their content: typescript import { EventStore } from "applesauce-core"; import { ProfileModel } from "applesauce-core/models"; const eventStore = new EventStore(); const pubkey = "3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d"; // Subscribe to profile updates eventStore.model(ProfileModel, pubkey).subscribe((profile) => { if (profile) { console.log("User profile updated:"); console.log("- Name:", profile.name || "No name"); console.log("- About:", profile.about || "No bio"); console.log("- Picture:", profile.picture || "No picture"); console.log("- Website:", profile.website || "No website"); } }); // Add a profile event to see the model in action eventStore.add({ content: '{"name":"fiatjaf","about":"~","picture":"https://fiatjaf.com/static/favicon.jpg","nip05":"_@fiatjaf.com","lud16":"fiatjaf@zbd.gg","website":"https://nostr.technology"}', created_at: 1738588530, id: "c43be8b4634298e97dde3020a5e6aeec37d7f5a4b0259705f496e81a550c8f8b", kind: 0, pubkey: "3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d", relays: [""], sig: "202a1bf6a58943d660c1891662dbdda142aa8e5bca9d4a3cb03cde816ad3bdda6f4ec3b880671506c2820285b32218a0afdec2d172de9694d83972190ab4f9da", tags: [], }); // The subscription will fire with the parsed profile data TimelineModel Example [​](https://hzrd149.github.io/applesauce/tutorial/03-models.html#timelinemodel-example) -------------------------------------------------------------------------------------------------------------- The `TimelineModel` provides a sorted, reactive timeline of events: typescript import { TimelineModel } from "applesauce-core/models"; // Subscribe to all text notes (kind 1) eventStore.model(TimelineModel, { kinds: [1] }).subscribe((timeline) => { console.log(`Timeline updated: ${timeline.length} notes`); timeline.forEach((note, index) => { console.log(`${index + 1}. ${note.content.slice(0, 50)}...`); console.log(` By: ${note.pubkey.slice(0, 8)}`); console.log(` At: ${new Date(note.created_at * 1000).toLocaleString()}`); }); }); // Add some notes to see the timeline update eventStore.add({ content: 'I just wish LLMs would stop saying their solutions are "comprehensive" or "powerful"', created_at: 1749596768, id: "77941979d4c04283fd9b2f0a280749248cbd41babe3a0731c1597a6d54ae7874", kind: 1, pubkey: "97c70a44366a6535c145b333f973ea86dfdc2d7a99da618c40c64705ad98e322", sig: "a0884549f09ef805d3ffa917c3d9e189882295f1b819c038e5d28ea1a668f4455f66ada40749dbdb6dfd48c323f507889330a2a4742b0cb66d8997afb31ff47e", tags: [["client", "Coracle", "31990:97c70a44366a6535c145b333f973ea86dfdc2d7a99da618c40c64705ad98e322:1685968093690"]], }); eventStore.add({ content: "These numbers are so kind.", created_at: 1745847253, id: "621233a1ad1b91620f0b4a308c2113243a98925909cdb7b26284cbb4d835a18c", kind: 1, pubkey: "3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d", sig: "eb8f30f7c44d031bfe315d476165f5cf29c21f1eaf07128f5a673cdb3b69ebf7902dacc06987f8d764b17225aefecdbc91992165e03372e40f57639a41203a1c", tags: [], }); // Timeline will update twice, showing 1 note then 2 notes Model Caching [​](https://hzrd149.github.io/applesauce/tutorial/03-models.html#model-caching) ---------------------------------------------------------------------------------------------- Models with the same parameters are cached and reused: typescript // These two subscriptions share the same underlying model const subscription1 = eventStore .model(ProfileModel, "621233a1ad1b91620f0b4a308c2113243a98925909cdb7b26284cbb4d835a18c") .subscribe(console.log); const subscription2 = eventStore .model(ProfileModel, "621233a1ad1b91620f0b4a308c2113243a98925909cdb7b26284cbb4d835a18c") .subscribe(console.log); // Both subscriptions will receive the same data // Only one actual subscription is created internally // Always unsubscribe when done subscription1.unsubscribe(); subscription2.unsubscribe(); Combining Models with RxJS Operators [​](https://hzrd149.github.io/applesauce/tutorial/03-models.html#combining-models-with-rxjs-operators) -------------------------------------------------------------------------------------------------------------------------------------------- Since models return RxJS observables, you can use operators to transform the data: typescript import { map, filter } from "rxjs/operators"; // Only get profiles that have names eventStore .model(ProfileModel, pubkey) .pipe( filter((profile) => profile && profile.name), map((profile) => profile.name.toUpperCase()), ) .subscribe((name) => { console.log("Profile name in caps:", name); }); // Get timeline length eventStore .model(TimelineModel, { kinds: [1] }) .pipe(map((timeline) => timeline.length)) .subscribe((count) => { console.log("Timeline has", count, "notes"); }); Other Useful Models [​](https://hzrd149.github.io/applesauce/tutorial/03-models.html#other-useful-models) ---------------------------------------------------------------------------------------------------------- ### MailboxesModel [​](https://hzrd149.github.io/applesauce/tutorial/03-models.html#mailboxesmodel) Gets a user's inbox and outbox relays from their relay list (kind 10002): typescript import { MailboxesModel } from "applesauce-core/models"; eventStore.model(MailboxesModel, pubkey).subscribe((mailboxes) => { if (mailboxes) { console.log("Outbox relays:", mailboxes.outboxes); console.log("Inbox relays:", mailboxes.inboxes); } }); ### RepliesModel [​](https://hzrd149.github.io/applesauce/tutorial/03-models.html#repliesmodel) Gets all replies to a specific event: typescript import { RepliesModel } from "applesauce-core/models"; const noteId = "abc123..."; eventStore.model(RepliesModel, noteId).subscribe((replies) => { console.log(`Found ${replies.length} replies to note ${noteId}`); replies.forEach((reply) => { console.log(`- ${reply.content.slice(0, 50)}...`); }); }); ### ContactsModel [​](https://hzrd149.github.io/applesauce/tutorial/03-models.html#contactsmodel) Gets a user's contact list (kind 3): typescript import { ContactsModel } from "applesauce-core/models"; eventStore.model(ContactsModel, pubkey).subscribe((contacts) => { if (contacts) { console.log("Following", contacts.length, "people:"); contacts.forEach((contact) => { console.log(`- ${contact.pubkey.slice(0, 8)}`); }); } }); Working with Multiple Models [​](https://hzrd149.github.io/applesauce/tutorial/03-models.html#working-with-multiple-models) ---------------------------------------------------------------------------------------------------------------------------- You can combine multiple models using the `combineLatest` operator from RxJS to build complex views: typescript import { combineLatest } from "rxjs"; const pubkey = "3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d"; // Combine profile and timeline data combineLatest([\ eventStore.model(ProfileModel, pubkey),\ eventStore.model(TimelineModel, { kinds: [1], authors: [pubkey] }),\ ]).subscribe(([profile, timeline]) => { const name = profile?.name || "Unknown"; const noteCount = timeline.length; console.log(`${name} has posted ${noteCount} notes`); }); Missing Event Handling [​](https://hzrd149.github.io/applesauce/tutorial/03-models.html#missing-event-handling) ---------------------------------------------------------------------------------------------------------------- Models handle missing events gracefully and typically return `undefined` when events aren't available: typescript eventStore.model(ProfileModel, "nonexistent-pubkey").subscribe((profile) => { if (profile === undefined) { console.log("Profile not found or still loading"); } else { console.log("Profile loaded:", profile); } }); Model Performance [​](https://hzrd149.github.io/applesauce/tutorial/03-models.html#model-performance) ------------------------------------------------------------------------------------------------------ Models are designed for performance: * **Cached** - Models with the same parameters are reused * **Lazy** - Only created when subscribed to * **Efficient** - Use internal EventStore subscriptions * **Memory-safe** - Automatically cleaned up when no subscribers typescript // This is efficient - only one ProfileModel created const model = eventStore.model(ProfileModel, pubkey); const sub1 = model.subscribe(handleProfile1); const sub2 = model.subscribe(handleProfile2); const sub3 = model.subscribe(handleProfile3); // Clean up all subscriptions sub1.unsubscribe(); sub2.unsubscribe(); sub3.unsubscribe(); Key Concepts [​](https://hzrd149.github.io/applesauce/tutorial/03-models.html#key-concepts) -------------------------------------------------------------------------------------------- * **Models transform raw events** into useful data structures * **Use `eventStore.model()`** to create model subscriptions * **Models return observables** - can be used with RxJS operators * **Models handle parsing** - no need to use helper methods manually * **Models are reactive** - automatically update when events change Example: React user profile [​](https://hzrd149.github.io/applesauce/tutorial/03-models.html#example-react-user-profile) ------------------------------------------------------------------------------------------------------------------------- For React applications, you can use the `useObservableMemo` hook from `applesauce-react` to easily integrate models: tsx import React from "react"; import { useObservableMemo } from "applesauce-react/hooks"; import { ProfileModel, TimelineModel } from "applesauce-core/models"; import { getDisplayName, getProfilePicture } from "applesauce-core/helpers"; function UserProfile({ pubkey }: { pubkey: string }) { // Create a new model for the user's profile and subscribe to it const profile = useObservableMemo(() => eventStore.model(ProfileModel, pubkey), [pubkey]); // Create a new model for the user's notes and subscribe to it const timeline = useObservableMemo( () => eventStore.model(TimelineModel, { kinds: [1], authors: [pubkey] }), [pubkey], ); const displayName = getDisplayName(profile, pubkey.slice(0, 8) + "..."); const avatar = getProfilePicture(profile, `https://robohash.org/${pubkey}.png`); return (
{displayName}

{displayName}

{profile?.about &&

{profile.about}

}

Notes ({timeline?.length || 0})

{timeline?.map((note) => (

{note.content}

))}
); } --- # Relays | applesauce [Skip to content](https://hzrd149.github.io/applesauce/relays/package.html#VPContent) Return to top Relays [​](https://hzrd149.github.io/applesauce/relays/package.html#relays) ============================================================================ The `applesauce-relay` package contains a few classes to make connecting to relays easier. Features [​](https://hzrd149.github.io/applesauce/relays/package.html#features) -------------------------------------------------------------------------------- * Simple to setup * Automatic connection management * NIP-42 auth support * Negentrapy support Installation [​](https://hzrd149.github.io/applesauce/relays/package.html#installation) ---------------------------------------------------------------------------------------- npmyarnpnpm sh npm install applesauce-relay sh yarn install applesauce-relay sh pnpm install applesauce-relay --- # Relay Pool | applesauce [Skip to content](https://hzrd149.github.io/applesauce/relays/pool.html#VPContent) Return to top Relay Pool [​](https://hzrd149.github.io/applesauce/relays/pool.html#relay-pool) ================================================================================= The `RelayPool` class in `applesauce-relay` provides a powerful way to manage multiple relay connections, allowing you to interact with multiple relays as if they were a single entity. Features [​](https://hzrd149.github.io/applesauce/relays/pool.html#features) ----------------------------------------------------------------------------- * Connect to multiple relays * Create and manage groups of relays * Send requests and events to multiple relays simultaneously * Maintain a blacklist of relays to avoid Relay Management [​](https://hzrd149.github.io/applesauce/relays/pool.html#relay-management) --------------------------------------------------------------------------------------------- The RelayPool provides methods to create and manage relay connections: typescript // Get or create a relay connection const relay = pool.relay("wss://relay.example.com"); // Create a group of relays const group = pool.group(["wss://relay1.example.com", "wss://relay2.example.com"]); Making Requests [​](https://hzrd149.github.io/applesauce/relays/pool.html#making-requests) ------------------------------------------------------------------------------------------- The RelayPool provides several methods to interact with relays. These methods mirror those found in the `Relay` class, allowing you to use familiar patterns while working with multiple relays simultaneously. ### REQ Method [​](https://hzrd149.github.io/applesauce/relays/pool.html#req-method) The `req` method sends a subscription request to multiple relays: typescript // Send a REQ to multiple relays pool .req(relays, { kinds: [1], limit: 10, }) .subscribe({ next: (response) => { if (response === "EOSE") { console.log("End of stored events from all relays"); } else { console.log("Event", response); } }, error: (error) => { console.error("Subscription error:", error); }, }); ### Event Method [​](https://hzrd149.github.io/applesauce/relays/pool.html#event-method) The `event` method sends an `EVENT` message to multiple relays and returns an observable of the responses from each relay. typescript const event = { kind: 1, content: "Hello from RelayPool!", created_at: Math.floor(Date.now() / 1000), tags: [], // ... other required fields }; // Subscribe to a stream of responses pool.event(relays, event).subscribe({ next: (response) => { console.log(`Published to ${response.from}:`, response.ok); if (!response.ok) console.log(`Error message: ${response.message}`); }, complete: () => { console.log("Publishing complete"); }, }); ### Publish Method [​](https://hzrd149.github.io/applesauce/relays/pool.html#publish-method) The `publish` method is a wrapper around the `event` method that returns a `Promise` and automatically handles reconnecting and retrying: typescript // Publish with retries (defaults to 3 retries) const responses = await pool.publish(relays, event); for (const response of responses) { console.log(`Published to ${response.from}:`, response.ok, response.message); } ### Request Method [​](https://hzrd149.github.io/applesauce/relays/pool.html#request-method) The `request` method allows you to make one-off requests with automatic retries: typescript // Request with automatic retries pool .request( relays, { kinds: [1], authors: ["pubkey1", "pubkey2"], limit: 50, }, { retries: 2, timeout: 5000, // 5 seconds }, ) .subscribe({ next: (event) => console.log("Received event:", event.id), complete: () => console.log("Request complete"), }); ### Subscription Method [​](https://hzrd149.github.io/applesauce/relays/pool.html#subscription-method) The `subscription` method creates persistent subscriptions that automatically reconnect: typescript // Create persistent subscription const subscription = pool .subscription( relays, { kinds: [1, 7], "#t": ["nostr"], }, { id: "custom-sub-id", // optional custom subscription ID retries: Infinity, // retry forever }, ) .subscribe({ next: (response) => { if (response === "EOSE") { console.log("End of stored events"); } else { console.log("Subscription update:", response); } }, }); // Later, you can unsubscribe subscription.unsubscribe(); All of these methods accept the same parameters as their counterparts in the `Relay` class, making it easy to transition between working with individual relays and relay pools. Relay Groups [​](https://hzrd149.github.io/applesauce/relays/pool.html#relay-groups) ------------------------------------------------------------------------------------- The `RelayGroup` class is used internally by RelayPool to manage collections of relays. You can access relay groups directly through the pool: typescript // Create a group of relays const group = pool.group(["wss://relay1.example.com", "wss://relay2.example.com"]); // Make requests to the group group.req({ kinds: [1] }).subscribe((response) => console.log(response)); // Send events to the group group.event(event).subscribe((response) => console.log(response)); // Use other group methods group.publish(event).subscribe((response) => console.log(response)); group.request({ kinds: [1] }).subscribe((event) => console.log(event)); group.subscription({ kinds: [1] }).subscribe((response) => console.log(response)); The RelayGroup intelligently merges responses from multiple relays, emitting EOSE only when all relays have sent their EOSE signals. Observable Properties [​](https://hzrd149.github.io/applesauce/relays/pool.html#observable-properties) ------------------------------------------------------------------------------------------------------- The RelayPool provides observables for tracking relays and groups: typescript // Subscribe to changes in the relays map pool.relays$.subscribe((relaysMap) => { console.log("Relays updated:", Array.from(relaysMap.keys())); }); // Subscribe to changes in the relay groups map pool.groups$.subscribe((groupsMap) => { console.log("Groups updated:", Array.from(groupsMap.keys())); }); --- # Loaders | applesauce [Skip to content](https://hzrd149.github.io/applesauce/loaders/package.html#VPContent) Return to top Loaders [​](https://hzrd149.github.io/applesauce/loaders/package.html#loaders) =============================================================================== The `applesauce-loaders` package provides a set of pre-built loaders for common methods of loading events from a relay pool. Features [​](https://hzrd149.github.io/applesauce/loaders/package.html#features) --------------------------------------------------------------------------------- * Easy to setup and use * Built-in request batching * Built-in event deduplication (using an event store) * Flexible enough to work with any relay connection pool Installation [​](https://hzrd149.github.io/applesauce/loaders/package.html#installation) ----------------------------------------------------------------------------------------- npmyarnpnpm sh npm install applesauce-loaders sh yarn install applesauce-loaders sh pnpm install applesauce-loaders --- # Factory | applesauce [Skip to content](https://hzrd149.github.io/applesauce/factory/package.html#VPContent) Return to top Factory [​](https://hzrd149.github.io/applesauce/factory/package.html#factory) =============================================================================== The `applesauce-factory` package provides the `EventFactory` and operations for creating and modifying Nostr events. Features [​](https://hzrd149.github.io/applesauce/factory/package.html#features) --------------------------------------------------------------------------------- * Works with any NIP-07 signer ( `applesauce-signers` ) * Tons of pre-built operations for creating and modifying events * Support for encrypted tags in NIP-51 events * Pre-built operations for NIP-59 gift wrapping * Blueprints for common event types * Relays hints for `e` and `p` tags Installation [​](https://hzrd149.github.io/applesauce/factory/package.html#installation) ----------------------------------------------------------------------------------------- npmyarnpnpm sh npm install applesauce-factory sh yarn install applesauce-factory sh pnpm install applesauce-factory --- # Accounts | applesauce [Skip to content](https://hzrd149.github.io/applesauce/accounts/package.html#VPContent) Return to top Accounts [​](https://hzrd149.github.io/applesauce/accounts/package.html#accounts) ================================================================================== The `applesauce-accounts` package provides a set of classes for managing accounts and their associated signers. Features [​](https://hzrd149.github.io/applesauce/accounts/package.html#features) ---------------------------------------------------------------------------------- * Full account manager class * Support for saving and loading accounts from JSON * Integrated with the `applesauce-signers` package * Suports custom account types * Custom account metadata (name, icon, etc) Installation [​](https://hzrd149.github.io/applesauce/accounts/package.html#installation) ------------------------------------------------------------------------------------------ npmyarnpnpm sh npm install applesauce-accounts sh yarn install applesauce-accounts sh pnpm install applesauce-accounts --- # Zaps Loader | applesauce [Skip to content](https://hzrd149.github.io/applesauce/loaders/zaps-loader.html#VPContent) Return to top Zaps Loader [​](https://hzrd149.github.io/applesauce/loaders/zaps-loader.html#zaps-loader) =========================================================================================== The Zaps Loader is a specialized loader for fetching [NIP-57](https://github.com/nostr-protocol/nips/blob/master/57.md) zap events for any given Nostr event. It is built on top of the [Tag Value Loader](https://hzrd149.github.io/applesauce/loaders/tag-value-loader.html) and automatically handles both regular events and addressable events. WARNING The observable returned by the Zaps Loader MUST be subscribed to in order for the request to be made. No request will be sent until you call `.subscribe()` on the returned observable. Basic Usage [​](https://hzrd149.github.io/applesauce/loaders/zaps-loader.html#basic-usage) ------------------------------------------------------------------------------------------- ts import { createZapsLoader } from "applesauce-loaders/loaders"; import { RelayPool } from "applesauce-relay"; // Create a relay pool const pool = new RelayPool(); // Create a zaps loader (do this once at the app level) const zapsLoader = createZapsLoader(pool); // Later, use the loader to fetch zaps for any event const someEvent = { id: "event_id", kind: 1 /* ... */ }; zapsLoader(someEvent, ["wss://relay.example.com"]).subscribe((zapEvent) => { console.log("Received zap:", zapEvent); }); How It Works [​](https://hzrd149.github.io/applesauce/loaders/zaps-loader.html#how-it-works) --------------------------------------------------------------------------------------------- The Zaps Loader automatically: * Determines if the target event is addressable (replaceable) or a regular event * Uses the appropriate tag (`a` for addressable events, `e` for regular events) to fetch zaps * Merges relay hints from the event's seen relays (if `useSeenRelays` is enabled) * Filters results to only return NIP-57 zap events (kind 9735) Configuration Options [​](https://hzrd149.github.io/applesauce/loaders/zaps-loader.html#configuration-options) --------------------------------------------------------------------------------------------------------------- The `createZapsLoader` function accepts these options: * `useSeenRelays`: Whether to include relays where the event was seen (default `true`) * All other options from Tag Value Loader: `bufferTime`, `bufferSize`, `authors`, `since`, `cacheRequest`, `extraRelays`, `eventStore` ts const zapsLoader = createZapsLoader(pool, { useSeenRelays: true, bufferTime: 500, eventStore, cacheRequest, }); Example with React [​](https://hzrd149.github.io/applesauce/loaders/zaps-loader.html#example-with-react) --------------------------------------------------------------------------------------------------------- tsx import { createZapsLoader } from "applesauce-loaders/loaders"; import { RelayPool } from "applesauce-relay"; import { useEffect, useState } from "react"; // Setup at app level const pool = new RelayPool(); const zapsLoader = createZapsLoader(pool); function ZapsComponent({ event }) { const [zaps, setZaps] = useState([]); useEffect(() => { const subscription = zapsLoader(event).subscribe((zapEvent) => { setZaps((prev) => [...prev, zapEvent]); }); return () => subscription.unsubscribe(); }, [event.id]); return (

Zaps ({zaps.length})

{zaps.map((zap) => (

Zap amount: {/* parse zap amount from event */}

))}
); } Addressable vs Regular Events [​](https://hzrd149.github.io/applesauce/loaders/zaps-loader.html#addressable-vs-regular-events) ------------------------------------------------------------------------------------------------------------------------------- The loader automatically handles both types of events: * **Regular events** (kind 0, 1, etc.): Uses `e` tags to find zaps * **Addressable events** (kind 30000+): Uses `a` tags with the replaceable address This abstraction means you don't need to worry about the event type - just pass any event to the loader. --- # Event Loader | applesauce [Skip to content](https://hzrd149.github.io/applesauce/loaders/event-loader.html#VPContent) Return to top Event Loader [​](https://hzrd149.github.io/applesauce/loaders/event-loader.html#event-loader) ============================================================================================== The Event Loader is a specialized loader for fetching Nostr events by their IDs. It provides an efficient way to batch and deduplicate requests, cache results, and handle relay hints. WARNING The observable returned by the Event Loader MUST be subscribed to in order for the request to be made. No request will be sent until you call `.subscribe()` on the returned observable. Basic Usage [​](https://hzrd149.github.io/applesauce/loaders/event-loader.html#basic-usage) -------------------------------------------------------------------------------------------- ts import { createEventLoader } from "applesauce-loaders/loaders"; import { RelayPool } from "applesauce-relay"; // Create a relay pool const pool = new RelayPool(); // Create an event loader (do this once at the app level) const eventLoader = createEventLoader(pool); // Later, use the loader to fetch events eventLoader({ id: "event_id", relays: ["wss://relay.example.com"], }).subscribe((event) => { console.log("Loaded event:", event); }); Configuration Options [​](https://hzrd149.github.io/applesauce/loaders/event-loader.html#configuration-options) ---------------------------------------------------------------------------------------------------------------- The `createEventLoader` function accepts these options: * `bufferTime`: Time interval to buffer requests in ms (default 1000) * `bufferSize`: Max buffer size (default 200) * `eventStore`: An event store used to deduplicate events * `cacheRequest`: A method used to load events from a local cache * `followRelayHints`: Whether to follow relay hints (default true) * `extraRelays`: An array of relays to always fetch from WARNING If an event store is not provided, the loader will not be able to deduplicate events. Working with Relay Pools [​](https://hzrd149.github.io/applesauce/loaders/event-loader.html#working-with-relay-pools) ---------------------------------------------------------------------------------------------------------------------- The Event Loader requires a request method for loading Nostr events from relays. You can provide this in multiple ways: ### Using a RelayPool instance [​](https://hzrd149.github.io/applesauce/loaders/event-loader.html#using-a-relaypool-instance) The simplest approach is to pass a RelayPool instance directly: ts import { createEventLoader } from "applesauce-loaders/loaders"; import { RelayPool } from "applesauce-relay"; const pool = new RelayPool(); const eventLoader = createEventLoader(pool, { eventStore, cacheRequest, }); ### Using a custom request method [​](https://hzrd149.github.io/applesauce/loaders/event-loader.html#using-a-custom-request-method) You can also provide a custom request method, such as one from nostr-tools: ts import { createEventLoader } from "applesauce-loaders/loaders"; import { SimplePool } from "nostr-tools"; const pool = SimplePool(); // Create a custom request function using nostr-tools function customRequest(relays, filters) { return new Observable((observer) => { const sub = pool.subscribeMany(relays, filters, { onevent: (event) => observer.next(event), eose: () => observer.complete(), }); return () => sub.close(); }); } // Create event loader with custom request const eventLoader = createEventLoader(customRequest, options); Loading from cache [​](https://hzrd149.github.io/applesauce/loaders/event-loader.html#loading-from-cache) ---------------------------------------------------------------------------------------------------------- For improved performance, you can configure the loader to use a local cache: ts import { createEventLoader } from "applesauce-loaders/loaders"; import { openDB, getEventsForFilters } from "nostr-idb"; // Setup a local event cache const cache = await openDB(); function cacheRequest(filters) { return getEventsForFilters(cache, filters); } const eventLoader = createEventLoader(pool, { cacheRequest, eventStore, }); // Events from cache are automatically marked using markFromCache eventLoader(pointer).subscribe((event) => { if (!isFromCache(event)) { // This is a new event from the network addEvents(cache, [event]); } }); Real-World Example [​](https://hzrd149.github.io/applesauce/loaders/event-loader.html#real-world-example) ---------------------------------------------------------------------------------------------------------- Here's how you might use the Event Loader in a React application: tsx import { createEventLoader } from "applesauce-loaders/loaders"; import { RelayPool } from "applesauce-relay"; import { EventStore } from "applesauce-core"; import { useEffect } from "react"; // Setup at app level const eventStore = new EventStore(); const pool = new RelayPool(); const eventLoader = createEventLoader(pool, { eventStore }); function EventComponent({ eventId, relays }) { const [event, setEvent] = useState(null); // Load the event when component mounts useEffect(() => { const subscription = eventLoader({ id: eventId, relays, }).subscribe((event) => setEvent(event)); return () => subscription.unsubscribe(); }, [eventId]); if (!event) return
Loading...
; return
{event.content}
; } Loading Sequence [​](https://hzrd149.github.io/applesauce/loaders/event-loader.html#loading-sequence) ------------------------------------------------------------------------------------------------------ The Event Loader follows this sequence when loading events: 1. Attempt to load from cache (if configured) 2. Use relay hints from event pointers (if enabled) 3. Fetch from additional relays (if configured) This approach ensures efficient event loading with minimal network requests. --- # Address Loader | applesauce [Skip to content](https://hzrd149.github.io/applesauce/loaders/address-loader.html#VPContent) Return to top Address Loader [​](https://hzrd149.github.io/applesauce/loaders/address-loader.html#address-loader) ==================================================================================================== The Address Loader is a specialized loader for fetching Nostr replaceable events by their address (kind, pubkey, and optional identifier). It provides an efficient way to batch and deduplicate requests, cache results, and handle relay hints. WARNING The observable returned by the Address Loader MUST be subscribed to in order for the request to be made. No request will be sent until you call `.subscribe()` on the returned observable. Basic Usage [​](https://hzrd149.github.io/applesauce/loaders/address-loader.html#basic-usage) ---------------------------------------------------------------------------------------------- ts import { createAddressLoader } from "applesauce-loaders/loaders"; import { RelayPool } from "applesauce-relay"; // Create a relay pool const pool = new RelayPool(); // Create an address loader (do this once at the app level) const addressLoader = createAddressLoader(pool); // Later, use the loader to fetch events by address addressLoader({ kind: 0, pubkey: "user_pubkey", relays: ["wss://relay.example.com"], }).subscribe((event) => { console.log("Loaded profile:", event); }); Configuration Options [​](https://hzrd149.github.io/applesauce/loaders/address-loader.html#configuration-options) ------------------------------------------------------------------------------------------------------------------ The `createAddressLoader` function accepts these options: * `bufferTime`: Time interval to buffer requests in ms (default 1000) * `bufferSize`: Max buffer size (default 200) * `eventStore`: An event store used to deduplicate events * `cacheRequest`: A method used to load events from a local cache * `followRelayHints`: Whether to follow relay hints (default true) * `lookupRelays`: Fallback lookup relays to check when event can't be found * `extraRelays`: An array of relays to always fetch from WARNING If an event store is not provided, the loader will not be able to deduplicate events. Working with Relay Pools [​](https://hzrd149.github.io/applesauce/loaders/address-loader.html#working-with-relay-pools) ------------------------------------------------------------------------------------------------------------------------ The Address Loader requires a request method for loading Nostr events from relays. You can provide this in multiple ways: ### Using a RelayPool instance [​](https://hzrd149.github.io/applesauce/loaders/address-loader.html#using-a-relaypool-instance) The simplest approach is to pass a RelayPool instance directly: ts import { createAddressLoader } from "applesauce-loaders/loaders"; import { RelayPool } from "applesauce-relay"; const pool = new RelayPool(); const addressLoader = createAddressLoader(pool, { eventStore, cacheRequest, }); ### Using a custom request method [​](https://hzrd149.github.io/applesauce/loaders/address-loader.html#using-a-custom-request-method) You can also provide a custom request method, such as one from nostr-tools: ts import { createAddressLoader } from "applesauce-loaders/loaders"; import { SimplePool } from "nostr-tools"; import { Observable } from "rxjs"; const pool = SimplePool(); // Create a custom request function using nostr-tools function customRequest(relays, filters) { return new Observable((observer) => { const sub = pool.subscribeMany(relays, filters, { onevent: (event) => observer.next(event), eose: () => observer.complete(), }); return () => sub.close(); }); } // Create address loader with custom request const addressLoader = createAddressLoader(customRequest, options); Loading from cache [​](https://hzrd149.github.io/applesauce/loaders/address-loader.html#loading-from-cache) ------------------------------------------------------------------------------------------------------------ For improved performance, you can configure the loader to use a local cache: ts import { createAddressLoader } from "applesauce-loaders/loaders"; import { openDB, getEventsForFilters } from "nostr-idb"; // Setup a local event cache const cache = await openDB(); function cacheRequest(filters) { return getEventsForFilters(cache, filters); } const addressLoader = createAddressLoader(pool, { cacheRequest, eventStore, }); // Events from cache are automatically marked using markFromCache addressLoader({ kind: 0, pubkey: "user_pubkey" }).subscribe((event) => { if (!isFromCache(event)) { // This is a new event from the network addEvents(cache, [event]); } }); Real-World Example [​](https://hzrd149.github.io/applesauce/loaders/address-loader.html#real-world-example) ------------------------------------------------------------------------------------------------------------ Here's how you might use the Address Loader in a React application to load user profiles: tsx import { EventStore } from "applesauce-core"; import { createAddressLoader } from "applesauce-loaders/loaders"; import { RelayPool } from "applesauce-relay"; import { kinds } from "nostr-tools"; import { useEffect, useState } from "react"; import { EMPTY, ignoreElements, merge } from "rxjs"; // Setup at app level const eventStore = new EventStore(); const pool = new RelayPool(); const addressLoader = createAddressLoader(pool, { eventStore, lookupRelays: ["wss://purplepag.es/"], }); function ProfileComponent({ pubkey, relays }) { const [profile, setProfile] = useState(null); // Load the profile when component mounts useEffect(() => { // Check if we already have the profile if (eventStore.hasReplaceable(kinds.Metadata, pubkey)) { setProfile(eventStore.getLatestReplaceable(kinds.Metadata, pubkey)); return; } // Load profile from the network const subscription = addressLoader({ kind: kinds.Metadata, pubkey, relays, }).subscribe((event) => { setProfile(JSON.parse(event.content)); }); return () => subscription.unsubscribe(); }, [pubkey]); if (!profile) return
Loading profile...
; return (

{profile.name || "Anonymous"}

{profile.picture && Profile}

{profile.about}

); } Loading Sequence [​](https://hzrd149.github.io/applesauce/loaders/address-loader.html#loading-sequence) -------------------------------------------------------------------------------------------------------- The Address Loader follows this sequence when loading events: 1. Attempt to load from cache (if configured) 2. Use relay hints from address pointers (if enabled) 3. Fetch from additional relays (if configured) 4. Try fallback lookup relays (if configured) This approach ensures efficient event loading with minimal network requests while providing good fallback options for retrieving replaceable events. --- # RxJS Operators | applesauce [Skip to content](https://hzrd149.github.io/applesauce/relays/operators.html#VPContent) Return to top RxJS Operators [​](https://hzrd149.github.io/applesauce/relays/operators.html#rxjs-operators) ============================================================================================== The `applesauce-relay` package provides several RxJS operators to help process and transform streams of events from Nostr relays. onlyEvents [​](https://hzrd149.github.io/applesauce/relays/operators.html#onlyevents) -------------------------------------------------------------------------------------- The `onlyEvents` operator filters the subscription response stream to only emit Nostr events, removing any "EOSE" (End Of Stored Events) messages. typescript import { onlyEvents } from "applesauce-relay/operators"; // Subscribe to events and only receive Nostr events (no EOSE messages) relay .req({ kinds: [1], limit: 10, }) .pipe(onlyEvents()) .subscribe((event) => { // This will only receive events, not "EOSE" strings console.log(event.id); }); markFromRelay [​](https://hzrd149.github.io/applesauce/relays/operators.html#markfromrelay) -------------------------------------------------------------------------------------------- The `markFromRelay` operator adds metadata to events indicating which relay they were received from. This is useful for tracking event propagation across the network. typescript import { markFromRelay } from "applesauce-relay/operators"; import { getSeenRelays } from "applesauce-core/helpers"; // Create a new relay instance const relay = new Relay("wss://relay.example.com"); // Subscribe to events and mark them as coming from this relay relay .req({ kinds: [1], limit: 10, }) .pipe(markFromRelay(relay.url)) .subscribe((response) => { if (typeof response !== "string") { // Check which relays this event has been seen on console.log(getSeenRelays(response)); } }); completeOnEose [​](https://hzrd149.github.io/applesauce/relays/operators.html#completeoneose) ---------------------------------------------------------------------------------------------- The `completeOnEose` operator completes the subscription stream when an "EOSE" (End Of Stored Events) message is received. This is particularly useful for one-off requests where you want to collect all events and then process them together. typescript import { completeOnEose } from "applesauce-relay/operators"; import { lastValueFrom } from "rxjs"; import { toArray } from "rxjs/operators"; // Method 1: Complete the stream when EOSE is received relay .req({ kinds: [1], limit: 10, }) .pipe(completeOnEose()) .subscribe({ next: (event) => console.log(event.id), complete: () => console.log("All stored events received"), }); // Method 2: Collect all events into an array const events = await lastValueFrom( relay .req({ kinds: [1], limit: 10, }) .pipe(completeOnEose(), toArray()), ); // Method 3: Include the EOSE message in the stream relay .req({ kinds: [1], limit: 10, }) .pipe(completeOnEose(true)) .subscribe((response) => { if (response === "EOSE") { console.log("End of stored events"); } else { console.log("Event:", response.id); } }); storeEvents [​](https://hzrd149.github.io/applesauce/relays/operators.html#storeevents) ---------------------------------------------------------------------------------------- The `storeEvents` operator adds all events from the subscription stream to an `EventStore` without filtering or removing duplicates. The stream continues to emit all original messages. typescript import { storeEvents } from "applesauce-relay/operators"; import { EventStore } from "applesauce-core"; // Create an event store const eventStore = new EventStore(); // Subscribe to events and add them to the store relay .req({ kinds: [1], limit: 10, }) .pipe(storeEvents(eventStore)) .subscribe((response) => { if (response === "EOSE") { // Access all events from the store const allEvents = eventStore.getAll(); console.log(`Received ${allEvents.length} events`); } }); toEventStore [​](https://hzrd149.github.io/applesauce/relays/operators.html#toeventstore) ------------------------------------------------------------------------------------------ The `toEventStore` operator adds all events to an `EventStore`, removes duplicates, and returns a sorted array of events when the EOSE message is received. This is perfect for fetching and processing a complete set of events. WARNING This operator is deprecated. It's recommended to use the `mapEventsToStore` and `mapEventsToTimeline` operators from `applesauce-core/observable` instead. typescript import { toEventStore } from "applesauce-relay/operators"; import { EventStore } from "applesauce-core"; import { lastValueFrom } from "rxjs"; // Create an event store const eventStore = new EventStore(); // Fetch events, deduplicate, and sort them const timeline = await lastValueFrom( relay .req({ kinds: [1], limit: 10, }) .pipe(toEventStore(eventStore)), ); console.log(`Received ${timeline.length} unique events`); ### Recommended alternative [​](https://hzrd149.github.io/applesauce/relays/operators.html#recommended-alternative) typescript import { mapEventsToStore, mapEventsToTimeline } from "applesauce-core/observable"; import { completeOnEose } from "applesauce-relay/operators"; import { EventStore } from "applesauce-core"; import { lastValueFrom } from "rxjs"; // Create an event store const eventStore = new EventStore(); // Fetch events, deduplicate, and sort them const timeline = await lastValueFrom( relay .req({ kinds: [1], limit: 10, }) .pipe(completeOnEose(), mapEventsToStore(eventStore, true), mapEventsToTimeline()), ); console.log(`Received ${timeline.length} unique events`); Combining Operators [​](https://hzrd149.github.io/applesauce/relays/operators.html#combining-operators) -------------------------------------------------------------------------------------------------------- These operators can be combined to create powerful data processing pipelines: typescript import { markFromRelay, onlyEvents, completeOnEose } from "applesauce-relay/operators"; import { mapEventsToStore, mapEventsToTimeline } from "applesauce-core/observable"; import { EventStore } from "applesauce-core"; import { lastValueFrom } from "rxjs"; // Create an event store const eventStore = new EventStore(); // Create a relay pool const pool = new RelayPool(); // Define relay URLs const relays = ["wss://relay1.example.com", "wss://relay2.example.com"]; // Fetch events from multiple relays, track where they came from, // deduplicate, and sort them const timeline = await lastValueFrom( pool .req(relays, { kinds: [1], limit: 10, }) .pipe( // Mark each event with its source relay markFromRelay(relays[0]), // Filter out EOSE messages onlyEvents(), // Complete when all events are received completeOnEose(), // Store events and remove duplicates mapEventsToStore(eventStore, true), // Create a sorted timeline mapEventsToTimeline(), ), ); console.log(`Received ${timeline.length} unique events`); --- # Signers | applesauce [Skip to content](https://hzrd149.github.io/applesauce/signers/package.html#VPContent) Return to top Signers [​](https://hzrd149.github.io/applesauce/signers/package.html#signers) =============================================================================== All signers in the `applesauce-signers` package are compatible with the [NIP-07](https://github.com/nostr-protocol/nips/blob/master/07.md) API Features [​](https://hzrd149.github.io/applesauce/signers/package.html#features) --------------------------------------------------------------------------------- * All signers follow the [NIP-07](https://github.com/nostr-protocol/nips/blob/master/07.md) API * [NIP-46](https://github.com/nostr-protocol/nips/blob/master/46.md) `bunker://` URI support * Support for client initinated NIP-46 connection (`nostrconnect://` URIs) * [NIP-49](https://github.com/nostr-protocol/nips/blob/master/49.md) encrypted password signer * Support for [nostr-signing-device](https://github.com/lnbits/nostr-signing-device) on chrome based browsers * Support for [Amber](https://github.com/greenart7c3/Amber) clipboard signer (deprecated) Installation [​](https://hzrd149.github.io/applesauce/signers/package.html#installation) ----------------------------------------------------------------------------------------- npmyarnpnpm sh npm install applesauce-signers sh yarn install applesauce-signers sh pnpm install applesauce-signers --- # Timeline Loader | applesauce [Skip to content](https://hzrd149.github.io/applesauce/loaders/timeline-loader.html#VPContent) Return to top Timeline Loader [​](https://hzrd149.github.io/applesauce/loaders/timeline-loader.html#timeline-loader) ======================================================================================================= The Timeline Loader is designed for fetching paginated Nostr events in chronological order. It maintains state between calls, allowing you to efficiently load timeline events in blocks until you reach a specific timestamp or exhaust available events. WARNING The observable returned by the Timeline Loader MUST be subscribed to in order for the request to be made. No request will be sent until you call `.subscribe()` on the returned observable. Basic Usage [​](https://hzrd149.github.io/applesauce/loaders/timeline-loader.html#basic-usage) ----------------------------------------------------------------------------------------------- ts import { createTimelineLoader } from "applesauce-loaders/loaders"; import { RelayPool } from "applesauce-relay"; // Create a relay pool const pool = new RelayPool(); // Create a timeline loader const timelineLoader = createTimelineLoader( pool, ["wss://relay.example.com"], { kinds: [1] }, // Load text notes ); // Initial load - gets the most recent events timelineLoader().subscribe((event) => { console.log("Loaded event:", event); }); // Later, load older events by calling the loader again // Each call continues from where the previous one left off timelineLoader().subscribe((event) => { console.log("Loaded older event:", event); }); // Load events until a specific timestamp const oneWeekAgo = Math.floor(Date.now() / 1000) - 7 * 24 * 60 * 60; timelineLoader(oneWeekAgo).subscribe((event) => { console.log("Event from last week:", event); }); Configuration Options [​](https://hzrd149.github.io/applesauce/loaders/timeline-loader.html#configuration-options) ------------------------------------------------------------------------------------------------------------------- The `createTimelineLoader` function accepts these options: * `limit`: Maximum number of events to request per filter * `cache`: A method used to load events from a local cache * `eventStore`: An event store to pass all events to WARNING If an event store is not provided, the loader will not be able to deduplicate events. Working with Relay Pools [​](https://hzrd149.github.io/applesauce/loaders/timeline-loader.html#working-with-relay-pools) ------------------------------------------------------------------------------------------------------------------------- The Timeline Loader requires a request method for loading Nostr events from relays. You can provide this in multiple ways: ### Using a RelayPool instance [​](https://hzrd149.github.io/applesauce/loaders/timeline-loader.html#using-a-relaypool-instance) The simplest approach is to pass a RelayPool instance directly: ts import { createTimelineLoader } from "applesauce-loaders/loaders"; import { RelayPool } from "applesauce-relay"; import { EventStore } from "applesauce-core"; const eventStore = new EventStore(); const pool = new RelayPool(); const timelineLoader = createTimelineLoader( pool, ["wss://relay.example.com"], { kinds: [1], authors: ["user_pubkey"] }, { eventStore }, ); ### Using a custom request method [​](https://hzrd149.github.io/applesauce/loaders/timeline-loader.html#using-a-custom-request-method) You can also provide a custom request method, such as one from nostr-tools: ts import { createTimelineLoader } from "applesauce-loaders/loaders"; import { SimplePool } from "nostr-tools"; import { Observable } from "rxjs"; const pool = SimplePool(); // Create a custom request function using nostr-tools function customRequest(relays, filters) { return new Observable((observer) => { const sub = pool.subscribeMany(relays, filters, { onevent: (event) => observer.next(event), eose: () => observer.complete(), }); return () => sub.close(); }); } // Create a function that matches the UpstreamPool interface const customPool = { request: customRequest, }; // Create timeline loader with custom pool const timelineLoader = createTimelineLoader(customPool, ["wss://relay.example.com"], filters); Loading from cache [​](https://hzrd149.github.io/applesauce/loaders/timeline-loader.html#loading-from-cache) ------------------------------------------------------------------------------------------------------------- For improved performance, you can configure the loader to use a local cache: ts import { createTimelineLoader } from "applesauce-loaders/loaders"; import { openDB, getEventsForFilters } from "nostr-idb"; // Setup a local event cache const cache = await openDB(); function cacheRequest(filters) { return getEventsForFilters(cache, filters); } const timelineLoader = createTimelineLoader( pool, ["wss://relay.example.com"], { kinds: [1] }, { cache: cacheRequest, eventStore }, ); Real-World Example [​](https://hzrd149.github.io/applesauce/loaders/timeline-loader.html#real-world-example) ------------------------------------------------------------------------------------------------------------- Here's how you might use the Timeline Loader in a React application for an infinite scrolling feed: tsx import { createTimelineLoader } from "applesauce-loaders/loaders"; import { RelayPool } from "applesauce-relay"; import { EventStore } from "applesauce-core"; import { useEffect, useState } from "react"; // Setup at app level const eventStore = new EventStore(); const pool = new RelayPool(); function Feed() { const [events, setEvents] = useState([]); const [loading, setLoading] = useState(false); const [timelineLoader, setTimelineLoader] = useState(null); // Initialize the timeline loader useEffect(() => { const loader = createTimelineLoader( pool, ["wss://relay.example.com"], { kinds: [1] }, // Load text notes { eventStore }, ); setTimelineLoader(() => loader); // Load initial events loadMoreEvents(loader); }, []); // Function to load more events const loadMoreEvents = (loader) => { if (!loader || loading) return; setLoading(true); const subscription = loader().subscribe({ next: (event) => { setEvents((prev) => [...prev, event]); }, complete: () => { setLoading(false); }, }); return () => subscription.unsubscribe(); }; return (
{events.map((event) => (
{event.content}
))}
); } Loading Sequence [​](https://hzrd149.github.io/applesauce/loaders/timeline-loader.html#loading-sequence) --------------------------------------------------------------------------------------------------------- The Timeline Loader follows this sequence when loading events: 1. Start with a cursor at Infinity (most recent events) 2. Attempt to load from cache (if configured) 3. Fetch from specified relays in parallel 4. Update the cursor to the oldest event's timestamp 5. Each subsequent call starts from the updated cursor 6. Stop when no more events are returned or the specified timestamp is reached This stateful approach allows efficient pagination through chronological timelines with minimal code complexity. --- # Reactions Loader | applesauce [Skip to content](https://hzrd149.github.io/applesauce/loaders/reactions-loader.html#VPContent) Return to top Reactions Loader [​](https://hzrd149.github.io/applesauce/loaders/reactions-loader.html#reactions-loader) ========================================================================================================== The Reactions Loader is a specialized loader for fetching [NIP-25](https://github.com/nostr-protocol/nips/blob/master/25.md) reaction events for any given Nostr event. It is built on top of the [Tag Value Loader](https://hzrd149.github.io/applesauce/loaders/tag-value-loader.html) and automatically handles both regular events and addressable events. WARNING The observable returned by the Reactions Loader MUST be subscribed to in order for the request to be made. No request will be sent until you call `.subscribe()` on the returned observable. Basic Usage [​](https://hzrd149.github.io/applesauce/loaders/reactions-loader.html#basic-usage) ------------------------------------------------------------------------------------------------ ts import { createReactionsLoader } from "applesauce-loaders/loaders"; import { RelayPool } from "applesauce-relay"; // Create a relay pool const pool = new RelayPool(); // Create a reactions loader (do this once at the app level) const reactionsLoader = createReactionsLoader(pool); // Later, use the loader to fetch reactions for any event const someEvent = { id: "event_id", kind: 1 /* ... */ }; reactionsLoader(someEvent, ["wss://relay.example.com"]).subscribe((reactionEvent) => { console.log("Received reaction:", reactionEvent); }); How It Works [​](https://hzrd149.github.io/applesauce/loaders/reactions-loader.html#how-it-works) -------------------------------------------------------------------------------------------------- The Reactions Loader automatically: * Determines if the target event is addressable (replaceable) or a regular event * Uses the appropriate tag (`a` for addressable events, `e` for regular events) to fetch reactions * Merges relay hints from the event's seen relays (if `useSeenRelays` is enabled) * Filters results to only return NIP-25 reaction events (kind 7) Configuration Options [​](https://hzrd149.github.io/applesauce/loaders/reactions-loader.html#configuration-options) -------------------------------------------------------------------------------------------------------------------- The `createReactionsLoader` function accepts these options: * `useSeenRelays`: Whether to include relays where the event was seen (default `true`) * All other options from Tag Value Loader: `bufferTime`, `bufferSize`, `authors`, `since`, `cacheRequest`, `extraRelays`, `eventStore` ts const reactionsLoader = createReactionsLoader(pool, { useSeenRelays: true, bufferTime: 500, eventStore, cacheRequest, }); Example with React [​](https://hzrd149.github.io/applesauce/loaders/reactions-loader.html#example-with-react) -------------------------------------------------------------------------------------------------------------- tsx import { createReactionsLoader } from "applesauce-loaders/loaders"; import { RelayPool } from "applesauce-relay"; import { useEffect, useState } from "react"; // Setup at app level const pool = new RelayPool(); const reactionsLoader = createReactionsLoader(pool); function ReactionsComponent({ event }) { const [reactions, setReactions] = useState([]); useEffect(() => { const subscription = reactionsLoader(event).subscribe((reactionEvent) => { setReactions((prev) => [...prev, reactionEvent]); }); return () => subscription.unsubscribe(); }, [event.id]); // Group reactions by content const reactionCounts = reactions.reduce((acc, reaction) => { const content = reaction.content || "+"; acc[content] = (acc[content] || 0) + 1; return acc; }, {}); return (

Reactions ({reactions.length})

{Object.entries(reactionCounts).map(([emoji, count]) => ( {emoji} {count} ))}
); } Understanding Reaction Events [​](https://hzrd149.github.io/applesauce/loaders/reactions-loader.html#understanding-reaction-events) ------------------------------------------------------------------------------------------------------------------------------------ NIP-25 reaction events have the following structure: * **Kind**: 7 (reaction) * **Content**: Usually an emoji (👍, ❤️, etc.) or "+" for likes, "-" for dislikes * **Tags**: Include `e` or `a` tags referencing the reacted-to event Example reaction event: json { "kind": 7, "content": "🔥", "tags": [\ ["e", "event_id_being_reacted_to"],\ ["p", "pubkey_of_event_author"]\ ], "created_at": 1234567890, "pubkey": "reactor_pubkey" } Addressable vs Regular Events [​](https://hzrd149.github.io/applesauce/loaders/reactions-loader.html#addressable-vs-regular-events) ------------------------------------------------------------------------------------------------------------------------------------ The loader automatically handles both types of events: * **Regular events** (kind 0, 1, etc.): Uses `e` tags to find reactions * **Addressable events** (kind 30000 to 39999): Uses `a` tags with the replaceable address This abstraction means you don't need to worry about the event type - just pass any event to the loader. Advanced Example: Reaction Analytics [​](https://hzrd149.github.io/applesauce/loaders/reactions-loader.html#advanced-example-reaction-analytics) ------------------------------------------------------------------------------------------------------------------------------------------------- tsx import { createReactionsLoader } from "applesauce-loaders/loaders"; import { RelayPool } from "applesauce-relay"; import { useEffect, useState } from "react"; const pool = new RelayPool(); const reactionsLoader = createReactionsLoader(pool); function ReactionAnalytics({ event }) { const [reactions, setReactions] = useState([]); const [uniqueReactors, setUniqueReactors] = useState(new Set()); useEffect(() => { const subscription = reactionsLoader(event).subscribe((reaction) => { setReactions((prev) => [...prev, reaction]); setUniqueReactors((prev) => new Set([...prev, reaction.pubkey])); }); return () => subscription.unsubscribe(); }, [event.id]); const positiveReactions = reactions.filter((r) => r.content === "+" || r.content === "👍" || r.content === "❤️"); const negativeReactions = reactions.filter((r) => r.content === "-" || r.content === "👎"); return (

Reaction Summary

Total reactions: {reactions.length}

Unique reactors: {uniqueReactors.size}

Positive: {positiveReactions.length}

Negative: {negativeReactions.length}

); } Performance Considerations [​](https://hzrd149.github.io/applesauce/loaders/reactions-loader.html#performance-considerations) ------------------------------------------------------------------------------------------------------------------------------ The Reactions Loader is optimized for performance through: * **Batching**: Multiple reaction requests are automatically batched together * **Deduplication**: Events are deduplicated when an event store is provided * **Caching**: Local cache integration prevents unnecessary network requests * **Relay optimization**: Uses seen relays from the target event for better discovery For best performance, ensure you provide an `eventStore` and `cacheRequest` when creating the loader. --- # 6. Creating Events with EventFactory | applesauce [Skip to content](https://hzrd149.github.io/applesauce/tutorial/06-event-factory.html#VPContent) Return to top 6\. Creating Events with EventFactory [​](https://hzrd149.github.io/applesauce/tutorial/06-event-factory.html#_6-creating-events-with-eventfactory) ==================================================================================================================================================== The `EventFactory` class is your tool for creating, signing, and modifying Nostr events. It provides a clean API with pre-built blueprints for common event types and handles the complexities of event creation for you. What is the EventFactory? [​](https://hzrd149.github.io/applesauce/tutorial/06-event-factory.html#what-is-the-eventfactory) ---------------------------------------------------------------------------------------------------------------------------- The `EventFactory` is a builder that: * **Creates events using blueprints** - Pre-built templates for common event types * **Handles signing** - Integrates with signers to sign events * **Manages metadata** - Automatically adds client tags, relay hints, etc. * **Provides operations** - Composable functions to modify events * **Ensures validity** - Creates properly formatted Nostr events Setting up the EventFactory [​](https://hzrd149.github.io/applesauce/tutorial/06-event-factory.html#setting-up-the-eventfactory) --------------------------------------------------------------------------------------------------------------------------------- First, you'll need a signer. For browser apps, the `ExtensionSigner` works with Nostr browser extensions: typescript import { EventFactory } from "applesauce-factory"; import { ExtensionSigner } from "applesauce-signers"; // Create a signer that uses the browser extension (like Alby or nos2x) const signer = new ExtensionSigner(); // Create the event factory with the signer const factory = new EventFactory({ signer, // Optional: Add client information to events client: { name: "My Nostr App", address: { identifier: "my-app", pubkey: "app-pubkey" }, }, }); > 💡 **Best Practice**: Create one `EventFactory` instance at the top level of your app and pass it down or use a context. Creating a Text Note [​](https://hzrd149.github.io/applesauce/tutorial/06-event-factory.html#creating-a-text-note) ------------------------------------------------------------------------------------------------------------------- Let's create a simple text note using the `NoteBlueprint`: typescript import { NoteBlueprint } from "applesauce-factory/blueprints"; async function createNote() { try { // Use the NoteBlueprint to create a draft event const draft = await factory.create(NoteBlueprint, "Hello Nostr! This is my first note. #introductions"); // Sign the draft event with the signer const signed = await factory.sign(draft); console.log("Created note:", signed); return signed; } catch (error) { console.error("Failed to create note:", error); } } Different Event Types with Blueprints [​](https://hzrd149.github.io/applesauce/tutorial/06-event-factory.html#different-event-types-with-blueprints) ----------------------------------------------------------------------------------------------------------------------------------------------------- EventFactory comes with blueprints for many common event types: ### Text Note with Hashtags [​](https://hzrd149.github.io/applesauce/tutorial/06-event-factory.html#text-note-with-hashtags) The `NoteBlueprint` is setup to automatically handle hashtags and mentions. typescript import { NoteBlueprint } from "applesauce-factory/blueprints"; // Simple note const hashtagsNote = await factory.create(NoteBlueprint, "Just posted my first note! #introductions"); console.log(hashtagsNote.tags); // Output: [["t", "introductions"]] // Note with hashtags (automatically parsed) const mentionsNote = await factory.create( NoteBlueprint, "GM nostr:npub180cvv07tjdrrgpa0j7j7tmnyl2yr6yr7l8j4s3evf6u64th6gkwsyjh6w6", ); console.log(mentionsNote.tags); // Output: [["p", "3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d"]] ### Reply to Another Note [​](https://hzrd149.github.io/applesauce/tutorial/06-event-factory.html#reply-to-another-note) The `NoteReplyBlueprint` can be used to create a reply event to another kind 1 note. typescript import { NoteReplyBlueprint } from "applesauce-factory/blueprints"; // Reply to an existing note const originalNote = { /* some note event */ }; const reply = await factory.create(NoteReplyBlueprint, originalNote, "Great point! I totally disagree."); ### Reaction (Like) [​](https://hzrd149.github.io/applesauce/tutorial/06-event-factory.html#reaction-like) The `ReactionBlueprint` can be used to create a reaction event to any nostr event. typescript import { ReactionBlueprint } from "applesauce-factory/blueprints"; // React to a note with a like const reaction = await factory.create(ReactionBlueprint, originalNote, "+"); // React with a heart const heartReaction = await factory.create(ReactionBlueprint, originalNote, "❤️"); ### Repost/Share [​](https://hzrd149.github.io/applesauce/tutorial/06-event-factory.html#repost-share) The `ShareBlueprint` can be used to create a repost/share event of any nostr event. typescript import { ShareBlueprint } from "applesauce-factory/blueprints"; // Share/repost a note const repost = await factory.create(ShareBlueprint, originalNote); Custom Event Creation [​](https://hzrd149.github.io/applesauce/tutorial/06-event-factory.html#custom-event-creation) --------------------------------------------------------------------------------------------------------------------- For more complex events, you can use the `build()` method with [operations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.EventOperations.html) : typescript import { setContent, includeHashtags, includeAltTag } from "applesauce-factory/operations"; // Build a custom note with specific operations const customNote = await factory.build( { kind: 1 }, // Start with a kind 1 note setContent("Check out this amazing project!"), includeHashtags(["nostr", "project"]), includeAltTag("A short text note"), ); const signed = await factory.sign(customNote); Error Handling Best Practices [​](https://hzrd149.github.io/applesauce/tutorial/06-event-factory.html#error-handling-best-practices) ------------------------------------------------------------------------------------------------------------------------------------- Any step in the event creation process can fail. You should handle these errors gracefully. typescript async function createNoteWithErrorHandling(content: string) { try { // Try to create the note const draft = await factory.create(NoteBlueprint, content); const signed = await factory.sign(draft); return signed; } catch (error) { console.error("Failed to create note:", error); return null; } } Key Concepts [​](https://hzrd149.github.io/applesauce/tutorial/06-event-factory.html#key-concepts) --------------------------------------------------------------------------------------------------- * **EventFactory creates events** using blueprints and operations * **Signers handle cryptography** - you don't need to manage keys directly * **Blueprints are templates** for common event types * **Always sign events** before using them or publishing them * **Handle errors gracefully** - users might cancel signing or * **Add events to EventStore** to see them in your UI --- # Actions | applesauce [Skip to content](https://hzrd149.github.io/applesauce/actions/package.html#VPContent) Return to top Actions [​](https://hzrd149.github.io/applesauce/actions/package.html#actions) =============================================================================== The `applesauce-actions` package provides pre-built actions for common actions a nostr app might need. Features [​](https://hzrd149.github.io/applesauce/actions/package.html#features) --------------------------------------------------------------------------------- * Built on `applesauce-factory` to create and modify events * Compatible with any NIP-07 signer ( and `applesauce-signers` ) * Works with any nostr SDK for publishing events Installation [​](https://hzrd149.github.io/applesauce/actions/package.html#installation) ----------------------------------------------------------------------------------------- npmyarnpnpm sh npm install applesauce-actions sh yarn install applesauce-actions sh pnpm install applesauce-actions --- # Text content | applesauce [Skip to content](https://hzrd149.github.io/applesauce/content/package.html#VPContent) Return to top Text content [​](https://hzrd149.github.io/applesauce/content/package.html#text-content) ========================================================================================= The `applesauce-content` package provides tools for parsing and rendering the text `content` of nostr events. Installation [​](https://hzrd149.github.io/applesauce/content/package.html#installation) ----------------------------------------------------------------------------------------- npmyarnpnpm sh npm install applesauce-content sh yarn install applesauce-content sh pnpm install applesauce-content --- # Tag Value Loader | applesauce [Skip to content](https://hzrd149.github.io/applesauce/loaders/tag-value-loader.html#VPContent) Return to top Tag Value Loader [​](https://hzrd149.github.io/applesauce/loaders/tag-value-loader.html#tag-value-loader) ========================================================================================================== The Tag Value Loader is a specialized loader for fetching Nostr events by their tag values. It provides an efficient way to batch and deduplicate requests, cache results, and handle relay hints. WARNING The observable returned by the Tag Value Loader MUST be subscribed to in order for the request to be made. No request will be sent until you call `.subscribe()` on the returned observable. Basic Usage [​](https://hzrd149.github.io/applesauce/loaders/tag-value-loader.html#basic-usage) ------------------------------------------------------------------------------------------------ ts import { createTagValueLoader } from "applesauce-loaders/loaders"; import { RelayPool } from "applesauce-relay"; // Create a relay pool const pool = new RelayPool(); // Create a tag value loader for a specific tag (do this once at the app level) const eTagLoader = createTagValueLoader(pool, "e"); // Later, use the loader to fetch events by tag value eTagLoader({ value: "event_id", relays: ["wss://relay.example.com"], }).subscribe((event) => { console.log("Loaded event:", event); }); Configuration Options [​](https://hzrd149.github.io/applesauce/loaders/tag-value-loader.html#configuration-options) -------------------------------------------------------------------------------------------------------------------- The `createTagValueLoader` function accepts these options: * `bufferTime`: Time interval to buffer requests in ms (default 1000) * `bufferSize`: Max buffer size (default 200) * `kinds`: Restrict queries to specific kinds * `authors`: Restrict queries to specific authors * `since`: Restrict queries since timestamp * `cacheRequest`: A method used to load events from a local cache * `extraRelays`: An array of relays to always fetch from * `eventStore`: An event store used to deduplicate events WARNING If an event store is not provided, the loader will not be able to deduplicate events. Working with Relay Pools [​](https://hzrd149.github.io/applesauce/loaders/tag-value-loader.html#working-with-relay-pools) -------------------------------------------------------------------------------------------------------------------------- The Tag Value Loader requires a request method for loading Nostr events from relays. You can provide this in multiple ways: ### Using a RelayPool instance [​](https://hzrd149.github.io/applesauce/loaders/tag-value-loader.html#using-a-relaypool-instance) The simplest approach is to pass a RelayPool instance directly: ts import { createTagValueLoader } from "applesauce-loaders/loaders"; import { RelayPool } from "applesauce-relay"; const pool = new RelayPool(); const eTagLoader = createTagValueLoader(pool, "e", { eventStore, cacheRequest, }); ### Using a custom request method [​](https://hzrd149.github.io/applesauce/loaders/tag-value-loader.html#using-a-custom-request-method) You can also provide a custom request method, such as one from nostr-tools: ts import { createTagValueLoader } from "applesauce-loaders/loaders"; import { SimplePool } from "nostr-tools"; import { Observable } from "rxjs"; const pool = SimplePool(); // Create a custom request function using nostr-tools function customRequest(relays, filters) { return new Observable((observer) => { const sub = pool.subscribeMany(relays, filters, { onevent: (event) => observer.next(event), eose: () => observer.complete(), }); return () => sub.close(); }); } // Create tag value loader with custom request const eTagLoader = createTagValueLoader(customRequest, "e", options); Loading from cache [​](https://hzrd149.github.io/applesauce/loaders/tag-value-loader.html#loading-from-cache) -------------------------------------------------------------------------------------------------------------- For improved performance, you can configure the loader to use a local cache: ts import { createTagValueLoader } from "applesauce-loaders/loaders"; import { openDB, getEventsForFilters } from "nostr-idb"; // Setup a local event cache const cache = await openDB(); function cacheRequest(filters) { return getEventsForFilters(cache, filters); } const eTagLoader = createTagValueLoader(pool, "e", { cacheRequest, eventStore, }); // Events from cache are automatically marked using markFromCache eTagLoader({ value: "event_id" }).subscribe((event) => { if (!isFromCache(event)) { // This is a new event from the network addEvents(cache, [event]); } }); Creating Specialized Loaders [​](https://hzrd149.github.io/applesauce/loaders/tag-value-loader.html#creating-specialized-loaders) ---------------------------------------------------------------------------------------------------------------------------------- The Tag Value Loader can be used to create specialized loaders for specific use cases: ### Reactions Loader [​](https://hzrd149.github.io/applesauce/loaders/tag-value-loader.html#reactions-loader) ts import { createTagValueLoader } from "applesauce-loaders/loaders"; import { kinds } from "nostr-tools"; import { getReplaceableAddress, isReplaceable, getSeenRelays, mergeRelaySets } from "applesauce-core/helpers"; function createReactionsLoader(pool, options) { // Create tag value loaders for both events and addressable events const eventLoader = createTagValueLoader(pool, "e", { ...options, kinds: [kinds.Reaction] }); const addressableLoader = createTagValueLoader(pool, "a", { ...options, kinds: [kinds.Reaction] }); // Return a function that uses the appropriate loader based on event type return (event, relays) => { // Use addressable loader for replaceable events, otherwise use event loader return isReplaceable(event.kind) ? addressableLoader({ value: getReplaceableAddress(event), relays }) : eventLoader({ value: event.id, relays }); }; } ### Zaps Loader [​](https://hzrd149.github.io/applesauce/loaders/tag-value-loader.html#zaps-loader) ts import { createTagValueLoader } from "applesauce-loaders/loaders"; import { kinds } from "nostr-tools"; import { getReplaceableAddress, isReplaceable, getSeenRelays, mergeRelaySets } from "applesauce-core/helpers"; function createZapsLoader(pool, options) { // Create tag value loaders for both events and addressable events const eventLoader = createTagValueLoader(pool, "e", { ...options, kinds: [kinds.Zap] }); const addressableLoader = createTagValueLoader(pool, "a", { ...options, kinds: [kinds.Zap] }); // Return a function that uses the appropriate loader based on event type return (event, relays) => { // Use addressable loader for replaceable events, otherwise use event loader return isReplaceable(event.kind) ? addressableLoader({ value: getReplaceableAddress(event), relays }) : eventLoader({ value: event.id, relays }); }; } Real-World Example [​](https://hzrd149.github.io/applesauce/loaders/tag-value-loader.html#real-world-example) -------------------------------------------------------------------------------------------------------------- Here's how you might use the Tag Value Loader in a React application to fetch replies to a note: tsx import { EventStore } from "applesauce-core"; import { createTagValueLoader } from "applesauce-loaders/loaders"; import { RelayPool } from "applesauce-relay"; import { useEffect, useState } from "react"; // Setup at app level const eventStore = new EventStore(); const pool = new RelayPool(); const eTagLoader = createTagValueLoader(pool, "e", { eventStore }); function RepliesComponent({ noteId, relays }) { const [replies, setReplies] = useState([]); // Load replies when component mounts useEffect(() => { const subscription = eTagLoader({ value: noteId, relays, }).subscribe((event) => { // Only add replies that reference this note in the root tag if (event.tags.some((tag) => tag[0] === "e" && tag[1] === noteId && tag[3] === "root")) { setReplies((prev) => [...prev, event]); } }); return () => subscription.unsubscribe(); }, [noteId]); return (

Replies ({replies.length})

{replies.map((reply) => (

{reply.content}

))}
); } Loading Sequence [​](https://hzrd149.github.io/applesauce/loaders/tag-value-loader.html#loading-sequence) ---------------------------------------------------------------------------------------------------------- The Tag Value Loader follows this sequence when loading events: 1. Attempt to load from cache (if configured) 2. Fetch from specified relays and any additional relays 3. Deduplicate events (if an event store is configured) This approach ensures efficient event loading with minimal network requests. --- # EventFactory | applesauce [Skip to content](https://hzrd149.github.io/applesauce/factory/event-factory.html#VPContent) Return to top EventFactory [​](https://hzrd149.github.io/applesauce/factory/event-factory.html#eventfactory) =============================================================================================== The `EventFactory` class is the main interface for creating, building, and modifying Nostr events. It provides a convenient wrapper around event operations and blueprints, making it easy to work with different types of Nostr events. Creating an EventFactory [​](https://hzrd149.github.io/applesauce/factory/event-factory.html#creating-an-eventfactory) ----------------------------------------------------------------------------------------------------------------------- The `EventFactory` is initialized with an `EventFactoryContext` that contains configuration options including signers, relay hints, and client information. ### Basic Usage [​](https://hzrd149.github.io/applesauce/factory/event-factory.html#basic-usage) typescript import { EventFactory } from "applesauce-factory"; // Create with empty context (minimal setup) const factory = new EventFactory(); // Create with signer const factory = new EventFactory({ signer: mySigner, // Any NIP-07 compatible signer }); ### With Full Context [​](https://hzrd149.github.io/applesauce/factory/event-factory.html#with-full-context) typescript import { EventFactory } from "applesauce-factory"; const factory = new EventFactory({ // Required for signing events signer: { getPublicKey: () => "your-pubkey", signEvent: (template) => signedEvent, nip04: { encrypt, decrypt }, // Optional NIP-04 support nip44: { encrypt, decrypt }, // Optional NIP-44 support }, // Optional: Add client tag to events client: { name: "My Nostr App", address: { identifier: "my-app", pubkey: "app-pubkey" }, }, // Optional: Provide relay hints for tags getEventRelayHint: (eventId) => "wss://relay.example.com", getPubkeyRelayHint: (pubkey) => "wss://relay.example.com", // Optional: Custom emojis for text content emojis: [{ name: "custom", url: "https://example.com/emoji.png" }], }); Core Methods [​](https://hzrd149.github.io/applesauce/factory/event-factory.html#core-methods) ----------------------------------------------------------------------------------------------- ### `create()` - Using Blueprints [​](https://hzrd149.github.io/applesauce/factory/event-factory.html#create-using-blueprints) The `create()` method uses pre-built blueprints to create common event types. Blueprints are pre-built sets of operations that can be used to create events. typescript // Create a short text note (kind 1) const noteEvent = await factory.create(NoteBlueprint, "Hello Nostr!"); // Create a reaction event (kind 7) const reactionEvent = await factory.create(ReactionBlueprint, eventToReactTo, "+"); // Create a reply to a note const replyEvent = await factory.create(NoteReplyBlueprint, noteToReplyTo, "Hello back!"); // Create a comment (NIP-22) const commentEvent = await factory.create(CommentBlueprint, articleToCommentOn, "Great article!"); ### `build()` - Build an event using operations [​](https://hzrd149.github.io/applesauce/factory/event-factory.html#build-build-an-event-using-operations) The `build()` method takes a starting template and builds an event using operations. typescript const customEvent = await factory.build( // Start with a template { kind: 30023 }, setContent("# My Article\n\nThis is my article content..."), // Include the "title" and "published_at" tags includeNameValueTag(["title", "My Article Title"]), includeNameValueTag(["published_at", "1234567890"]), // Include only one "d" tag includeSingletonTag(["d", "article-id"]), ); ### `modify()` - Updating Existing Events [​](https://hzrd149.github.io/applesauce/factory/event-factory.html#modify-updating-existing-events) The `modify()` method updates an existing event with a new `created_at` timestamp and operations. typescript // Modify an existing event const modifiedEvent = await factory.modify( existingEvent, // Replace the "title" and "published_at" tags includeNameValueTag(["title", "My Article Title"]), includeNameValueTag(["published_at", "1234567890"]), ); // Modify tags specifically const updatedEvent = await factory.modifyTags(existingEvent, addPubkeyTag("user_pubkey")); Event Lifecycle [​](https://hzrd149.github.io/applesauce/factory/event-factory.html#event-lifecycle) ----------------------------------------------------------------------------------------------------- ### 1\. Template → Signed [​](https://hzrd149.github.io/applesauce/factory/event-factory.html#_1-template-%E2%86%92-signed) typescript // 1. Create template const draft = await factory.build({ kind: 1, content: "Hello Nostr!", }); // 2. Sign the event (creates NostrEvent) const signed = await factory.sign(draft); ### 2\. Working with Operations [​](https://hzrd149.github.io/applesauce/factory/event-factory.html#_2-working-with-operations) Operations are functions that modify events during creation or modification: typescript import { setContent, addHashtags, addMentions, includeClientTag } from "applesauce-factory/operations"; const event = await factory.build( { kind: 1 }, setContent("My post content"), addHashtags(["nostr", "bitcoin"]), addMentions(["npub1..."]), includeClientTag("My App", "naddr1..."), ); Helper Methods [​](https://hzrd149.github.io/applesauce/factory/event-factory.html#helper-methods) --------------------------------------------------------------------------------------------------- The `EventFactory` includes convenient helper methods for common event types: typescript // Short text note const note = await factory.note("Hello World!", { hashtags: ["greeting"], }); // Reply to a note const reply = await factory.noteReply(noteToReplyTo, "Great post!"); // Reaction const reaction = await factory.reaction(eventToReactTo, "🔥"); // Delete event const deleteEvent = await factory.delete([eventToDelete, ...eventsToDelete], "I didn't mean to post my nsec1..."); // Share/repost const share = await factory.share(eventToShare); // Comment (NIP-22) const comment = await factory.comment(articleToCommentOn, "Interesting perspective!"); Advanced Features [​](https://hzrd149.github.io/applesauce/factory/event-factory.html#advanced-features) --------------------------------------------------------------------------------------------------------- ### Encrypted Content [​](https://hzrd149.github.io/applesauce/factory/event-factory.html#encrypted-content) When working with encrypted content in events, the factory preserves plaintext content so the app wont need to decrypt it later: typescript // Create a draft NIP-04 message const draft = await factory.build( { kind: 4 }, setEncryptedContent("other_pubkey", "Hello how have you been?"), includeNameValueTag(["p", "other_pubkey"]), ); // Signe the event const signed = await factory.sign(draft); // The plaintext content is still available for the app to use const content = getEncryptedContent(signed); ### Replaceable Events [​](https://hzrd149.github.io/applesauce/factory/event-factory.html#replaceable-events) For replaceable events (kinds 10000-19999 and 30000-39999), the factory automatically includes required `d` tags: typescript // Automatically adds "d" tag for addressable events const profileEvent = await factory.build({ kind: 30023, // Long-form content content: "Article content...", // "d" tag will be automatically added if missing }); ### Relay Hints [​](https://hzrd149.github.io/applesauce/factory/event-factory.html#relay-hints) When relay hint functions are provided in the context, they're automatically used for `e` and `p` tags: typescript const factory = new EventFactory({ signer: mySigner, getEventRelayHint: (eventId) => "wss://relay.example.com", getPubkeyRelayHint: (pubkey) => "wss://relay.example.com", }); // Tags will automatically include relay hints const reply = await factory.noteReply("Great post!", "event-id"); // Results in: ["e", "event-id", "wss://relay.example.com"] Error Handling [​](https://hzrd149.github.io/applesauce/factory/event-factory.html#error-handling) --------------------------------------------------------------------------------------------------- typescript try { const event = await factory.create(NoteBlueprint, "Hello World!"); console.log("Event created:", event); } catch (error) { if (error.message.includes("signer")) { console.error("Signer not available or failed"); } else { console.error("Event creation failed:", error); } } --- # Event Blueprints | applesauce [Skip to content](https://hzrd149.github.io/applesauce/factory/blueprints.html#VPContent) Return to top Event Blueprints [​](https://hzrd149.github.io/applesauce/factory/blueprints.html#event-blueprints) ==================================================================================================== Blueprints are pre-configured templates for creating common Nostr events. They encapsulate the logic for setting the correct event kind, content, and tags for specific event types, making it easy to create well-formed Nostr events. Using Blueprints [​](https://hzrd149.github.io/applesauce/factory/blueprints.html#using-blueprints) ---------------------------------------------------------------------------------------------------- ### With EventFactory [​](https://hzrd149.github.io/applesauce/factory/blueprints.html#with-eventfactory) The most common way to use blueprints is through an `EventFactory` instance. This allows you to reuse the same context (signer, relay hints, etc.) across multiple events. typescript import { EventFactory } from "applesauce-factory"; import { NoteBlueprint, ReactionBlueprint } from "applesauce-factory/blueprints"; // Create a factory with your context const factory = new EventFactory({ signer: mySigner, client: { name: "MyApp", address: { identifier: "myapp", pubkey: "pubkey..." } }, }); // Create events using the factory's helper methods const note = await factory.note("Hello, Nostr!"); const reaction = await factory.reaction(someEvent, "🔥"); // Or use the generic create method with any blueprint const customNote = await factory.create(NoteBlueprint, "Custom note content #nostr", { zapSplit: [{ pubkey: "pubkey...", weight: 100 }], }); ### With One-off Context [​](https://hzrd149.github.io/applesauce/factory/blueprints.html#with-one-off-context) For one-time event creation, you can use the `create` function with a context and blueprint: typescript import { create } from "applesauce-factory"; import { NoteBlueprint, CommentBlueprint } from "applesauce-factory/blueprints"; // Create a single event with a one-off context const note = await create( { signer: mySigner }, // context NoteBlueprint, // blueprint constructor "Hello, world!", // blueprint arguments ); // Create a comment on an existing event const comment = await create({ signer: mySigner }, CommentBlueprint, parentEvent, "Great post!"); Available Blueprints [​](https://hzrd149.github.io/applesauce/factory/blueprints.html#available-blueprints) ------------------------------------------------------------------------------------------------------------ * `NoteBlueprint(content, options?)` * `CommentBlueprint(parent, content, options?)` * `NoteReplyBlueprint(parent, content, options?)` * `ReactionBlueprint(event, emoji?)` * `ShareBlueprint(event, options?)` * `PicturePostBlueprint(pictures, content, options?)` * `FileMetadataBlueprint(file, options?)` * `DeleteBlueprint(events)` * `LiveStreamBlueprint(title, options?)` And a lot more in the [reference](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html) . Custom Blueprints [​](https://hzrd149.github.io/applesauce/factory/blueprints.html#custom-blueprints) ------------------------------------------------------------------------------------------------------ You can create your own custom blueprints by following the same pattern used by the built-in blueprints. A blueprint is a function that returns a call to the `blueprint()` helper function. ### Basic Custom Blueprint [​](https://hzrd149.github.io/applesauce/factory/blueprints.html#basic-custom-blueprint) typescript import { kinds } from "nostr-tools"; import { blueprint } from "applesauce-factory"; import { includeSingletonTag, MetaTagOptions } from "applesauce-factory/operations"; /** Custom event blueprint */ export function AppConfigBlueprint(config: Record) { return blueprint( kinds.AplicationData, // or your custom kind number // Add your operations here setContent(JSON.stringify(config)), includeSingletonTag(["d", "app-config"]), ); } ### Using Your Custom Blueprint [​](https://hzrd149.github.io/applesauce/factory/blueprints.html#using-your-custom-blueprint) Once created, use your custom blueprint just like the built-in ones: typescript // With EventFactory const customEvent = await factory.create(AppConfigBlueprint, { theme: "light" }); // With one-off context const advancedEvent = await create({ signer: mySigner }, AppConfigBlueprint, { theme: "light" }); Blueprint Patterns [​](https://hzrd149.github.io/applesauce/factory/blueprints.html#blueprint-patterns) -------------------------------------------------------------------------------------------------------- ### Common Patterns [​](https://hzrd149.github.io/applesauce/factory/blueprints.html#common-patterns) 1. **Type Safety**: Always define TypeScript types for your blueprint options 2. **Conditional Operations**: Use ternary operators to conditionally apply operations 3. **Reusable Operations**: Extract common logic into reusable operation functions 4. **Context Usage**: Leverage the context for relay hints, custom emojis, and other shared data ### Best Practices [​](https://hzrd149.github.io/applesauce/factory/blueprints.html#best-practices) * Keep blueprints focused on a single event type * Use descriptive names and comprehensive JSDoc comments * Validate inputs when necessary (like the `PicturePostBlueprint` does for image types) * Combine multiple operations for complex event structures * Always handle optional parameters gracefully --- # 8. Running Actions with ActionHub | applesauce [Skip to content](https://hzrd149.github.io/applesauce/tutorial/08-actions.html#VPContent) Return to top 8\. Running Actions with ActionHub [​](https://hzrd149.github.io/applesauce/tutorial/08-actions.html#_8-running-actions-with-actionhub) ======================================================================================================================================== The `ActionHub` is the central orchestrator for running actions in your Nostr application. It combines your EventStore, EventFactory, and publishing logic into a unified interface, making it simple to execute complex actions that read from your local data and publish new events to the network. What is ActionHub? [​](https://hzrd149.github.io/applesauce/tutorial/08-actions.html#what-is-actionhub) -------------------------------------------------------------------------------------------------------- ActionHub is a class that: * **Executes pre-built actions** - Like following users, creating contact lists, etc. * **Handles event creation and publishing** - Automatically creates, signs, and publishes events * **Provides error handling** - Gracefully handles validation and publishing errors * **Offers flexible execution modes** - Automatic publishing or manual control Setting up ActionHub [​](https://hzrd149.github.io/applesauce/tutorial/08-actions.html#setting-up-actionhub) ------------------------------------------------------------------------------------------------------------- ### Basic Setup [​](https://hzrd149.github.io/applesauce/tutorial/08-actions.html#basic-setup) To create an ActionHub, you need your `EventStore` and `EventFactory` instances: typescript import { ActionHub } from "applesauce-actions"; import { EventStore } from "applesauce-core"; import { EventFactory } from "applesauce-factory"; import { ExtensionSigner } from "applesauce-factory/signers"; // Your existing instances const eventStore = new EventStore(); const signer = new ExtensionSigner(); const eventFactory = new EventFactory({ signer }); // Create ActionHub without automatic publishing const actionHub = new ActionHub(eventStore, eventFactory); ### With Custom Publishing Logic [​](https://hzrd149.github.io/applesauce/tutorial/08-actions.html#with-custom-publishing-logic) For most applications, you'll want to provide a publish method that handles how events are sent to relays: typescript import { RelayPool } from "applesauce-relay"; import { NostrEvent } from "nostr-tools"; const pool = new RelayPool(); const defaultRelays = ["wss://relay.damus.io", "wss://nos.lol", "wss://relay.nostr.band"]; // Create a custom publish function function publish(event: NostrEvent) { return pool.publish(event, defaultRelays); } // Create ActionHub with automatic publishing const actionHub = new ActionHub(eventStore, eventFactory, publish); Running Actions [​](https://hzrd149.github.io/applesauce/tutorial/08-actions.html#running-actions) --------------------------------------------------------------------------------------------------- ### Using `hub.run()` - Automatic Publishing [​](https://hzrd149.github.io/applesauce/tutorial/08-actions.html#using-hub-run-automatic-publishing) The `hub.run()` method executes an action and automatically publishes all generated events: typescript import { FollowUser, UnfollowUser, NewContacts } from "applesauce-actions/actions"; // Create a new contact list (if one doesn't exist) try { await actionHub.run(NewContacts); console.log("Contact list created successfully"); } catch (error) { if (error.message.includes("contact list already exists")) { console.log("User already has a contact list"); } else { console.error("Failed to create contact list:", error); } } // Follow a user - events are automatically published const userToFollow = "3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d"; const relayHint = "wss://relay.damus.io"; try { await actionHub.run(FollowUser, userToFollow, relayHint); console.log("Successfully followed user"); } catch (error) { console.error("Failed to follow user:", error); } // Unfollow a user try { await actionHub.run(UnfollowUser, userToFollow); console.log("Successfully unfollowed user"); } catch (error) { console.error("Failed to unfollow user:", error); } ### Using `hub.exec()` for Manual Control [​](https://hzrd149.github.io/applesauce/tutorial/08-actions.html#using-hub-exec-for-manual-control) For more control over event handling, you can use `hub.exec()` which returns an observable: typescript import { tap, catchError } from "rxjs/operators"; import { EMPTY } from "rxjs"; // Execute action with manual event handling actionHub.exec(FollowUser, userPubkey, relayHint).subscribe({ next: async (event) => { try { // Custom publishing logic for this specific action await customPublish(event); console.log("Event published successfully"); } catch (error) { console.error("Failed to publish event:", error); } }, error: (error) => { console.error("Action failed:", error); }, complete: () => { console.log("Action completed"); }, }); Available Actions [​](https://hzrd149.github.io/applesauce/tutorial/08-actions.html#available-actions) ------------------------------------------------------------------------------------------------------- There are a lot of pre-built [actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html) , but here are a few common ones that are worth mentioning. ### Contact List Actions [​](https://hzrd149.github.io/applesauce/tutorial/08-actions.html#contact-list-actions) typescript import { NewContacts, FollowUser, UnfollowUser } from "applesauce-actions/actions"; // Create a new contact list await actionHub.run(NewContacts); // Follow a user await actionHub.run(FollowUser, pubkey, relayHint); // Unfollow a user await actionHub.run(UnfollowUser, pubkey); ### Profile Actions [​](https://hzrd149.github.io/applesauce/tutorial/08-actions.html#profile-actions) typescript import { UpdateProfile } from "applesauce-actions/actions"; // Update your profile await actionHub.run(UpdateProfile, { name: "Alice", about: "Bitcoin developer", picture: "https://example.com/alice.jpg", website: "https://alice.dev", }); Error Handling [​](https://hzrd149.github.io/applesauce/tutorial/08-actions.html#error-handling) ------------------------------------------------------------------------------------------------- Actions can fail for various reasons. Always handle errors appropriately: typescript async function safeFollowUser(pubkey, relayHint) { try { await actionHub.run(FollowUser, pubkey, relayHint); return { success: true }; } catch (error) { console.error("Follow action failed:", error); if (error.message.includes("contact list")) { // Try to create contact list first try { await actionHub.run(NewContacts); await actionHub.run(FollowUser, pubkey, relayHint); return { success: true }; } catch (retryError) { return { success: false, error: "Failed to create contact list" }; } } if (error.message.includes("signer")) { return { success: false, error: "Please connect your Nostr extension" }; } return { success: false, error: error.message }; } } // Usage const result = await safeFollowUser(pubkey, relayHint); if (result.success) { console.log("User followed successfully"); } else { console.error("Failed to follow user:", result.error); } Configuration Options [​](https://hzrd149.github.io/applesauce/tutorial/08-actions.html#configuration-options) --------------------------------------------------------------------------------------------------------------- ### Disable Automatic EventStore Saving [​](https://hzrd149.github.io/applesauce/tutorial/08-actions.html#disable-automatic-eventstore-saving) By default, `ActionHub` saves all generated events to your `EventStore`. You can disable this: typescript const actionHub = new ActionHub(eventStore, eventFactory, publish); actionHub.saveToStore = false; // Disable automatic saving // Now events are only published, not saved to local store await actionHub.run(FollowUser, pubkey, relayHint); ### Conditional Saving [​](https://hzrd149.github.io/applesauce/tutorial/08-actions.html#conditional-saving) You might want to save events only after successful publishing: typescript const actionHub = new ActionHub(eventStore, eventFactory); actionHub.saveToStore = false; // Disable automatic saving // Manual event handling with conditional saving await actionHub.exec(FollowUser, pubkey, relayHint).forEach(async (event) => { try { // Publish first await publish(event); // Save to store only after successful publish eventStore.add(event); console.log("Event published and saved"); } catch (error) { console.error("Failed to publish, not saving to store:", error); } }); Best Practices [​](https://hzrd149.github.io/applesauce/tutorial/08-actions.html#best-practices) ------------------------------------------------------------------------------------------------- ### 1\. Single ActionHub Instance [​](https://hzrd149.github.io/applesauce/tutorial/08-actions.html#_1-single-actionhub-instance) Create one ActionHub instance for your entire application: typescript // app.ts export const actionHub = new ActionHub(eventStore, eventFactory, publish); // other-file.ts import { actionHub } from "./app"; await actionHub.run(FollowUser, pubkey); ### 2\. Error Handling [​](https://hzrd149.github.io/applesauce/tutorial/08-actions.html#_2-error-handling) Actions can throw errors so many sure to handle them gracefully. typescript try { await actionHub.run(FollowUser, pubkey); } catch (error) { console.error("Failed to follow user:", error); } Key Concepts [​](https://hzrd149.github.io/applesauce/tutorial/08-actions.html#key-concepts) --------------------------------------------------------------------------------------------- * **ActionHub orchestrates** EventStore, EventFactory, and publishing * **Actions are pre-built** functions for common Nostr operations * **`hub.run()` provides automatic** event creation and publishing * **`hub.exec()` gives manual control** over event handling * **Error handling is crucial** for good user experience * **Single instance per app** is recommended for consistency Next Steps [​](https://hzrd149.github.io/applesauce/tutorial/08-actions.html#next-steps) ----------------------------------------------------------------------------------------- You now know enough to build a Nostr application! Checkout some some of the examples apps in the [examples](https://hzrd149.github.io/applesauce/examples) directory to see whats possible. --- # Wallet | applesauce [Skip to content](https://hzrd149.github.io/applesauce/wallet/package.html#VPContent) Return to top Wallet [​](https://hzrd149.github.io/applesauce/wallet/package.html#wallet) ============================================================================ The `applesauce-wallet` package provides a set of actions and queries for managing [NIP-60](https://github.com/nostr-protocol/nips/blob/master/60.md) wallets and [Cashu](https://github.com/cashubtc/cashu) tokens. WARNING The `applesauce-wallet` package is still a work-in-progress and is still missing many features. Installation [​](https://hzrd149.github.io/applesauce/wallet/package.html#installation) ---------------------------------------------------------------------------------------- npmyarnpnpm sh npm install applesauce-wallet sh yarn install applesauce-wallet sh pnpm install applesauce-wallet --- # Models | applesauce [Skip to content](https://hzrd149.github.io/applesauce/wallet/models.html#VPContent) Return to top Models [​](https://hzrd149.github.io/applesauce/wallet/models.html#models) =========================================================================== The `applesauce-wallet` package provides a few pre-built models for subscribing to the state of the wallet. WalletModel [​](https://hzrd149.github.io/applesauce/wallet/models.html#walletmodel) ------------------------------------------------------------------------------------- The `WalletModel` subscribes to the state of a NIP-60 wallet, providing information about whether it's locked and its associated mints. typescript import { WalletModel } from "applesauce-wallet/models"; const wallet = eventStore.model(WalletModel, pubkey).subscribe((info) => { if (!info) return console.log("No wallet found"); if (info.locked) { console.log("Wallet is locked"); } else { console.log("Wallet mints:", info.mints); console.log("Has private key:", !!info.privateKey); } }); WalletTokensQuery [​](https://hzrd149.github.io/applesauce/wallet/models.html#wallettokensquery) ------------------------------------------------------------------------------------------------- The `WalletTokensQuery` subscribes to all token events for a wallet, with optional filtering by locked status. typescript import { WalletTokensModel } from "applesauce-wallet/models"; // Get all tokens const allTokens = eventStore.model(WalletTokensModel, pubkey); // Get only unlocked tokens const unlockedTokens = eventStore.model(WalletTokensModel, pubkey, false); WalletBalanceQuery [​](https://hzrd149.github.io/applesauce/wallet/models.html#walletbalancequery) --------------------------------------------------------------------------------------------------- The `WalletBalanceQuery` returns the visible balance of a wallet for each mint. typescript import { WalletBalanceModel } from "applesauce-wallet/models"; eventStore.model(WalletBalanceModel, pubkey).subscribe((balances) => { for (const [mint, amount] of Object.entries(balances)) { console.log(`Balance for ${mint}: ${amount}`); } }); --- # Managing events | applesauce [Skip to content](https://hzrd149.github.io/applesauce/core/event-store.html#VPContent) Return to top Managing events [​](https://hzrd149.github.io/applesauce/core/event-store.html#managing-events) ================================================================================================ The `EventStore` is a reactive in-memory event database At its core the event store uses the [`Database`](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Database.html) class to store and index events Creating an event store [​](https://hzrd149.github.io/applesauce/core/event-store.html#creating-an-event-store) ---------------------------------------------------------------------------------------------------------------- ts import { EventStore } from "applesauce-core"; const eventStore = new EventStore(); INFO Its recommended to only create a single event store for your app Adding events [​](https://hzrd149.github.io/applesauce/core/event-store.html#adding-events) -------------------------------------------------------------------------------------------- To add events to the event store you can use the [`eventStore.add`](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#add) method Adding events to the event store will update any subscriptions that match that event ts eventStore.timeline({kinds: [1]}).subscribe(events => { console.log(`timeline updated (${events.length})`) }) const event = { kind: 1, ... } eventStore.add(event) ### Duplicate an replaceable events [​](https://hzrd149.github.io/applesauce/core/event-store.html#duplicate-an-replaceable-events) The event store understands to to handle replaceable (`1xxxx`) and parameterized replaceable events (`3xxxx`) If the event store already has the event (same `id`) or if its a replaceable event and it already has newer version of it. `eventStore.add` will returning the **existing** instance of the event This allows you to easily deduplicate events from multiple relays ts const incoming = [\ {\ id: "f177c37f...",\ kind: 1,\ content: "",\ pubkey: "c3ae4ad8...",\ created_at: 1733345284,\ tags: [],\ sig: "...",\ },\ {\ id: "efd33141...",\ kind: 1,\ content: "",\ pubkey: "20d29810...",\ created_at: 1733343882,\ tags: [],\ sig: "...",\ },\ // duplicate of #1\ {\ id: "f177c37f...",\ kind: 1,\ content: "",\ pubkey: "c3ae4ad8...",\ created_at: 1733345284,\ tags: [],\ sig: "...",\ },\ ]; const sub = eventStore.stream({ kinds: [1] }).subscribe((event) => { console.log("new event", event); }); // add first event eventStore.add(incoming[0]); // add second event eventStore.add(incoming[1]); // add duplicate event const event = eventStore.add(incoming[2]); // since the event f177c37f has already been added // the subscription will not update and the returned event is the original console.log(event !== incoming[2]); Subscribing [​](https://hzrd149.github.io/applesauce/core/event-store.html#subscribing) ---------------------------------------------------------------------------------------- Subscriptions are rxjs [observables](https://rxjs.dev/guide/observable) that update when new events are added to the event store ### Single events [​](https://hzrd149.github.io/applesauce/core/event-store.html#single-events) Subscribing to a single event will notify you when the event has been added to the event store or when it is deleted ts const event = { content: "Hashtags are useless.", created_at: 1733153425, id: "000021ba6f5f4da9d1f913c73dcf8fc8347052b4e74e14a2e41101c0f40792c8", kind: 1, pubkey: "3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d", sig: "6f197e399d1ebae054fbc20570fc8ef113a79afaa6057125170ba81afcecea2449969c9d1dbc61ff50328cae7166e9981734ba29672d9ae45acb675ff45ebd84", tags: [["nonce", "8002", "16"]], }; const sub = eventStore.event("000021ba6f5f4da9d1f913c73dcf8fc8347052b4e74e14a2e41101c0f40792c8").subscribe((event) => { // value maybe undefined when the event is not in the event store // or if it has been deleted if (event) { console.log("event has been found", event); } }); eventStore.add(event); ### Replaceable events [​](https://hzrd149.github.io/applesauce/core/event-store.html#replaceable-events) Subscribing to a replaceable event will notify you when there is a newer version or when it is deleted ts const original = { id: "7607adc3934f368bf1a00cb1023e455707a90af94a29c2acf877dffb0ec4c0cb", pubkey: "d8dd41ef1e287dfc668d2473fbef8fa9deea5c2ef03947105ef568e68827e7e4", created_at: 1733346633, kind: 0, tags: [], content: '{ "name": "john" }', sig: "b706636043a64c5d1a07cabf66db08b1374d6efa4558e8832f5b90becb5cba190215a2ec1303e11dac494977801600b012959daa7145fba6d96ae3fcb629759e", }; const updated = { id: "2f54a4491a31451cbe0d296297649af458d89df2f24d7f86d2474fd0607e29a1", pubkey: "d8dd41ef1e287dfc668d2473fbef8fa9deea5c2ef03947105ef568e68827e7e4", created_at: 1733346633, kind: 0, tags: [], content: '{ "name": "john smith" }', sig: "d66ecc0fb2b9170818defb593150563061716bce82d276d07b4b68be9ab542b2d14bb1335eb62971a84be5f315ecf32bdf53000e780a20330f63d7803a1fd95c", }; eventStore.add(original); // get the original and listen for any updates const sub = eventStore .replaceable(0, "d8dd41ef1e287dfc668d2473fbef8fa9deea5c2ef03947105ef568e68827e7e4") .subscribe((event) => { // first event will be the original if (event) console.log("Profile Updated", event); }); // this will trigger the subscription eventStore.add(updated); ### Streams [​](https://hzrd149.github.io/applesauce/core/event-store.html#streams) A stream subscription takes a filter(s) and returns all events that match and notifies you when there are new events ts const sub = eventStore.stream({ kinds: [1] }).subscribe((event) => { console.log("Found text note", event); }); // or if you only want to subscribe to future events const sub = eventStore.stream({ kinds: [1] }, true).subscribe((event) => { console.log("Found new text note", event); }); ### Timelines [​](https://hzrd149.github.io/applesauce/core/event-store.html#timelines) A timeline subscription takes a filter(s) and returns a sorted array of events that match the filter(s) ts const timeline = eventStore.timeline({ kinds: [1] }).subscribe((events) => { console.log(events); }); // fetch some events using another library fetchEvents({ kinds: [1, 0] }, (event) => { // timeline will update for each new event eventStore.add(event); }); Fallback event loaders [​](https://hzrd149.github.io/applesauce/core/event-store.html#fallback-event-loaders) -------------------------------------------------------------------------------------------------------------- The event store has three optional loader methods that act as fallbacks when events are not found in the store. These loaders are particularly useful for loading user profiles or other single events on-demand when the UI needs them. ### Setting up custom loaders [​](https://hzrd149.github.io/applesauce/core/event-store.html#setting-up-custom-loaders) You can implement your own loader methods using any Nostr library or relay connection approach: ts import { EventStore } from "applesauce-core"; const eventStore = new EventStore(); // Event loader - loads events by ID eventStore.eventLoader = async (pointer) => { console.log("loading event", pointer); const event = await cache.getEventById(pointer.id); if (event) return event; }; // Replaceable loader - loads kind 0, 3, 1xxxx events eventStore.replaceableLoader = async (pointer) => { console.log("loading replaceable event", pointer); return await loadReplaceableEvent(pointer.kind, pointer.pubkey); }; // Addressable loader - loads kind 3xxxx events eventStore.addressableLoader = async (pointer) => { console.log("loading addressable event", pointer); const event = await fetchAddressableEvent(pointer.kind, pointer.pubkey, pointer.identifier); if (event) return event; }; Now if events are subscribed to and they don't exist in the store, the loaders will be called. ts const sub = eventStore .profile("3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d") .subscribe((profile) => { if (profile) console.log("Profile loaded:", profile); }); // Console: // loading replaceable event { kind: 0, pubkey: '3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d' } // Profile loaded: { name: 'fiatjaf', ... } The loaders are called automatically and the loaded events are added to the store, making them available for future requests and updating any active subscriptions. ### Using with applesauce-loaders [​](https://hzrd149.github.io/applesauce/core/event-store.html#using-with-applesauce-loaders) While you can implement loaders with any Nostr library, the `applesauce-relay` and `applesauce-loaders` packages make it much simpler: ts import { EventStore } from "applesauce-core"; import { createAddressLoader, createEventLoader } from "applesauce-loaders/loaders"; import { RelayPool } from "applesauce-relay"; const eventStore = new EventStore(); const pool = new RelayPool(); // Create an address loader that handles all addressable and replaceable events const addressLoader = createAddressLoader(pool, { // Try a local relay first for caching cacheRequest: (filters) => pool.relay("ws://localhost:4869").request(filters), // Fallback to public relays lookupRelays: ["wss://purplepag.es", "wss://relay.damus.io"], }); // Set loaders on event store eventStore.addressableLoader = addressLoader; eventStore.replaceableLoader = addressLoader; // Create an event loader that loads events by ID const eventLoader = createEventLoader(pool, { // Try a local relay first for caching cacheRequest: (filters) => pool.relay("ws://localhost:4869").request(filters), }); // Set loader on event store eventStore.eventLoader = eventLoader; Static Methods [​](https://hzrd149.github.io/applesauce/core/event-store.html#static-methods) ---------------------------------------------------------------------------------------------- The event store provides several methods to directly access events without creating subscriptions. These methods are useful when you need to check for or retrieve events synchronously. ### Event Management [​](https://hzrd149.github.io/applesauce/core/event-store.html#event-management) * `add(event)`: Add a new event to the store * `remove(event)`: Remove an event from the store * `update(event)`: Notify the store that an event has been updated ### Checking Event Existence [​](https://hzrd149.github.io/applesauce/core/event-store.html#checking-event-existence) * `hasEvent(id)`: Check if an event with a specific ID exists in the store * `hasReplaceable(kind, pubkey, identifier?)`: Check if a replaceable event exists for the given kind and pubkey combination ### Retrieving Events [​](https://hzrd149.github.io/applesauce/core/event-store.html#retrieving-events) * `getEvent(id)`: Get a single event by its ID * `getReplaceable(kind, pubkey, identifier?)`: Get the latest version of a replaceable event * `getReplaceableHistory(kind, pubkey, identifier?)`: Get the history of all versions of a replaceable event * `getByFilters(filters)`: Get a set of all events that match the given filter(s) * `getTimeline(filters)`: Get a sorted array of events that match the given filter(s) Example usage: ts // Check if an event exists const exists = eventStore.hasEvent("000021ba6f5f..."); // Get an event by ID const event = eventStore.getEvent("000021ba6f5f..."); // Get events matching filters const events = eventStore.getByFilters({ kinds: [1], authors: ["000021ba6f5f..."] }); // Get a timeline of events const timeline = eventStore.getTimeline({ kinds: [1] }); // Check and get replaceable events const hasProfile = eventStore.hasReplaceable(0, "000021ba6f5f..."); const profile = eventStore.getReplaceable(0, "000021ba6f5f..."); --- # Wallet Connect | applesauce [Skip to content](https://hzrd149.github.io/applesauce/wallet-connect/package.html#VPContent) Return to top Wallet Connect [​](https://hzrd149.github.io/applesauce/wallet-connect/package.html#wallet-connect) ==================================================================================================== The `applesauce-wallet-connect` package provides a complete implementation of [NIP-47](https://github.com/nostr-protocol/nips/blob/master/47.md) Nostr Wallet Connect for both clients and services. Features [​](https://hzrd149.github.io/applesauce/wallet-connect/package.html#features) ---------------------------------------------------------------------------------------- * **WalletConnect**: Client-side implementation for connecting to NIP-47 wallet services * **WalletService**: Service-side implementation for creating NIP-47 wallet services * Full support for all NIP-47 methods * Support for both `nostr+walletconnect://` and `nostr+walletauth://` connection URIs * TypeScript support with full type safety * RxJS-based reactive architecture * Support for both NIP-04 and NIP-44 encryption * Comprehensive error handling with typed errors Installation [​](https://hzrd149.github.io/applesauce/wallet-connect/package.html#installation) ------------------------------------------------------------------------------------------------ npmyarnpnpm sh npm install applesauce-wallet-connect sh yarn install applesauce-wallet-connect sh pnpm install applesauce-wallet-connect Quick Start [​](https://hzrd149.github.io/applesauce/wallet-connect/package.html#quick-start) ---------------------------------------------------------------------------------------------- ### Client (WalletConnect) [​](https://hzrd149.github.io/applesauce/wallet-connect/package.html#client-walletconnect) Connect to a wallet service using a connection string: typescript import { WalletConnect } from "applesauce-wallet-connect"; const wallet = WalletConnect.fromConnectionString("nostr+walletconnect://relay.example.com?secret=...&pubkey=..."); // Pay an invoice const result = await wallet.payInvoice("lnbc1..."); console.log("Payment preimage:", result.preimage); // Get wallet balance const balance = await wallet.getBalance(); console.log("Balance:", balance.balance, "msats"); ### Service (WalletService) [​](https://hzrd149.github.io/applesauce/wallet-connect/package.html#service-walletservice) Create a wallet service that handles NIP-47 requests: typescript import { WalletService } from "applesauce-wallet-connect"; import { SimpleSigner } from "applesauce-signers"; // Create a signer for the service const signer = new SimpleSigner(); // Define method handlers const handlers = { get_info: async () => ({ alias: "My Wallet", color: "#ff0000", pubkey: await signer.getPublicKey(), network: "mainnet" as const, block_height: 800000, block_hash: "0000...0000", methods: ["get_info", "get_balance", "pay_invoice"], }), get_balance: async () => ({ balance: 100000, // 100 sats in msats }), pay_invoice: async (params) => { // Implement your payment logic here console.log("Paying invoice:", params.invoice); return { preimage: "payment_preimage_here", fees_paid: 1000, }; }, }; // Create the service const service = new WalletService({ subscriptionMethod: mySubscriptionMethod, publishMethod: myPublishMethod, relays: ["wss://relay.example.com"], signer, handlers, }); // Start the service await service.start(); console.log("Wallet service started"); // Get the connection string for the wallet service console.log(service.getConnectionString()); Supported Methods [​](https://hzrd149.github.io/applesauce/wallet-connect/package.html#supported-methods) ---------------------------------------------------------------------------------------------------------- Both WalletConnect and WalletService support all NIP-47 methods: * `get_info` - Get wallet information * `get_balance` - Get wallet balance * `pay_invoice` - Pay a Lightning invoice * `multi_pay_invoice` - Pay multiple invoices * `pay_keysend` - Send a keysend payment * `multi_pay_keysend` - Send multiple keysend payments * `make_invoice` - Create a new invoice * `lookup_invoice` - Look up an invoice * `list_transactions` - List transactions --- # Migration Guide: v2 to v3 | applesauce [Skip to content](https://hzrd149.github.io/applesauce/migration/v2-v3.html#VPContent) Return to top Migration Guide: v2 to v3 [​](https://hzrd149.github.io/applesauce/migration/v2-v3.html#migration-guide-v2-to-v3) ================================================================================================================== This guide will help you migrate your existing applesauce v2 applications to v3. Applesauce v3 introduces several breaking changes that improve the API consistency and modernize the codebase, but require some code updates. Overview of Major Changes [​](https://hzrd149.github.io/applesauce/migration/v2-v3.html#overview-of-major-changes) ------------------------------------------------------------------------------------------------------------------- * **Async APIs**: All signer and account methods now return Promises (no more synchronous APIs) * **NIP-07 Updates**: Removed `getRelays` method as it's no longer part of the NIP-07 specification * **Relay Operations**: `publish` and `authenticate` methods now return Promises instead of Observables * **Factory Reorganization**: Event operations have been reorganized into groups which breaks imports 1\. Accounts & Signers Changes [​](https://hzrd149.github.io/applesauce/migration/v2-v3.html#_1-accounts-signers-changes) -------------------------------------------------------------------------------------------------------------------------- ### Async API Migration [​](https://hzrd149.github.io/applesauce/migration/v2-v3.html#async-api-migration) **Major Change**: All signer and account methods now return Promises instead of being synchronous. This is to help standardize the API and make it easier to wrap and extend the classes. ts import { SimpleSigner } from "applesauce-accounts"; // v2 - Synchronous API const account = new SimpleSigner(); const pubkey = account.getPubkey(); // Returns string directly const event = account.signEvent(draft); // Returns NostrEvent directly // v3 - Async API const account = new SimpleSigner(); const pubkey = await account.getPubkey(); // Returns Promise const event = await account.signEvent(draft); // Returns Promise ### Removed getRelays Method [​](https://hzrd149.github.io/applesauce/migration/v2-v3.html#removed-getrelays-method) The `getRelays` method has been removed from all signers and accounts as it's no longer part of the NIP-07 specification: ts // v2 - This method existed const relays = await account.getRelays(); // ❌ Removed in v3 ### New ExtensionAccount.fromExtension Method [​](https://hzrd149.github.io/applesauce/migration/v2-v3.html#new-extensionaccount-fromextension-method) A new static method has been added for creating extension accounts: ts // v3 - New static method import { ExtensionAccount } from "applesauce-accounts"; const account = await ExtensionAccount.fromExtension(); // Creates account from window.nostr ### Migration Steps [​](https://hzrd149.github.io/applesauce/migration/v2-v3.html#migration-steps) 1. **Add await keywords** to all account and signer method calls: ts // v2 const pubkey = account.getPubkey(); const encrypted = account.encrypt(pubkey, message); const decrypted = account.decrypt(pubkey, encryptedMessage); const signed = account.signEvent(draft); // v3 const pubkey = await account.getPubkey(); const encrypted = await account.encrypt(pubkey, message); const decrypted = await account.decrypt(pubkey, encryptedMessage); const signed = await account.signEvent(draft); 2. **Remove getRelays usage**: ts // v2 - Remove this const relays = await account.getRelays(); 2\. Relay Changes [​](https://hzrd149.github.io/applesauce/migration/v2-v3.html#_2-relay-changes) -------------------------------------------------------------------------------------------------- ### Promise-Based Publish Methods [​](https://hzrd149.github.io/applesauce/migration/v2-v3.html#promise-based-publish-methods) **Major Change**: Relay publish methods now return Promises instead of Observables. ts import { lastValueFrom } from "rxjs"; // v2 - Observable-based const response = await lastValueFrom(relay.publish(event)); const responses = await lastValueFrom(pool.publish(event, relays)); // v3 - Promise-based const response = await relay.publish(event); // Returns Promise const responses = await pool.publish(event, relays); // Returns Promise ### Authentication Methods [​](https://hzrd149.github.io/applesauce/migration/v2-v3.html#authentication-methods) Authentication methods also now return Promises: ts // v2 - Observable-based const authResponse = await lastValueFrom(relay.authenticate(challenge)); const authResponse2 = await lastValueFrom(relay.auth(challenge)); // v3 - Promise-based const authResponse = await relay.authenticate(challenge); // Returns Promise const authResponse2 = await relay.auth(challenge); // Returns Promise ### Removed Interfaces [​](https://hzrd149.github.io/applesauce/migration/v2-v3.html#removed-interfaces) The following interfaces have been removed: * `IRelayState` - Use the Relay class directly * `Nip01Actions` - Methods are now part of the Relay class ### Migration Steps [​](https://hzrd149.github.io/applesauce/migration/v2-v3.html#migration-steps-1) 1. **Remove lastValueFrom usage** for publish methods: ts // v2 import { lastValueFrom } from "rxjs"; const response = await lastValueFrom(relay.publish(event)); // v3 const response = await relay.publish(event); 2. **Update authentication calls**: ts // v2 const authResponse = await lastValueFrom(relay.authenticate(challenge)); // v3 const authResponse = await relay.authenticate(challenge); 3\. Factory & Operations Changes [​](https://hzrd149.github.io/applesauce/migration/v2-v3.html#_3-factory-operations-changes) ------------------------------------------------------------------------------------------------------------------------------ ### Reorganized Exports [​](https://hzrd149.github.io/applesauce/migration/v2-v3.html#reorganized-exports) **Major Change**: Event operations have been reorganized and all exports have been renamed. ### Import groups of operations instead of individual methods [​](https://hzrd149.github.io/applesauce/migration/v2-v3.html#import-groups-of-operations-instead-of-individual-methods) Most of the operations have been moved into groups to make it easier to import and use them. ts // v2 import { setListTitle, setListImage, setListDescription } from "applesauce-factory/operations"; await factory.build( { kind: 30000 }, setListTitle("new list"), setListImage("https://example.com/image.png"), setListDescription("This is a new list"), ); // v3 - Use new names import { List } from "applesauce-factory/operations"; await factory.build( { kind: 30000 }, List.setTitle("new list"), List.setImage("https://example.com/image.png"), List.setDescription("This is a new list"), ); Summary of Required Changes [​](https://hzrd149.github.io/applesauce/migration/v2-v3.html#summary-of-required-changes) ----------------------------------------------------------------------------------------------------------------------- ### Breaking Changes (Must Update) [​](https://hzrd149.github.io/applesauce/migration/v2-v3.html#breaking-changes-must-update) 1. **Add `await` to all account/signer method calls** - they now return Promises 2. **Remove `getRelays()` usage on signers and accounts** - method no longer exists 3. **Update relay publish calls** - remove `lastValueFrom()` wrapper since it returns a promise 4. **Update relay authentication calls** - remove `lastValueFrom()` wrapper since it returns a promise ### Recommended Updates [​](https://hzrd149.github.io/applesauce/migration/v2-v3.html#recommended-updates) 1. **Use new `ExtensionAccount.fromExtension()` static method** for creating extension accounts --- # Relay Class | applesauce [Skip to content](https://hzrd149.github.io/applesauce/relays/relays.html#VPContent) Return to top Relay Class [​](https://hzrd149.github.io/applesauce/relays/relays.html#relay-class) ===================================================================================== The `Relay` class provides a reactive interface for connecting to and communicating with Nostr relays using RxJS observables. Creating a Relay Connection [​](https://hzrd149.github.io/applesauce/relays/relays.html#creating-a-relay-connection) --------------------------------------------------------------------------------------------------------------------- typescript import { Relay } from "applesauce-relay"; // Create a new relay instance const relay = new Relay("wss://relay.example.com"); // Access relay state observables relay.connected$.subscribe((connected) => console.log("Connection status:", connected)); relay.notices$.subscribe((notices) => console.log("Relay notices:", notices)); Subscribing to Events [​](https://hzrd149.github.io/applesauce/relays/relays.html#subscribing-to-events) --------------------------------------------------------------------------------------------------------- The `req` or `subscription` methods returns an observable that emits events from the relay. WARNING The `req` method will `complete` when the connection is closed or `error` when the connection has an error. for Persistent subscriptions you should use the `subscription` method. typescript // Subscribe to specific kinds of events relay .req({ kinds: [1], authors: ["pubkey1", "pubkey2"], }) .subscribe({ next: (response) => { if (response === "EOSE") { console.log("End of stored events"); } else { console.log("Event:", response); } }, error: (err) => console.error("Subscription error:", err), }); Publishing Events [​](https://hzrd149.github.io/applesauce/relays/relays.html#publishing-events) ------------------------------------------------------------------------------------------------- Send events to the relay using the `event` or `publish` methods. INFO The `publish` method is a wrapper around the `event` method that returns a `Promise` and automatically handles reconnecting and retrying. typescript import { generatePrivateKey, getPublicKey, getEventHash, signEvent } from "nostr-tools"; const sk = generatePrivateKey(); const pk = getPublicKey(sk); const event = { kind: 1, pubkey: pk, created_at: Math.floor(Date.now() / 1000), tags: [], content: "Hello Nostr!", }; event.id = getEventHash(event); event.sig = signEvent(event, sk); // Use the observable method relay.event(event).subscribe((response) => { console.log(`Published: ${response.ok}`, response.message); }); // Or use the publish method with await const response = await relay.publish(event); console.log(`Published: ${response.ok}`, response.message); Making One-time Requests [​](https://hzrd149.github.io/applesauce/relays/relays.html#making-one-time-requests) --------------------------------------------------------------------------------------------------------------- Use the `request` method for one-time queries that complete after receiving `EOSE`. typescript import { lastValueFrom } from "rxjs"; import { getProfileContent } from "applesauce-core/helpers"; // Get latest user profile async function getProfile(pubkey) { const events = await lastValueFrom( relay.request({ kinds: [0], authors: [pubkey], limit: 1, }), ); return getProfileContent(events[0]); } Authentication [​](https://hzrd149.github.io/applesauce/relays/relays.html#authentication) ------------------------------------------------------------------------------------------- The `Relay` class supports [NIP-42](https://github.com/nostr-protocol/nips/blob/master/42.md) authentication and keeps track of the authentication state and challenge. * `challenge$` - An observable that tracks the authentication challenge from the relay. * `authenticated$` - An observable that tracks the authentication state of the relay. * `authenticate` - An async method that can be used to authenticate the relay. More information about authentication can be found in the [typedocs](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay) . typescript // Listen for authentication challenges relay.challenge$.subscribe((challenge) => { if (!challenge) return; // Using browser extension as signer relay .authenticate(window.nostr) .then(() => { console.log("Authentication successful"); }) .catch((err) => { console.error("Authentication failed:", err); }); }); If you want to manually build the authentication event you can use the `auth` method to send the event to the relay. typescript import { makeAuthEvent } from "nostr-tools/nip42"; // Listen for authentication challenges relay.challenge$.subscribe(async (challenge) => { if (!challenge) return; // Create a new auth event and sign it const auth = await window.nostr.signEvent(makeAuthEvent(relay.url, challenge)); // Send it to the relay and wait for the response relay.auth(auth).subscribe({ next: (response) => { console.log("Authentication response:", response); }, error: (err) => { console.error("Authentication failed:", err); }, }); }); Persistent Subscriptions [​](https://hzrd149.github.io/applesauce/relays/relays.html#persistent-subscriptions) --------------------------------------------------------------------------------------------------------------- The `subscription` method can be used to create persistent subscriptions that automatically reconnect after connection issues. It provides two key options for handling failures: ### Retry Options [​](https://hzrd149.github.io/applesauce/relays/relays.html#retry-options) The `retries` option controls how many times the subscription will retry when encountering errors. It accepts either a number or a full RxJS `RetryConfig` object. typescript // Basic retry with number of attempts const subscription = relay .subscription({ kinds: [1, 6], since: Math.floor(Date.now() / 1000) }, { id: "feed", retries: 3 }) .subscribe({ next: (response) => { if (response !== "EOSE") { console.log("New event:", response.content); } }, }); // Advanced retry with custom configuration const subscription = relay .subscription( { kinds: [1] }, { id: "advanced-feed", retries: { count: 5, delay: 1000, resetOnSuccess: true, }, }, ) .subscribe(console.log); ### Reconnection Options [​](https://hzrd149.github.io/applesauce/relays/relays.html#reconnection-options) The `reconnect` option controls whether the subscription should automatically reconnect when the WebSocket connection is closed. It accepts: * `true` - Reconnect infinitely * `false` (default) - Don't reconnect * `number` - Reconnect a specific number of times * `RepeatConfig` - Full RxJS repeat configuration typescript // Infinite reconnection const subscription = relay .subscription({ kinds: [1] }, { id: "persistent-feed", reconnect: true }) .subscribe(console.log); // Limited reconnection attempts const subscription = relay.subscription({ kinds: [1] }, { id: "limited-feed", reconnect: 5 }).subscribe(console.log); // Custom reconnection with delay const subscription = relay .subscription( { kinds: [1] }, { id: "custom-feed", reconnect: { count: 10, delay: 2000, }, }, ) .subscribe(console.log); ### How It Works [​](https://hzrd149.github.io/applesauce/relays/relays.html#how-it-works) Under the hood, the `subscription` method uses RxJS operators to implement retry and reconnection logic: 1. **Retry Logic**: Uses the [`retry()`](https://rxjs.dev/api/operators/retry) operator to retry failed subscriptions based on the `retries` option 2. **Reconnection Logic**: Uses the [`repeat()`](https://rxjs.dev/api/operators/repeat) operator to restart the subscription when the connection is lost based on the `reconnect` option The default behavior provides 3 retries and no automatic reconnection, but you can customize these values based on your application's needs. Dynamic Filters [​](https://hzrd149.github.io/applesauce/relays/relays.html#dynamic-filters) --------------------------------------------------------------------------------------------- The `req`, and `subscription` methods can accept an observable for the filters. this allows for you to set the filters later or update them dynamically. WARNING Make sure to use a `ReplaySubject`, `BehaviorSubject`, or the `shareReplay(1)` operator to keep the last filters in case the relay disconnects and needs to resubscribe. typescript import { BehaviorSubject } from "rxjs"; import { onlyEvents } from "applesauce-relay/operators"; // Create a subject with initial filters const filters = new BehaviorSubject({ kinds: [1], limit: 20, }); // Subscribe using dynamic filters relay .req(filters) .pipe(onlyEvents()) .subscribe((event) => console.log(event.content)); // Update filters later setTimeout(() => { filters.next({ kinds: [1], "#t": ["nostr"], limit: 20, }); }, 5000); Relay Information [​](https://hzrd149.github.io/applesauce/relays/relays.html#relay-information) ------------------------------------------------------------------------------------------------- The `Relay` class keeps track of the relay information and emits it as an observable from the `information$` property. typescript // Get relay information relay.information$.subscribe((info) => { if (info) { console.log("Relay name:", info.name); console.log("Supported NIPs:", info.supported_nips); console.log("Software:", info.software); if (info.limitation) { console.log("Max message size:", info.limitation.max_message_length); } } }); --- # AppleSauce AppleSauce ========== Modules ------- [applesauce-accounts](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.html) [](https://hzrd149.github.io/applesauce/typedoc/modules.html#applesauce-accounts) [applesauce-actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.html) [](https://hzrd149.github.io/applesauce/typedoc/modules.html#applesauce-actions) [applesauce-content](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.html) [](https://hzrd149.github.io/applesauce/typedoc/modules.html#applesauce-content) [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) [](https://hzrd149.github.io/applesauce/typedoc/modules.html#applesauce-core) [applesauce-dvm](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-dvm.html) [](https://hzrd149.github.io/applesauce/typedoc/modules.html#applesauce-dvm) [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) [](https://hzrd149.github.io/applesauce/typedoc/modules.html#applesauce-factory) [applesauce-loaders](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-loaders.html) [](https://hzrd149.github.io/applesauce/typedoc/modules.html#applesauce-loaders) [applesauce-react](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-react.html) [](https://hzrd149.github.io/applesauce/typedoc/modules.html#applesauce-react) [applesauce-relay](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-relay.html) [](https://hzrd149.github.io/applesauce/typedoc/modules.html#applesauce-relay) [applesauce-signers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.html) [](https://hzrd149.github.io/applesauce/typedoc/modules.html#applesauce-signers) [applesauce-solidjs](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-solidjs.html) [](https://hzrd149.github.io/applesauce/typedoc/modules.html#applesauce-solidjs) [applesauce-wallet](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.html) [](https://hzrd149.github.io/applesauce/typedoc/modules.html#applesauce-wallet) [applesauce-wallet-connect](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html) [](https://hzrd149.github.io/applesauce/typedoc/modules.html#applesauce-wallet-connect) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Modules [applesauce-accounts](https://hzrd149.github.io/applesauce/typedoc/modules.html#applesauce-accounts) [applesauce-actions](https://hzrd149.github.io/applesauce/typedoc/modules.html#applesauce-actions) [applesauce-content](https://hzrd149.github.io/applesauce/typedoc/modules.html#applesauce-content) [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules.html#applesauce-core) [applesauce-dvm](https://hzrd149.github.io/applesauce/typedoc/modules.html#applesauce-dvm) [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules.html#applesauce-factory) [applesauce-loaders](https://hzrd149.github.io/applesauce/typedoc/modules.html#applesauce-loaders) [applesauce-react](https://hzrd149.github.io/applesauce/typedoc/modules.html#applesauce-react) [applesauce-relay](https://hzrd149.github.io/applesauce/typedoc/modules.html#applesauce-relay) [applesauce-signers](https://hzrd149.github.io/applesauce/typedoc/modules.html#applesauce-signers) [applesauce-solidjs](https://hzrd149.github.io/applesauce/typedoc/modules.html#applesauce-solidjs) [applesauce-wallet](https://hzrd149.github.io/applesauce/typedoc/modules.html#applesauce-wallet) [applesauce-wallet-connect](https://hzrd149.github.io/applesauce/typedoc/modules.html#applesauce-wallet-connect) --- # Markdown | applesauce [Skip to content](https://hzrd149.github.io/applesauce/content/markdown.html#VPContent) Return to top Markdown [​](https://hzrd149.github.io/applesauce/content/markdown.html#markdown) ================================================================================== The `applesauce-content` package exports some [remark](https://www.npmjs.com/package/remark) transformers. see remark [docs](https://remark.js.org/) to see how to add additional transformers Nostr Mentions [​](https://hzrd149.github.io/applesauce/content/markdown.html#nostr-mentions) ---------------------------------------------------------------------------------------------- The [`remarkNostrMentions`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-content.Markdown.remarkNostrMentions.html) transformer can be used to linkify [NIP-21](https://github.com/nostr-protocol/nips/blob/master/21.md) `nostr:` URIs --- # WalletService Class | applesauce [Skip to content](https://hzrd149.github.io/applesauce/wallet-connect/wallet-service.html#VPContent) Return to top WalletService Class [​](https://hzrd149.github.io/applesauce/wallet-connect/wallet-service.html#walletservice-class) ===================================================================================================================== The `WalletService` class provides a service-side implementation for creating NIP-47 wallet services. It handles incoming wallet requests, processes them through configured handlers, and sends responses back to clients. Overview [​](https://hzrd149.github.io/applesauce/wallet-connect/wallet-service.html#overview) ----------------------------------------------------------------------------------------------- `WalletService` is designed to be a complete server for Nostr Wallet Connect clients. It provides: * **Request Handling**: Automatic processing of NIP-47 wallet requests * **Handler System**: Pluggable method handlers for different wallet operations * **Encryption Support**: Automatic handling of NIP-04 and NIP-44 encryption * **Response Management**: Structured response handling with error support * **Notification Support**: Ability to send notifications to connected clients * **Lifecycle Management**: Start/stop functionality with proper cleanup Creating a Service [​](https://hzrd149.github.io/applesauce/wallet-connect/wallet-service.html#creating-a-service) ------------------------------------------------------------------------------------------------------------------- ### Basic Service Setup [​](https://hzrd149.github.io/applesauce/wallet-connect/wallet-service.html#basic-service-setup) typescript import { WalletService, WalletServiceHandlers } from "applesauce-wallet-connect"; import { SimpleSigner } from "applesauce-signers"; // Create a signer for the service const signer = new SimpleSigner(); // Define method handlers const handlers: WalletServiceHandlers = { get_info: async () => ({ alias: "My Lightning Wallet", color: "#ff6600", pubkey: await signer.getPublicKey(), network: "mainnet", block_height: 800000, block_hash: "0000000000000000000000000000000000000000000000000000000000000000", methods: ["get_info", "get_balance", "pay_invoice", "make_invoice"], }), get_balance: async () => ({ balance: 1000000, // 1000 sats }), pay_invoice: async (params) => { // Implement your payment logic here console.log(`Paying invoice: ${params.invoice} for ${params.amount} msats`); return { preimage: "payment_preimage_here", fees_paid: 1000, }; }, }; // Create the service const service = new WalletService({ relays: ["wss://relay.example.com"], signer, handlers, notifications: ["payment_received", "payment_sent"], }); // Start the service await service.start(); console.log("Wallet service started"); // Get the connection string for clients const connectionString = service.getConnectionString(); console.log("Clients can connect using:", connectionString); ### Setting Up Relay Methods [​](https://hzrd149.github.io/applesauce/wallet-connect/wallet-service.html#setting-up-relay-methods) The service needs methods for subscribing to and publishing events. You can set these globally or per instance: typescript import { RelayPool } from "applesauce-relay"; const pool = new RelayPool(); // Set global methods WalletService.subscriptionMethod = pool.subscription.bind(pool); WalletService.publishMethod = pool.publish.bind(pool); // Now all instances will use these methods by default const service = new WalletService(options); For more details on setting up relay methods, see the [Nostr Connect documentation](https://hzrd149.github.io/applesauce/signers/nostr-connect.html) . Handling Authentication Requests [​](https://hzrd149.github.io/applesauce/wallet-connect/wallet-service.html#handling-authentication-requests) ----------------------------------------------------------------------------------------------------------------------------------------------- ### Processing Auth URIs [​](https://hzrd149.github.io/applesauce/wallet-connect/wallet-service.html#processing-auth-uris) When a client wants to connect, they'll provide a `nostr+walletauth://` URI. You need to: 1. **Parse the URI**: Extract the client's public key and secret 2. **Create a Service**: Use the extracted information to create a service instance 3. **Start the Service**: Begin listening for requests from that client typescript import { parseWalletAuthURI } from "applesauce-wallet-connect/helpers"; // Parse the auth URI from the client const { secret, service: clientPubkey, relays } = parseWalletAuthURI(authUri); // Create a service instance for this client const walletService = new WalletService({ relays, signer, handlers, secret: hexToBytes(secret), // Convert hex secret to bytes }); // Start the service await walletService.start(); // The client can now connect using the connection string const connectionString = walletService.getConnectionString(); ### Using fromAuthURI [​](https://hzrd149.github.io/applesauce/wallet-connect/wallet-service.html#using-fromauthuri) For convenience, you can use the `fromAuthURI` static method: typescript const walletService = await WalletService.fromAuthURI(authUri, { signer, handlers, }); await walletService.start(); Method Handlers [​](https://hzrd149.github.io/applesauce/wallet-connect/wallet-service.html#method-handlers) ------------------------------------------------------------------------------------------------------------- ### Understanding Handlers [​](https://hzrd149.github.io/applesauce/wallet-connect/wallet-service.html#understanding-handlers) Handlers are functions that implement the actual wallet functionality. Each handler corresponds to a NIP-47 command: * `get_info`: Return wallet information * `get_balance`: Return current balance * `pay_invoice`: Process Lightning invoice payments * `make_invoice`: Create new Lightning invoices * `pay_keysend`: Send keysend payments * And more... For a complete list of available commands and their parameters, see the [NIP-47 specification](https://github.com/nostr-protocol/nips/blob/master/47.md#commands) . ### Handler Implementation [​](https://hzrd149.github.io/applesauce/wallet-connect/wallet-service.html#handler-implementation) Each handler receives the parameters from the client request and should return the appropriate result: typescript const handlers: WalletServiceHandlers = { get_info: async () => { // Return wallet information return { alias: "My Wallet", color: "#ff6600", pubkey: await signer.getPublicKey(), network: "mainnet", block_height: 800000, block_hash: "0000000000000000000000000000000000000000000000000000000000000000", methods: ["get_info", "get_balance", "pay_invoice"], }; }, get_balance: async () => { // Get balance from your Lightning node or database const balance = await getLightningBalance(); return { balance }; }, pay_invoice: async (params) => { const { invoice, amount } = params; // Validate the invoice if (!isValidInvoice(invoice)) { throw new InvalidInvoiceError("Invalid Lightning invoice format"); } // Check balance const balance = await getLightningBalance(); if (balance < amount) { throw new InsufficientBalanceError(`Insufficient balance: ${balance} msats, required: ${amount} msats`); } // Process the payment through your Lightning node const result = await processLightningPayment(invoice, amount); return { preimage: result.preimage, fees_paid: result.fees_paid, }; }, }; Error Handling [​](https://hzrd149.github.io/applesauce/wallet-connect/wallet-service.html#error-handling) ----------------------------------------------------------------------------------------------------------- ### Throwing Typed Errors [​](https://hzrd149.github.io/applesauce/wallet-connect/wallet-service.html#throwing-typed-errors) When implementing handlers, you should throw appropriate error types for different failure scenarios: typescript import { InsufficientBalanceError, InvalidInvoiceError, InternalError, WalletBaseError, } from "applesauce-wallet-connect/helpers/error"; const payInvoiceHandler: PayInvoiceHandler = async (params) => { try { const { invoice, amount } = params; // Validate invoice if (!isValidInvoice(invoice)) { throw new InvalidInvoiceError("Invalid Lightning invoice format"); } // Check balance const balance = await getLightningBalance(); if (balance < amount) { throw new InsufficientBalanceError(`Insufficient balance: ${balance} msats, required: ${amount} msats`); } // Process payment const result = await processPayment(invoice, amount); return result; } catch (error) { if (error instanceof WalletBaseError) { throw error; // Re-throw wallet errors } // Wrap unexpected errors throw new InternalError(`Payment processing failed: ${error.message}`); } }; ### Available Error Types [​](https://hzrd149.github.io/applesauce/wallet-connect/wallet-service.html#available-error-types) * `InsufficientBalanceError`: When there's not enough balance * `InvalidInvoiceError`: When an invoice is malformed * `RateLimitedError`: When rate limits are exceeded * `RestrictedError`: When an operation is not allowed * `UserRejectedError`: When the user rejects the operation * `NotImplementedError`: When a method is not supported * `InternalError`: For unexpected internal errors For a complete list of error types, see the [typedocs](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html) . Sending Notifications [​](https://hzrd149.github.io/applesauce/wallet-connect/wallet-service.html#sending-notifications) ------------------------------------------------------------------------------------------------------------------------- ### Notifying Clients [​](https://hzrd149.github.io/applesauce/wallet-connect/wallet-service.html#notifying-clients) You can send notifications to connected clients about important events: typescript // Send a payment received notification await service.notify("payment_received", { payment_hash: "abc123...", amount: 100000, fee: 1000, }); // Send a payment sent notification await service.notify("payment_sent", { payment_hash: "def456...", amount: 50000, fee: 500, }); ### Supported Notification Types [​](https://hzrd149.github.io/applesauce/wallet-connect/wallet-service.html#supported-notification-types) * `payment_received`: When a payment is received * `payment_sent`: When a payment is sent * `payment_failed`: When a payment fails Service Lifecycle [​](https://hzrd149.github.io/applesauce/wallet-connect/wallet-service.html#service-lifecycle) ----------------------------------------------------------------------------------------------------------------- ### Starting and Stopping [​](https://hzrd149.github.io/applesauce/wallet-connect/wallet-service.html#starting-and-stopping) typescript // Start the service await service.start(); // Check if running if (service.isRunning()) { console.log("Service is active"); } // Stop the service service.stop(); ### Graceful Shutdown [​](https://hzrd149.github.io/applesauce/wallet-connect/wallet-service.html#graceful-shutdown) typescript // Handle shutdown signals process.on("SIGTERM", () => { console.log("Shutting down wallet service..."); service.stop(); process.exit(0); }); process.on("SIGINT", () => { console.log("Shutting down wallet service..."); service.stop(); process.exit(0); }); Advanced Usage [​](https://hzrd149.github.io/applesauce/wallet-connect/wallet-service.html#advanced-usage) ----------------------------------------------------------------------------------------------------------- ### Dynamic Method Support [​](https://hzrd149.github.io/applesauce/wallet-connect/wallet-service.html#dynamic-method-support) You can conditionally enable methods based on runtime conditions: typescript const handlers: WalletServiceHandlers = {}; // Only enable payment methods if payment processor is available if (paymentProcessor.isAvailable()) { handlers.pay_invoice = payInvoiceHandler; handlers.make_invoice = makeInvoiceHandler; } // Always enable info methods handlers.get_info = getInfoHandler; handlers.get_balance = getBalanceHandler; const service = new WalletService({ relays: ["wss://relay.example.com"], signer, handlers, }); ### Custom Error Types [​](https://hzrd149.github.io/applesauce/wallet-connect/wallet-service.html#custom-error-types) You can create custom error types for your specific use cases: typescript import { WalletBaseError } from "applesauce-wallet-connect/helpers/error"; class PaymentProcessorError extends WalletBaseError { constructor( public processorCode: string, message: string, ) { super("INTERNAL", `Payment processor error (${processorCode}): ${message}`); } } const payInvoiceHandler: PayInvoiceHandler = async (params) => { try { const result = await paymentProcessor.pay(params.invoice); return result; } catch (error) { if (error.code === "INSUFFICIENT_FUNDS") { throw new InsufficientBalanceError("Insufficient balance in payment processor"); } throw new PaymentProcessorError(error.code, error.message); } }; --- # Applesauce packages | applesauce [Skip to content](https://hzrd149.github.io/applesauce/introduction/packages.html#VPContent) Return to top Applesauce packages [​](https://hzrd149.github.io/applesauce/introduction/packages.html#applesauce-packages) ============================================================================================================= Core [​](https://hzrd149.github.io/applesauce/introduction/packages.html#core) ------------------------------------------------------------------------------- The `applesauce-core` package contains the `EventStore` and the majority of the helpers, and models. [see more](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) npmyarnpnpm sh npm install applesauce-core sh yarn install applesauce-core sh pnpm install applesauce-core Content [​](https://hzrd149.github.io/applesauce/introduction/packages.html#content) ------------------------------------------------------------------------------------- The `applesauce-content` package contains helpers for parsing text content and markdown. [see more](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.html) npmyarnpnpm sh npm install applesauce-content sh yarn install applesauce-content sh pnpm install applesauce-content Signers [​](https://hzrd149.github.io/applesauce/introduction/packages.html#signers) ------------------------------------------------------------------------------------- The `applesauce-signers` package contains a bunch of NIP-07 compatible signer classes. [see more](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.html) npmyarnpnpm sh npm install applesauce-signers sh yarn install applesauce-signers sh pnpm install applesauce-signers Accounts [​](https://hzrd149.github.io/applesauce/introduction/packages.html#accounts) --------------------------------------------------------------------------------------- The `applesauce-accounts` package contains the main `AccountManager` class and various types of common nostr account types. [see more](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.html) npmyarnpnpm sh npm install applesauce-accounts sh yarn install applesauce-accounts sh pnpm install applesauce-accounts Factory [​](https://hzrd149.github.io/applesauce/introduction/packages.html#factory) ------------------------------------------------------------------------------------- The `applesauce-factory` package contains the main `EventFactory` class and a lot of [Blueprints](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html) and [Operations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html) for creating an modifying nostr events. [see more](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) npmyarnpnpm sh npm install applesauce-factory sh yarn install applesauce-factory sh pnpm install applesauce-factory Loaders [​](https://hzrd149.github.io/applesauce/introduction/packages.html#loaders) ------------------------------------------------------------------------------------- The `applesauce-loaders` package provides loaders that simplify fetching nostr events from multiple relays. These loaders can be integrated with any nostr connection framework of your choice. [see more](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-loaders.html) npmyarnpnpm sh npm install applesauce-loaders sh yarn install applesauce-loaders sh pnpm install applesauce-loaders ::: Actions [​](https://hzrd149.github.io/applesauce/introduction/packages.html#actions) ------------------------------------------------------------------------------------- The `applesauce-actions` package provides prebuilt actions that apps can use. [see more](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.html) npmyarnpnpm sh npm install applesauce-actions sh yarn install applesauce-actions sh pnpm install applesauce-actions Relays [​](https://hzrd149.github.io/applesauce/introduction/packages.html#relays) ----------------------------------------------------------------------------------- The `applesauce-relay` package provides a flexible api for communicating with Nostr relays, built on top of [RxJS](https://rxjs.dev/) . npmyarnpnpm sh npm install applesauce-relay sh yarn install applesauce-relay sh pnpm install applesauce-relay React [​](https://hzrd149.github.io/applesauce/introduction/packages.html#react) --------------------------------------------------------------------------------- The `applesauce-react` package contains a bunch of useful react hooks for working with other applesauce packages. [see more](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-react.html) npmyarnpnpm sh npm install applesauce-react sh yarn install applesauce-react sh pnpm install applesauce-react Wallet [​](https://hzrd149.github.io/applesauce/introduction/packages.html#wallet) ----------------------------------------------------------------------------------- The `applesauce-wallet` package provides queries and actions for [NIP-60](https://github.com/nostr-protocol/nips/blob/master/60.md) cashu wallets. npmyarnpnpm sh npm install applesauce-wallet sh yarn install applesauce-wallet sh pnpm install applesauce-wallet --- # Wallet Actions | applesauce [Skip to content](https://hzrd149.github.io/applesauce/wallet/actions.html#VPContent) Return to top Wallet Actions [​](https://hzrd149.github.io/applesauce/wallet/actions.html#wallet-actions) ============================================================================================ The `applesauce-wallet` package provides a set of [Actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.Actions.html) for common wallet operations. CreateWallet [​](https://hzrd149.github.io/applesauce/wallet/actions.html#createwallet) ---------------------------------------------------------------------------------------- Creates a new NIP-60 wallet event and wallet backup. typescript import { CreateWallet } from "applesauce-wallet/actions"; await hub.run(CreateWallet, ["wss://mint.example.com"], privateKey); WalletAddPrivateKey [​](https://hzrd149.github.io/applesauce/wallet/actions.html#walletaddprivatekey) ------------------------------------------------------------------------------------------------------ Adds a private key to an existing wallet event. typescript import { WalletAddPrivateKey } from "applesauce-wallet/actions"; await hub.run(WalletAddPrivateKey, privateKey); UnlockWallet [​](https://hzrd149.github.io/applesauce/wallet/actions.html#unlockwallet) ---------------------------------------------------------------------------------------- Unlocks the wallet event and optionally unlocks tokens and history events. typescript import { UnlockWallet } from "applesauce-wallet/actions"; // Unlock just the wallet await hub.run(UnlockWallet); // Unlock wallet and associated tokens/history await hub.run(UnlockWallet, { tokens: true, history: true }); ReceiveToken [​](https://hzrd149.github.io/applesauce/wallet/actions.html#receivetoken) ---------------------------------------------------------------------------------------- Adds a Cashu token to the wallet and optionally marks nutzaps as redeemed. typescript import { ReceiveToken } from "applesauce-wallet/actions"; await hub.run(ReceiveToken, token, redeemedEventIds); RolloverTokens [​](https://hzrd149.github.io/applesauce/wallet/actions.html#rollovertokens) -------------------------------------------------------------------------------------------- Deletes old tokens and creates a new consolidated token. typescript import { RolloverTokens } from "applesauce-wallet/actions"; await hub.run(RolloverTokens, oldTokenEvents, newToken); CompleteSpend [​](https://hzrd149.github.io/applesauce/wallet/actions.html#completespend) ------------------------------------------------------------------------------------------ Finalizes a spend operation by deleting spent tokens and creating a history entry. typescript import { CompleteSpend } from "applesauce-wallet/actions"; await hub.run(CompleteSpend, spentTokenEvents, changeToken); ConsolidateTokens [​](https://hzrd149.github.io/applesauce/wallet/actions.html#consolidatetokens) -------------------------------------------------------------------------------------------------- Combines all unlocked token events into a single event per mint. typescript import { ConsolidateTokens } from "applesauce-wallet/actions"; // Consolidate all unlocked tokens await hub.run(ConsolidateTokens); // Ignore locked tokens during consolidation await hub.run(ConsolidateTokens, { ignoreLocked: true }); WARNING Actions will throw errors if preconditions are not met (e.g., trying to add a private key to a locked wallet) --- # Nostr Connect | applesauce [Skip to content](https://hzrd149.github.io/applesauce/signers/nostr-connect.html#VPContent) Return to top Nostr Connect [​](https://hzrd149.github.io/applesauce/signers/nostr-connect.html#nostr-connect) ================================================================================================= The [`NostrConnectSigner`](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html) is a client side implementation of a [NIP-46](https://github.com/nostr-protocol/nips/blob/master/46.md) remote signer. Relay Communication [​](https://hzrd149.github.io/applesauce/signers/nostr-connect.html#relay-communication) ------------------------------------------------------------------------------------------------------------- The `NostrConnectSigner` requires two methods for communicating with relays: a subscription method for receiving events and a publish method for sending events. These methods can be set either through the constructor or globally on the class. At least one of these approaches must be used before creating a `NostrConnectSigner` instance. typescript import { Observable } from "rxjs"; function subscriptionMethod(relays, filters) { return new Observable((observer) => { // Create subscription to relays const cleanup = subscribeToRelays(relays, filters, (event) => { observer.next(event); }); return () => cleanup(); }); } async function publishMethod(relays, event) { for (const relay of relays) { await publishToRelay(relay, event); } } // Set methods globally once at app initialization NostrConnectSigner.subscriptionMethod = subscriptionMethod; NostrConnectSigner.publishMethod = publishMethod; // Or pass them as options when creating a signer const signer = new NostrConnectSigner({ relays: ["wss://relay.example.com"], subscriptionMethod, publishMethod, // ... other options }); ### Using the relay pool [​](https://hzrd149.github.io/applesauce/signers/nostr-connect.html#using-the-relay-pool) The simplest way to set these methods is to use the `RelayPool` from the `applesauce-relay` package. typescript import { RelayPool } from "applesauce-relay"; const pool = new RelayPool(); // Set the pool globally NostrConnectSigner.pool = pool; // Or pass the pool as an option when creating a signer const signer = new NostrConnectSigner({ relays: ["wss://relay.example.com"], pool, // ... other options }); Connecting to a remote signer [​](https://hzrd149.github.io/applesauce/signers/nostr-connect.html#connecting-to-a-remote-signer) --------------------------------------------------------------------------------------------------------------------------------- The `NostrConnectSigner` can be created with a remote signer's public key, and will automatically connect to it. js import { NostrConnectSigner } from "applesauce-signers"; const signer = new NostrConnectSigner({ remote: "", // Optional: Users pubkey pubkey: "", // Optional: Custom subscription method subscriptionMethod: customSubMethod, // Optional: Custom publish method publishMethod: customPubMethod, // Optional: Custom auth handler onAuth: async (url) => { // Handle auth requests }, }); // start the connection process await signer.connect(/* optional secret */, /* optional requested permissions */); console.log("Connected!"); // get the users pubkey const pubkey = await signer.getPublicKey(); console.log("Users pubkey is", pubkey); Initiating connection from client [​](https://hzrd149.github.io/applesauce/signers/nostr-connect.html#initiating-connection-from-client) ----------------------------------------------------------------------------------------------------------------------------------------- To start a connection from the client side, you can use the `getNostrConnectURI` and `waitForSigner` methods: js const signer = new NostrConnectSigner({ subscriptionMethod: customSubMethod, publishMethod: customPubMethod, relays: ["wss://relay.example.com"], // ... other options }); // get the nostrconnect:// URI with optional metadata const uri = signer.getNostrConnectURI({ name: "My App", url: "https://example.com", image: "https://example.com/icon.png", permissions: NostrConnectSigner.buildSigningPermissions([0, 1, 3, 10002]), }); console.log(uri); // Create an optional AbortSignal to cancel the waiting process if needed const controller = new AbortController(); const signal = controller.signal; try { // wait for the remote signer to connect, optionally passing an AbortSignal await signer.waitForSigner(signal); console.log("Connected!"); const pubkey = await signer.getPublicKey(); console.log("Users pubkey is", pubkey); } catch (error) { console.error("Connection was aborted:", error); } // Later, if you need to abort the waiting process: setTimeout(() => { controller.abort(); }, 10_000); Handling bunker URIs [​](https://hzrd149.github.io/applesauce/signers/nostr-connect.html#handling-bunker-uris) --------------------------------------------------------------------------------------------------------------- The `NostrConnectSigner.fromBunkerURI` method can be used to create a new signer from a `bunker://` URI, it will return a promise that will resolve when the signer is connected. js const signer = await NostrConnectSigner.fromBunkerURI( "bunker://266815e0c9210dfa324c6cba3573b14bee49da4209a9456f9484e5106cd408a5?relay=wss://relay.nsec.app&secret=d9aa70", { permissions: NostrConnectSigner.buildSigningPermissions([0, 1, 3, 10002]), // ... other options }, ); You can also parse a bunker URI manually using `NostrConnectSigner.parseBunkerURI`: js const { remote, relays, secret } = NostrConnectSigner.parseBunkerURI(uri); Permissions [​](https://hzrd149.github.io/applesauce/signers/nostr-connect.html#permissions) --------------------------------------------------------------------------------------------- The `NostrConnectSigner` uses a set of predefined permissions that can be requested from the remote signer: typescript enum Permission { GetPublicKey = "get_pubic_key", SignEvent = "sign_event", Nip04Encrypt = "nip04_encrypt", Nip04Decrypt = "nip04_decrypt", Nip44Encrypt = "nip44_encrypt", Nip44Decrypt = "nip44_decrypt", } Use the static `NostrConnectSigner.buildSigningPermissions` method to create an array of signing permissions for specific event kinds: js const permissions = NostrConnectSigner.buildSigningPermissions([0, 1, 3, 10002]); These permissions can be passed when: * Connecting to a remote signer via `connect(secret, permissions)` * Creating a nostr connect URI via `getNostrConnectURI({ permissions })` * Creating a signer from a bunker URI via `fromBunkerURI(uri, { permissions })` App Metadata [​](https://hzrd149.github.io/applesauce/signers/nostr-connect.html#app-metadata) ----------------------------------------------------------------------------------------------- When creating a nostr connect URI, you can provide metadata about your application: typescript type NostrConnectAppMetadata = { name?: string; image?: string; url?: string | URL; permissions?: string[]; }; This metadata is used to display information about your application to the user when they connect their signer. Encryption Methods [​](https://hzrd149.github.io/applesauce/signers/nostr-connect.html#encryption-methods) ----------------------------------------------------------------------------------------------------------- The `NostrConnectSigner` supports both NIP-04 and NIP-44 encryption through the `nip04` and `nip44` properties: typescript // NIP-04 encryption const encrypted = await signer.nip04.encrypt(pubkey, plaintext); const decrypted = await signer.nip04.decrypt(pubkey, ciphertext); // NIP-44 encryption const encrypted = await signer.nip44.encrypt(pubkey, plaintext); const decrypted = await signer.nip44.decrypt(pubkey, ciphertext); --- # Nostr Connect Provider | applesauce [Skip to content](https://hzrd149.github.io/applesauce/signers/bunker-provider.html#VPContent) Return to top Nostr Connect Provider [​](https://hzrd149.github.io/applesauce/signers/bunker-provider.html#nostr-connect-provider) ===================================================================================================================== The [`NostrConnectProvider`](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html) is a server-side implementation of a [NIP-46](https://github.com/nostr-protocol/nips/blob/master/46.md) remote signer. It allows clients to connect and request signing operations through encrypted Nostr events. Upstream signer [​](https://hzrd149.github.io/applesauce/signers/bunker-provider.html#upstream-signer) ------------------------------------------------------------------------------------------------------- The `NostrConnectProvider` requires an upstream signer that will be used for the common [NIP-07](https://github.com/nostr-protocol/nips/blob/master/07.md) operations (`sign_event`, `nip04_encrypt`, etc.) typescript import { SimpleSigner } from "applesauce-signers"; // Create a new signer for the users key const upstream = SimpleSigner.fromKey("nsec1..."); // Create a new provider that will use the upstream signer const provider = new NostrConnectProvider({ relays: ["wss://relay.example.com"], upstream, }); // Or create a new provider that uses the user's key for signing and communication (legacy) const provider = new NostrConnectProvider({ relays: ["wss://relay.example.com"], upstream, // Explicitly set the signer that is used for communication to the users signer signer: upstream, }); // Start the provider await provider.start(/* optional nostrconnect:// URI */); Relay Communication [​](https://hzrd149.github.io/applesauce/signers/bunker-provider.html#relay-communication) --------------------------------------------------------------------------------------------------------------- The `NostrConnectProvider` requires two methods for communicating with relays: a subscription method for receiving events and a publish method for sending events. These methods can be set either through the constructor or globally on the class. At least one of these approaches must be used before creating a `NostrConnectProvider` instance. typescript import { Observable } from "rxjs"; function subscriptionMethod(relays, filters) { return new Observable((observer) => { // Create subscription to relays const cleanup = subscribeToRelays(relays, filters, (event) => { observer.next(event); }); return () => cleanup(); }); } async function publishMethod(relays, event) { for (const relay of relays) { await publishToRelay(relay, event); } } // Set methods globally once at app initialization NostrConnectProvider.subscriptionMethod = subscriptionMethod; NostrConnectProvider.publishMethod = publishMethod; // Or pass them as options when creating a provider const provider = new NostrConnectProvider({ relays: ["wss://relay.example.com"], subscriptionMethod, publishMethod, // ... other options }); ### Using the relay pool [​](https://hzrd149.github.io/applesauce/signers/bunker-provider.html#using-the-relay-pool) The simplest way to set these methods is to use the `RelayPool` from the `applesauce-relay` package. typescript import { RelayPool } from "applesauce-relay"; const pool = new RelayPool(); // Set the pool globally NostrConnectProvider.pool = pool; // Or pass the pool as an option when creating a provider const provider = new NostrConnectProvider({ relays: ["wss://relay.example.com"], pool, // ... other options }); Authorization Callbacks [​](https://hzrd149.github.io/applesauce/signers/bunker-provider.html#authorization-callbacks) ----------------------------------------------------------------------------------------------------------------------- The provider supports several authorization callbacks to control what operations clients can perform: typescript const provider = new NostrConnectProvider({ // ... other options // Control connection requests onConnect: (client, permissions) => { // Return true to accept, false to reject return permissions.includes("sign_event"); // Only allow clients that request signing }, // Control event signing onSignEvent: (draft, client) => { // Check if the event kind is allowed if (draft.kind === 1) return true; // Allow text notes if (draft.kind === 3) return true; // Allow contact lists throw new Error("Unsupported event kind"); // Reject other kinds with custom message }, // Control NIP-04 encryption/decryption onNip04Encrypt: (pubkey, plaintext, client) => true, onNip04Decrypt: (pubkey, ciphertext, client) => true, // Control NIP-44 encryption/decryption onNip44Encrypt: (pubkey, plaintext, client) => true, onNip44Decrypt: (pubkey, ciphertext, client) => true, }); Waiting for Client (`bunker://` URI) [​](https://hzrd149.github.io/applesauce/signers/bunker-provider.html#waiting-for-client-bunker-uri) ------------------------------------------------------------------------------------------------------------------------------------------ To create a provider that waits for clients to connect, you can use the `waitForClient` method: typescript import { NostrConnectProvider, SimpleSigner } from "applesauce-signers"; // Create a signer for the users key const user = SimpleSigner.fromKey("nsec1..."); // Create a signer for the provider's identity (recomended to be different from the upstream signer) const signer = new SimpleSigner(); const provider = new NostrConnectProvider({ relays: ["wss://relay.signer.com"], upstream: user, // Signer for actual operations signer: signer, // Provider's identity (optional, will create a new SimpleSigner if not provided) secret: "my-secret-key", // Recommended secret for client authentication (optional) onClientConnect: (client) => { console.log("Client connected:", client); }, onClientDisconnect: (client) => { console.log("Client disconnected:", client); }, onConnect: (client, permissions) => { console.log("Connection request from:", client, "with permissions:", permissions); return true; // Accept the connection }, onSignEvent: (draft, client) => { console.log("Sign request from:", client, "for event:", draft); return true; // Allow signing }, // ... other authorization callbacks }); // Start the provider and wait for a client try { // Get the bunker:// URI for clients to connect const bunkerUri = await provider.getBunkerURI(); console.log("Bunker URI:", bunkerUri); // Open the subscription and wait for the client to connect const clientPubkey = await provider.waitForClient(); console.log("Connected to client:", clientPubkey); } catch (error) { console.error("Failed to connect:", error); } // Stop the provider when done await provider.stop(); ### Getting the Bunker URI [​](https://hzrd149.github.io/applesauce/signers/bunker-provider.html#getting-the-bunker-uri) The `getBunkerURI()` method returns a `bunker://` URI that clients can use to connect: typescript const bunkerUri = await provider.getBunkerURI(); // Returns: bunker://?relay=&secret= This URI can be displayed as a QR code or shared with clients to initiate connections. Connect to client (`nostrconnect://` URI) [​](https://hzrd149.github.io/applesauce/signers/bunker-provider.html#connect-to-client-nostrconnect-uri) ---------------------------------------------------------------------------------------------------------------------------------------------------- To create a provider that responds to a client's `nostrconnect://` URI, pass the URI to the `start` method: typescript import { NostrConnectProvider, SimpleSigner } from "applesauce-signers"; // Create a signer for the users key const user = SimpleSigner.fromKey("nsec1..."); // Create a new provider with the users signer const provider = new NostrConnectProvider({ relays: ["wss://relay.signer.com"], upstream: user, onClientConnect: (client) => { console.log("Client connected:", client); }, onConnect: (client, permissions) => { console.log("Connection request from:", client, "with permissions:", permissions); return true; }, // ... other callbacks }); // Get the nostrconnect:// URI from the client const nostrConnectUri = "nostrconnect://client-pubkey?secret=shared-secret&relay=wss://relay.signer.com&name=MyApp"; try { // Start the provider and respond to the client's `nostrconnect://` URI await provider.start(nostrConnectUri); console.log("Provider started and connected to client"); } catch (error) { console.error("Failed to start provider:", error); } // Stop when done await provider.stop(); ### Handling Initial Connect Requests [​](https://hzrd149.github.io/applesauce/signers/bunker-provider.html#handling-initial-connect-requests) You can also start a provider with an initial `connect` request event: typescript // Start with a connect request event await provider.start(connectRequestEvent); // Or start and wait for the first connect request await provider.start(); New `connect` requests [​](https://hzrd149.github.io/applesauce/signers/bunker-provider.html#new-connect-requests) ------------------------------------------------------------------------------------------------------------------- Its not recomended but it is possible to listen for `connect` requests sent to the users pubkey and create a connection. typescript const pool = new RelayPool(); const user = SimpleSigner.fromKey("nsec1..."); const providers: NostrConnectProvider[] = []; // Open a new subscription that will listen for new `connect` requests pool .subscription(["wss://relay.signer.com"], { kinds: [kinds.NostrConnect], "#p": [await user.getPublicKey()] }) .subscribe((event) => { // WARNING: manually validate that this is a new `connect` request, otherwise you will create infinite providers! // Presume this is a `connect` request and ask the user if they want to connect to the random client that just asked if ((await askUserForConnection(event.pubkey, event)) === false) return; // Create a new provider that will respond to the connect request const provider = new NostrConnectProvider({ relays: ["wss://relay.signer.com"], upstream: user, pool, // Use the users signer, since the client is expecting to hear back from the users pubkey signer: user, }); // Start the provider and respond to the `connect` request provider.start(event); providers.push(provider); }); // Later close all providers function shutdown() { for (const provider of providers) { provider.stop(); } } Provider Lifecycle [​](https://hzrd149.github.io/applesauce/signers/bunker-provider.html#provider-lifecycle) ------------------------------------------------------------------------------------------------------------- ### Starting the Provider [​](https://hzrd149.github.io/applesauce/signers/bunker-provider.html#starting-the-provider) typescript // Start without waiting for a specific client await provider.start(); // Start and respond to a specific nostrconnect:// URI await provider.start(nostrConnectUri); // Start and respond to a connect request event await provider.start(connectRequestEvent); ### Stopping the Provider [​](https://hzrd149.github.io/applesauce/signers/bunker-provider.html#stopping-the-provider) typescript await provider.stop(); This will: * Close the relay subscription * Clear the state * Cancel any pending operations ### Checking Provider Status [​](https://hzrd149.github.io/applesauce/signers/bunker-provider.html#checking-provider-status) typescript if (provider.listening) { console.log("Provider is listening for requests"); } if (provider.connected) { console.log("Provider is connected to client:", provider.client); } Error Handling [​](https://hzrd149.github.io/applesauce/signers/bunker-provider.html#error-handling) ----------------------------------------------------------------------------------------------------- The provider automatically handles errors and sends appropriate error responses to clients: typescript const upstream = { signEvent: async (draft) => { // Errors throw in the upstream signer will be passed along to the client throw new Error("You shall not sign!"); }, }; const provider = new NostrConnectProvider({ // ... other options onConnect: (client, permissions) => { // Errors throw in the callback methods will be passed along to the client throw new Error("You shall not pass!"); }, }); --- # Action Hub | applesauce [Skip to content](https://hzrd149.github.io/applesauce/actions/action-hub.html#VPContent) Return to top Action Hub [​](https://hzrd149.github.io/applesauce/actions/action-hub.html#action-hub) ======================================================================================== The [ActionHub](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-actions.ActionHub.html) class is the central orchestrator for running actions in your Nostr application. It combines an event store, event factory, and optional publish method into a unified interface, making it simple to execute actions that read from your local event store and publish new events to the Nostr network. Creating an Action Hub [​](https://hzrd149.github.io/applesauce/actions/action-hub.html#creating-an-action-hub) ---------------------------------------------------------------------------------------------------------------- ### Basic Setup [​](https://hzrd149.github.io/applesauce/actions/action-hub.html#basic-setup) To create an ActionHub, you need an event store and event factory. Optionally, you can provide a publish method to automatically handle event publishing. ts import { ActionHub } from "applesauce-actions"; import { NostrEvent } from "nostr-tools"; // Create a basic ActionHub without automatic publishing const hub = new ActionHub(eventStore, eventFactory); // Or create one with automatic publishing const publish = async (event: NostrEvent) => { console.log("Publishing event:", event.kind); await relayPool.publish(event, defaultRelays); }; const hub = new ActionHub(eventStore, eventFactory, publish); ### With Custom Publishing Logic [​](https://hzrd149.github.io/applesauce/actions/action-hub.html#with-custom-publishing-logic) You can provide sophisticated publishing logic when creating your ActionHub: ts const publish = async (event: NostrEvent) => { // Log the event console.log("Publishing", event); // Publish to relays await app.relayPool.publish(event, app.defaultRelays); // Save to local backup await localBackup.save(event); // Notify UI of new event eventBus.emit("eventPublished", event); }; const hub = new ActionHub(eventStore, eventFactory, publish); INFO For performance reasons, it's recommended to create only one `ActionHub` instance for your entire application and reuse it across all action executions. Configuration Options [​](https://hzrd149.github.io/applesauce/actions/action-hub.html#configuration-options) -------------------------------------------------------------------------------------------------------------- ### Save to Store [​](https://hzrd149.github.io/applesauce/actions/action-hub.html#save-to-store) By default, the ActionHub will automatically save all events created by actions to your event store. You can disable this behavior: ts const hub = new ActionHub(eventStore, eventFactory, publish); hub.saveToStore = false; // Disable automatic saving to event store Running Actions [​](https://hzrd149.github.io/applesauce/actions/action-hub.html#running-actions) -------------------------------------------------------------------------------------------------- The ActionHub provides two primary methods for executing actions: `.run()` for fire-and-forget execution with automatic publishing, and `.exec()` for fine-grained control over event handling. ### Using `.run()` - Automatic Publishing [​](https://hzrd149.github.io/applesauce/actions/action-hub.html#using-run-automatic-publishing) The [ActionHub.run](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-actions.ActionHub.html#run) method executes an action and automatically publishes all generated events using the publish method provided during ActionHub creation. WARNING `ActionHub.run()` will throw an error if no `publish` method was provided when creating the ActionHub. ts import { FollowUser, NewContacts } from "applesauce-actions/actions"; // Create a new contact list (throws if one already exists) try { await hub.run(NewContacts); console.log("Contact list created successfully"); } catch (err) { console.error("Failed to create contact list:", err.message); } // Follow a user - events are automatically published await hub.run( FollowUser, "3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d", "wss://pyramid.fiatjaf.com/", ); // Unfollow a user await hub.run(UnfollowUser, "3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d"); ### Using `.exec()` - Manual Event Handling [​](https://hzrd149.github.io/applesauce/actions/action-hub.html#using-exec-manual-event-handling) The [ActionHub.exec](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-actions.ActionHub.html#exec) method executes an action and returns an RxJS Observable of events, giving you complete control over how events are handled and published. #### Using RxJS forEach for Simple Cases [​](https://hzrd149.github.io/applesauce/actions/action-hub.html#using-rxjs-foreach-for-simple-cases) The RxJS [Observable.forEach](https://rxjs.dev/api/index/class/Observable#foreach) method provides a clean way to handle all events with a single function: ts import { FollowUser } from "applesauce-actions/actions"; // Custom publishing logic for this specific action const customPublish = async (event: NostrEvent) => { // Publish to specific relays await relayPool.publish(event, ["wss://relay.damus.io", "wss://nos.lol"]); // Save to local database with custom metadata await localDatabase.saveContactListUpdate(event, { source: "user_action" }); }; // Execute action and handle each event await hub.exec(NewContacts).forEach(customPublish); // Follow user with custom handling await hub .exec(FollowUser, "3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d", "wss://pyramid.fiatjaf.com/") .forEach(customPublish); #### Using RxJS Subscriptions for Advanced Control [​](https://hzrd149.github.io/applesauce/actions/action-hub.html#using-rxjs-subscriptions-for-advanced-control) For more complex scenarios, you can manually subscribe to the observable: ts import { tap, catchError, finalize } from "rxjs/operators"; import { EMPTY } from "rxjs"; const subscription = hub .exec(FollowUser, userPubkey, relayUrl) .pipe( tap((event) => console.log("Generated event:", event.kind)), catchError((err) => { console.error("Action failed:", err); return EMPTY; // Handle errors gracefully }), finalize(() => console.log("Action completed")), ) .subscribe({ next: async (event) => { try { await customPublish(event); console.log("Event published successfully"); } catch (err) { console.error("Failed to publish event:", err); } }, complete: () => { console.log("All events processed"); subscription.unsubscribe(); }, error: (err) => { console.error("Observable error:", err); subscription.unsubscribe(); }, }); #### Collecting Events Before Publishing [​](https://hzrd149.github.io/applesauce/actions/action-hub.html#collecting-events-before-publishing) You can collect all events from an action before publishing them: ts import { toArray, lastValueFrom } from "rxjs"; // Collect all events into an array const events = await lastValueFrom(hub.exec(NewContacts).pipe(toArray())); console.log(`Action generated ${events.length} events`); // Publish them in a specific order or with delays for (const event of events) { await publish(event); await delay(100); // Small delay between publishes } Error Handling [​](https://hzrd149.github.io/applesauce/actions/action-hub.html#error-handling) ------------------------------------------------------------------------------------------------ ### Action Validation Errors [​](https://hzrd149.github.io/applesauce/actions/action-hub.html#action-validation-errors) Actions will throw errors for various validation failures: ts try { await hub.run(NewContacts); } catch (err) { if (err.message.includes("contact list already exists")) { console.log("User already has a contact list"); } else { console.error("Unexpected error:", err); } } ### Publishing Errors [​](https://hzrd149.github.io/applesauce/actions/action-hub.html#publishing-errors) When using `.exec()`, you can handle publishing errors independently: ts await hub.exec(FollowUser, userPubkey).forEach(async (event) => { try { await publish(event); } catch (publishError) { console.error("Failed to publish event:", publishError); // Could retry, save for later, or notify user await saveForRetry(event); } }); Best Practices [​](https://hzrd149.github.io/applesauce/actions/action-hub.html#best-practices) ------------------------------------------------------------------------------------------------ ### Single ActionHub Instance [​](https://hzrd149.github.io/applesauce/actions/action-hub.html#single-actionhub-instance) Create one ActionHub instance per application and reuse it: ts // app.ts export const actionHub = new ActionHub(eventStore, eventFactory, publish); // other-file.ts import { actionHub } from "./app.js"; await actionHub.run(FollowUser, pubkey); ### Conditional Event Store Saving [​](https://hzrd149.github.io/applesauce/actions/action-hub.html#conditional-event-store-saving) For actions that generate many events, you might want to control when events are saved to the store: ts const hub = new ActionHub(eventStore, eventFactory, publish); // Disable automatic saving for bulk operations hub.saveToStore = false; // Run bulk action const events = await lastValueFrom(hub.exec(BulkFollowUsers, userList).pipe(toArray())); // Manually save only successful events for (const event of events) { try { await publish(event); await eventStore.add(event); // Save only after successful publish } catch (err) { console.error("Skipping failed event:", err); } } // Re-enable automatic saving hub.saveToStore = true; --- # Actions | applesauce [Skip to content](https://hzrd149.github.io/applesauce/actions/actions.html#VPContent) Return to top Actions [​](https://hzrd149.github.io/applesauce/actions/actions.html#actions) =============================================================================== Actions are the core building blocks for creating and modifying Nostr events in a structured way. An [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) is an [AsyncIterator](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/AsyncIterator) that reads from the `EventStore` and yields signed Nostr events ready for publishing. What is an Action? [​](https://hzrd149.github.io/applesauce/actions/actions.html#what-is-an-action) ---------------------------------------------------------------------------------------------------- An action is a function that returns an async generator. The generator has access to: * `events` - The event store for reading existing events * `factory` - The event factory for creating and signing new events * `self` - The current user's public key Actions follow this basic pattern: ts import { Action } from "applesauce-actions"; function MyAction(param1: string, param2?: boolean): Action { return async function* ({ events, factory, self }) { // Read existing events from the store const existingEvent = events.getReplaceable(kind, self); // Create or modify events using the factory const draft = await factory.modify(existingEvent, ...operations); // Sign and yield the event for publishing yield await factory.sign(draft); }; } WARNING To avoid overriding replaceable events, actions should throw if an existing replaceable event can't be found when expected. Pre-built Actions [​](https://hzrd149.github.io/applesauce/actions/actions.html#pre-built-actions) --------------------------------------------------------------------------------------------------- The `applesauce-actions` package comes with many pre-built actions for common social client operations. You can find the complete list in the [reference](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html) . Some examples include: * `CreateProfile` / `UpdateProfile` - Managing user profiles * `FollowUser` / `UnfollowUser` - Managing contact lists * `BookmarkEvent` / `UnbookmarkEvent` - Managing bookmarks * `MuteUser` / `UnmuteUser` - Managing mute lists * `PinNote` / `UnpinNote` - Managing pinned notes Action Patterns [​](https://hzrd149.github.io/applesauce/actions/actions.html#action-patterns) ----------------------------------------------------------------------------------------------- ### Creating New Events [​](https://hzrd149.github.io/applesauce/actions/actions.html#creating-new-events) When creating a new replaceable event, actions typically check if one already exists: ts export function CreateProfile(content: ProfileContent): Action { return async function* ({ events, factory, self }) { const metadata = events.getReplaceable(kinds.Metadata, self); if (metadata) throw new Error("Profile already exists"); const draft = await factory.build({ kind: kinds.Metadata }, setProfileContent(content)); yield await factory.sign(draft); }; } ### Updating Existing Events [​](https://hzrd149.github.io/applesauce/actions/actions.html#updating-existing-events) When updating events, actions verify the event exists before modifying: ts export function UpdateProfile(content: Partial): Action { return async function* ({ events, factory, self }) { const metadata = events.getReplaceable(kinds.Metadata, self); if (!metadata) throw new Error("Profile does not exist"); const draft = await factory.modify(metadata, updateProfileContent(content)); yield await factory.sign(draft); }; } ### Modifying Tags [​](https://hzrd149.github.io/applesauce/actions/actions.html#modifying-tags) Many actions work by adding or removing tags from existing events: ts export function FollowUser(pubkey: string, relay?: string, hidden = false): Action { return async function* ({ events, factory, self }) { const contacts = events.getReplaceable(kinds.Contacts, self); if (!contacts) throw new Error("Missing contacts event"); const pointer = { pubkey, relays: relay ? [relay] : undefined }; const operation = addPubkeyTag(pointer); const draft = await factory.modifyTags(contacts, hidden ? { hidden: operation } : operation); yield await factory.sign(draft); }; } ### Complex Operations [​](https://hzrd149.github.io/applesauce/actions/actions.html#complex-operations) Some actions perform multiple operations or create multiple events: ts export function CreateBookmarkSet( title: string, description: string, additional: { image?: string; hidden?: NostrEvent[]; public?: NostrEvent[] }, ): Action { return async function* ({ events, factory, self }) { const existing = getBookmarkEvent(events, self); if (existing) throw new Error("Bookmark list already exists"); const draft = await factory.build( { kind: kinds.BookmarkList }, setListTitle(title), setListDescription(description), additional.image ? setListImage(additional.image) : undefined, additional.public ? modifyPublicTags(...additional.public.map(addEventBookmarkTag)) : undefined, additional.hidden ? modifyHiddenTags(...additional.hidden.map(addEventBookmarkTag)) : undefined, ); yield await factory.sign(draft); }; } Creating Custom Actions [​](https://hzrd149.github.io/applesauce/actions/actions.html#creating-custom-actions) --------------------------------------------------------------------------------------------------------------- To create your own action, define a function that returns an async generator that yields signed events: ts import { Action } from "applesauce-actions"; import { kinds } from "nostr-tools"; function SetDisplayName(displayName: string): Action { return async function* ({ events, factory, self }) { // Get the current profile const profile = events.getReplaceable(kinds.Metadata, self); if (!profile) throw new Error("Profile not found"); // Parse existing content const content = JSON.parse(profile.content || "{}"); // Update the display name content.display_name = displayName; // Create a new profile event with updated content const draft = await factory.modify(profile, (event) => { event.content = JSON.stringify(content); return event; }); // Sign and yield the event yield await factory.sign(draft); }; } ### Multi-Event Actions [​](https://hzrd149.github.io/applesauce/actions/actions.html#multi-event-actions) Actions can yield multiple events if needed: ts function CreateUserSetup(profile: ProfileContent, initialFollows: string[]): Action { return async function* ({ events, factory, self }) { // Create profile const profileDraft = await factory.build({ kind: kinds.Metadata }, setProfileContent(profile)); yield await factory.sign(profileDraft); // Create contacts list const contactsDraft = await factory.build({ kind: kinds.Contacts, tags: initialFollows.map((pubkey) => ["p", pubkey]), }); yield await factory.sign(contactsDraft); }; } Best Practices [​](https://hzrd149.github.io/applesauce/actions/actions.html#best-practices) --------------------------------------------------------------------------------------------- 1. **Validate inputs** - Check that required events exist before attempting modifications 2. **Use factory operations** - Leverage the event factory's built-in operations for common tasks 3. **Handle errors gracefully** - Throw descriptive errors when preconditions aren't met 4. **Keep actions focused** - Each action should have a single, clear responsibility 5. **Document parameters** - Use JSDoc comments to describe action parameters and behavior The async generator pattern allows actions to be composable, testable, and easy to reason about while providing a clean interface for event creation and modification. --- # Event Operations | applesauce [Skip to content](https://hzrd149.github.io/applesauce/factory/event-operations.html#VPContent) Return to top Event Operations [​](https://hzrd149.github.io/applesauce/factory/event-operations.html#event-operations) ========================================================================================================== Event operations are the core building blocks of the event factory system. They provide a composable, functional approach to creating and modifying Nostr events by focusing on single-responsibility transformations. Overview [​](https://hzrd149.github.io/applesauce/factory/event-operations.html#overview) ------------------------------------------------------------------------------------------ An event operation is a function that takes an event template and returns a modified version of that event. Operations are designed to be: * **Composable**: Multiple operations can be chained together using `eventPipe()` * **Pure**: Operations don't mutate the input, they return new objects * **Focused**: Each operation handles one specific aspect of event creation/modification * **Async-aware**: Operations can be synchronous or asynchronous See all avaliable event operations in the [reference](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.EventOperations.html) . Type Definition [​](https://hzrd149.github.io/applesauce/factory/event-operations.html#type-definition) -------------------------------------------------------------------------------------------------------- typescript type EventOperation = (draft: EventTemplate, context: EventFactoryContext) => EventTemplate | Promise; Every event operation receives: * **`draft`**: The current event template/draft to transform * **`context`**: An `EventFactoryContext` containing optional signer, relay hints, emojis, and client information Core Patterns [​](https://hzrd149.github.io/applesauce/factory/event-operations.html#core-patterns) ---------------------------------------------------------------------------------------------------- ### 1\. Simple Property Operations [​](https://hzrd149.github.io/applesauce/factory/event-operations.html#_1-simple-property-operations) These operations modify basic event properties like content or timestamps: typescript // Set event content export function setContent(content: string): EventOperation { return async (draft) => { return { ...draft, content }; }; } // Update created_at timestamp export function updateCreatedAt(): EventOperation { return (draft) => ({ ...draft, created_at: unixNow() }); } ### 2\. Tag Manipulation Operations [​](https://hzrd149.github.io/applesauce/factory/event-operations.html#_2-tag-manipulation-operations) These operations modify the event's tags array using the [`modifyPublicTags`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.EventOperations.modifyPublicTags.html) and [`modifyHiddenTags`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.EventOperations.modifyHiddenTags.html) event operations and some [tag operations](https://hzrd149.github.io/applesauce/factory/tag-operations.html) : typescript // Include a singleton tag (only one instance allowed) export function includeSingletonTag(tag: [string, ...string[]], replace = true): EventOperation { return modifyPublicTags(setSingletonTag(tag, replace)); } // Include NIP-31 alt tag export function includeAltTag(description: string): EventOperation { return modifyPublicTags(setSingletonTag(["alt", description])); } ### 3\. Context-Aware Operations [​](https://hzrd149.github.io/applesauce/factory/event-operations.html#_3-context-aware-operations) These operations use the context to make decisions or fetch additional data: typescript // Include reaction tags with relay hints export function includeReactionTags(event: NostrEvent): EventOperation { return async (draft, ctx) => { let tags = Array.from(draft.tags); const eventHint = await ctx?.getEventRelayHint?.(event.id); const pubkeyHint = await ctx?.getPubkeyRelayHint?.(event.pubkey); // Add tags with relay hints if available tags = ensureEventPointerTag(tags, { id: event.id, relays: eventHint ? [eventHint] : undefined, }); return { ...draft, tags }; }; } ### 4\. Composite Operations [​](https://hzrd149.github.io/applesauce/factory/event-operations.html#_4-composite-operations) These operations can combine multiple smaller operations using `eventPipe()` for example: typescript // Set text content with automatic processing export function setShortTextContent(content: string, options?: TextContentOptions): EventOperation { return eventPipe( setContent(content), // Set the content repairContentNostrLinks(), // Fix @mentions tagPubkeyMentionedInContent(), // Add "p" tags for mentions includeQuoteTags(), // Add "q" tags for quotes includeContentHashtags(), // Add "t" tags for hashtags options?.emojis ? includeContentEmojiTags(options.emojis) : skip(), options?.contentWarning !== undefined ? setContentWarning(options.contentWarning) : skip(), ); } Custom Operations [​](https://hzrd149.github.io/applesauce/factory/event-operations.html#custom-operations) ------------------------------------------------------------------------------------------------------------ ### Basic Custom Operation [​](https://hzrd149.github.io/applesauce/factory/event-operations.html#basic-custom-operation) Here's how to create a simple operation that adds a "title" tag: typescript export function setTitle(title: string): EventOperation { return (draft) => { let tags = Array.from(draft.tags); // Remove existing title tags tags = tags.filter((tag) => tag[0] !== "title"); // Add new title tag tags.push(["title", title]); return { ...draft, tags }; }; } ### JSON Content Merger Operation [​](https://hzrd149.github.io/applesauce/factory/event-operations.html#json-content-merger-operation) Here's an example of a more complex operation that merges JSON data into existing JSON content: typescript export function mergeJsonContent(jsonData: Record): EventOperation { return (draft) => { let existingContent: Record = {}; // Try to parse existing content as JSON if (draft.content) { try { existingContent = JSON.parse(draft.content); } catch (error) { // If parsing fails, treat as empty object existingContent = {}; } } // Merge the new data with existing content const mergedContent = { ...existingContent, ...jsonData }; // Return draft with updated JSON content return { ...draft, content: JSON.stringify(mergedContent) }; }; } // Usage example: const draft = await factory.modify( existingEvent, mergeJsonContent({ version: "1.0", author: "Alice", tags: ["music", "art"], }), ); ### Context-Aware Custom Operation [​](https://hzrd149.github.io/applesauce/factory/event-operations.html#context-aware-custom-operation) Here's an operation that uses the context to conditionally add client information: typescript export function includeClientTag(): EventOperation { return (draft, ctx) => { // Only add client tag if client info is available in context if (!ctx.client?.name) return draft; let tags = Array.from(draft.tags); // Remove existing client tags tags = tags.filter((tag) => tag[0] !== "client"); // Add client tag with optional address const clientTag = ["client", ctx.client.name]; if (ctx.client.address) { const { kind, pubkey, identifier } = ctx.client.address; clientTag.push(`${kind}:${pubkey}:${identifier}`); } tags.push(clientTag); return { ...draft, tags }; }; } ### Async Custom Operation [​](https://hzrd149.github.io/applesauce/factory/event-operations.html#async-custom-operation) Operations can be asynchronous when they need to perform I/O or complex computations: typescript export function includeHashOfContent(): EventOperation { return async (draft) => { // Simulate async hash computation const hash = await computeHash(draft.content); let tags = Array.from(draft.tags); tags = tags.filter((tag) => tag[0] !== "content-hash"); tags.push(["content-hash", hash]); return { ...draft, tags }; }; } async function computeHash(content: string): Promise { // Your hash implementation here return "sha256:" + content.length.toString(); // Simplified example } Best Practices [​](https://hzrd149.github.io/applesauce/factory/event-operations.html#best-practices) ------------------------------------------------------------------------------------------------------ ### 1\. Single Responsibility [​](https://hzrd149.github.io/applesauce/factory/event-operations.html#_1-single-responsibility) Each operation should focus on one specific transformation: typescript // Good: Focused on one thing export function setTitle(title: string): EventOperation { /* ... */ } // Avoid: Doing too many things export function setTitleAndContentAndTags(/* ... */) { /* ... */ } ### 2\. Immutability [​](https://hzrd149.github.io/applesauce/factory/event-operations.html#_2-immutability) Always return new objects, never mutate the input: typescript // Good: Creates new objects return { ...draft, content: newContent }; // Bad: Mutates input draft.content = newContent; return draft; ### 3\. Array Copying [​](https://hzrd149.github.io/applesauce/factory/event-operations.html#_3-array-copying) When modifying tags, always copy the array first: typescript // Good: Copy first let tags = Array.from(draft.tags); tags.push(newTag); // Bad: Direct mutation draft.tags.push(newTag); ### 4\. Conditional Operations [​](https://hzrd149.github.io/applesauce/factory/event-operations.html#_4-conditional-operations) Use `skip()` for conditional operations in pipes: typescript eventPipe( setContent(content), shouldAddTitle ? setTitle(title) : skip(), // ... other operations ); ### 5\. Error Handling [​](https://hzrd149.github.io/applesauce/factory/event-operations.html#_5-error-handling) Handle errors gracefully if there error isn't critical, especially in async operations: typescript export function safeJsonOperation(data: any): EventOperation { return (draft) => { try { const content = JSON.stringify(data); return { ...draft, content }; } catch (error) { console.warn("Failed to serialize JSON data:", error); return draft; // Return unchanged on error } }; } Composition [​](https://hzrd149.github.io/applesauce/factory/event-operations.html#composition) ------------------------------------------------------------------------------------------------ The `eventPipe()` function allows you to compose multiple operations into a single operation: typescript function setArticleContent(content: string): EventOperation { return eventPipe( // Set the content setShortTextContent(content), // Add an alt tag for accessibility includeAltTag("A long form article"), // Update the created_at timestamp updateCreatedAt(), // Add a client tag includeClientTag(), ); } // Use in event factory const event = await factory.build({ kind: 300023 }, setArticleContent("...content")); Operations in a pipe are executed sequentially, with each operation receiving the result of the previous operation. The `eventPipe()` function handles both synchronous and asynchronous operations seamlessly. --- # WalletConnect Class | applesauce [Skip to content](https://hzrd149.github.io/applesauce/wallet-connect/wallet-connect.html#VPContent) Return to top WalletConnect Class [​](https://hzrd149.github.io/applesauce/wallet-connect/wallet-connect.html#walletconnect-class) ===================================================================================================================== The `WalletConnect` class provides a client-side implementation for connecting to NIP-47 wallet services. It handles all communication with wallet services, including request encryption, response decryption, and notification handling. Overview [​](https://hzrd149.github.io/applesauce/wallet-connect/wallet-connect.html#overview) ----------------------------------------------------------------------------------------------- `WalletConnect` is designed to be a complete client for interacting with Nostr Wallet Connect services. It provides: * **Reactive Architecture**: Built on RxJS for efficient event handling * **Encryption Support**: Automatic handling of NIP-04 and NIP-44 encryption * **Request Management**: Built-in timeout handling and error management * **Notification Support**: Real-time wallet notifications * **Type Safety**: Full TypeScript support with typed responses Relay Connections [​](https://hzrd149.github.io/applesauce/wallet-connect/wallet-connect.html#relay-connections) ----------------------------------------------------------------------------------------------------------------- The `WalletConnect` requires two methods for communicating with relays: a subscription method for receiving events and a publish method for sending events. These methods can be set either through the constructor or globally on the class. At least one of these approaches must be used before creating a `WalletConnect` instance. typescript import { Observable } from "rxjs"; function subscriptionMethod(relays, filters) { return new Observable((observer) => { // Create subscription to relays const cleanup = subscribeToRelays(relays, filters, (event) => { observer.next(event); }); return () => cleanup(); }); } async function publishMethod(relays, event) { for (const relay of relays) { await publishToRelay(relay, event); } } // Set methods globally once at app initialization WalletConnect.subscriptionMethod = subscriptionMethod; WalletConnect.publishMethod = publishMethod; // Or pass them as options when creating a signer const signer = new WalletConnect({ relays: ["wss://relay.example.com"], subscriptionMethod, publishMethod, // ... other options }); ### Using the relay pool [​](https://hzrd149.github.io/applesauce/wallet-connect/wallet-connect.html#using-the-relay-pool) The simplest way to set these methods is to use the `RelayPool` from the `applesauce-relay` package. typescript import { RelayPool } from "applesauce-relay"; const pool = new RelayPool(); // Set the pool globally WalletConnect.pool = pool; // Or pass the pool as an option when creating a client const client = new WalletConnect({ relays: ["wss://relay.example.com"], pool, // ... other options }); Using a `nostr+walletconnect://` URI [​](https://hzrd149.github.io/applesauce/wallet-connect/wallet-connect.html#using-a-nostr-walletconnect-uri) -------------------------------------------------------------------------------------------------------------------------------------------------- The most common way to create a client is using a connection string: typescript import { WalletConnect } from "applesauce-wallet-connect"; // Create a new client from a connection string const wallet = WalletConnect.fromConnectionString( "nostr+walletconnect://relay.example.com?secret=abc123&pubkey=def456", ); // Start using the wallet await wallet.getInfo(); await wallet.payInvoice("lnbc1..."); Using a `nostr+walletauth://` URI [​](https://hzrd149.github.io/applesauce/wallet-connect/wallet-connect.html#using-a-nostr-walletauth-uri) -------------------------------------------------------------------------------------------------------------------------------------------- Some wallets support a `nostr+walletauth://` URI for the client app to request a connection from the wallet service. typescript import { WalletConnect } from "applesauce-wallet-connect"; // Create a new client with a random secret key const secret = generateSecretKey(); const wallet = new WalletConnect( secret, relays: ["wss://relay.wallet.com"], ); // Get the auth URI and show it to the user as a QR code const authUri = wallet.getAuthURI(); // Wait for the service to respond await wallet.waitForService(); console.log("Connected to wallet service!"); // Start using the wallet await wallet.getInfo(); Checking Wallet Capabilities [​](https://hzrd149.github.io/applesauce/wallet-connect/wallet-connect.html#checking-wallet-capabilities) --------------------------------------------------------------------------------------------------------------------------------------- Before using specific methods, it's good practice to check what the wallet supports: typescript // Get the wallet's supported methods and capabilities const support = await wallet.getSupport(); if (support) { console.log("Supported methods:", support.methods); console.log("Encryption methods:", support.encryption); console.log("Notification types:", support.notifications); } // Check specific method support if (await wallet.supportsMethod("pay_invoice")) { console.log("Wallet supports invoice payments"); } if (await wallet.supportsNotifications()) { console.log("Wallet supports notifications"); } Basic Wallet Operations [​](https://hzrd149.github.io/applesauce/wallet-connect/wallet-connect.html#basic-wallet-operations) ----------------------------------------------------------------------------------------------------------------------------- ### Getting Wallet Information [​](https://hzrd149.github.io/applesauce/wallet-connect/wallet-connect.html#getting-wallet-information) typescript // Get basic wallet info const info = await wallet.getInfo(); console.log("Wallet alias:", info.alias); console.log("Network:", info.network); // Get current balance const balance = await wallet.getBalance(); console.log("Balance:", balance.balance, "msats"); ### Transaction History [​](https://hzrd149.github.io/applesauce/wallet-connect/wallet-connect.html#transaction-history) typescript // Get recent transactions const transactions = await wallet.listTransactions({ limit: 10, type: "incoming", }); transactions.transactions.forEach((tx) => { console.log(`${tx.type}: ${tx.amount} msats`); }); Payment Operations [​](https://hzrd149.github.io/applesauce/wallet-connect/wallet-connect.html#payment-operations) ------------------------------------------------------------------------------------------------------------------- ### Invoice Payments [​](https://hzrd149.github.io/applesauce/wallet-connect/wallet-connect.html#invoice-payments) typescript // Pay a Lightning invoice const result = await wallet.payInvoice("lnbc1..."); console.log("Payment successful:", result.preimage); // Pay multiple invoices at once const results = await wallet.payMultipleInvoices([{ invoice: "lnbc1..." }, { invoice: "lnbc2..." }]); ### Keysend Payments [​](https://hzrd149.github.io/applesauce/wallet-connect/wallet-connect.html#keysend-payments) typescript // Send a keysend payment const result = await wallet.payKeysend( "pubkey123...", 100000, // 100 sats in msats undefined, // preimage (optional) [{ type: 696969, value: "Hello from Nostr!" }], // TLV records ); ### Creating Invoices [​](https://hzrd149.github.io/applesauce/wallet-connect/wallet-connect.html#creating-invoices) typescript // Create a new invoice const invoice = await wallet.makeInvoice(50000, { description: "Coffee payment", expiry: 3600, // 1 hour }); console.log("Invoice created:", invoice.payment_request); Notifications [​](https://hzrd149.github.io/applesauce/wallet-connect/wallet-connect.html#notifications) --------------------------------------------------------------------------------------------------------- ### Using the notification Method [​](https://hzrd149.github.io/applesauce/wallet-connect/wallet-connect.html#using-the-notification-method) The `notification` method allows you to listen for specific types of notifications: typescript // Listen for payment received notifications const subscription = wallet.notification("payment_received", (notification) => { const { payment_hash, amount, fee } = notification; console.log(`Payment received: ${amount} msats`); }); // Listen for payment sent notifications const sentSubscription = wallet.notification("payment_sent", (notification) => { console.log("Payment sent successfully"); }); // Clean up when done subscription.unsubscribe(); sentSubscription.unsubscribe(); ### Using Observables [​](https://hzrd149.github.io/applesauce/wallet-connect/wallet-connect.html#using-observables) For more advanced usage, you can subscribe to the observables directly: typescript import { filter, map } from "rxjs"; // Subscribe to all notifications wallet.notifications$.subscribe((notification) => { console.log("Notification:", notification); }); // Filter notifications by type wallet.notifications$ .pipe( filter((n) => n.notification_type === "payment_received"), map((n) => n.notification), ) .subscribe((notification) => { console.log("Payment received:", notification); }); Available Observables [​](https://hzrd149.github.io/applesauce/wallet-connect/wallet-connect.html#available-observables) ------------------------------------------------------------------------------------------------------------------------- ### support$ [​](https://hzrd149.github.io/applesauce/wallet-connect/wallet-connect.html#support) Emits wallet support information when it changes: typescript wallet.support$.subscribe((support) => { if (support) { console.log("Wallet supports:", support.methods); } }); ### notifications$ [​](https://hzrd149.github.io/applesauce/wallet-connect/wallet-connect.html#notifications-1) Emits all wallet notifications: typescript wallet.notifications$.subscribe((notification) => { console.log("Notification:", notification); }); ### encryption$ [​](https://hzrd149.github.io/applesauce/wallet-connect/wallet-connect.html#encryption) Emits the preferred encryption method: typescript wallet.encryption$.subscribe((method) => { console.log("Using encryption:", method); }); Error Handling [​](https://hzrd149.github.io/applesauce/wallet-connect/wallet-connect.html#error-handling) ----------------------------------------------------------------------------------------------------------- WalletConnect provides comprehensive error handling with typed errors: typescript try { const result = await wallet.payInvoice("lnbc1..."); console.log("Payment successful:", result.preimage); } catch (error) { if (error instanceof InsufficientBalanceError) { console.log("Not enough balance:", error.message); } else if (error instanceof InvalidInvoiceError) { console.log("Invalid invoice:", error.message); } else { console.log("Unexpected error:", error.message); } } ### Common Error Types [​](https://hzrd149.github.io/applesauce/wallet-connect/wallet-connect.html#common-error-types) * `InsufficientBalanceError`: When the wallet doesn't have enough balance * `InvalidInvoiceError`: When an invoice is malformed * `RateLimitedError`: When too many requests are made * `UserRejectedError`: When the user rejects the operation For a complete list of error types and their meanings, see the [typedocs](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html) . --- # Account Manager | applesauce [Skip to content](https://hzrd149.github.io/applesauce/accounts/manager.html#VPContent) Return to top Account Manager [​](https://hzrd149.github.io/applesauce/accounts/manager.html#account-manager) ================================================================================================ The [AccountManager](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html) class is the core of the library, as its name suggests its used to manage multiple accounts Account types [​](https://hzrd149.github.io/applesauce/accounts/manager.html#account-types) -------------------------------------------------------------------------------------------- By default the account manager comes with no account types. you have to manually add them when you create the instance. luckily there is a handy method to add the most common types [registerCommonAccountTypes](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.registerCommonAccountTypes.html) ts import { AccountManager, registerCommonAccountTypes, AmberClipboardAccount } from "applesauce-accounts"; // create an account manager instance const manager = new AccountManager(); // register common account types registerCommonAccountTypes(manager); // manually add account type manager.registerType(AmberClipboardAccount); Adding and removing accounts [​](https://hzrd149.github.io/applesauce/accounts/manager.html#adding-and-removing-accounts) -------------------------------------------------------------------------------------------------------------------------- ts import { AccountManager, registerCommonAccountTypes, SimpleAccount } from "applesauce-accounts"; // create an account manager instance const manager = new AccountManager(); // register common account types registerCommonAccountTypes(manager); // subscribe to the active account manager.active$.subscribe((account) => { if (account) console.log(`${account.id} is now active`); else console.log("no account is active"); updateUI(); }); // create an account const account = SimpleAccount.fromKey("788229e1801c4576391d39a03610293ea7e6645c9d39aca54c62fc6d71cbc385"); // add it to the manager manager.addAccount(account); // set it as active manager.setActive(account); // later, remove the account and the active account will also update manager.removeAccount(account.id); Active account [​](https://hzrd149.github.io/applesauce/accounts/manager.html#active-account) ---------------------------------------------------------------------------------------------- The `AccountManager` class exposes a set of methods to track which account is active and switch the active account * `AccountManager.active` gets the currently active account * `AccountManager.active$` an observable of the active account, can be used to subscribe to changes * `AccountManager.setActive(id: string | Account)` set the active account Persisting accounts [​](https://hzrd149.github.io/applesauce/accounts/manager.html#persisting-accounts) -------------------------------------------------------------------------------------------------------- The account manager exposes two methods that can be used to persist accounts between app reloads. `toJSON` and `fromJSON` ts import { AccountManager, registerCommonAccountTypes, SimpleAccount } from "applesauce-accounts"; // create an account manager instance const manager = new AccountManager(); // register common account types registerCommonAccountTypes(manager); // first load all accounts from localStorage const json = JSON.parse(localStorage.getItem("accounts") || "[]"); await manager.fromJSON(json); // next, subscribe to any accounts added or removed manager.accounts$.subscribe((accounts) => { // save all the accounts into the "accounts" field localStorage.setItem("accounts", JSON.stringify(manager.toJSON())); }); // load active account from storage const active = localStorage.getItem("active"); if (active) manager.setActive(active); // subscribe to active changes manager.active$.subscribe((account) => { if (account) localStorage.setItem("active", account.id); else localStorage.clearItem("active"); }); --- # Applesauce-react | applesauce [Skip to content](https://hzrd149.github.io/applesauce/react/package.html#VPContent) Return to top Applesauce-react [​](https://hzrd149.github.io/applesauce/react/package.html#applesauce-react) =============================================================================================== Install [​](https://hzrd149.github.io/applesauce/react/package.html#install) ----------------------------------------------------------------------------- bash npm install applesauce-react Using providers [​](https://hzrd149.github.io/applesauce/react/package.html#using-providers) --------------------------------------------------------------------------------------------- To start using applesauce with react you must add some of the providers to your react root * If you want to use the `useEventModel` hook you must add the [EventStoreProvider](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-react.EventStoreProvider.html) * If you want to use the `useEventFactory` hook you must add the [FactoryProvider](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-react.FactoryProvider.html) * If you want to use the `useAccountManager` or `useActiveAccount` hook you must add the [AccountsProvider](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-react.AccountsProvider.html) * If you want to use the `useEventStore` hook you must add the `EventStoreProvider` or [EventStoreProvider](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-react.EventStoreProvider.html) Simple setup [​](https://hzrd149.github.io/applesauce/react/package.html#simple-setup) --------------------------------------------------------------------------------------- A simple example would look like js import { EventStore } from "applesauce-core"; import { useEventStore } from "applesauce-react/hooks"; import { EventStoreProvider } from "applesauce-react/providers"; const eventStore = new EventStore(); function App() { // get event store from context const store = useEventStore(); return
; } const root = createRoot(document.getElementById("root")); root.render( // the EventStoreProvider also wraps the EventStoreProvider , ); Advanced setup [​](https://hzrd149.github.io/applesauce/react/package.html#advanced-setup) ------------------------------------------------------------------------------------------- A more complete example that uses all the providers would look something like First create a new `AccountManager` that saves its state to local storage js // accounts.js import { safeParse } from "applesauce-core/helpers/json"; import { AccountManager, registerCommonAccountTypes } from "applesauce-accounts"; // setup account manager const accountManager = new AccountManager(); registerCommonAccountTypes(accountManager); accountManager.registerType(AmberClipboardAccount); // load all accounts if (localStorage.getItem("accounts")) { const json = safeParse(localStorage.getItem("accounts")); if (json) accountManager.fromJSON(json); } // save accounts to localStorage when they change accountManager.accounts$.subscribe(() => { localStorage.setItem("accounts", JSON.stringify(accountManager.toJSON())); }); // load active account if (localStorage.active) accountManager.setActive(localStorage.active); // save active to localStorage accountManager.active$.subscribe((account) => { if (account) localStorage.setItem("active", account.id); else localStorage.removeItem("active"); }); export default accountManager; Next update `app.js` to use the new hooks js // app.js import { NoteBlueprint } from "applesauce-factory/blueprints"; import { useEventStore, useEventFactory, useActiveAccount } from "applesauce-react/hooks"; function App() { // get event store from context const account = useActiveAccount(); const store = useEventStore(); const factory = useEventFactory(); const post = async () => { // ignore if no active account if (!account) return; const draft = await factory.create(NoteBlueprint, "hello world"); const signed = await account.signEvent(draft); store.add(signed); }; return (
); } export default App; And finally update `index.js` to use the Providers js // index.js import { EventStore } from "applesauce-core"; import { EventFactory } from "applesauce-factory"; import { NoteBlueprint } from "applesauce-factory/blueprints"; import { useEventStore, useEventFactory, useActiveAccount, EventStoreProvider } from "applesauce-react/hooks"; import { AccountsProvider, FactoryProvider } from "applesauce-react/providers"; import accountManager from "./accounts.js"; import App from "./app.js"; // create event store and factory const eventStore = new EventStore(); const factory = new EventFactory({ // use the active signer from the account manager signer: accountManager.signer, }); const root = createRoot(document.getElementById("root")); root.render( // provide the stores, factory, and accounts to the react app , ); --- # Tag Operations | applesauce [Skip to content](https://hzrd149.github.io/applesauce/factory/tag-operations.html#VPContent) Return to top Tag Operations [​](https://hzrd149.github.io/applesauce/factory/tag-operations.html#tag-operations) ==================================================================================================== Tag operations are specialized functions designed to modify arrays of Nostr event tags. Unlike [event operations](https://hzrd149.github.io/applesauce/factory/event-operations.html) which work on entire events, tag operations focus exclusively on transforming tag arrays. This makes them perfect for use with [`modifyPublicTags`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.EventOperations.modifyPublicTags.html) and [`modifyHiddenTags`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.EventOperations.modifyHiddenTags.html) event operations, allowing precise control over both public event tags and hidden encrypted tags on NIP-51 lists. Overview [​](https://hzrd149.github.io/applesauce/factory/tag-operations.html#overview) ---------------------------------------------------------------------------------------- A tag operation is a function that takes an array of tags and returns a modified version of that array. Tag operations are designed to be: * **Composable**: Multiple tag operations can be chained together using `tagPipe()` * **Pure**: Operations don't mutate the input array, they return new arrays * **Focused**: Each operation handles one specific type of tag transformation * **Async-aware**: Operations can be synchronous or asynchronous * **Context-aware**: Operations can use relay hints and other context information See all available tag operations in the [reference](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html) . Type Definition [​](https://hzrd149.github.io/applesauce/factory/tag-operations.html#type-definition) ------------------------------------------------------------------------------------------------------ typescript type TagOperation = (tags: string[][], context: EventFactoryContext) => string[][] | Promise; Every tag operation receives: * **`tags`**: The current array of tags to transform * **`context`**: An `EventFactoryContext` containing optional signer, relay hints, emojis, and client information Usage with Event Operations [​](https://hzrd149.github.io/applesauce/factory/tag-operations.html#usage-with-event-operations) ------------------------------------------------------------------------------------------------------------------------------ Tag operations are typically used within event operations via `modifyPublicTags` and `modifyHiddenTags`: typescript // Modify public tags const eventOp = modifyPublicTags( addPubkeyTag("npub1..."), setSingletonTag(["title", "My List"]), removeEventTag("event-id"), ); // Modify hidden tags (requires signer) const hiddenOp = modifyHiddenTags(addEventTag("secret-event-id"), addPubkeyTag("secret-pubkey")); // Use both in event creation const event = await factory.build( { kind: 30000 }, // Follow set eventOp, hiddenOp, ); Core Patterns [​](https://hzrd149.github.io/applesauce/factory/tag-operations.html#core-patterns) -------------------------------------------------------------------------------------------------- ### 1\. Simple Tag Manipulation [​](https://hzrd149.github.io/applesauce/factory/tag-operations.html#_1-simple-tag-manipulation) These operations add, remove, or modify basic tags: typescript // Add a pubkey tag with relay hint export function addPubkeyTag(pubkey: string | ProfilePointer, replace = true): TagOperation { return async (tags, { getPubkeyRelayHint }) => { const pointer = typeof pubkey === "string" ? { pubkey: pubkey } : { ...pubkey }; // Add relay hint if available if (getPubkeyRelayHint && pointer.relays?.[0] === undefined) { const hint = await getPubkeyRelayHint(pointer.pubkey); if (hint) pointer.relays = [hint]; } // Remove existing matching tags if replace is true if (replace) tags = tags.filter((t) => !(t[0] === "p" && t[1] === pointer.pubkey)); // Add new tag return [...tags, createPTagFromProfilePointer(pointer)]; }; } // Remove all matching tags export function removePubkeyTag(pubkey: string): TagOperation { return (tags) => tags.filter((t) => !(t[0] === "p" && t[1] === pubkey)); } ### 2\. Singleton Tag Operations [​](https://hzrd149.github.io/applesauce/factory/tag-operations.html#_2-singleton-tag-operations) These operations ensure only one instance of a tag type exists using the [`ensureSingletonTag`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.ensureSingletonTag.html) helper function: typescript // Set a singleton tag (only one allowed) export function setSingletonTag(tag: [string, ...string[]], replace = true): TagOperation { return (tags) => ensureSingletonTag(tags, tag, replace); } // Remove all instances of a singleton tag export function removeSingletonTag(tag: string): TagOperation { return (tags) => tags.filter((t) => !(t[0] === tag)); } ### 3\. Name/Value Tag Operations [​](https://hzrd149.github.io/applesauce/factory/tag-operations.html#_3-name-value-tag-operations) These operations handle tags with name-value pairs: typescript // Add a name/value tag with optional custom matcher export function addNameValueTag( tag: [string, string, ...string[]], replace = true, matcher?: (a: string, b: string) => boolean, ): TagOperation { return (tags) => { if (replace) return ensureNamedValueTag(tags, tag, true, matcher); else return [...tags, tag]; }; } // Remove matching name/value tags export function removeNameValueTag(tag: string[]): TagOperation { return (tags) => tags.filter((t) => !(t[0] === tag[0] && t[1] === tag[1])); } ### 4\. Context-Aware Operations [​](https://hzrd149.github.io/applesauce/factory/tag-operations.html#_4-context-aware-operations) These operations use the context to fetch relay hints or other information: typescript // Add event tag with automatic relay hint export function addEventTag(id: string | EventPointer, replace = true): TagOperation { return async (tags, { getEventRelayHint }) => { const pointer = typeof id === "string" ? { id } : id; // Fetch relay hint from context if available if (getEventRelayHint && pointer.relays?.[0] === undefined) { const hint = await getEventRelayHint(pointer.id); if (hint) pointer.relays = [hint]; } // Remove existing tags if replace is true if (replace) tags = tags.filter((t) => !(t[0] === "e" && t[1] === pointer.id)); return [...tags, createETagFromEventPointer(pointer)]; }; } ### 5\. Specialized Operations [​](https://hzrd149.github.io/applesauce/factory/tag-operations.html#_5-specialized-operations) These operations handle specific use cases like bookmarks or relays: typescript // Add relay tag with URL normalization export function addRelayTag(url: string | URL, tagName = "relay", replace = true): TagOperation { url = normalizeURL(url).toString(); return addNameValueTag([tagName, url], replace, (a, b) => isSameURL(a, b)); } // Add bookmark tag (handles both events and articles) export function addEventBookmarkTag(event: NostrEvent): TagOperation { if (event.kind !== kinds.ShortTextNote && event.kind !== kinds.LongFormArticle) throw new Error(`Event kind (${event.kind}) cannot be added to bookmarks`); return isReplaceable(event.kind) ? addCoordinateTag(getAddressPointerForEvent(event)) : addEventTag(event.id); } Custom Operations [​](https://hzrd149.github.io/applesauce/factory/tag-operations.html#custom-operations) ---------------------------------------------------------------------------------------------------------- ### Basic Custom Operation [​](https://hzrd149.github.io/applesauce/factory/tag-operations.html#basic-custom-operation) Here's how to create a simple operation that adds a custom tag: typescript export function addCustomTag(value: string): TagOperation { return (tags) => { // Remove existing custom tags const filtered = tags.filter((tag) => tag[0] !== "custom"); // Add new custom tag return [...filtered, ["custom", value]]; }; } ### Conditional Tag Operation [​](https://hzrd149.github.io/applesauce/factory/tag-operations.html#conditional-tag-operation) Create operations that conditionally modify tags: typescript export function addConditionalTag(condition: boolean, tag: [string, ...string[]]): TagOperation { return (tags) => { if (!condition) return tags; // Remove existing tags of this type const filtered = tags.filter((t) => t[0] !== tag[0]); // Add the new tag return [...filtered, tag]; }; } ### Async Tag Operation with Context [​](https://hzrd149.github.io/applesauce/factory/tag-operations.html#async-tag-operation-with-context) Operations can be asynchronous and use context: typescript export function addTagWithRelayHint(eventId: string): TagOperation { return async (tags, { getEventRelayHint }) => { // Fetch relay hint asynchronously const relayHint = await getEventRelayHint?.(eventId); // Create tag with or without relay hint const tag = relayHint ? ["e", eventId, relayHint] : ["e", eventId]; return [...tags, tag]; }; } ### Bulk Tag Operation [​](https://hzrd149.github.io/applesauce/factory/tag-operations.html#bulk-tag-operation) Handle multiple items at once: typescript export function addMultiplePubkeyTags(pubkeys: string[]): TagOperation { return async (tags, context) => { let result = [...tags]; // Add each pubkey tag for (const pubkey of pubkeys) { result = await addPubkeyTag(pubkey)(result, context); } return result; }; } Best Practices [​](https://hzrd149.github.io/applesauce/factory/tag-operations.html#best-practices) ---------------------------------------------------------------------------------------------------- ### 1\. Immutability [​](https://hzrd149.github.io/applesauce/factory/tag-operations.html#_1-immutability) Always return new arrays, never mutate the input: typescript // Good: Creates new array return [...tags, newTag]; // Bad: Mutates input tags.push(newTag); return tags; ### 2\. Filtering Before Adding [​](https://hzrd149.github.io/applesauce/factory/tag-operations.html#_2-filtering-before-adding) When replacing tags, filter first: typescript // Good: Filter then add const filtered = tags.filter((t) => t[0] !== "title"); return [...filtered, ["title", newTitle]]; // Avoid: Complex logic return tags.map((t) => (t[0] === "title" ? ["title", newTitle] : t)); ### 3\. Handle Edge Cases [​](https://hzrd149.github.io/applesauce/factory/tag-operations.html#_3-handle-edge-cases) Check for invalid inputs: typescript export function safeAddTag(tag: [string, ...string[]]): TagOperation { // Validate tag format if (!tag || tag.length < 2 || !tag[0] || !tag[1]) { throw new Error("Invalid tag format"); } return (tags) => { return [...tags, tag]; }; } ### 4\. Use Helper Functions [​](https://hzrd149.github.io/applesauce/factory/tag-operations.html#_4-use-helper-functions) Leverage existing helper functions: typescript import { ensureSingletonTag } from "applesauce-factory/helpers/tag"; export function addUniqueTag(tag: [string, ...string[]]): TagOperation { // Replace any existing tags with the same name to ensure only one instance of the tag exists return (tags) => ensureSingletonTag(tags, tag, true); } Composition [​](https://hzrd149.github.io/applesauce/factory/tag-operations.html#composition) ---------------------------------------------------------------------------------------------- The `tagPipe()` function allows you to compose multiple tag operations into a single operation: typescript function setupListTags(title: string, pubkeys: string[]): TagOperation { return tagPipe( // Set the title setSingletonTag(["title", title]), // Add all pubkeys ...pubkeys.map((pubkey) => addPubkeyTag(pubkey)), // Remove any old description removeSingletonTag("description"), ); } // Use in event operation const eventOp = factory.build( { kind: 30000 }, // Use the modifyPublicTags to modify the public tags on the event modifyPublicTags(setupListTags("My Friends", ["npub1...", "npub2..."])), ); Integration with Hidden Tags [​](https://hzrd149.github.io/applesauce/factory/tag-operations.html#integration-with-hidden-tags) -------------------------------------------------------------------------------------------------------------------------------- Tag operations work seamlessly with both public and hidden tags using the [`modifyPublicTags`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.EventOperations.modifyPublicTags.html) and [`modifyHiddenTags`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.EventOperations.modifyHiddenTags.html) event operations: typescript // Create operations for both public and hidden tags const publicTags = tagPipe(setSingletonTag(["title", "Public List"]), addPubkeyTag("public-user")); const hiddenTags = tagPipe(addPubkeyTag("secret-user"), addPubkeyTag("other-user")); // Apply to event const event = await factory.build({ kind: 30000 }, modifyPublicTags(publicTags), modifyHiddenTags(hiddenTags)); This separation allows you to maintain public metadata while keeping sensitive information encrypted in hidden tags, perfect for NIP-51 lists and other privacy-focused applications. --- # applesauce [Skip to content](https://hzrd149.github.io/applesauce/signers/signers.html#VPContent) Return to top Password Signer [​](https://hzrd149.github.io/applesauce/signers/signers.html#password-signer) ----------------------------------------------------------------------------------------------- The [PasswordSigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html) is a [NIP-49](https://github.com/nostr-protocol/nips/blob/master/49.md) (Private Key Encryption) signer To reuse an existing `ncryptsec` you can set the `signer.ncryptsec` field ts // create a new password signer const signer = new PasswordSigner(); // use a pre-existing ncryptsec signer.ncryptsec = "ncryptsec1q..."; To create a new ncryptsec you can set the `signer.key` field on the signer ts // create a new password signer const signer = new PasswordSigner(); // or create a new one using a key and password const randomBytes = new Uint8Array(64); window.crypto.getRandomValues(randomBytes); signer.key = randomBytes; signer.setPassword("changeme"); // new ncryptset console.log(signer.ncryptsec); ### Locking and Unlocking [​](https://hzrd149.github.io/applesauce/signers/signers.html#locking-and-unlocking) To unlock the signer so it can sign events you have to call the [`unlock`](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#unlock) method ts try { const password = prompt("Enter Password"); await signer.unlock(password); } catch (err) { console.log("Failed to unlock signer. maybe incorrect password?"); } ### Changing the password [​](https://hzrd149.github.io/applesauce/signers/signers.html#changing-the-password) To change the password you can simply unlock the signer then call [`setPassword`](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#setPassword) ts try { const unlockPassword = prompt("Enter current password"); await signer.unlock(unlockPassword); // set new password const unlockPassword = prompt("Enter new password"); await signer.setPassword(unlockPassword); } catch (err) { console.log("Failed to unlock signer. maybe incorrect password?"); } ### Additional fields and methods [​](https://hzrd149.github.io/applesauce/signers/signers.html#additional-fields-and-methods) * [`unlocked`](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#unlocked) a boolean field whether the signer is unlocked * [`testPassword`](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#testPassword) will return a promise that resolves or rejects based on if can decrypt the ncryptsec Simple Signer [​](https://hzrd149.github.io/applesauce/signers/signers.html#simple-signer) ------------------------------------------------------------------------------------------- The [`SimpleSigner`](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SimpleSigner.html) class is a standard signer that holds the secret key in memory and supports NIP-04 and NIP-44 encryption You can create a new signer and secret key by not passing anything into the constructor ts const signer = new SimpleSigner(); Or you can import and existing secret key ts const key = new Uint8Array(); window.crypto.getRandomValues(key); // pass the key into constructor const signer = new SimpleSigner(key); // or set it manually signer.key = key; Serial Port Signer [​](https://hzrd149.github.io/applesauce/signers/signers.html#serial-port-signer) ----------------------------------------------------------------------------------------------------- The [SerialPortSigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html) is a that supports the [nostr-signing-device](https://github.com/lnbits/nostr-signing-device) WARNING This signer only works on chrome browsers and does not support NIP-44 encryption ### Checking support [​](https://hzrd149.github.io/applesauce/signers/signers.html#checking-support) The signer exposes a static property [`SerialPortSigner.SUPPORTED`](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#SUPPORTED) that will test if `navigator.serial` is supported Amber Clipboard Signer [​](https://hzrd149.github.io/applesauce/signers/signers.html#amber-clipboard-signer) ------------------------------------------------------------------------------------------------------------- The [`AmberClipboardSigner`](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html) class can be used to connect to the [Amber web api](https://github.com/greenart7c3/Amber/blob/master/docs/web-apps.md) WARNING This signer can NOT work in the background and always requires direct user approval --- # Models | applesauce [Skip to content](https://hzrd149.github.io/applesauce/core/models.html#VPContent) Return to top Models [​](https://hzrd149.github.io/applesauce/core/models.html#models) ========================================================================= Models are pre-built methods for subscribing to computed state from the `EventStore`. INFO Models do not fetch any events from relays, they only subscribe to the events that are already in the event store. Using models [​](https://hzrd149.github.io/applesauce/core/models.html#using-models) ------------------------------------------------------------------------------------- The [`eventStore.model`](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#model) method can be used to create a model and returns a rxjs observable that can be subscribed to. ts import { TimelineModel } from "applesauce-core/models"; // The first argument is the model constructor and the remaining are passed to the model const observable = eventStore.model(TimelineModel, { kinds: [1] }); // start the query by subscribing to it observable.subscribe((events) => { console.log(events); }); // adding events to the event store will update the timeline query eventStore.add({kind: 1, content: 'new note', ...}) Performance [​](https://hzrd149.github.io/applesauce/core/models.html#performance) ----------------------------------------------------------------------------------- Models with similar arguments are cached in the event store and reused for performance reasons. This can help with multiple UI components subscribing to the same model. ts import { ProfileModel } from "applesauce-core/models"; // Create the first model const first = eventStore.model(ProfileModel, { pubkey: "pubkey" }); // Create the second model const second = eventStore.model(ProfileModel, { pubkey: "pubkey" }); // Both will be the same observable console.log(first === second); // true Prebuilt Models [​](https://hzrd149.github.io/applesauce/core/models.html#prebuilt-models) ------------------------------------------------------------------------------------------- There are some common prebuilt models that come with `applesauce-core` * [`ProfileModel`](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Models.ProfileModel.html) subscribes to a single pubkey's profile (kind 0) * [`TimelineModel`](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Models.TimelineModel.html) subscribes to a sorted array of events that match filters * [`RepliesQuery`](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Models.RepliesModel.html) subscribes to all NIP-10 and NIP-22 replies to an event And there are a lot more in [the docs](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html) Custom Models [​](https://hzrd149.github.io/applesauce/core/models.html#custom-models) --------------------------------------------------------------------------------------- A custom model is simply a function that returns a [`Model`](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Model.html) function. ts import { Model } from "applesauce-core"; function CustomModel(arg: string): Model { return (eventStore) => new Observable((observer) => { // observable code here observer.next("testing"); }); } As an example here is a custom model that will parse a [NIP-78](https://github.com/nostr-protocol/nips/blob/master/78.md) app event that contains JSON ts import { map } from "rxjs/operators"; import { Model } from "applesauce-core"; /** A model that gets JSON from a app data event */ function AppSettingsModel(pubkey: string): Model { return (eventStore) => eventStore.replaceable(30078, pubkey, "app-settings").pipe( map((event) => { if (!event) return undefined; return JSON.parse(event.content) as T; }), ); } // Create the model and subscribe to it const sub = eventStore .model(AppSettingsModel, "3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d") .subscribe((json) => { // json will either be undefined or { theme: string } if (json) console.log("updated data", json); }); // Add an event to the event store to trigger the model eventStore.add({ kind: 30078, content: '{"theme": "dark"}', // rest of event }); --- # React Hooks | applesauce [Skip to content](https://hzrd149.github.io/applesauce/react/hooks.html#VPContent) Return to top React Hooks [​](https://hzrd149.github.io/applesauce/react/hooks.html#react-hooks) =================================================================================== useObservableMemo [​](https://hzrd149.github.io/applesauce/react/hooks.html#useobservablememo) ----------------------------------------------------------------------------------------------- The [`useObservableMemo`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-react.Hooks.useObservableMemo.html) hook is a thing wrapper around the `useObservableState` hook from [observable-hooks](https://observable-hooks.js.org/) that re-creates the observable when the dependencies change and allows `undefined` to returned This is useful for subscribing to observables that are not created yet ts const account = useActiveAccount(); // IAccount | null const profile = useObservableMemo(() => { if (account) return eventStore.profile(account.pubkey); else return undefined; }, [account.pubkey]); useEventStore [​](https://hzrd149.github.io/applesauce/react/hooks.html#useeventstore) --------------------------------------------------------------------------------------- The [`useEventStore`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-react.Hooks.useEventStore.html) hook can be used at access the `EventStore` from anywhere in the react tree useModel [​](https://hzrd149.github.io/applesauce/react/hooks.html#usemodel) ----------------------------------------------------------------------------- The [`useModel`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-react.Hooks.useModel.html) hook requires the `EventStoreProvider` and can be used to create and run a model in the `EventStore` and subscribe to the results ts function UserAvatar({ pubkey }: { pubkey: string }) { const profile = useModel(ProfileQuery, [pubkey]); // profile will be undefined until the event is loaded return } useEventFactory [​](https://hzrd149.github.io/applesauce/react/hooks.html#useeventfactory) ------------------------------------------------------------------------------------------- The [`useEventFactory`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-react.Hooks.useEventFactory.html) hook can be used at access the `EventFactory` from anywhere in the react tree useActiveAccount [​](https://hzrd149.github.io/applesauce/react/hooks.html#useactiveaccount) --------------------------------------------------------------------------------------------- The [useActiveAccount](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-react.Hooks.useActiveAccount.html) hook requires the `AccountsProvider` and returns the currently active account or `undefined` useAccountManager [​](https://hzrd149.github.io/applesauce/react/hooks.html#useaccountmanager) ----------------------------------------------------------------------------------------------- The [useAccountManager](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-react.Hooks.useAccountManager.html) hook requires the `AccountsProvider` and returns the `AccountManager` class useRenderedContent [​](https://hzrd149.github.io/applesauce/react/hooks.html#userenderedcontent) ------------------------------------------------------------------------------------------------- The [useRenderedContent](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-react.Hooks.useRenderedContent.html) hook can be used to parse and render an events `content` into a JSX tree INFO The components directory should be defined outside of the component itself to avoid unnecessary re-renders js const event = { content: "hello world #grownostr", tags: [["t", "grownostr"]] }; // a directory of optional components to use when rendering the content const components = { // render hashtags inline hashtag: ({ node }) => {node.name}, // custom NIP-30 emojis emoji: ({ node }) => , }; // A simple component to render an event function SimpleNote({ event }) { const content = useRenderedContent(event, components); return (
{event.pubkey} {event.created_at}
{content}
); } // render the event ; --- # Accounts | applesauce [Skip to content](https://hzrd149.github.io/applesauce/accounts/accounts.html#VPContent) Return to top Accounts [​](https://hzrd149.github.io/applesauce/accounts/accounts.html#accounts) =================================================================================== The [account classes](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.Accounts.html) are simple wrappers around various [Signers](https://hzrd149.github.io/applesauce/signers/signers.html) and expose a `toJSON` and `fromJSON` method to let you save them to localStorage or indexeddb databases Built-in account types [​](https://hzrd149.github.io/applesauce/accounts/accounts.html#built-in-account-types) --------------------------------------------------------------------------------------------------------------- * [ExtensionAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html) is a wrapper around [ExtensionSigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ExtensionSigner.html) * [PasswordAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html) is a wrapper around [PasswordSigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html) * [NostrConnectAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html) is a wrapper around [NostrConnectSigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html) * [SimpleAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html) is a wrapper around [SimpleSigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SimpleSigner.html) * [SerialPortAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html) is a wrapper around [SerialPortSigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html) * [ReadonlyAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html) is a wrapper around [ReadonlySigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ReadonlySigner.html) * [AmberClipboardAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html) is a wrapper around [AmberClipboardSigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html) Creating new accounts [​](https://hzrd149.github.io/applesauce/accounts/accounts.html#creating-new-accounts) ------------------------------------------------------------------------------------------------------------- All account classes require the signer to be created and setup first ts import { SimpleSigner } from "applesauce-signers/signers"; import { SimpleAccount } from "applesauce-accounts/accounts"; // create the signer first const signer = new SimpleSigner(); // setup signer const pubkey = await signer.getPublicKey(); // create account const account = new SimpleAccount(pubkey, signer); For a nostr connect signer it would look something like ts import { NostrConnectSigner } from "applesauce-signers/signers"; import { NostrConnectAccount } from "applesauce-accounts/accounts"; const signer = await NostrConnectSigner.fromBunkerURI("bunker://...."); const pubkey = await signer.getPublicKey(); const account = new NostrConnectAccount(pubkey, signer); Request queue [​](https://hzrd149.github.io/applesauce/accounts/accounts.html#request-queue) --------------------------------------------------------------------------------------------- By default all accounts use a request queue, so the signer only gets on sign/encrypt/decrypt request at a time. This should make it safe to make a bunch of requests to the account without overloading the user ts import { ExtensionSigner } from "applesauce-signers/signers"; import { ExtensionAccount } from "applesauce-accounts/accounts"; const signer = new ExtensionSigner(); const pubkey = await signer.getPublicKey(); const account = new ExtensionAccount(pubkey, signer); // make requests account.signEvent({ kind: 1, content: "hello world", created_at: 0, tags: [] }).then((signed) => { console.log(signed); }); // make another without waiting account.signEvent({ kind: 1, content: "creating spam", created_at: 0, tags: [] }).then((signed) => { console.log(signed); }); account.nip04 .decrypt("3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d", "encrypted-text") .then((plaintext) => { console.log(plaintext); }); All the requests will be made one at a time in order, if any request fails (user rejects, signer timeout) then the queue will continue The `account.abortQueue(reason?: Error)` method can be used to abort all pending requests. this will cause all promises to throw with `undefined` or `reason` if it was passed to the `abortQueue` method To disable the request queue set `account.disableQueue = false` directly after creating the account. it can also be disabled on the `AccountManager` before any accounts are added Custom account types [​](https://hzrd149.github.io/applesauce/accounts/accounts.html#custom-account-types) ----------------------------------------------------------------------------------------------------------- To create your own account type first your going to need to create a new signer class that implements [Nip07Interface](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Nip07Interface.html) ### Create a new signer class [​](https://hzrd149.github.io/applesauce/accounts/accounts.html#create-a-new-signer-class) ts class ApiSigner implements Nip07Interface { nip04: { encrypt: (pubkey: string, plaintext: string) => Promise | string; decrypt: (pubkey: string, ciphertext: string) => Promise | string; }; nip44: { encrypt: (pubkey: string, plaintext: string) => Promise | string; decrypt: (pubkey: string, ciphertext: string) => Promise | string; }; constructor(public api: string) { // extra boilerplate to make sure encryption methods are nested under .nip04 and .nip44 this.nip04 = { encrypt: this.nip04Encrypt.bind(this), decrypt: this.nip04Decrypt.bind(this), }; this.nip44 = { encrypt: this.nip44Encrypt.bind(this), decrypt: this.nip44Decrypt.bind(this), }; } async getPublicKey(): Promise { const res = await fetch(this.api + "/get-public-key"); const json = await res.json(); return json.pubkey; } async signEvent(template: EventTemplate): Promise { const res = await fetch(this.api + "/sign", { body: template, method: "POST" }); const json = await res.json(); return json.event; } nip04Encrypt(): string { throw new Error("Not implemented yet"); } nip04Decrypt(): string { throw new Error("Not implemented yet"); } nip44Encrypt(): string { throw new Error("Not implemented yet"); } nip44Decrypt(): string { throw new Error("Not implemented yet"); } } ### Create a new account class [​](https://hzrd149.github.io/applesauce/accounts/accounts.html#create-a-new-account-class) Next create a new account class that extends `BaseAccount` to wrap the signer ts import { SerializedAccount, BaseAccount } from "applesauce-accounts"; type ApiAccountSignerData = { api: string; }; // Its good practice to make the class have a generic type for metadata export default class ApiAccount extends BaseAccount< ApiSigner, ApiAccountSignerData, Metadata > { // NOTE: you must set the static type, otherwise it cant be used in the AccountManager static type = "api-account"; // add a toJSON method that saves all relevant information for the account toJSON() { return { // save basic account information type: ApiAccount.type, id: this.id, pubkey: this.pubkey, metadata: this.metadata, // save important signer data signer: { api: this.signer.api, }, }; } // add a static fromJSON method so it can be re-created when the app loads again static fromJSON( json: SerializedAccount, ): ApiAccount { // create signer with saved data const signer = new ApiSigner(json.signer.api); // create new account class const account = new ApiAccount(json.pubkey, signer); // don't forget to call loadCommonFields, it sets the id and metadata return super.loadCommonFields(account); } } ### Add account type to account manager [​](https://hzrd149.github.io/applesauce/accounts/accounts.html#add-account-type-to-account-manager) Next you need to register the account type Now you can create a new `ApiSigner` and add it to the account manager ts const signer = new ApiSigner("https://api.example.com"); const pubkey = await signer.getPublicKey(); const account = new ApiAccount(pubkey, signer); accountManager.addAccount(account); accountManager.setActive(account); --- # Text Content | applesauce [Skip to content](https://hzrd149.github.io/applesauce/content/text.html#VPContent) Return to top Text Content [​](https://hzrd149.github.io/applesauce/content/text.html#text-content) ====================================================================================== Parsing content [​](https://hzrd149.github.io/applesauce/content/text.html#parsing-content) -------------------------------------------------------------------------------------------- The [`getParsedContent`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-content.Text.getParsedContent.html) method can be used to parse and transform an event into the content syntax tree Cashing [​](https://hzrd149.github.io/applesauce/content/text.html#cashing) ---------------------------------------------------------------------------- Because parsing and transforming content is an expensive operation `getParsedContent` method will cache the results on the event under a [Symbol](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol) , by default this is the [`TextNoteContentSymbol`](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-content.Text.TextNoteContentSymbol.html) If your parsing or transforming different event kinds than kind 1, its recommended to create a new `Symbol` to and pass to `getParsedContent` to avoid cache collisions with the default kind 1 processor Links [​](https://hzrd149.github.io/applesauce/content/text.html#links) ------------------------------------------------------------------------ The [`links`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-content.Text.links.html) transformer can be used to parse URLs and add [`Link`](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Link.html) nodes to the tree Mentions [​](https://hzrd149.github.io/applesauce/content/text.html#mentions) ------------------------------------------------------------------------------ The [`nostrMentions`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-content.Text.nostrMentions.html) transformer can be used to add [`Mention`](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Mention.html) nodes to the tree Hashtags [​](https://hzrd149.github.io/applesauce/content/text.html#hashtags) ------------------------------------------------------------------------------ The [`hashtags`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-content.Text.hashtags.html) transformer can be used to add [`Hashtag`](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Hashtag.html) nodes to the tree Emojis [​](https://hzrd149.github.io/applesauce/content/text.html#emojis) -------------------------------------------------------------------------- The [`emojis`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-content.Text.emojis.html) transformer will add [`Emoji`](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Emoji.html) tags for any [NIP-30](https://github.com/nostr-protocol/nips/blob/master/30.md) emojis Galleries [​](https://hzrd149.github.io/applesauce/content/text.html#galleries) -------------------------------------------------------------------------------- The [`galleries`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-content.Text.galleries.html) transformer will group image URLs into a [`Gallery`](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Gallery.html) node Lightning invoices [​](https://hzrd149.github.io/applesauce/content/text.html#lightning-invoices) -------------------------------------------------------------------------------------------------- The [`lightningInvoices`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-content.Text.lightningInvoices.html) transformer can be used to parse bolt11 lightning invoices in the content Cashu tokens and payment requests [​](https://hzrd149.github.io/applesauce/content/text.html#cashu-tokens-and-payment-requests) -------------------------------------------------------------------------------------------------------------------------------- The [`cashuTokens`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-content.Text.cashuTokens.html) transformer can be used to parse cashu tokens in the content --- # Helpers | applesauce [Skip to content](https://hzrd149.github.io/applesauce/core/helpers.html#VPContent) Return to top Helpers [​](https://hzrd149.github.io/applesauce/core/helpers.html#helpers) ============================================================================ `applesauce-core` and other packages export helper methods for working with events. WARNING Some helper methods may throw errors. make sure your app can handle errors correctly. Core helpers [​](https://hzrd149.github.io/applesauce/core/helpers.html#core-helpers) -------------------------------------------------------------------------------------- The [`applesauce-core`](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) package contains the majority of the helper methods ### Events [​](https://hzrd149.github.io/applesauce/core/helpers.html#events) * [`isEvent`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isEvent.html) Checks if an object is a nostr event * [`markFromCache`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.markFromCache.html) Marks an event as being from the cache * [`isFromCache`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isFromCache.html) Checks if an event is marked from cache * [`getTagValue`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getTagValue.html) Gets the value of the first tag matching the name * [`getIndexableTags`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getIndexableTags.html) Get a `Set` of all indexable tags on the event ### Profiles [​](https://hzrd149.github.io/applesauce/core/helpers.html#profiles) * [`getProfileContent`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getProfileContent.html) Returns the parsed profile content for a kind 0 event * [`isValidProfile`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isValidProfile.html) Checks if the content of the kind 0 event is valid JSON ### Mailboxes [​](https://hzrd149.github.io/applesauce/core/helpers.html#mailboxes) * [`getInboxes`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getInboxes.html) Gets the inbox relays from a `10002` event * [`getOutboxes`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getOutboxes.html) Gets the outbox relays from a `10002` event ### Comments [​](https://hzrd149.github.io/applesauce/core/helpers.html#comments) * [`getCommentRootPointer`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getCommentRootPointer.html) Get the root pointer for a NIP-22 comment * [`getCommentReplyPointer`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getCommentReplyPointer.html) Get the reply pointer for a NIP-22 comment ### Event relays [​](https://hzrd149.github.io/applesauce/core/helpers.html#event-relays) * [`addSeenRelay`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.addSeenRelay.html) Adds a relay to the list of relay the event was seen on * [`getSeenRelays`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getSeenRelays.html) Get the list of relays this event was seen on ### Zaps [​](https://hzrd149.github.io/applesauce/core/helpers.html#zaps) * [`isValidZap`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isValidZap.html) Checks if an event is a valid zap and can be parsed * [`getZapSender`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getZapSender.html) Gets the senders pubkey * [`getZapRecipient`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getZapRecipient.html) Gets the pubkey of the user who received the zap * [`getZapPayment`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getZapPayment.html) Gets the parsed bolt11 invoice * [`getZapAddressPointer`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getZapAddressPointer.html) Gets the address pointer of the zap * [`getZapEventPointer`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getZapEventPointer.html) Gets the event pointer of the zap * [`getZapRequest`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getZapRequest.html) Gets the zap request event inside the zap event ### Lightning [​](https://hzrd149.github.io/applesauce/core/helpers.html#lightning) * [`parseBolt11`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.parseBolt11.html) Parses a bolt11 lightning invoice * [`parseLNURLOrAddress`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.parseLNURLOrAddress.html) Parses a LNURL or lightning address into a LNURLp ### Pointers [​](https://hzrd149.github.io/applesauce/core/helpers.html#pointers) * [`getEventPointerFromETag`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getEventPointerFromETag.html) Creates an `EventPointer` from a standard "e" tag * [`getEventPointerFromQTag`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getEventPointerFromQTag.html) Creates an `EventPointer` from a standard "q" tag * [`getAddressPointerFromATag`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getAddressPointerFromATag.html) Creates an `AddressPointer` from a standard "a" tag * [`getProfilePointerFromPTag`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getProfilePointerFromPTag.html) Creates an `ProfilePointer` from a standard "p" tag * [`getAddressPointerForEvent`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getAddressPointerForEvent.html) Returns an `AddressPointer` for a replaceable event ### Delete events [​](https://hzrd149.github.io/applesauce/core/helpers.html#delete-events) * [`getDeleteIds`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getDeleteIds.html) Gets a list of referenced event ids * [`getDeleteCoordinates`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getDeleteCoordinates.html) Get the list of replaceable event coordinates the event is referencing ### Emojis [​](https://hzrd149.github.io/applesauce/core/helpers.html#emojis) * [`getPackName`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getPackName.html) Gets the emoji pack name * [`getEmojis`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getEmojis.html) Get all emojis in an emoji pack * [`getEmojiTag`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getEmojiTag.html) CGets an "emoji" tag that matches an emoji code ### URLs [​](https://hzrd149.github.io/applesauce/core/helpers.html#urls) * [`getURLFilename`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getURLFilename.html) returns the filename part fo the path in a URL * [`isAudioURL`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isAudioURL.html) Checks if the URL ends with a audio file extension * [`isVideoURL`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isVideoURL.html) Checks if the URL ends with a video file extension * [`isImageURL`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isImageURL.html) Checks if the URL ends with a image file extension * [`isStreamURL`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isStreamURL.html) Checks if the URL ends with a stream file extension ### Tags [​](https://hzrd149.github.io/applesauce/core/helpers.html#tags) * [`isETag`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isETag.html) Checks if tag is an "e" tag and has at least one value * [`isATag`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isATag.html) Checks if tag is an "a" tag and has at least one value * [`isPTag`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isPTag.html) Checks if tag is an "p" tag and has at least one value * [`isDTag`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isDTag.html) Checks if tag is an "d" tag and has at least one value * [`isRTag`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isRTag.html) Checks if tag is an "r" tag and has at least one value * [`isTTag`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isTTag.html) Checks if tag is an "t" tag and has at least one value ### Hidden Tags [​](https://hzrd149.github.io/applesauce/core/helpers.html#hidden-tags) Hidden tags are used in [NIP-51](https://github.com/nostr-protocol/nips/blob/master/51.md) lists and [NIP-60](https://github.com/nostr-protocol/nips/blob/master/60.md) wallets * [`canHaveHiddenTags`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.canHaveHiddenTags.html) Checks if a given event kind can have hidden tags * [`hasHiddenTags`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.hasHiddenTags.html) Checks if an event has hidden tags * [`getHiddenTags`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getHiddenTags.html) Returns the hidden tags for an event if they are unlocked * [`isHiddenTagsLocked`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isHiddenTagsLocked.html) Checks if the hidden tags are locked * [`unlockHiddenTags`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.unlockHiddenTags.html) Unlocks the hidden tags using a `signer` * [`modifyEventTags`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.modifyEventTags.html) Modifies an events public or hidden tags ### Filters [​](https://hzrd149.github.io/applesauce/core/helpers.html#filters) * [`isFilterEqual`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isFilterEqual.html) Check if two filters are equal ### Time [​](https://hzrd149.github.io/applesauce/core/helpers.html#time) * [`unixNow`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.unixNow.html) Returns the current unix timestamp Factory Helpers [​](https://hzrd149.github.io/applesauce/core/helpers.html#factory-helpers) -------------------------------------------------------------------------------------------- The [`applesauce-factory`](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html) package exports some helpers for building events and tags Some of the most useful ones are * [`fillAndTrimTag`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.fillAndTrimTag.html) Replaces `undefined` or `null` in tags with `""` and trims to tag down to a set length if it ends with `""` * [`createQTagFromEventPointer`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.createQTagFromEventPointer.html) Creates a `"q"` tag for from an `EventPointer` to tag quoted events * [`createPTagFromProfilePointer`](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.createPTagFromProfilePointer.html) Creates a `"p"` tag for from a `ProfilePointer` to tag mentioned pubkeys --- # applesauce-accounts | AppleSauce * [applesauce-accounts](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.html) Module applesauce-accounts ========================== applesauce-accounts[](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.html#applesauce-accounts) ========================================================================================================================= A simple nostr account management system built on top of [applesauce-signers](https://hzrd149.github.io/applesauce/signers/installation.html) See [documentation](https://hzrd149.github.io/applesauce/signers/signers.html) Namespaces ---------- [Accounts](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.Accounts.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.html#accounts) Classes ------- [AccountManager](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.html#accountmanager) [BaseAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.html#baseaccount) [ProxySigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.ProxySigner.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.html#proxysigner) [SignerMismatchError](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.SignerMismatchError.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.html#signermismatcherror) Interfaces ---------- [DecryptionCache](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.DecryptionCache.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.html#decryptioncache) [IAccount](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.html#iaccount) [IAccountConstructor](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccountConstructor.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.html#iaccountconstructor) Type Aliases ------------ [EventTemplate](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.EventTemplate.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.html#eventtemplate) [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.html#serializedaccount) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page [applesauce-accounts](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.html#applesauce-accounts) Namespaces [Accounts](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.html#accounts) Classes [AccountManager](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.html#accountmanager) [BaseAccount](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.html#baseaccount) [ProxySigner](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.html#proxysigner) [SignerMismatchError](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.html#signermismatcherror) Interfaces [DecryptionCache](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.html#decryptioncache) [IAccount](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.html#iaccount) [IAccountConstructor](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.html#iaccountconstructor) Type Aliases [EventTemplate](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.html#eventtemplate) [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.html#serializedaccount) --- # applesauce-actions | AppleSauce * [applesauce-actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.html) Module applesauce-actions ========================= Applesauce Actions[](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.html#applesauce-actions) ====================================================================================================================== A collection of pre-built actions nostr clients can use. Built on top of `applesauce-core` and `applesauce-factory`. [Documentation](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.html) Installation[](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.html#installation) ---------------------------------------------------------------------------------------------------------- npm install applesauce-actions Overview[](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.html#overview) -------------------------------------------------------------------------------------------------- Actions are common pre-built async operations that apps can perform. They use: * `EventStore` for access to known nostr events * `EventFactory` to build and sign new nostr events * A `publish` method to publish or save the resulting events The package provides an `ActionHub` class that combines these components into a single manager for easier action execution. Basic Usage[](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.html#basic-usage) -------------------------------------------------------------------------------------------------------- import { ActionHub } from "applesauce-actions";import { FollowUser } from "applesauce-actions/actions";async function publishEvent(event: NostrEvent) { await relayPool.publish(event, ["wss://relay.example.com"]);}// Create an action hub with your event store, factory and publish methodconst hub = new ActionHub(eventStore, eventFactory, publishEvent);// Example: Follow a userawait hub .exec(FollowUser, "3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d") .forEach((event) => publishEvent(event)); For more detailed documentation and examples, visit the [full documentation](https://hzrd149.github.io/applesauce/overview/actions.html) . Namespaces ---------- [Actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.html#actions) Classes ------- [ActionHub](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-actions.ActionHub.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.html#actionhub) Type Aliases ------------ [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.html#action) [ActionConstructor](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.ActionConstructor.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.html#actionconstructor) [ActionContext](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.ActionContext.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.html#actioncontext) [PublishMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.PublishMethod.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.html#publishmethod) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page [Applesauce Actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.html#applesauce-actions) * [Installation](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.html#installation) * [Overview](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.html#overview) * [Basic Usage](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.html#basic-usage) Namespaces [Actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.html#actions) Classes [ActionHub](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.html#actionhub) Type Aliases [Action](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.html#action) [ActionConstructor](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.html#actionconstructor) [ActionContext](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.html#actioncontext) [PublishMethod](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.html#publishmethod) --- # applesauce-content | AppleSauce * [applesauce-content](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.html) Module applesauce-content ========================= applesauce-content[](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.html#applesauce-content) ====================================================================================================================== applesauce package for parsing text note content Example[](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.html#example) ------------------------------------------------------------------------------------------------ import { getParsedContent } from "applesauce-content/text";const stringContent = `hello nostr!nostr:npub180cvv07tjdrrgpa0j7j7tmnyl2yr6yr7l8j4s3evf6u64th6gkwsyjh6w6`;const ats = getParsedContent(stringContent);console.log(ats);/*{ type: 'root', event: undefined, children: [ { type: 'text', value: 'hello nostr!' }, { type: 'text', value: '\n' }, { type: 'mention', decoded: [Object], encoded: 'npub180cvv07tjdrrgpa0j7j7tmnyl2yr6yr7l8j4s3evf6u64th6gkwsyjh6w6' } ]}*/ Namespaces ---------- [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Helpers.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.html#helpers) [Markdown](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Markdown.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.html#markdown) [Nast](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Nast.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.html#nast) [Text](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Text.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.html#text) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page [applesauce-content](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.html#applesauce-content) * [Example](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.html#example) Namespaces [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.html#helpers) [Markdown](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.html#markdown) [Nast](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.html#nast) [Text](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.html#text) --- # applesauce-dvm | AppleSauce * [applesauce-dvm](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-dvm.html) Module applesauce-dvm ===================== Applesauce DVM[](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-dvm.html#applesauce-dvm) ========================================================================================================== Helpers and blueprints for [NIP-90](https://github.com/nostr-protocol/nips/blob/master/90.md) data vending machines. Installation[](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-dvm.html#installation) ------------------------------------------------------------------------------------------------------ npm install applesauce-dvm Usage[](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-dvm.html#usage) ---------------------------------------------------------------------------------------- import { DVMClient } from "applesauce-dvm";import { RelayPool, onlyEvents } from "applesauce-relay";import { EventFactory } from "applesauce-factory";import { SimpleSigner } from "applesauce-signers/signers";// Create a relay pool for connectionsconst pool = new RelayPool();// Create an event factory for signing and creating eventsconst signer = new SimpleSigner();const factory = new EventFactory({ signer });// Create a DVM clientconst client = new DVMClient( factory, ["wss://relay.example.com/"], // A publish method that publishes to the relays async (relays, event) => { await lastValueFrom(pool.event(relays, event)); }, // A subscribe method that subscribes to the relays (relays, filters) => { return pool.req(relays, filters).pipe(onlyEvents()); },);// Make a kind 5002 translation requestclient.translate("Hello, world!").subscribe((event) => { console.log(event);}); Namespaces ---------- [Blueprints](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-dvm.Blueprints.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-dvm.html#blueprints) [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-dvm.Helpers.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-dvm.html#helpers) Classes ------- [DVMClient](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-dvm.DVMClient.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-dvm.html#dvmclient) Type Aliases ------------ [PublishMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-dvm.PublishMethod.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-dvm.html#publishmethod) [SubscriptionMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-dvm.SubscriptionMethod.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-dvm.html#subscriptionmethod) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page [Applesauce DVM](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-dvm.html#applesauce-dvm) * [Installation](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-dvm.html#installation) * [Usage](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-dvm.html#usage) Namespaces [Blueprints](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-dvm.html#blueprints) [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-dvm.html#helpers) Classes [DVMClient](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-dvm.html#dvmclient) Type Aliases [PublishMethod](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-dvm.html#publishmethod) [SubscriptionMethod](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-dvm.html#subscriptionmethod) --- # applesauce-solidjs | AppleSauce * [applesauce-solidjs](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-solidjs.html) Module applesauce-solidjs ========================= applesauce-solidjs[](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-solidjs.html#applesauce-solidjs) ====================================================================================================================== [SolidJS](https://www.solidjs.com/) hooks and providers for applesauce Installation[](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-solidjs.html#installation) ---------------------------------------------------------------------------------------------------------- npm install applesauce-solidjs Example[](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-solidjs.html#example) ------------------------------------------------------------------------------------------------ import { from } from "solid-js";import { EventStore, Models } from "applesauce-core";const eventStore = new EventStore();function UserName({ pubkey }: { pubkey: string }) { const profile = from(eventStore.model(Models.ProfileModel, [pubkey])); return {profile() ? profile().name : "loading..."};}function App() { return (

App

);} Namespaces ---------- [Context](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-solidjs.Context.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-solidjs.html#context) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page [applesauce-solidjs](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-solidjs.html#applesauce-solidjs) * [Installation](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-solidjs.html#installation) * [Example](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-solidjs.html#example) Namespaces [Context](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-solidjs.html#context) --- # applesauce-core | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) Module applesauce-core ====================== applesauce-core[](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html#applesauce-core) ============================================================================================================= AppleSauce is a collection of utilities for building reactive nostr applications. The core package provides an in-memory event database and reactive models to help you build nostr UIs with less code. Key Components[](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html#key-components) ----------------------------------------------------------------------------------------------------------- * **Helpers**: Core utility methods for parsing and extracting data from nostr events * **EventStore**: In-memory database for storing and subscribing to nostr events * **Models**: Complex subscriptions for common nostr data patterns Documentation[](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html#documentation) --------------------------------------------------------------------------------------------------------- For detailed documentation and guides, visit: * [Getting Started](https://hzrd149.github.io/applesauce/introduction/getting-started) * [API Reference](https://hzrd149.github.io/applesauce/typedoc/) Example[](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html#example) --------------------------------------------------------------------------------------------- import { EventStore } from "applesauce-core";import { ProfileModel, TimelineModel } from "applesauce-core/models";import { Relay } from "nostr-tools/relay";// Create a single EventStore instance for your appconst eventStore = new EventStore();// Use any nostr library for relay connections (nostr-tools, ndk, nostrify, etc...)const relay = await Relay.connect("wss://relay.example.com");// Subscribe to events and add them to the storeconst sub = relay.subscribe([{ authors: ["3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d"] }], { onevent(event) { eventStore.add(event); },});// Subscribe to profile changes using ProfileModelconst profile = eventStore.model(ProfileModel, "3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d");profile.subscribe((parsed) => { if (parsed) console.log(parsed);});// Subscribe to a timeline of eventsconst timeline = eventStore.model(TimelineModel, { kinds: [1] });timeline.subscribe((events) => { console.log(events);}); Namespaces ---------- [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html#helpers) [Models](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html#models) Classes ------- [EventSet](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html#eventset) [EventStore](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html#eventstore) [TimeoutError](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.TimeoutError.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html#timeouterror) Interfaces ---------- [IEventClaims](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventClaims.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html#ieventclaims) [IEventSet](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html#ieventset) [IEventStore](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html#ieventstore) [IEventStoreActions](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreActions.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html#ieventstoreactions) [IEventStoreModels](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreModels.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html#ieventstoremodels) [IEventStoreRead](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreRead.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html#ieventstoreread) [IEventStoreStreams](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreStreams.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html#ieventstorestreams) [IEventStoreSubscriptions](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreSubscriptions.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html#ieventstoresubscriptions) Type Aliases ------------ [Model](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Model.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html#model) [ModelConstructor](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.ModelConstructor.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html#modelconstructor) Functions --------- [defined](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.defined.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html#defined) [firstValueFrom](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.firstValueFrom.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html#firstvaluefrom) [getObservableValue](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.getObservableValue.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html#getobservablevalue) [lastValueFrom](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.lastValueFrom.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html#lastvaluefrom) [mapEventsToStore](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.mapEventsToStore.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html#mapeventstostore) [mapEventsToTimeline](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.mapEventsToTimeline.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html#mapeventstotimeline) [simpleTimeout](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.simpleTimeout.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html#simpletimeout) [watchEventsUpdates](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.watchEventsUpdates.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html#watcheventsupdates) [watchEventUpdates](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.watchEventUpdates.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html#watcheventupdates) [withImmediateValueOrDefault](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.withImmediateValueOrDefault.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html#withimmediatevalueordefault) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html#applesauce-core) * [Key Components](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html#key-components) * [Documentation](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html#documentation) * [Example](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html#example) Namespaces [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html#helpers) [Models](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html#models) Classes [EventSet](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html#eventset) [EventStore](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html#eventstore) [TimeoutError](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html#timeouterror) Interfaces [IEventClaims](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html#ieventclaims) [IEventSet](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html#ieventset) [IEventStore](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html#ieventstore) [IEventStoreActions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html#ieventstoreactions) [IEventStoreModels](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html#ieventstoremodels) [IEventStoreRead](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html#ieventstoreread) [IEventStoreStreams](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html#ieventstorestreams) [IEventStoreSubscriptions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html#ieventstoresubscriptions) Type Aliases [Model](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html#model) [ModelConstructor](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html#modelconstructor) Functions [defined](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html#defined) [firstValueFrom](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html#firstvaluefrom) [getObservableValue](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html#getobservablevalue) [lastValueFrom](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html#lastvaluefrom) [mapEventsToStore](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html#mapeventstostore) [mapEventsToTimeline](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html#mapeventstotimeline) [simpleTimeout](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html#simpletimeout) [watchEventsUpdates](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html#watcheventsupdates) [watchEventUpdates](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html#watcheventupdates) [withImmediateValueOrDefault](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html#withimmediatevalueordefault) --- # applesauce-loaders | AppleSauce * [applesauce-loaders](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-loaders.html) Module applesauce-loaders ========================= applesauce-loaders[](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-loaders.html#applesauce-loaders) ====================================================================================================================== A collection of functional loading methods to make common event loading patterns easier. [Documentation](https://hzrd149.github.io/applesauce/loaders/package.html) [typedoc](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-loaders.html) Address Loader[](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-loaders.html#address-loader) -------------------------------------------------------------------------------------------------------------- The Address Loader is a specialized loader for fetching Nostr replaceable events by their address (kind, pubkey, and optional identifier). It provides an efficient way to batch and deduplicate requests, cache results, and handle relay hints. import { createAddressLoader } from "applesauce-loaders/loaders";import { EventStore } from "applesauce-core";import { RelayPool } from "applesauce-relay";const eventStore = new EventStore();const pool = new RelayPool();// Create an address loader (do this once at the app level)const addressLoader = createAddressLoader(pool, { // Pass all events to the event store to deduplicate them eventStore, // Optional configuration options bufferTime: 1000, followRelayHints: true, extraRelays: ["wss://relay.example.com"],});// Load a profile (kind 0)addressLoader({ kind: 0, pubkey: "3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d", relays: ["wss://relay.example.com"],}).subscribe((event) => { // Handle the loaded event console.log(event);});// Load a contact list (kind 3)addressLoader({ kind: 3, pubkey: "3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d", relays: ["wss://relay.example.com"],}).subscribe((event) => { // Handle the loaded event console.log(event);});// Load a parameterized replaceable eventaddressLoader({ kind: 30000, pubkey: "3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d", identifier: "list of bad people", relays: ["wss://relay.example.com"],}).subscribe((event) => { // Handle the loaded event console.log(event);}); Event Loader[](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-loaders.html#event-loader) ---------------------------------------------------------------------------------------------------------- The Event Loader is a specialized loader for fetching Nostr events by their IDs. It provides an efficient way to batch and deduplicate requests, cache results, and handle relay hints. import { createEventLoader } from "applesauce-loaders/loaders";// Create an event loader (do this once at the app level)const eventLoader = createEventLoader(pool, { // Pass all events to the event store to deduplicate them eventStore, // Optional configuration options bufferTime: 1000, followRelayHints: true, extraRelays: ["wss://relay.example.com"],});// Load an event by IDeventLoader({ id: "2650f6292166624f45795248edb9ca136c276a3d10a0d8f4efd2b8b23eb2d5fc", relays: ["wss://relay.example.com"],}).subscribe((event) => { // Handle the loaded event console.log(event);});// Load from extra relayseventLoader({ id: "2650f6292166624f45795248edb9ca136c276a3d10a0d8f4efd2b8b23eb2d5fc", relays: ["wss://relay.example.com"],}).subscribe((event) => { // Handle the loaded event console.log(event);}); Timeline Loader[](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-loaders.html#timeline-loader) ---------------------------------------------------------------------------------------------------------------- The Timeline Loader is designed for fetching paginated Nostr events in chronological order. It maintains state between calls, allowing you to efficiently load timeline events in blocks until you reach a specific timestamp or exhaust available events. import { createTimelineLoader } from "applesauce-loaders/loaders";// Create a timeline loaderconst timelineLoader = createTimelineLoader( pool, ["wss://relay.example.com"], { kinds: [1] }, // Load text notes { eventStore },);// Initial load - gets the most recent eventstimelineLoader().subscribe((event) => { console.log("Loaded event:", event);});// Later, load older events by calling the loader again// Each call continues from where the previous one left offtimelineLoader().subscribe((event) => { console.log("Loaded older event:", event);});// Load events until a specific timestampconst oneWeekAgo = Math.floor(Date.now() / 1000) - 7 * 24 * 60 * 60;timelineLoader(oneWeekAgo).subscribe((event) => { console.log("Event from last week:", event);}); Loading from cache[](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-loaders.html#loading-from-cache) ---------------------------------------------------------------------------------------------------------------------- All loaders support a `cacheRequest` option to load events from a local cache. import { NostrEvent, Filter } from "nostr-tools";import { createEventLoader } from "applesauce-loaders/loaders";// Custom method for loading events from a databaseasync function cacheRequest(filters: Filter[]): Promise { return await cacheDatabase.getEvents(filters);}const eventLoader = createEventLoader(pool, { // Pass all events to the event store to deduplicate them eventStore, // Pass a custom cache method cacheRequest, // Optional configuration options bufferTime: 1000,});// Because no relays are specified, the event will be loaded from the cacheeventLoader({ id: "2650f6292166624f45795248edb9ca136c276a3d10a0d8f4efd2b8b23eb2d5fc",}).subscribe((event) => { // Handle the loaded event console.log(event);}); Configuration Options[](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-loaders.html#configuration-options) ---------------------------------------------------------------------------------------------------------------------------- All loaders accept these common configuration options: ### Address Loader Options[](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-loaders.html#address-loader-options) * `bufferTime`: Time interval to buffer requests in ms (default 1000) * `bufferSize`: Max buffer size (default 200) * `eventStore`: An event store used to deduplicate events * `cacheRequest`: A method used to load events from a local cache * `followRelayHints`: Whether to follow relay hints (default true) * `lookupRelays`: Fallback lookup relays to check when event can't be found * `extraRelays`: An array of relays to always fetch from ### Event Loader Options[](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-loaders.html#event-loader-options) * `bufferTime`: Time interval to buffer requests in ms (default 1000) * `bufferSize`: Max buffer size (default 200) * `eventStore`: An event store used to deduplicate events * `cacheRequest`: A method used to load events from a local cache * `followRelayHints`: Whether to follow relay hints (default true) * `extraRelays`: An array of relays to always fetch from ### Timeline Loader Options[](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-loaders.html#timeline-loader-options) * `limit`: Maximum number of events to request per filter * `cache`: A method used to load events from a local cache * `eventStore`: An event store to pass all events to Working with Relay Pools[](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-loaders.html#working-with-relay-pools) ---------------------------------------------------------------------------------------------------------------------------------- All loaders require a request method for loading Nostr events from relays. You can provide this in multiple ways: ### Using a RelayPool instance[](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-loaders.html#using-a-relaypool-instance) The simplest approach is to pass a RelayPool instance directly: import { createAddressLoader, createEventLoader } from "applesauce-loaders/loaders";import { RelayPool } from "applesauce-relay";const pool = new RelayPool();const addressLoader = createAddressLoader(pool, { eventStore });const eventLoader = createEventLoader(pool, { eventStore }); ### Using a custom request method[](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-loaders.html#using-a-custom-request-method) You can also provide a custom request method, such as one from nostr-tools: import { createEventLoader } from "applesauce-loaders/loaders";import { SimplePool } from "nostr-tools";import { Observable } from "rxjs";const pool = SimplePool();// Create a custom request function using nostr-toolsfunction customRequest(relays, filters) { return new Observable((observer) => { const sub = pool.subscribeMany(relays, filters, { onevent: (event) => observer.next(event), eose: () => observer.complete(), }); return () => sub.close(); });}// Create event loader with custom requestconst eventLoader = createEventLoader(customRequest, options); Namespaces ---------- [Loaders](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-loaders.Loaders.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-loaders.html#loaders) [Operators](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-loaders.Operators.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-loaders.html#operators) Type Aliases ------------ [CacheRequest](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-loaders.CacheRequest.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-loaders.html#cacherequest) [FilterRequest](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-loaders.FilterRequest.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-loaders.html#filterrequest) [NostrRequest](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-loaders.NostrRequest.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-loaders.html#nostrrequest) [TimelessFilter](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-loaders.TimelessFilter.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-loaders.html#timelessfilter) [UpstreamPool](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-loaders.UpstreamPool.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-loaders.html#upstreampool) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page [applesauce-loaders](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-loaders.html#applesauce-loaders) * [Address Loader](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-loaders.html#address-loader) * [Event Loader](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-loaders.html#event-loader) * [Timeline Loader](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-loaders.html#timeline-loader) * [Loading from cache](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-loaders.html#loading-from-cache) * [Configuration Options](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-loaders.html#configuration-options) * * [Address Loader Options](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-loaders.html#address-loader-options) * [Event Loader Options](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-loaders.html#event-loader-options) * [Timeline Loader Options](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-loaders.html#timeline-loader-options) * [Working with Relay Pools](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-loaders.html#working-with-relay-pools) * * [Using a RelayPool instance](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-loaders.html#using-a-relaypool-instance) * [Using a custom request method](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-loaders.html#using-a-custom-request-method) Namespaces [Loaders](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-loaders.html#loaders) [Operators](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-loaders.html#operators) Type Aliases [CacheRequest](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-loaders.html#cacherequest) [FilterRequest](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-loaders.html#filterrequest) [NostrRequest](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-loaders.html#nostrrequest) [TimelessFilter](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-loaders.html#timelessfilter) [UpstreamPool](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-loaders.html#upstreampool) --- # applesauce-factory | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) Module applesauce-factory ========================= applesauce-factory[](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html#applesauce-factory) ====================================================================================================================== applesauce event factory is a package for easily creating or modifying nostr events Documentation[](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html#documentation) ------------------------------------------------------------------------------------------------------------ For detailed documentation and guides, visit: * [Documentation](https://hzrd149.github.io/applesauce/overview/factory.html) * [API Reference](https://hzrd149.github.io/applesauce/typedoc/) Creating a Factory[](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html#creating-a-factory) ---------------------------------------------------------------------------------------------------------------------- When creating a new event factory you can pass a [context](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventFactoryContext.html) object that is used by all blueprints: const signer = new SimpleSigner();const factory = new EventFactory({ // optionally pass a signer in (required for encryption) signer: signer, // or pass NIP-07 window.nostr if it exists // optionally set a NIP-89 client client: { name: "My Awesome Client", address: { pubkey: "3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d", identifier: "awesome-client", }, },}); Creating a short text note[](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html#creating-a-short-text-note) -------------------------------------------------------------------------------------------------------------------------------------- import { EventFactory } from "applesauce-factory";import { NoteBlueprint } from "applesauce-factory/blueprints";const factory = new EventFactory({ // config options, // see https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventFactoryContext.html});const unsignedEvent = await factory.create( NoteBlueprint, "hello nostr:npub180cvv07tjdrrgpa0j7j7tmnyl2yr6yr7l8j4s3evf6u64th6gkwsyjh6w6 #introductions",);console.log(unsignedEvent);{ kind: 1, content: "hello nostr:npub180cvv07tjdrrgpa0j7j7tmnyl2yr6yr7l8j4s3evf6u64th6gkwsyjh6w6 #introductions", created_at: 0, tags: [['p', '3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d'], ['t', 'introductions']]} Relay Hints[](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html#relay-hints) -------------------------------------------------------------------------------------------------------- Relay hints can be added to all event tags that support them by passing in `getEventRelayHint` and `getPubkeyRelayHint` methods into the context: const factory = new EventFactory({ getEventRelayHint: async (event) => { // an async process to find the best relay hint for this event try { return await calculateRelayHint(event) } catch(){ return undefined } }, getPubkeyRelayHint: async (pubkey) => { // an async process to find a relay hint for this pubkey return loadPubkeyMailboxes(pubkey).then((mailboxes) => getOutboxes(mailboxes)[0]); },}); Modifying Events[](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html#modifying-events) ------------------------------------------------------------------------------------------------------------------ The factory provides methods to modify existing events: * `EventFactory.modify` - Takes a list of EventOperations to modify common properties * `EventFactory.modifyTags` - Takes a list of TagOperations to modify the tags array Example of modifying a list: const list = { kind: 30003, content: "", tags: [ ["title", "read later"], ["description", "notes ill read later"], ],};const modified = await factory.modify( list, setListTitle("read never"), setListDescription("I will never get around to reading these notes"),); Prebuilt Blueprints[](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html#prebuilt-blueprints) ------------------------------------------------------------------------------------------------------------------------ The `applesauce-factory` package comes with common event blueprints for social clients. you can find them in the [typescript docs](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html) Namespaces ---------- [Blueprints](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html#blueprints) [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html#helpers) [Operations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html#operations) Classes ------- [EventFactory](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html#eventfactory) Interfaces ---------- [ClientPointerContext](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.ClientPointerContext.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html#clientpointercontext) [EmojiContext](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EmojiContext.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html#emojicontext) [EventFactoryClient](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EventFactoryClient.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html#eventfactoryclient) [EventFactoryContext](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EventFactoryContext.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html#eventfactorycontext) [EventSigner](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EventSigner.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html#eventsigner) [EventSignerContext](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EventSignerContext.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html#eventsignercontext) [RelayHintContext](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.RelayHintContext.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html#relayhintcontext) Type Aliases ------------ [EventBlueprint](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventBlueprint.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html#eventblueprint) [EventFactoryTemplate](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventFactoryTemplate.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html#eventfactorytemplate) [EventOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventOperation.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html#eventoperation) [Operation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Operation.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html#operation) [TagOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.TagOperation.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html#tagoperation) Functions --------- [blueprint](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.blueprint.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html#blueprint) [build](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.build.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html#build) [create](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.create.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html#create) [modify](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.modify.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html#modify) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html#applesauce-factory) * [Documentation](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html#documentation) * [Creating a Factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html#creating-a-factory) * [Creating a short text note](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html#creating-a-short-text-note) * [Relay Hints](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html#relay-hints) * [Modifying Events](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html#modifying-events) * [Prebuilt Blueprints](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html#prebuilt-blueprints) Namespaces [Blueprints](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html#blueprints) [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html#helpers) [Operations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html#operations) Classes [EventFactory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html#eventfactory) Interfaces [ClientPointerContext](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html#clientpointercontext) [EmojiContext](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html#emojicontext) [EventFactoryClient](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html#eventfactoryclient) [EventFactoryContext](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html#eventfactorycontext) [EventSigner](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html#eventsigner) [EventSignerContext](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html#eventsignercontext) [RelayHintContext](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html#relayhintcontext) Type Aliases [EventBlueprint](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html#eventblueprint) [EventFactoryTemplate](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html#eventfactorytemplate) [EventOperation](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html#eventoperation) [Operation](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html#operation) [TagOperation](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html#tagoperation) Functions [blueprint](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html#blueprint) [build](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html#build) [create](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html#create) [modify](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html#modify) --- # applesauce-react | AppleSauce * [applesauce-react](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-react.html) Module applesauce-react ======================= applesauce-react[](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-react.html#applesauce-react) ================================================================================================================ React hooks and providers for applesauce Installation[](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-react.html#installation) -------------------------------------------------------------------------------------------------------- npm install applesauce-react Example[](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-react.html#example) ---------------------------------------------------------------------------------------------- import { EventStore, Models } from "applesauce-core";import { EventStoreProvider } from "applesauce-react/providers";import { useEventModel } from "applesauce-react/hooks";const eventStore = new EventStore();function UserName({ pubkey }) { const profile = useEventModel(Models.ProfileModel, [pubkey]); return {profile.name || "loading..."};}function App() { return (

App

);} Namespaces ---------- [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-react.Helpers.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-react.html#helpers) [Hooks](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-react.Hooks.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-react.html#hooks) Variables --------- [AccountsContext](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-react.AccountsContext.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-react.html#accountscontext) [ActionsContext](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-react.ActionsContext.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-react.html#actionscontext) [EventStoreContext](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-react.EventStoreContext.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-react.html#eventstorecontext) [FactoryContext](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-react.FactoryContext.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-react.html#factorycontext) Functions --------- [AccountsProvider](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-react.AccountsProvider.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-react.html#accountsprovider) [ActionsProvider](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-react.ActionsProvider.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-react.html#actionsprovider) [EventStoreProvider](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-react.EventStoreProvider.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-react.html#eventstoreprovider) [FactoryProvider](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-react.FactoryProvider.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-react.html#factoryprovider) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page [applesauce-react](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-react.html#applesauce-react) * [Installation](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-react.html#installation) * [Example](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-react.html#example) Namespaces [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-react.html#helpers) [Hooks](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-react.html#hooks) Variables [AccountsContext](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-react.html#accountscontext) [ActionsContext](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-react.html#actionscontext) [EventStoreContext](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-react.html#eventstorecontext) [FactoryContext](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-react.html#factorycontext) Functions [AccountsProvider](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-react.html#accountsprovider) [ActionsProvider](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-react.html#actionsprovider) [EventStoreProvider](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-react.html#eventstoreprovider) [FactoryProvider](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-react.html#factoryprovider) --- # SerialPortSigner | AppleSauce * [applesauce-signers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.html) * [SerialPortSigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html) Class SerialPortSigner ====================== A signer that works with [nostr-signing-device](https://github.com/lnbits/nostr-signing-device) #### Implements * [ISigner](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.ISigner.html) ##### Index ### Constructors [constructor](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#constructor) ### Properties [lastCommand](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#lastcommand) [log](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#log) [nip04](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#nip04) [pubkey?](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#pubkey) [verifyEvent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#verifyevent) [writer](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#writer) [METHOD\_LOG](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#method_log) [METHOD\_PING](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#method_ping) [METHOD\_PUBLIC\_KEY](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#method_public_key) [METHOD\_RESTORE](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#method_restore) [METHOD\_SHARED\_SECRET](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#method_shared_secret) [METHOD\_SIGN\_MESSAGE](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#method_sign_message) [PUBLIC\_METHODS](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#public_methods) [SUPPORTED](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#supported) ### Accessors [isConnected](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#isconnected) ### Methods [callMethodOnDevice](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#callmethodondevice) [connectToDevice](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#connecttodevice) [getPublicKey](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#getpublickey) [nip04Decrypt](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#nip04decrypt) [nip04Encrypt](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#nip04encrypt) [parseResponse](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#parseresponse) [ping](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#ping) [readFromSerialPort](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#readfromserialport) [restore](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#restore) [sendCommand](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#sendcommand) [signEvent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#signevent) Constructors ------------ ### constructor[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#constructor) * new SerialPortSigner(): [SerialPortSigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html) [](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#constructorserialportsigner) #### Returns [SerialPortSigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html) Properties ---------- ### `Protected`lastCommand[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#lastcommand) lastCommand: null | Deferred = null ### `Protected`log[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#log) log: Debugger = ... ### nip04[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#nip04) nip04: {     decrypt: (pubkey: string, ciphertext: string) \=> Promise;     encrypt: (pubkey: string, plaintext: string) \=> Promise; } ### `Optional`pubkey[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#pubkey) pubkey?: string ### verifyEvent[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#verifyevent) verifyEvent: (event: Event) \=> event is VerifiedEvent = verifyEvent ### `Protected`writer[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#writer) writer: null | WritableStreamDefaultWriter = null ### `Static`METHOD\_LOG[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#method_log) METHOD\_LOG: string = "/log" ### `Static`METHOD\_PING[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#method_ping) METHOD\_PING: string = "/ping" ### `Static`METHOD\_PUBLIC\_KEY[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#method_public_key) METHOD\_PUBLIC\_KEY: string = "/public-key" ### `Static`METHOD\_RESTORE[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#method_restore) METHOD\_RESTORE: string = "/restore" ### `Static`METHOD\_SHARED\_SECRET[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#method_shared_secret) METHOD\_SHARED\_SECRET: string = "/shared-secret" ### `Static`METHOD\_SIGN\_MESSAGE[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#method_sign_message) METHOD\_SIGN\_MESSAGE: string = "/sign-message" ### `Static`PUBLIC\_METHODS[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#public_methods) PUBLIC\_METHODS: string\[\] = ... ### `Static`SUPPORTED[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#supported) SUPPORTED: boolean = ... Accessors --------- ### isConnected[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#isconnected) * get isConnected(): boolean #### Returns boolean Methods ------- ### callMethodOnDevice[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#callmethodondevice) * callMethodOnDevice(     method: string,     params: string\[\],     opts?: DeviceOpts, ): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#callmethodondevice-1) #### Parameters * method: string * params: string\[\] * opts: DeviceOpts = {} #### Returns Promise ### connectToDevice[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#connecttodevice) * connectToDevice(\_\_namedParameters: DeviceOpts): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#connecttodevice-1) #### Parameters * \_\_namedParameters: DeviceOpts #### Returns Promise ### getPublicKey[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#getpublickey) * getPublicKey(): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#getpublickey-1) Returns the public key on the device #### Returns Promise ### nip04Decrypt[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#nip04decrypt) * nip04Decrypt(pubkey: string, data: string): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#nip04decrypt-1) #### Parameters * pubkey: string * data: string #### Returns Promise ### nip04Encrypt[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#nip04encrypt) * nip04Encrypt(pubkey: string, text: string): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#nip04encrypt-1) #### Parameters * pubkey: string * text: string #### Returns Promise ### `Protected`parseResponse[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#parseresponse) * parseResponse(value: string): { data: string; method: string }[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#parseresponse-1) #### Parameters * value: string #### Returns { data: string; method: string } ### ping[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#ping) * ping(): void[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#ping-1) Pings to device to see if the connection is open #### Returns void ### `Protected`readFromSerialPort[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#readfromserialport) * readFromSerialPort(     reader: ReadableStreamDefaultReader, ): (separator?: string) \=> Promise<{ done: boolean; value: string }\>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#readfromserialport-1) #### Parameters * reader: ReadableStreamDefaultReader #### Returns (separator?: string) \=> Promise<{ done: boolean; value: string }\> ### restore[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#restore) * restore(secretKey: Uint8Array): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#restore-1) Sets the secret key used on the device #### Parameters * secretKey: Uint8Array #### Returns Promise ### sendCommand[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#sendcommand) * sendCommand(method: string, params?: string\[\]): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#sendcommand-1) #### Parameters * method: string * params: string\[\] = \[\] #### Returns Promise ### signEvent[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#signevent) * signEvent(draft: EventTemplate & { pubkey?: string }): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#signevent-1) Requires the device to sign an event #### Parameters * draft: EventTemplate & { pubkey?: string } #### Returns Promise ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Constructors [constructor](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#constructor) Properties [lastCommand](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#lastcommand) [log](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#log) [nip04](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#nip04) [pubkey](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#pubkey) [verifyEvent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#verifyevent) [writer](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#writer) [METHOD\_LOG](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#method_log) [METHOD\_PING](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#method_ping) [METHOD\_PUBLIC\_KEY](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#method_public_key) [METHOD\_RESTORE](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#method_restore) [METHOD\_SHARED\_SECRET](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#method_shared_secret) [METHOD\_SIGN\_MESSAGE](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#method_sign_message) [PUBLIC\_METHODS](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#public_methods) [SUPPORTED](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#supported) Accessors [isConnected](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#isconnected) Methods [callMethodOnDevice](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#callmethodondevice) [connectToDevice](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#connecttodevice) [getPublicKey](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#getpublickey) [nip04Decrypt](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#nip04decrypt) [nip04Encrypt](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#nip04encrypt) [parseResponse](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#parseresponse) [ping](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#ping) [readFromSerialPort](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#readfromserialport) [restore](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#restore) [sendCommand](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#sendcommand) [signEvent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html#signevent) --- # isFromCache | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [isFromCache](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isFromCache.html) Function isFromCache ==================== * isFromCache(event: Event): boolean[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isFromCache.html#isfromcache) Returns if an event was from a cache #### Parameters * event: Event #### Returns boolean ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # AccountsProvider | AppleSauce * [applesauce-react](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-react.html) * [AccountsProvider](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-react.AccountsProvider.html) Function AccountsProvider ========================= * AccountsProvider(     \_\_namedParameters: PropsWithChildren<{ manager?: [AccountManager](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html) }\>, ): Element[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-react.AccountsProvider.html#accountsprovider) Provides an AccountManager to the component tree #### Parameters * \_\_namedParameters: PropsWithChildren<{ manager?: [AccountManager](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html) }\> #### Returns Element ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # ExtensionSigner | AppleSauce * [applesauce-signers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.html) * [ExtensionSigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ExtensionSigner.html) Class ExtensionSigner ===================== A signer that is a proxy for window.nostr #### Implements * [ISigner](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.ISigner.html) ##### Index ### Constructors [constructor](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ExtensionSigner.html#constructor) ### Properties [pubkey](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ExtensionSigner.html#pubkey) ### Accessors [nip04](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ExtensionSigner.html#nip04) [nip44](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ExtensionSigner.html#nip44) ### Methods [getPublicKey](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ExtensionSigner.html#getpublickey) [signEvent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ExtensionSigner.html#signevent) Constructors ------------ ### constructor[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ExtensionSigner.html#constructor) * new ExtensionSigner(): [ExtensionSigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ExtensionSigner.html) [](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ExtensionSigner.html#constructorextensionsigner) #### Returns [ExtensionSigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ExtensionSigner.html) Properties ---------- ### `Protected`pubkey[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ExtensionSigner.html#pubkey) pubkey: undefined | string = undefined Accessors --------- ### nip04[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ExtensionSigner.html#nip04) * get nip04(): | undefined | {     decrypt: (pubkey: string, ciphertext: string) \=> Promise;     encrypt: (pubkey: string, plaintext: string) \=> Promise; } #### Returns     | undefined     | {         decrypt: (pubkey: string, ciphertext: string) \=> Promise;         encrypt: (pubkey: string, plaintext: string) \=> Promise;     } ### nip44[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ExtensionSigner.html#nip44) * get nip44(): | undefined | {     decrypt: (pubkey: string, ciphertext: string) \=> Promise;     encrypt: (pubkey: string, plaintext: string) \=> Promise; } #### Returns     | undefined     | {         decrypt: (pubkey: string, ciphertext: string) \=> Promise;         encrypt: (pubkey: string, plaintext: string) \=> Promise;     } Methods ------- ### getPublicKey[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ExtensionSigner.html#getpublickey) * getPublicKey(): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ExtensionSigner.html#getpublickey-1) #### Returns Promise ### signEvent[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ExtensionSigner.html#signevent) * signEvent(template: EventTemplate): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ExtensionSigner.html#signevent-1) #### Parameters * template: EventTemplate #### Returns Promise ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Constructors [constructor](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ExtensionSigner.html#constructor) Properties [pubkey](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ExtensionSigner.html#pubkey) Accessors [nip04](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ExtensionSigner.html#nip04) [nip44](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ExtensionSigner.html#nip44) Methods [getPublicKey](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ExtensionSigner.html#getpublickey) [signEvent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ExtensionSigner.html#signevent) --- # ensureSingletonTag | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html) * [ensureSingletonTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.ensureSingletonTag.html) Function ensureSingletonTag =========================== * ensureSingletonTag(     tags: string\[\]\[\],     tag: \[string, ...string\[\]\],     replace?: boolean, ): string\[\]\[\][](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.ensureSingletonTag.html#ensuresingletontag) Ensures a single named tag exists #### Parameters * tags: string\[\]\[\] * tag: \[string, ...string\[\]\] * replace: boolean = true #### Returns string\[\]\[\] ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # Model | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Model](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Model.html) Type Alias Model =================== Model: (events: [IEventStore](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html) ) \=> Observable<[T](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Model.html#t) \> A computed view of an event set or event store #### Type Parameters * T extends unknown #### Type declaration * * (events: [IEventStore](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html) ): Observable<[T](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Model.html#t) \> * #### Parameters * events: [IEventStore](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html) #### Returns Observable<[T](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Model.html#t) \> ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # getTagValue | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [getTagValue](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getTagValue.html) Function getTagValue ==================== * getTagValue<[T](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getTagValue.html#gettagvaluet) extends { content: string; kind: number; tags: string\[\]\[\] }\>(     event: [T](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getTagValue.html#gettagvaluet) ,     name: string, ): undefined | string[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getTagValue.html#gettagvalue) Returns the second index ( tag\[1\] ) of the first tag that matches the name If the event has any hidden tags they will be searched first #### Type Parameters * T extends { content: string; kind: number; tags: string\[\]\[\] } #### Parameters * event: [T](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getTagValue.html#gettagvaluet) * name: string #### Returns undefined | string ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # getIndexableTags | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [getIndexableTags](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getIndexableTags.html) Function getIndexableTags ========================= * getIndexableTags(event: Event): Set[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getIndexableTags.html#getindexabletags) Returns a Set of tag names and values that are indexable #### Parameters * event: Event #### Returns Set ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # AmberClipboardSigner | AppleSauce * [applesauce-signers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.html) * [AmberClipboardSigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html) Class AmberClipboardSigner ========================== A Signer for [amber](https://github.com/greenart7c3/Amber) clipboard API #### See[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#see) [https://github.com/greenart7c3/Amber/blob/master/docs/web-apps.md](https://github.com/greenart7c3/Amber/blob/master/docs/web-apps.md) #### Implements * [ISigner](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.ISigner.html) ##### Index ### Constructors [constructor](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#constructor) ### Properties [nip04](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#nip04) [nip44](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#nip44) [pubkey?](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#pubkey) [verifyEvent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#verifyevent) [SUPPORTED](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#supported) ### Methods [destroy](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#destroy) [getPublicKey](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#getpublickey) [nip04Decrypt](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#nip04decrypt) [nip04Encrypt](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#nip04encrypt) [nip44Decrypt](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#nip44decrypt) [nip44Encrypt](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#nip44encrypt) [rejectPending](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#rejectpending) [signEvent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#signevent) [createGetPublicKeyIntent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#creategetpublickeyintent) [createNip04DecryptIntent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#createnip04decryptintent) [createNip04EncryptIntent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#createnip04encryptintent) [createNip44DecryptIntent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#createnip44decryptintent) [createNip44EncryptIntent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#createnip44encryptintent) [createSignEventIntent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#createsigneventintent) Constructors ------------ ### constructor[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#constructor) * new AmberClipboardSigner(): [AmberClipboardSigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html) [](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#constructoramberclipboardsigner) #### Returns [AmberClipboardSigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html) Properties ---------- ### nip04[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#nip04) nip04: {     decrypt: (pubkey: string, ciphertext: string) \=> Promise;     encrypt: (pubkey: string, plaintext: string) \=> Promise; } ### nip44[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#nip44) nip44: {     decrypt: (pubkey: string, ciphertext: string) \=> Promise;     encrypt: (pubkey: string, plaintext: string) \=> Promise; } ### `Optional`pubkey[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#pubkey) pubkey?: string ### verifyEvent[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#verifyevent) verifyEvent: (event: Event) \=> event is VerifiedEvent = verifyEvent ### `Static`SUPPORTED[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#supported) SUPPORTED: false | (() \=> Promise) = ... If the signer is supported on this platform #### Type declaration * false * () \=> Promise * * (): Promise * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Clipboard/readText) #### Returns Promise Methods ------- ### destroy[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#destroy) * destroy(): void[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#destroy-1) Removes any event listeners created #### Returns void ### getPublicKey[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#getpublickey) * getPublicKey(): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#getpublickey-1) #### Returns Promise ### nip04Decrypt[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#nip04decrypt) * nip04Decrypt(pubkey: string, data: string): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#nip04decrypt-1) #### Parameters * pubkey: string * data: string #### Returns Promise ### nip04Encrypt[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#nip04encrypt) * nip04Encrypt(pubkey: string, plaintext: string): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#nip04encrypt-1) #### Parameters * pubkey: string * plaintext: string #### Returns Promise ### nip44Decrypt[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#nip44decrypt) * nip44Decrypt(pubkey: string, data: string): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#nip44decrypt-1) #### Parameters * pubkey: string * data: string #### Returns Promise ### nip44Encrypt[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#nip44encrypt) * nip44Encrypt(pubkey: string, plaintext: string): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#nip44encrypt-1) #### Parameters * pubkey: string * plaintext: string #### Returns Promise ### rejectPending[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#rejectpending) * rejectPending(): void[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#rejectpending-1) Reject the currently pending request #### Returns void ### signEvent[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#signevent) * signEvent(draft: EventTemplate & { pubkey?: string }): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#signevent-1) #### Parameters * draft: EventTemplate & { pubkey?: string } #### Returns Promise ### `Static`createGetPublicKeyIntent[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#creategetpublickeyintent) * createGetPublicKeyIntent(): string[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#creategetpublickeyintent-1) #### Returns string ### `Static`createNip04DecryptIntent[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#createnip04decryptintent) * createNip04DecryptIntent(pubkey: string, ciphertext: string): string[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#createnip04decryptintent-1) #### Parameters * pubkey: string * ciphertext: string #### Returns string ### `Static`createNip04EncryptIntent[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#createnip04encryptintent) * createNip04EncryptIntent(pubkey: string, plainText: string): string[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#createnip04encryptintent-1) #### Parameters * pubkey: string * plainText: string #### Returns string ### `Static`createNip44DecryptIntent[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#createnip44decryptintent) * createNip44DecryptIntent(pubkey: string, ciphertext: string): string[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#createnip44decryptintent-1) #### Parameters * pubkey: string * ciphertext: string #### Returns string ### `Static`createNip44EncryptIntent[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#createnip44encryptintent) * createNip44EncryptIntent(pubkey: string, plainText: string): string[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#createnip44encryptintent-1) #### Parameters * pubkey: string * plainText: string #### Returns string ### `Static`createSignEventIntent[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#createsigneventintent) * createSignEventIntent(draft: EventTemplate): string[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#createsigneventintent-1) #### Parameters * draft: EventTemplate #### Returns string ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Constructors [constructor](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#constructor) Properties [nip04](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#nip04) [nip44](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#nip44) [pubkey](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#pubkey) [verifyEvent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#verifyevent) [SUPPORTED](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#supported) Methods [destroy](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#destroy) [getPublicKey](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#getpublickey) [nip04Decrypt](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#nip04decrypt) [nip04Encrypt](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#nip04encrypt) [nip44Decrypt](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#nip44decrypt) [nip44Encrypt](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#nip44encrypt) [rejectPending](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#rejectpending) [signEvent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#signevent) [createGetPublicKeyIntent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#creategetpublickeyintent) [createNip04DecryptIntent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#createnip04decryptintent) [createNip04EncryptIntent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#createnip04encryptintent) [createNip44DecryptIntent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#createnip44decryptintent) [createNip44EncryptIntent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#createnip44encryptintent) [createSignEventIntent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html#createsigneventintent) --- # links | AppleSauce * [applesauce-content](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.html) * [Text](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Text.html) * [links](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-content.Text.links.html) Function links ============== * links(): Transformer<[Root](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Root.html) \>[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-content.Text.links.html#links) Finds and creates web links in the tree #### Returns Transformer<[Root](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Root.html) \> ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # nostrMentions | AppleSauce * [applesauce-content](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.html) * [Text](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Text.html) * [nostrMentions](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-content.Text.nostrMentions.html) Function nostrMentions ====================== * nostrMentions(): Transformer<[Root](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Root.html) \>[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-content.Text.nostrMentions.html#nostrmentions) Finds and creates NIP-19 nostr mentions in the tree #### Returns Transformer<[Root](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Root.html) \> ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # useEventFactory | AppleSauce * [applesauce-react](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-react.html) * [Hooks](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-react.Hooks.html) * [useEventFactory](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-react.Hooks.useEventFactory.html) Function useEventFactory ======================== * useEventFactory(require: false): undefined | [EventFactory](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-react.Hooks.useEventFactory.html#useeventfactory) #### Parameters * require: false #### Returns undefined | [EventFactory](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html) * useEventFactory(require: true): [EventFactory](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-react.Hooks.useEventFactory.html#useeventfactory-1) #### Parameters * require: true #### Returns [EventFactory](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html) * useEventFactory(): [EventFactory](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-react.Hooks.useEventFactory.html#useeventfactory-2) #### Returns [EventFactory](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # useActiveAccount | AppleSauce * [applesauce-react](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-react.html) * [Hooks](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-react.Hooks.html) * [useActiveAccount](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-react.Hooks.useActiveAccount.html) Function useActiveAccount ========================= * useActiveAccount(): undefined | [IAccount](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html) <[ISigner](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.ISigner.html) , any, any\>[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-react.Hooks.useActiveAccount.html#useactiveaccount) #### Returns undefined | [IAccount](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html) <[ISigner](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.ISigner.html) , any, any\> ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # useAccountManager | AppleSauce * [applesauce-react](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-react.html) * [Hooks](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-react.Hooks.html) * [useAccountManager](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-react.Hooks.useAccountManager.html) Function useAccountManager ========================== * useAccountManager(): [AccountManager](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-react.Hooks.useAccountManager.html#useaccountmanager) #### Returns [AccountManager](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html) * useAccountManager(require: false): undefined | [AccountManager](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-react.Hooks.useAccountManager.html#useaccountmanager-1) #### Parameters * require: false #### Returns undefined | [AccountManager](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html) * useAccountManager(require: true): [AccountManager](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-react.Hooks.useAccountManager.html#useaccountmanager-2) #### Parameters * require: true #### Returns [AccountManager](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # isValidProfile | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [isValidProfile](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isValidProfile.html) Function isValidProfile ======================= * isValidProfile(profile?: Event): boolean[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isValidProfile.html#isvalidprofile) Checks if the content of the kind 0 event is valid JSON #### Parameters * `Optional`profile: Event #### Returns boolean ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # hashtags | AppleSauce * [applesauce-content](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.html) * [Text](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Text.html) * [hashtags](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-content.Text.hashtags.html) Function hashtags ================= * hashtags(): Transformer<[Root](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Root.html) \>[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-content.Text.hashtags.html#hashtags) Find and create hashtag notes in provided tree #### Returns Transformer<[Root](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Root.html) \> ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # emojis | AppleSauce * [applesauce-content](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.html) * [Text](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Text.html) * [emojis](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-content.Text.emojis.html) Function emojis =============== * emojis(): Transformer<[Root](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Root.html) \>[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-content.Text.emojis.html#emojis) Finds and creates emoji nodes in the tree #### Returns Transformer<[Root](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Root.html) \> ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # addSeenRelay | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [addSeenRelay](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.addSeenRelay.html) Function addSeenRelay ===================== * addSeenRelay(event: Event, relay: string): Set[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.addSeenRelay.html#addseenrelay) Marks an event as being seen on a relay #### Parameters * event: Event * relay: string #### Returns Set ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # Link | AppleSauce * [applesauce-content](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.html) * [Nast](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Nast.html) * [Link](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Link.html) Interface Link ============== interface Link {     [data](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Link.html#data) ?: [CommonData](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.CommonData.html) ;     [href](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Link.html#href) : string;     [position](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Link.html#position) ?: Position;     [type](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Link.html#type) : "link";     [value](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Link.html#value) : string; } #### Hierarchy ([View Summary](https://hzrd149.github.io/applesauce/typedoc/hierarchy.html#applesauce-content.Nast.Link) ) * [Node](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Node.html) * Link ##### Index ### Properties [data?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Link.html#data) [href](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Link.html#href) [position?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Link.html#position) [type](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Link.html#type) [value](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Link.html#value) Properties ---------- ### `Optional`data[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Link.html#data) data?: [CommonData](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.CommonData.html) ### href[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Link.html#href) href: string ### `Optional`position[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Link.html#position) position?: Position Position of a node in a source document. Nodes that are generated (not in the original source document) must not have a position. ### type[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Link.html#type) type: "link" Node type. ### value[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Link.html#value) value: string ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [data](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Link.html#data) [href](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Link.html#href) [position](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Link.html#position) [type](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Link.html#type) [value](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Link.html#value) --- # Hashtag | AppleSauce * [applesauce-content](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.html) * [Nast](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Nast.html) * [Hashtag](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Hashtag.html) Interface Hashtag ================= interface Hashtag {     [data](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Hashtag.html#data) ?: [CommonData](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.CommonData.html) ;     [hashtag](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Hashtag.html#hashtag) : string;     [name](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Hashtag.html#name) : string;     [position](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Hashtag.html#position) ?: Position;     [tag](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Hashtag.html#tag) ?: \["t", ...string\[\]\];     [type](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Hashtag.html#type) : "hashtag"; } #### Hierarchy ([View Summary](https://hzrd149.github.io/applesauce/typedoc/hierarchy.html#applesauce-content.Nast.Hashtag) ) * [Node](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Node.html) * Hashtag ##### Index ### Properties [data?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Hashtag.html#data) [hashtag](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Hashtag.html#hashtag) [name](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Hashtag.html#name) [position?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Hashtag.html#position) [tag?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Hashtag.html#tag) [type](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Hashtag.html#type) Properties ---------- ### `Optional`data[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Hashtag.html#data) data?: [CommonData](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.CommonData.html) ### hashtag[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Hashtag.html#hashtag) hashtag: string The lowercase canonical name ### name[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Hashtag.html#name) name: string The name as it was written in the event ### `Optional`position[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Hashtag.html#position) position?: Position Position of a node in a source document. Nodes that are generated (not in the original source document) must not have a position. ### `Optional`tag[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Hashtag.html#tag) tag?: \["t", ...string\[\]\] The indexable tag for the hashtag. will be undefined if none was found ### type[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Hashtag.html#type) type: "hashtag" Node type. ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [data](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Hashtag.html#data) [hashtag](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Hashtag.html#hashtag) [name](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Hashtag.html#name) [position](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Hashtag.html#position) [tag](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Hashtag.html#tag) [type](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Hashtag.html#type) --- # Nip07Interface | AppleSauce * [applesauce-signers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.html) * [Nip07Interface](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Nip07Interface.html) Type Alias Nip07Interface ========================= Nip07Interface: [ISigner](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.ISigner.html) #### Deprecated[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Nip07Interface.html#deprecated) Use ISigner instead ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # ReadonlySigner | AppleSauce * [applesauce-signers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.html) * [ReadonlySigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ReadonlySigner.html) Class ReadonlySigner ==================== A signer that only implements getPublicKey and throws on ever other method #### Implements * [ISigner](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.ISigner.html) ##### Index ### Constructors [constructor](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ReadonlySigner.html#constructor) ### Properties [nip04](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ReadonlySigner.html#nip04) [nip44](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ReadonlySigner.html#nip44) ### Methods [getPublicKey](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ReadonlySigner.html#getpublickey) [nip04Decrypt](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ReadonlySigner.html#nip04decrypt) [nip04Encrypt](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ReadonlySigner.html#nip04encrypt) [nip44Decrypt](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ReadonlySigner.html#nip44decrypt) [nip44Encrypt](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ReadonlySigner.html#nip44encrypt) [signEvent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ReadonlySigner.html#signevent) [fromPubkey](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ReadonlySigner.html#frompubkey) Constructors ------------ ### constructor[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ReadonlySigner.html#constructor) * new ReadonlySigner(pubkey: string): [ReadonlySigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ReadonlySigner.html) [](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ReadonlySigner.html#constructorreadonlysigner) #### Parameters * pubkey: string #### Returns [ReadonlySigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ReadonlySigner.html) Properties ---------- ### nip04[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ReadonlySigner.html#nip04) nip04: {     decrypt: (pubkey: string, ciphertext: string) \=> Promise;     encrypt: (pubkey: string, plaintext: string) \=> Promise; } ### nip44[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ReadonlySigner.html#nip44) nip44: {     decrypt: (pubkey: string, ciphertext: string) \=> Promise;     encrypt: (pubkey: string, plaintext: string) \=> Promise; } Methods ------- ### getPublicKey[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ReadonlySigner.html#getpublickey) * getPublicKey(): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ReadonlySigner.html#getpublickey-1) #### Returns Promise ### nip04Decrypt[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ReadonlySigner.html#nip04decrypt) * nip04Decrypt(): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ReadonlySigner.html#nip04decrypt-1) #### Returns Promise ### nip04Encrypt[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ReadonlySigner.html#nip04encrypt) * nip04Encrypt(): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ReadonlySigner.html#nip04encrypt-1) #### Returns Promise ### nip44Decrypt[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ReadonlySigner.html#nip44decrypt) * nip44Decrypt(): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ReadonlySigner.html#nip44decrypt-1) #### Returns Promise ### nip44Encrypt[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ReadonlySigner.html#nip44encrypt) * nip44Encrypt(): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ReadonlySigner.html#nip44encrypt-1) #### Returns Promise ### signEvent[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ReadonlySigner.html#signevent) * signEvent(): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ReadonlySigner.html#signevent-1) #### Returns Promise ### `Static`fromPubkey[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ReadonlySigner.html#frompubkey) * fromPubkey(pubkey: string): [ReadonlySigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ReadonlySigner.html) [](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ReadonlySigner.html#frompubkey-1) Creates a ReadonlySigner from a hex public key or NIP-19 npub #### Parameters * pubkey: string #### Returns [ReadonlySigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ReadonlySigner.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Constructors [constructor](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ReadonlySigner.html#constructor) Properties [nip04](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ReadonlySigner.html#nip04) [nip44](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ReadonlySigner.html#nip44) Methods [getPublicKey](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ReadonlySigner.html#getpublickey) [nip04Decrypt](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ReadonlySigner.html#nip04decrypt) [nip04Encrypt](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ReadonlySigner.html#nip04encrypt) [nip44Decrypt](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ReadonlySigner.html#nip44decrypt) [nip44Encrypt](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ReadonlySigner.html#nip44encrypt) [signEvent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ReadonlySigner.html#signevent) [fromPubkey](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ReadonlySigner.html#frompubkey) --- # getCommentReplyPointer | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [getCommentReplyPointer](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getCommentReplyPointer.html) Function getCommentReplyPointer =============================== * getCommentReplyPointer(comment: Event): null | [CommentPointer](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.CommentPointer.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getCommentReplyPointer.html#getcommentreplypointer) Returns the reply pointer for a comment #### Parameters * comment: Event #### Returns null | [CommentPointer](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.CommentPointer.html) #### Throws[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getCommentReplyPointer.html#throws) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # galleries | AppleSauce * [applesauce-content](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.html) * [Text](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Text.html) * [galleries](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-content.Text.galleries.html) Function galleries ================== * galleries(types?: string\[\]): Transformer<[Root](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Root.html) \>[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-content.Text.galleries.html#galleries) Group images into galleries in an ATS tree #### Parameters * types: string\[\] = IMAGE\_EXT #### Returns Transformer<[Root](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Root.html) \> ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # getSeenRelays | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [getSeenRelays](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getSeenRelays.html) Function getSeenRelays ====================== * getSeenRelays(event: Event): undefined | Set[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getSeenRelays.html#getseenrelays) Returns the set of relays this event was seen on #### Parameters * event: Event #### Returns undefined | Set ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # getProfileContent | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [getProfileContent](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getProfileContent.html) Function getProfileContent ========================== * getProfileContent(event: Event): [ProfileContent](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ProfileContent.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getProfileContent.html#getprofilecontent) Returns the parsed profile content for a kind 0 event #### Parameters * event: Event #### Returns [ProfileContent](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ProfileContent.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # lightningInvoices | AppleSauce * [applesauce-content](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.html) * [Text](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Text.html) * [lightningInvoices](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-content.Text.lightningInvoices.html) Function lightningInvoices ========================== * lightningInvoices(): Transformer<[Root](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Root.html) \>[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-content.Text.lightningInvoices.html#lightninginvoices) Finds and creates lightning invoice nodes in the tree #### Returns Transformer<[Root](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Root.html) \> ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # getZapRecipient | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [getZapRecipient](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getZapRecipient.html) Function getZapRecipient ======================== * getZapRecipient(zap: Event): string[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getZapRecipient.html#getzaprecipient) Gets the receivers pubkey #### Parameters * zap: Event #### Returns string #### Throws[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getZapRecipient.html#throws) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # isValidZap | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [isValidZap](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isValidZap.html) Function isValidZap =================== * isValidZap(zap?: Event): boolean[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isValidZap.html#isvalidzap) Checks if the zap is valid DOES NOT validate LNURL address #### Parameters * `Optional`zap: Event #### Returns boolean ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # Emoji | AppleSauce * [applesauce-content](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.html) * [Nast](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Nast.html) * [Emoji](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Emoji.html) Interface Emoji =============== interface Emoji {     [code](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Emoji.html#code) : string;     [data](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Emoji.html#data) ?: [CommonData](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.CommonData.html) ;     [position](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Emoji.html#position) ?: Position;     [raw](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Emoji.html#raw) : string;     [tag](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Emoji.html#tag) : \["emoji", ...string\[\]\];     [type](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Emoji.html#type) : "emoji";     [url](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Emoji.html#url) : string; } #### Hierarchy ([View Summary](https://hzrd149.github.io/applesauce/typedoc/hierarchy.html#applesauce-content.Nast.Emoji) ) * [Node](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Node.html) * Emoji ##### Index ### Properties [code](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Emoji.html#code) [data?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Emoji.html#data) [position?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Emoji.html#position) [raw](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Emoji.html#raw) [tag](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Emoji.html#tag) [type](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Emoji.html#type) [url](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Emoji.html#url) Properties ---------- ### code[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Emoji.html#code) code: string ### `Optional`data[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Emoji.html#data) data?: [CommonData](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.CommonData.html) ### `Optional`position[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Emoji.html#position) position?: Position Position of a node in a source document. Nodes that are generated (not in the original source document) must not have a position. ### raw[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Emoji.html#raw) raw: string ### tag[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Emoji.html#tag) tag: \["emoji", ...string\[\]\] ### type[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Emoji.html#type) type: "emoji" Node type. ### url[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Emoji.html#url) url: string ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [code](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Emoji.html#code) [data](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Emoji.html#data) [position](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Emoji.html#position) [raw](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Emoji.html#raw) [tag](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Emoji.html#tag) [type](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Emoji.html#type) [url](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Emoji.html#url) --- # getZapAddressPointer | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [getZapAddressPointer](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getZapAddressPointer.html) Function getZapAddressPointer ============================= * getZapAddressPointer(zap: Event): null | AddressPointer[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getZapAddressPointer.html#getzapaddresspointer) Gets the AddressPointer that was zapped #### Parameters * zap: Event #### Returns null | AddressPointer ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # getZapSender | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [getZapSender](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getZapSender.html) Function getZapSender ===================== * getZapSender(zap: Event): string[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getZapSender.html#getzapsender) Returns the senders pubkey #### Parameters * zap: Event #### Returns string ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # getZapEventPointer | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [getZapEventPointer](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getZapEventPointer.html) Function getZapEventPointer =========================== * getZapEventPointer(zap: Event): null | EventPointer[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getZapEventPointer.html#getzapeventpointer) Gets the EventPointer that was zapped #### Parameters * zap: Event #### Returns null | EventPointer ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # getZapRequest | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [getZapRequest](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getZapRequest.html) Function getZapRequest ====================== * getZapRequest(zap: Event): Event[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getZapRequest.html#getzaprequest) Returns the zap request event inside the zap receipt #### Parameters * zap: Event #### Returns Event #### Throws[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getZapRequest.html#throws) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # Gallery | AppleSauce * [applesauce-content](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.html) * [Nast](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Nast.html) * [Gallery](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Gallery.html) Interface Gallery ================= interface Gallery {     [data](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Gallery.html#data) ?: [CommonData](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.CommonData.html) ;     [links](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Gallery.html#links) : string\[\];     [position](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Gallery.html#position) ?: Position;     [type](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Gallery.html#type) : "gallery"; } #### Hierarchy ([View Summary](https://hzrd149.github.io/applesauce/typedoc/hierarchy.html#applesauce-content.Nast.Gallery) ) * [Node](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Node.html) * Gallery ##### Index ### Properties [data?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Gallery.html#data) [links](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Gallery.html#links) [position?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Gallery.html#position) [type](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Gallery.html#type) Properties ---------- ### `Optional`data[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Gallery.html#data) data?: [CommonData](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.CommonData.html) ### links[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Gallery.html#links) links: string\[\] ### `Optional`position[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Gallery.html#position) position?: Position Position of a node in a source document. Nodes that are generated (not in the original source document) must not have a position. ### type[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Gallery.html#type) type: "gallery" Node type. ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [data](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Gallery.html#data) [links](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Gallery.html#links) [position](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Gallery.html#position) [type](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Gallery.html#type) --- # cashuTokens | AppleSauce * [applesauce-content](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.html) * [Text](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Text.html) * [cashuTokens](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-content.Text.cashuTokens.html) Function cashuTokens ==================== * cashuTokens(): Transformer<[Root](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Root.html) \>[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-content.Text.cashuTokens.html#cashutokens) Parse cashu tokens from an ATS tree #### Returns Transformer<[Root](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Root.html) \> ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # getProfilePointerFromPTag | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [getProfilePointerFromPTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getProfilePointerFromPTag.html) Function getProfilePointerFromPTag ================================== * getProfilePointerFromPTag(tag: string\[\]): ProfilePointer[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getProfilePointerFromPTag.html#getprofilepointerfromptag) Gets a ProfilePointer from a common "p" tag #### Parameters * tag: string\[\] #### Returns ProfilePointer #### Throws[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getProfilePointerFromPTag.html#throws) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # getAddressPointerFromATag | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [getAddressPointerFromATag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getAddressPointerFromATag.html) Function getAddressPointerFromATag ================================== * getAddressPointerFromATag(tag: string\[\]): AddressPointer[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getAddressPointerFromATag.html#getaddresspointerfromatag) Get an AddressPointer from a common "a" tag #### Parameters * tag: string\[\] #### Returns AddressPointer #### Throws[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getAddressPointerFromATag.html#throws) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # getEventPointerFromETag | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [getEventPointerFromETag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getEventPointerFromETag.html) Function getEventPointerFromETag ================================ * getEventPointerFromETag(tag: string\[\]): EventPointer[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getEventPointerFromETag.html#geteventpointerfrometag) Gets an EventPointer form a common "e" tag #### Parameters * tag: string\[\] #### Returns EventPointer #### Throws[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getEventPointerFromETag.html#throws) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # getEventPointerFromQTag | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [getEventPointerFromQTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getEventPointerFromQTag.html) Function getEventPointerFromQTag ================================ * getEventPointerFromQTag(tag: string\[\]): EventPointer[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getEventPointerFromQTag.html#geteventpointerfromqtag) Gets an EventPointer form a common "q" tag #### Parameters * tag: string\[\] #### Returns EventPointer #### Throws[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getEventPointerFromQTag.html#throws) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # parseLNURLOrAddress | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [parseLNURLOrAddress](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.parseLNURLOrAddress.html) Function parseLNURLOrAddress ============================ * parseLNURLOrAddress(addressOrLNURL: string): undefined | URL[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.parseLNURLOrAddress.html#parselnurloraddress) #### Parameters * addressOrLNURL: string #### Returns undefined | URL ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # getDeleteIds | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [getDeleteIds](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getDeleteIds.html) Function getDeleteIds ===================== * getDeleteIds(deleteEvent: Event): string\[\][](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getDeleteIds.html#getdeleteids) #### Parameters * deleteEvent: Event #### Returns string\[\] ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # getAddressPointerForEvent | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [getAddressPointerForEvent](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getAddressPointerForEvent.html) Function getAddressPointerForEvent ================================== * getAddressPointerForEvent(event: Event, relays?: string\[\]): AddressPointer[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getAddressPointerForEvent.html#getaddresspointerforevent) Returns an AddressPointer for a replaceable event #### Parameters * event: Event * `Optional`relays: string\[\] #### Returns AddressPointer #### Throws[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getAddressPointerForEvent.html#throws) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # getDeleteCoordinates | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [getDeleteCoordinates](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getDeleteCoordinates.html) Function getDeleteCoordinates ============================= * getDeleteCoordinates(deleteEvent: Event): string\[\][](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getDeleteCoordinates.html#getdeletecoordinates) #### Parameters * deleteEvent: Event #### Returns string\[\] ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # Mention | AppleSauce * [applesauce-content](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.html) * [Nast](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Nast.html) * [Mention](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Mention.html) Interface Mention ================= interface Mention {     [data](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Mention.html#data) ?: [CommonData](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.CommonData.html) ;     [decoded](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Mention.html#decoded) :         | { data: EventPointer; type: "nevent" }         | { data: ProfilePointer; type: "nprofile" }         | { data: AddressPointer; type: "naddr" }         | { data: string; type: "npub" }         | { data: Uint8Array; type: "nsec" }         | { data: string; type: "note" };     [encoded](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Mention.html#encoded) : string;     [position](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Mention.html#position) ?: Position;     [type](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Mention.html#type) : "mention"; } #### Hierarchy ([View Summary](https://hzrd149.github.io/applesauce/typedoc/hierarchy.html#applesauce-content.Nast.Mention) ) * [Node](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Node.html) * Mention ##### Index ### Properties [data?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Mention.html#data) [decoded](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Mention.html#decoded) [encoded](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Mention.html#encoded) [position?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Mention.html#position) [type](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Mention.html#type) Properties ---------- ### `Optional`data[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Mention.html#data) data?: [CommonData](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.CommonData.html) ### decoded[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Mention.html#decoded) decoded:     | { data: EventPointer; type: "nevent" }     | { data: ProfilePointer; type: "nprofile" }     | { data: AddressPointer; type: "naddr" }     | { data: string; type: "npub" }     | { data: Uint8Array; type: "nsec" }     | { data: string; type: "note" } ### encoded[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Mention.html#encoded) encoded: string ### `Optional`position[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Mention.html#position) position?: Position Position of a node in a source document. Nodes that are generated (not in the original source document) must not have a position. ### type[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Mention.html#type) type: "mention" Node type. ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [data](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Mention.html#data) [decoded](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Mention.html#decoded) [encoded](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Mention.html#encoded) [position](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Mention.html#position) [type](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Mention.html#type) --- # getPackName | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [getPackName](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getPackName.html) Function getPackName ==================== * getPackName(pack: Event): undefined | string[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getPackName.html#getpackname) Returns the name of a NIP-30 emoji pack #### Parameters * pack: Event #### Returns undefined | string ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # parseBolt11 | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [parseBolt11](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.parseBolt11.html) Function parseBolt11 ==================== * parseBolt11(paymentRequest: string): [ParsedInvoice](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ParsedInvoice.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.parseBolt11.html#parsebolt11) Parses a lightning invoice #### Parameters * paymentRequest: string #### Returns [ParsedInvoice](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ParsedInvoice.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # getEmojiTag | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [getEmojiTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getEmojiTag.html) Function getEmojiTag ==================== * getEmojiTag(     tags: string\[\]\[\] | { tags: string\[\]\[\] },     code: string, ): undefined | \["emoji", string, string\][](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getEmojiTag.html#getemojitag) Gets an "emoji" tag that matches an emoji code #### Parameters * tags: string\[\]\[\] | { tags: string\[\]\[\] } * code: string #### Returns undefined | \["emoji", string, string\] ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # getInboxes | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [getInboxes](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getInboxes.html) Function getInboxes =================== * getInboxes(event: Event): string\[\][](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getInboxes.html#getinboxes) Parses a 10002 event and stores the inboxes in the event using the [MailboxesInboxesSymbol](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.MailboxesInboxesSymbol.html) symbol #### Parameters * event: Event #### Returns string\[\] ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # useRenderedContent | AppleSauce * [applesauce-react](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-react.html) * [Hooks](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-react.Hooks.html) * [useRenderedContent](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-react.Hooks.useRenderedContent.html) Function useRenderedContent =========================== * useRenderedContent(     event: undefined | string | Event | EventTemplate,     components: [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-react.Helpers.html) .[ComponentMap](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-react.Helpers.ComponentMap.html) ,     opts?: Options, ): null | Element[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-react.Hooks.useRenderedContent.html#userenderedcontent) Returns the parsed and render text content for an event #### Parameters * event: undefined | string | Event | EventTemplate * components: [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-react.Helpers.html) .[ComponentMap](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-react.Helpers.ComponentMap.html) * `Optional`opts: Options #### Returns null | Element ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # getURLFilename | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [getURLFilename](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getURLFilename.html) Function getURLFilename ======================= * getURLFilename(url: URL): undefined | string[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getURLFilename.html#geturlfilename) #### Parameters * url: URL #### Returns undefined | string ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # isAudioURL | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [isAudioURL](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isAudioURL.html) Function isAudioURL =================== * isAudioURL(url: string | URL): boolean[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isAudioURL.html#isaudiourl) Checks if a url is a audio URL #### Parameters * url: string | URL #### Returns boolean ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # isImageURL | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [isImageURL](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isImageURL.html) Function isImageURL =================== * isImageURL(url: string | URL): boolean[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isImageURL.html#isimageurl) Checks if a url is a image URL #### Parameters * url: string | URL #### Returns boolean ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # isVideoURL | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [isVideoURL](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isVideoURL.html) Function isVideoURL =================== * isVideoURL(url: string | URL): boolean[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isVideoURL.html#isvideourl) Checks if a url is a video URL #### Parameters * url: string | URL #### Returns boolean ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # applesauce-wallet | AppleSauce * [applesauce-wallet](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.html) Module applesauce-wallet ======================== Applesauce Wallet[](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.html#applesauce-wallet) =================================================================================================================== The `applesauce-wallet` package is a package of helpers, models, blueprints and other useful stuff for [NIP-60](https://github.com/nostr-protocol/nips/blob/master/60.md) wallets and [NIP-61](https://github.com/nostr-protocol/nips/blob/master/61.md) nutzaps Namespaces ---------- [Actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.Actions.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.html#actions) [Blueprints](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.Blueprints.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.html#blueprints) [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.Helpers.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.html#helpers) [Models](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.Models.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.html#models) [Operations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.Operations.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.html#operations) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page [Applesauce Wallet](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.html#applesauce-wallet) Namespaces [Actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.html#actions) [Blueprints](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.html#blueprints) [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.html#helpers) [Models](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.html#models) [Operations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.html#operations) --- # applesauce-signers | AppleSauce * [applesauce-signers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.html) Module applesauce-signers ========================= applesauce-signer[](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.html#applesauce-signer) ==================================================================================================================== A collection of signer classes for applesauce that are compatible with the [NIP-07](https://github.com/nostr-protocol/nips/blob/master/07.md) API. Documentation[](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.html#documentation) ------------------------------------------------------------------------------------------------------------ For detailed documentation and API reference, see: * [Signers Documentation](https://hzrd149.github.io/applesauce/signers/signers.html) * [Nostr Connect Documentation](https://hzrd149.github.io/applesauce/signers/nostr-connect.html) * [API Reference](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.html) Available Signers[](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.html#available-signers) -------------------------------------------------------------------------------------------------------------------- ### Password Signer (NIP-49)[](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.html#password-signer-nip-49) A secure signer that encrypts private keys using [NIP-49](https://github.com/nostr-protocol/nips/blob/master/49.md) . // Create a new password signerconst signer = new PasswordSigner();// Set up with a new key and passwordconst randomBytes = new Uint8Array(64);window.crypto.getRandomValues(randomBytes);signer.key = randomBytes;signer.setPassword("your-password");// Unlock the signer when neededawait signer.unlock("your-password"); ### Simple Signer[](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.html#simple-signer) A basic signer that holds the secret key in memory with NIP-04 and NIP-44 encryption support. // Create new signer with random keyconst signer = new SimpleSigner();// Or import existing keyconst key = new Uint8Array(32);window.crypto.getRandomValues(key);const signer = new SimpleSigner(key); ### Nostr Connect Signer (NIP-46)[](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.html#nostr-connect-signer-nip-46) A client-side implementation for remote signing using [NIP-46](https://github.com/nostr-protocol/nips/blob/master/46.md) . // First, set up the required relay communication methodsimport { Observable } from "rxjs";// Define subscription method for receiving eventsconst subscriptionMethod = (filters, relays) => { return new Observable((observer) => { // Create subscription to relays const cleanup = subscribeToRelays(relays, filters, (event) => { observer.next(event); }); return () => cleanup(); });};// Define publish method for sending eventsconst publishMethod = async (event, relays) => { for (const relay of relays) await publishToRelay(relay, event);};// You can set these methods globally at app initializationNostrConnectSigner.subscriptionMethod = subscriptionMethod;NostrConnectSigner.publishMethod = publishMethod;// Now create and use the signerconst signer = new NostrConnectSigner({ remote: "", relays: ["wss://relay.example.com"], // Or pass methods directly to the constructor subscriptionMethod, publishMethod,});// Create a connection URI for your appconst uri = signer.getNostrConnectURI({ name: "My App", url: "https://example.com", permissions: NostrConnectSigner.buildSigningPermissions([0, 1, 3]),});// Connect using bunker URIconst bunkerSigner = await NostrConnectSigner.fromBunkerURI("bunker://...your-uri-here...", { permissions: NostrConnectSigner.buildSigningPermissions([0, 1, 3]),}); ### Other Signers[](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.html#other-signers) * **Serial Port Signer**: For hardware signing devices (Chrome browsers only) * **Amber Clipboard Signer**: Integration with Amber wallet's web API Namespaces ---------- [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.Helpers.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.html#helpers) Classes ------- [AmberClipboardSigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.html#amberclipboardsigner) [ExtensionMissingError](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ExtensionMissingError.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.html#extensionmissingerror) [ExtensionSigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ExtensionSigner.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.html#extensionsigner) [NostrConnectProvider](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.html#nostrconnectprovider) [NostrConnectSigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.html#nostrconnectsigner) [PasswordSigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.html#passwordsigner) [ReadonlySigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ReadonlySigner.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.html#readonlysigner) [SerialPortSigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.html#serialportsigner) [SimpleSigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SimpleSigner.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.html#simplesigner) Interfaces ---------- [ProviderAuthorization](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-signers.ProviderAuthorization.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.html#providerauthorization) Type Aliases ------------ [ISigner](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.ISigner.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.html#isigner) [Nip07Interface](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Nip07Interface.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.html#nip07interface) [NostrConnectProviderOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.NostrConnectProviderOptions.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.html#nostrconnectprovideroptions) [NostrConnectSignerOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.NostrConnectSignerOptions.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.html#nostrconnectsigneroptions) [NostrPool](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.NostrPool.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.html#nostrpool) [NostrPublishMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.NostrPublishMethod.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.html#nostrpublishmethod) [NostrSubscriptionMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.NostrSubscriptionMethod.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.html#nostrsubscriptionmethod) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page [applesauce-signer](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.html#applesauce-signer) * [Documentation](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.html#documentation) * [Available Signers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.html#available-signers) * * [Password Signer (NIP-49)](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.html#password-signer-nip-49) * [Simple Signer](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.html#simple-signer) * [Nostr Connect Signer (NIP-46)](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.html#nostr-connect-signer-nip-46) * [Other Signers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.html#other-signers) Namespaces [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.html#helpers) Classes [AmberClipboardSigner](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.html#amberclipboardsigner) [ExtensionMissingError](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.html#extensionmissingerror) [ExtensionSigner](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.html#extensionsigner) [NostrConnectProvider](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.html#nostrconnectprovider) [NostrConnectSigner](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.html#nostrconnectsigner) [PasswordSigner](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.html#passwordsigner) [ReadonlySigner](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.html#readonlysigner) [SerialPortSigner](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.html#serialportsigner) [SimpleSigner](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.html#simplesigner) Interfaces [ProviderAuthorization](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.html#providerauthorization) Type Aliases [ISigner](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.html#isigner) [Nip07Interface](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.html#nip07interface) [NostrConnectProviderOptions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.html#nostrconnectprovideroptions) [NostrConnectSignerOptions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.html#nostrconnectsigneroptions) [NostrPool](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.html#nostrpool) [NostrPublishMethod](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.html#nostrpublishmethod) [NostrSubscriptionMethod](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.html#nostrsubscriptionmethod) --- # getOutboxes | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [getOutboxes](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getOutboxes.html) Function getOutboxes ==================== * getOutboxes(event: Event): string\[\][](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getOutboxes.html#getoutboxes) Parses a 10002 event and stores the outboxes in the event using the [MailboxesOutboxesSymbol](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.MailboxesOutboxesSymbol.html) symbol #### Parameters * event: Event #### Returns string\[\] ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # getCommentRootPointer | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [getCommentRootPointer](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getCommentRootPointer.html) Function getCommentRootPointer ============================== * getCommentRootPointer(comment: Event): null | [CommentPointer](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.CommentPointer.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getCommentRootPointer.html#getcommentrootpointer) Returns the root pointer for a comment #### Parameters * comment: Event #### Returns null | [CommentPointer](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.CommentPointer.html) #### Throws[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getCommentRootPointer.html#throws) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # isStreamURL | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [isStreamURL](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isStreamURL.html) Function isStreamURL ==================== * isStreamURL(url: string | URL): boolean[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isStreamURL.html#isstreamurl) Checks if a url is a stream URL #### Parameters * url: string | URL #### Returns boolean ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # isETag | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [isETag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isETag.html) Function isETag =============== * isETag(tag: string\[\]): tag is \["e", string, ...string\[\]\][](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isETag.html#isetag) Checks if tag is an "e" tag and has at least one value #### Parameters * tag: string\[\] #### Returns tag is \["e", string, ...string\[\]\] ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # canHaveHiddenTags | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [canHaveHiddenTags](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.canHaveHiddenTags.html) Function canHaveHiddenTags ========================== * canHaveHiddenTags(kind: number): boolean[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.canHaveHiddenTags.html#canhavehiddentags) Checks if an event can have hidden tags #### Parameters * kind: number #### Returns boolean ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # isRTag | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [isRTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isRTag.html) Function isRTag =============== * isRTag(tag: string\[\]): tag is \["r", string, ...string\[\]\][](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isRTag.html#isrtag) Checks if tag is an "r" tag and has at least one value #### Parameters * tag: string\[\] #### Returns tag is \["r", string, ...string\[\]\] ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # isPTag | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [isPTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isPTag.html) Function isPTag =============== * isPTag(tag: string\[\]): tag is \["p", string, ...string\[\]\][](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isPTag.html#isptag) Checks if tag is an "p" tag and has at least one value #### Parameters * tag: string\[\] #### Returns tag is \["p", string, ...string\[\]\] ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # isTTag | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [isTTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isTTag.html) Function isTTag =============== * isTTag(tag: string\[\]): tag is \["t", string, ...string\[\]\][](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isTTag.html#isttag) Checks if tag is an "a" tag and has at least one value #### Parameters * tag: string\[\] #### Returns tag is \["t", string, ...string\[\]\] ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # isATag | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [isATag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isATag.html) Function isATag =============== * isATag(tag: string\[\]): tag is \["a", string, ...string\[\]\][](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isATag.html#isatag) Checks if tag is an "a" tag and has at least one value #### Parameters * tag: string\[\] #### Returns tag is \["a", string, ...string\[\]\] ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # isDTag | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [isDTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isDTag.html) Function isDTag =============== * isDTag(tag: string\[\]): tag is \["d", string, ...string\[\]\][](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isDTag.html#isdtag) Checks if tag is an "d" tag and has at least one value #### Parameters * tag: string\[\] #### Returns tag is \["d", string, ...string\[\]\] ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # getHiddenTags | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [getHiddenTags](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getHiddenTags.html) Function getHiddenTags ====================== * getHiddenTags<[T](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getHiddenTags.html#gethiddentagst) extends { content: string; kind: number }\>(     event: [T](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getHiddenTags.html#gethiddentagst) , ): undefined | string\[\]\[\][](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getHiddenTags.html#gethiddentags) Returns the hidden tags for an event if they are unlocked #### Type Parameters * T extends { content: string; kind: number } #### Parameters * event: [T](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getHiddenTags.html#gethiddentagst) #### Returns undefined | string\[\]\[\] ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # hasHiddenTags | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [hasHiddenTags](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.hasHiddenTags.html) Function hasHiddenTags ====================== * hasHiddenTags<[T](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.hasHiddenTags.html#hashiddentagst) extends { content: string; kind: number }\>(event: [T](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.hasHiddenTags.html#hashiddentagst) ): boolean[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.hasHiddenTags.html#hashiddentags) Checks if an event has hidden tags #### Type Parameters * T extends { content: string; kind: number } #### Parameters * event: [T](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.hasHiddenTags.html#hashiddentagst) #### Returns boolean ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # isHiddenTagsLocked | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [isHiddenTagsLocked](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isHiddenTagsLocked.html) Function isHiddenTagsLocked =========================== * isHiddenTagsLocked<[T](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isHiddenTagsLocked.html#ishiddentagslockedt) extends object\>(event: [T](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isHiddenTagsLocked.html#ishiddentagslockedt) ): boolean[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isHiddenTagsLocked.html#ishiddentagslocked) Checks if the hidden tags are locked #### Type Parameters * T extends object #### Parameters * event: [T](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isHiddenTagsLocked.html#ishiddentagslockedt) #### Returns boolean ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # SerialPortAccount | AppleSauce * [applesauce-accounts](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.html) * [Accounts](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.Accounts.html) * [SerialPortAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html) Class SerialPortAccount ================================= An account for SerialPortSigner #### Type Parameters * Metadata extends unknown #### Hierarchy ([View Summary](https://hzrd149.github.io/applesauce/typedoc/hierarchy.html#applesauce-accounts.Accounts.SerialPortAccount) ) * [BaseAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html) <[SerialPortSigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html) , void, [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#constructorserialportaccountmetadata) \> * SerialPortAccount ##### Index ### Constructors [constructor](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#constructor) ### Properties [abort](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#abort) [disableQueue?](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#disablequeue) [id](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#id) [lock](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#lock) [metadata$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#metadata-1) [pubkey](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#pubkey) [queueLength](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#queuelength) [signer](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#signer) [type](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#type) ### Accessors [metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#metadata-2) [nip04](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#nip04) [nip44](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#nip44) [type](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#type-1) ### Methods [abortQueue](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#abortqueue) [getPublicKey](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#getpublickey) [operation](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#operation) [reduceQueue](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#reducequeue) [saveCommonFields](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#savecommonfields) [signEvent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#signevent) [toJSON](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#tojson) [unlock](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#unlock) [waitForQueue](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#waitforqueue) [fromJSON](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#fromjson) [loadCommonFields](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#loadcommonfields) Constructors ------------ ### constructor[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#constructor) * new SerialPortAccount<[Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#constructorserialportaccountmetadata) extends unknown\>(     pubkey: string,     signer: [SerialPortSigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html) , ): [SerialPortAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html) <[Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#constructorserialportaccountmetadata) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#constructorserialportaccount) #### Type Parameters * Metadata extends unknown #### Parameters * pubkey: string * signer: [SerialPortSigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html) #### Returns [SerialPortAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html) <[Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#constructorserialportaccountmetadata) \> Properties ---------- ### `Protected`abort[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#abort) abort: null | AbortController = null ### `Optional`disableQueue[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#disablequeue) disableQueue?: boolean Disable request queueing ### id[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#id) id: string = ... ### `Protected`lock[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#lock) lock: null | Promise = null ### metadata$[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#metadata-1) metadata$: BehaviorSubject = ... ### pubkey[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#pubkey) pubkey: string ### `Protected`queueLength[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#queuelength) queueLength: number = 0 internal queue ### signer[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#signer) signer: [SerialPortSigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SerialPortSigner.html) ### `Static` `Readonly`type[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#type) type: "serial-port" Accessors --------- ### metadata[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#metadata-2) * get metadata(): undefined | [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountmetadata) #### Returns undefined | [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountmetadata) * set metadata(metadata: [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountmetadata) ): void #### Parameters * metadata: [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountmetadata) #### Returns void ### nip04[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#nip04) * get nip04(): | undefined | {     decrypt: (pubkey: string, ciphertext: string) \=> Promise;     encrypt: (pubkey: string, plaintext: string) \=> Promise; } #### Returns     | undefined     | {         decrypt: (pubkey: string, ciphertext: string) \=> Promise;         encrypt: (pubkey: string, plaintext: string) \=> Promise;     } ### nip44[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#nip44) * get nip44(): | undefined | {     decrypt: (pubkey: string, ciphertext: string) \=> Promise;     encrypt: (pubkey: string, plaintext: string) \=> Promise; } #### Returns     | undefined     | {         decrypt: (pubkey: string, ciphertext: string) \=> Promise;         encrypt: (pubkey: string, plaintext: string) \=> Promise;     } ### type[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#type-1) * get type(): string #### Returns string Methods ------- ### abortQueue[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#abortqueue) * abortQueue(reason: Error): void[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#abortqueue-1) Aborts all pending requests in the queue #### Parameters * reason: Error #### Returns void ### getPublicKey[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#getpublickey) * getPublicKey(): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#getpublickey-1) Gets the pubkey from the signer #### Returns Promise ### `Protected`operation[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#operation) * operation<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#operationt) extends unknown\>(operation: () \=> Promise<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#operationt) \>): Promise<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#operationt) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#operation-1) A method that wraps any signer interaction, this allows the account to wait for unlock or queue requests #### Type Parameters * T extends unknown #### Parameters * operation: () \=> Promise<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#operationt) \> #### Returns Promise<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#operationt) \> ### `Protected`reduceQueue[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#reducequeue) * reduceQueue(): void[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#reducequeue-1) #### Returns void ### `Protected`saveCommonFields[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#savecommonfields) * saveCommonFields(     json: Omit<         [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) <[SignerData](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountsignerdata) , [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountmetadata) \>,         "id" | "type" | "metadata" | "pubkey",     \>, ): [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) [](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#savecommonfields-1) Adds the common fields to the serialized output of a toJSON method #### Parameters * json: Omit<     [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) <[SignerData](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountsignerdata) , [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountmetadata) \>,     "id" | "type" | "metadata" | "pubkey", \> #### Returns [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) ### signEvent[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#signevent) * signEvent(template: [EventTemplate](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.EventTemplate.html) ): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#signevent-1) sign the event and make sure its signed with the correct pubkey #### Parameters * template: [EventTemplate](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.EventTemplate.html) #### Returns Promise ### toJSON[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#tojson) * toJSON(): [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) [](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#tojson-1) #### Returns [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) ### unlock[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#unlock) * unlock(): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#unlock-1) #### Returns Promise ### `Protected`waitForQueue[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#waitforqueue) * waitForQueue<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#waitforqueuet) extends unknown\>(operation: () \=> Promise<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#waitforqueuet) \>): Promise<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#waitforqueuet) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#waitforqueue-1) #### Type Parameters * T extends unknown #### Parameters * operation: () \=> Promise<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#waitforqueuet) \> #### Returns Promise<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#waitforqueuet) \> ### `Static`fromJSON[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#fromjson) * fromJSON<[Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#fromjsonmetadata) extends unknown\>(     json: [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) , ): [SerialPortAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html) <[Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#fromjsonmetadata) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#fromjson-1) #### Type Parameters * Metadata extends unknown #### Parameters * json: [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) #### Returns [SerialPortAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html) <[Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#fromjsonmetadata) \> ### `Static`loadCommonFields[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#loadcommonfields) * loadCommonFields<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#loadcommonfieldst) extends [IAccount](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html) <[ISigner](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.ISigner.html) , any, any\>\>(     account: [T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#loadcommonfieldst) ,     json: [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) , ): [T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#loadcommonfieldst) [](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#loadcommonfields-1) Sets an accounts id and metadata. NOTE: This should only be used in fromJSON methods #### Type Parameters * T extends [IAccount](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html) <[ISigner](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.ISigner.html) , any, any\> #### Parameters * account: [T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#loadcommonfieldst) * json: [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) #### Returns [T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#loadcommonfieldst) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Constructors [constructor](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#constructor) Properties [abort](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#abort) [disableQueue](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#disablequeue) [id](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#id) [lock](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#lock) [metadata$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#metadata-1) [pubkey](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#pubkey) [queueLength](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#queuelength) [signer](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#signer) [type](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#type) Accessors [metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#metadata-2) [nip04](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#nip04) [nip44](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#nip44) [type](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#type-1) Methods [abortQueue](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#abortqueue) [getPublicKey](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#getpublickey) [operation](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#operation) [reduceQueue](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#reducequeue) [saveCommonFields](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#savecommonfields) [signEvent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#signevent) [toJSON](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#tojson) [unlock](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#unlock) [waitForQueue](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#waitforqueue) [fromJSON](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#fromjson) [loadCommonFields](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html#loadcommonfields) --- # isFilterEqual | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [isFilterEqual](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isFilterEqual.html) Function isFilterEqual ====================== * isFilterEqual(a: Filter | Filter\[\], b: Filter | Filter\[\]): boolean[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isFilterEqual.html#isfilterequal) Check if two filters are equal #### Parameters * a: Filter | Filter\[\] * b: Filter | Filter\[\] #### Returns boolean ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # unixNow | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [unixNow](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.unixNow.html) Function unixNow ================ * unixNow(): number[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.unixNow.html#unixnow) Returns the current unix timestamp #### Returns number ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # createQTagFromEventPointer | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html) * [createQTagFromEventPointer](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.createQTagFromEventPointer.html) Function createQTagFromEventPointer =================================== * createQTagFromEventPointer(pointer: EventPointer): string\[\][](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.createQTagFromEventPointer.html#createqtagfromeventpointer) Creates a "q" tag for an EventPointer #### Parameters * pointer: EventPointer #### Returns string\[\] ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # fillAndTrimTag | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html) * [fillAndTrimTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.fillAndTrimTag.html) Function fillAndTrimTag ======================= * fillAndTrimTag(tag: (undefined | null | string)\[\], minLength?: number): string\[\][](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.fillAndTrimTag.html#fillandtrimtag) Replaces null and undefined with "" in tags and trims them down to a set length if they ends with "" #### Parameters * tag: (undefined | null | string)\[\] * minLength: number = 2 #### Returns string\[\] ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # getZapPayment | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [getZapPayment](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getZapPayment.html) Function getZapPayment ====================== * getZapPayment(zap: Event): undefined | [ParsedInvoice](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ParsedInvoice.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getZapPayment.html#getzappayment) Returns the parsed bolt11 invoice #### Parameters * zap: Event #### Returns undefined | [ParsedInvoice](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ParsedInvoice.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # ReadonlyAccount | AppleSauce * [applesauce-accounts](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.html) * [Accounts](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.Accounts.html) * [ReadonlyAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html) Class ReadonlyAccount =============================== An account that cannot sign or encrypt anything #### Type Parameters * Metadata extends unknown #### Hierarchy ([View Summary](https://hzrd149.github.io/applesauce/typedoc/hierarchy.html#applesauce-accounts.Accounts.ReadonlyAccount) ) * [BaseAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html) <[ReadonlySigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ReadonlySigner.html) , void, [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#constructorreadonlyaccountmetadata) \> * ReadonlyAccount ##### Index ### Constructors [constructor](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#constructor) ### Properties [abort](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#abort) [disableQueue?](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#disablequeue) [id](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#id) [lock](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#lock) [metadata$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#metadata-1) [pubkey](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#pubkey) [queueLength](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#queuelength) [signer](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#signer) [type](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#type) ### Accessors [metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#metadata-2) [nip04](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#nip04) [nip44](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#nip44) [type](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#type-1) ### Methods [abortQueue](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#abortqueue) [getPublicKey](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#getpublickey) [operation](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#operation) [reduceQueue](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#reducequeue) [saveCommonFields](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#savecommonfields) [signEvent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#signevent) [toJSON](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#tojson) [waitForQueue](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#waitforqueue) [fromJSON](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#fromjson) [fromPubkey](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#frompubkey) [loadCommonFields](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#loadcommonfields) Constructors ------------ ### constructor[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#constructor) * new ReadonlyAccount<[Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#constructorreadonlyaccountmetadata) extends unknown\>(     pubkey: string,     signer: [ReadonlySigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ReadonlySigner.html) , ): [ReadonlyAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html) <[Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#constructorreadonlyaccountmetadata) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#constructorreadonlyaccount) #### Type Parameters * Metadata extends unknown #### Parameters * pubkey: string * signer: [ReadonlySigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ReadonlySigner.html) #### Returns [ReadonlyAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html) <[Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#constructorreadonlyaccountmetadata) \> Properties ---------- ### `Protected`abort[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#abort) abort: null | AbortController = null ### `Optional`disableQueue[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#disablequeue) disableQueue?: boolean Disable request queueing ### id[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#id) id: string = ... ### `Protected`lock[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#lock) lock: null | Promise = null ### metadata$[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#metadata-1) metadata$: BehaviorSubject = ... ### pubkey[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#pubkey) pubkey: string ### `Protected`queueLength[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#queuelength) queueLength: number = 0 internal queue ### signer[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#signer) signer: [ReadonlySigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ReadonlySigner.html) ### `Static` `Readonly`type[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#type) type: "readonly" Accessors --------- ### metadata[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#metadata-2) * get metadata(): undefined | [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountmetadata) #### Returns undefined | [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountmetadata) * set metadata(metadata: [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountmetadata) ): void #### Parameters * metadata: [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountmetadata) #### Returns void ### nip04[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#nip04) * get nip04(): | undefined | {     decrypt: (pubkey: string, ciphertext: string) \=> Promise;     encrypt: (pubkey: string, plaintext: string) \=> Promise; } #### Returns     | undefined     | {         decrypt: (pubkey: string, ciphertext: string) \=> Promise;         encrypt: (pubkey: string, plaintext: string) \=> Promise;     } ### nip44[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#nip44) * get nip44(): | undefined | {     decrypt: (pubkey: string, ciphertext: string) \=> Promise;     encrypt: (pubkey: string, plaintext: string) \=> Promise; } #### Returns     | undefined     | {         decrypt: (pubkey: string, ciphertext: string) \=> Promise;         encrypt: (pubkey: string, plaintext: string) \=> Promise;     } ### type[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#type-1) * get type(): string #### Returns string Methods ------- ### abortQueue[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#abortqueue) * abortQueue(reason: Error): void[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#abortqueue-1) Aborts all pending requests in the queue #### Parameters * reason: Error #### Returns void ### getPublicKey[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#getpublickey) * getPublicKey(): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#getpublickey-1) Gets the pubkey from the signer #### Returns Promise ### `Protected`operation[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#operation) * operation<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#operationt) extends unknown\>(operation: () \=> Promise<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#operationt) \>): Promise<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#operationt) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#operation-1) A method that wraps any signer interaction, this allows the account to wait for unlock or queue requests #### Type Parameters * T extends unknown #### Parameters * operation: () \=> Promise<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#operationt) \> #### Returns Promise<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#operationt) \> ### `Protected`reduceQueue[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#reducequeue) * reduceQueue(): void[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#reducequeue-1) #### Returns void ### `Protected`saveCommonFields[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#savecommonfields) * saveCommonFields(     json: Omit<         [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) <[SignerData](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountsignerdata) , [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountmetadata) \>,         "id" | "type" | "metadata" | "pubkey",     \>, ): [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) [](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#savecommonfields-1) Adds the common fields to the serialized output of a toJSON method #### Parameters * json: Omit<     [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) <[SignerData](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountsignerdata) , [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountmetadata) \>,     "id" | "type" | "metadata" | "pubkey", \> #### Returns [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) ### signEvent[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#signevent) * signEvent(template: [EventTemplate](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.EventTemplate.html) ): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#signevent-1) sign the event and make sure its signed with the correct pubkey #### Parameters * template: [EventTemplate](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.EventTemplate.html) #### Returns Promise ### toJSON[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#tojson) * toJSON(): [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) [](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#tojson-1) #### Returns [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) ### `Protected`waitForQueue[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#waitforqueue) * waitForQueue<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#waitforqueuet) extends unknown\>(operation: () \=> Promise<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#waitforqueuet) \>): Promise<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#waitforqueuet) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#waitforqueue-1) #### Type Parameters * T extends unknown #### Parameters * operation: () \=> Promise<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#waitforqueuet) \> #### Returns Promise<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#waitforqueuet) \> ### `Static`fromJSON[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#fromjson) * fromJSON<[Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#fromjsonmetadata) extends unknown\>(     json: [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) , ): [ReadonlyAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html) <[Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#fromjsonmetadata) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#fromjson-1) #### Type Parameters * Metadata extends unknown #### Parameters * json: [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) #### Returns [ReadonlyAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html) <[Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#fromjsonmetadata) \> ### `Static`fromPubkey[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#frompubkey) * fromPubkey(pubkey: string): [ReadonlyAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html) [](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#frompubkey-1) Creates a ReadonlyAccount from a hex public key or NIP-19 npub #### Parameters * pubkey: string #### Returns [ReadonlyAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html) ### `Static`loadCommonFields[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#loadcommonfields) * loadCommonFields<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#loadcommonfieldst) extends [IAccount](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html) <[ISigner](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.ISigner.html) , any, any\>\>(     account: [T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#loadcommonfieldst) ,     json: [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) , ): [T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#loadcommonfieldst) [](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#loadcommonfields-1) Sets an accounts id and metadata. NOTE: This should only be used in fromJSON methods #### Type Parameters * T extends [IAccount](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html) <[ISigner](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.ISigner.html) , any, any\> #### Parameters * account: [T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#loadcommonfieldst) * json: [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) #### Returns [T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#loadcommonfieldst) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Constructors [constructor](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#constructor) Properties [abort](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#abort) [disableQueue](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#disablequeue) [id](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#id) [lock](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#lock) [metadata$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#metadata-1) [pubkey](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#pubkey) [queueLength](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#queuelength) [signer](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#signer) [type](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#type) Accessors [metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#metadata-2) [nip04](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#nip04) [nip44](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#nip44) [type](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#type-1) Methods [abortQueue](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#abortqueue) [getPublicKey](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#getpublickey) [operation](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#operation) [reduceQueue](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#reducequeue) [saveCommonFields](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#savecommonfields) [signEvent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#signevent) [toJSON](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#tojson) [waitForQueue](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#waitforqueue) [fromJSON](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#fromjson) [fromPubkey](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#frompubkey) [loadCommonFields](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html#loadcommonfields) --- # TextNoteContentSymbol | AppleSauce * [applesauce-content](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.html) * [Text](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Text.html) * [TextNoteContentSymbol](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-content.Text.TextNoteContentSymbol.html) Variable TextNoteContentSymbol`Const` ===================================== TextNoteContentSymbol: typeof [TextNoteContentSymbol](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-content.Text.TextNoteContentSymbol.html) = ... ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # getEmojis | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [getEmojis](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getEmojis.html) Function getEmojis ================== * getEmojis(pack: Event): [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) .[Emoji](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.Emoji.html) \[\][](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getEmojis.html#getemojis) Returns an array of emojis from a NIP-30 emoji pack #### Parameters * pack: Event #### Returns [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) .[Emoji](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.Emoji.html) \[\] ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # AmberClipboardAccount | AppleSauce * [applesauce-accounts](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.html) * [Accounts](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.Accounts.html) * [AmberClipboardAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html) Class AmberClipboardAccount ===================================== An account for the amber clipboard api #### Type Parameters * Metadata extends unknown #### Hierarchy ([View Summary](https://hzrd149.github.io/applesauce/typedoc/hierarchy.html#applesauce-accounts.Accounts.AmberClipboardAccount) ) * [BaseAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html) <[AmberClipboardSigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html) , void, [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#constructoramberclipboardaccountmetadata) \> * AmberClipboardAccount ##### Index ### Constructors [constructor](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#constructor) ### Properties [abort](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#abort) [disableQueue?](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#disablequeue) [id](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#id) [lock](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#lock) [metadata$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#metadata-1) [pubkey](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#pubkey) [queueLength](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#queuelength) [signer](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#signer) [type](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#type) ### Accessors [metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#metadata-2) [nip04](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#nip04) [nip44](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#nip44) [type](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#type-1) ### Methods [abortQueue](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#abortqueue) [getPublicKey](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#getpublickey) [operation](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#operation) [reduceQueue](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#reducequeue) [saveCommonFields](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#savecommonfields) [signEvent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#signevent) [toJSON](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#tojson) [waitForQueue](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#waitforqueue) [fromJSON](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#fromjson) [loadCommonFields](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#loadcommonfields) Constructors ------------ ### constructor[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#constructor) * new AmberClipboardAccount<[Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#constructoramberclipboardaccountmetadata) extends unknown\>(     pubkey: string,     signer: [AmberClipboardSigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html) , ): [AmberClipboardAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html) <[Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#constructoramberclipboardaccountmetadata) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#constructoramberclipboardaccount) #### Type Parameters * Metadata extends unknown #### Parameters * pubkey: string * signer: [AmberClipboardSigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html) #### Returns [AmberClipboardAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html) <[Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#constructoramberclipboardaccountmetadata) \> Properties ---------- ### `Protected`abort[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#abort) abort: null | AbortController = null ### `Optional`disableQueue[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#disablequeue) disableQueue?: boolean Disable request queueing ### id[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#id) id: string = ... ### `Protected`lock[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#lock) lock: null | Promise = null ### metadata$[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#metadata-1) metadata$: BehaviorSubject = ... ### pubkey[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#pubkey) pubkey: string ### `Protected`queueLength[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#queuelength) queueLength: number = 0 internal queue ### signer[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#signer) signer: [AmberClipboardSigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.AmberClipboardSigner.html) ### `Static` `Readonly`type[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#type) type: "amber-clipboard" Accessors --------- ### metadata[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#metadata-2) * get metadata(): undefined | [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountmetadata) #### Returns undefined | [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountmetadata) * set metadata(metadata: [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountmetadata) ): void #### Parameters * metadata: [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountmetadata) #### Returns void ### nip04[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#nip04) * get nip04(): | undefined | {     decrypt: (pubkey: string, ciphertext: string) \=> Promise;     encrypt: (pubkey: string, plaintext: string) \=> Promise; } #### Returns     | undefined     | {         decrypt: (pubkey: string, ciphertext: string) \=> Promise;         encrypt: (pubkey: string, plaintext: string) \=> Promise;     } ### nip44[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#nip44) * get nip44(): | undefined | {     decrypt: (pubkey: string, ciphertext: string) \=> Promise;     encrypt: (pubkey: string, plaintext: string) \=> Promise; } #### Returns     | undefined     | {         decrypt: (pubkey: string, ciphertext: string) \=> Promise;         encrypt: (pubkey: string, plaintext: string) \=> Promise;     } ### type[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#type-1) * get type(): string #### Returns string Methods ------- ### abortQueue[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#abortqueue) * abortQueue(reason: Error): void[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#abortqueue-1) Aborts all pending requests in the queue #### Parameters * reason: Error #### Returns void ### getPublicKey[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#getpublickey) * getPublicKey(): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#getpublickey-1) Gets the pubkey from the signer #### Returns Promise ### `Protected`operation[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#operation) * operation<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#operationt) extends unknown\>(operation: () \=> Promise<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#operationt) \>): Promise<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#operationt) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#operation-1) A method that wraps any signer interaction, this allows the account to wait for unlock or queue requests #### Type Parameters * T extends unknown #### Parameters * operation: () \=> Promise<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#operationt) \> #### Returns Promise<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#operationt) \> ### `Protected`reduceQueue[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#reducequeue) * reduceQueue(): void[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#reducequeue-1) #### Returns void ### `Protected`saveCommonFields[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#savecommonfields) * saveCommonFields(     json: Omit<         [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) <[SignerData](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountsignerdata) , [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountmetadata) \>,         "id" | "type" | "metadata" | "pubkey",     \>, ): [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) [](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#savecommonfields-1) Adds the common fields to the serialized output of a toJSON method #### Parameters * json: Omit<     [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) <[SignerData](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountsignerdata) , [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountmetadata) \>,     "id" | "type" | "metadata" | "pubkey", \> #### Returns [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) ### signEvent[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#signevent) * signEvent(template: [EventTemplate](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.EventTemplate.html) ): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#signevent-1) sign the event and make sure its signed with the correct pubkey #### Parameters * template: [EventTemplate](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.EventTemplate.html) #### Returns Promise ### toJSON[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#tojson) * toJSON(): [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) [](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#tojson-1) #### Returns [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) ### `Protected`waitForQueue[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#waitforqueue) * waitForQueue<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#waitforqueuet) extends unknown\>(operation: () \=> Promise<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#waitforqueuet) \>): Promise<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#waitforqueuet) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#waitforqueue-1) #### Type Parameters * T extends unknown #### Parameters * operation: () \=> Promise<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#waitforqueuet) \> #### Returns Promise<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#waitforqueuet) \> ### `Static`fromJSON[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#fromjson) * fromJSON<[Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#fromjsonmetadata) extends unknown\>(     json: [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) , ): [AmberClipboardAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html) <[Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#fromjsonmetadata) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#fromjson-1) #### Type Parameters * Metadata extends unknown #### Parameters * json: [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) #### Returns [AmberClipboardAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html) <[Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#fromjsonmetadata) \> ### `Static`loadCommonFields[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#loadcommonfields) * loadCommonFields<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#loadcommonfieldst) extends [IAccount](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html) <[ISigner](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.ISigner.html) , any, any\>\>(     account: [T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#loadcommonfieldst) ,     json: [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) , ): [T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#loadcommonfieldst) [](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#loadcommonfields-1) Sets an accounts id and metadata. NOTE: This should only be used in fromJSON methods #### Type Parameters * T extends [IAccount](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html) <[ISigner](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.ISigner.html) , any, any\> #### Parameters * account: [T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#loadcommonfieldst) * json: [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) #### Returns [T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#loadcommonfieldst) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Constructors [constructor](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#constructor) Properties [abort](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#abort) [disableQueue](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#disablequeue) [id](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#id) [lock](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#lock) [metadata$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#metadata-1) [pubkey](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#pubkey) [queueLength](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#queuelength) [signer](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#signer) [type](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#type) Accessors [metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#metadata-2) [nip04](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#nip04) [nip44](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#nip44) [type](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#type-1) Methods [abortQueue](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#abortqueue) [getPublicKey](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#getpublickey) [operation](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#operation) [reduceQueue](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#reducequeue) [saveCommonFields](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#savecommonfields) [signEvent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#signevent) [toJSON](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#tojson) [waitForQueue](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#waitforqueue) [fromJSON](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#fromjson) [loadCommonFields](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html#loadcommonfields) --- # SimpleSigner | AppleSauce * [applesauce-signers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.html) * [SimpleSigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SimpleSigner.html) Class SimpleSigner ================== A Simple NIP-07 signer class #### Implements * [ISigner](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.ISigner.html) ##### Index ### Constructors [constructor](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SimpleSigner.html#constructor) ### Properties [key](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SimpleSigner.html#key) [nip04](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SimpleSigner.html#nip04) [nip44](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SimpleSigner.html#nip44) ### Methods [getPublicKey](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SimpleSigner.html#getpublickey) [signEvent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SimpleSigner.html#signevent) [fromKey](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SimpleSigner.html#fromkey) Constructors ------------ ### constructor[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SimpleSigner.html#constructor) * new SimpleSigner(key?: Uint8Array): [SimpleSigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SimpleSigner.html) [](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SimpleSigner.html#constructorsimplesigner) #### Parameters * `Optional`key: Uint8Array #### Returns [SimpleSigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SimpleSigner.html) Properties ---------- ### key[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SimpleSigner.html#key) key: Uint8Array ### nip04[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SimpleSigner.html#nip04) nip04: {     decrypt: (pubkey: string, ciphertext: string) \=> Promise;     encrypt: (pubkey: string, plaintext: string) \=> Promise; } = ... ### nip44[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SimpleSigner.html#nip44) nip44: {     decrypt: (pubkey: string, ciphertext: string) \=> Promise;     encrypt: (pubkey: string, plaintext: string) \=> Promise; } = ... Methods ------- ### getPublicKey[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SimpleSigner.html#getpublickey) * getPublicKey(): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SimpleSigner.html#getpublickey-1) #### Returns Promise ### signEvent[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SimpleSigner.html#signevent) * signEvent(event: EventTemplate): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SimpleSigner.html#signevent-1) #### Parameters * event: EventTemplate #### Returns Promise ### `Static`fromKey[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SimpleSigner.html#fromkey) * fromKey(privateKey: string | Uint8Array): [SimpleSigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SimpleSigner.html) [](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SimpleSigner.html#fromkey-1) Creates a SimpleSigner from a hex private key or NIP-19 nsec #### Parameters * privateKey: string | Uint8Array #### Returns [SimpleSigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SimpleSigner.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Constructors [constructor](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SimpleSigner.html#constructor) Properties [key](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SimpleSigner.html#key) [nip04](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SimpleSigner.html#nip04) [nip44](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SimpleSigner.html#nip44) Methods [getPublicKey](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SimpleSigner.html#getpublickey) [signEvent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SimpleSigner.html#signevent) [fromKey](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SimpleSigner.html#fromkey) --- # markFromCache | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [markFromCache](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.markFromCache.html) Function markFromCache ====================== * markFromCache(event: Event): void[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.markFromCache.html#markfromcache) Marks an event as being from a cache #### Parameters * event: Event #### Returns void ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # NostrConnectAccount | AppleSauce * [applesauce-accounts](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.html) * [Accounts](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.Accounts.html) * [NostrConnectAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html) Class NostrConnectAccount =================================== An account type for NIP-46 signers #### Type Parameters * Metadata extends unknown #### Hierarchy ([View Summary](https://hzrd149.github.io/applesauce/typedoc/hierarchy.html#applesauce-accounts.Accounts.NostrConnectAccount) ) * [BaseAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html) <[NostrConnectSigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html) , [NostrConnectAccountSignerData](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.Accounts.NostrConnectAccountSignerData.html) , [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#constructornostrconnectaccountmetadata) \> * NostrConnectAccount ##### Index ### Constructors [constructor](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#constructor) ### Properties [abort](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#abort) [disableQueue?](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#disablequeue) [id](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#id) [lock](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#lock) [metadata$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#metadata-1) [pubkey](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#pubkey) [queueLength](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#queuelength) [signer](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#signer) [type](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#type) ### Accessors [metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#metadata-2) [nip04](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#nip04) [nip44](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#nip44) [type](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#type-1) ### Methods [abortQueue](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#abortqueue) [getPublicKey](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#getpublickey) [operation](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#operation) [reduceQueue](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#reducequeue) [saveCommonFields](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#savecommonfields) [signEvent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#signevent) [toJSON](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#tojson) [waitForQueue](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#waitforqueue) [fromJSON](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#fromjson) [loadCommonFields](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#loadcommonfields) Constructors ------------ ### constructor[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#constructor) * new NostrConnectAccount<[Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#constructornostrconnectaccountmetadata) extends unknown\>(     pubkey: string,     signer: [NostrConnectSigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html) , ): [NostrConnectAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html) <[Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#constructornostrconnectaccountmetadata) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#constructornostrconnectaccount) #### Type Parameters * Metadata extends unknown #### Parameters * pubkey: string * signer: [NostrConnectSigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html) #### Returns [NostrConnectAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html) <[Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#constructornostrconnectaccountmetadata) \> Properties ---------- ### `Protected`abort[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#abort) abort: null | AbortController = null ### `Optional`disableQueue[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#disablequeue) disableQueue?: boolean Disable request queueing ### id[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#id) id: string = ... ### `Protected`lock[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#lock) lock: null | Promise = null ### metadata$[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#metadata-1) metadata$: BehaviorSubject = ... ### pubkey[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#pubkey) pubkey: string ### `Protected`queueLength[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#queuelength) queueLength: number = 0 internal queue ### signer[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#signer) signer: [NostrConnectSigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html) ### `Static` `Readonly`type[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#type) type: "nostr-connect" Accessors --------- ### metadata[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#metadata-2) * get metadata(): undefined | [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountmetadata) #### Returns undefined | [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountmetadata) * set metadata(metadata: [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountmetadata) ): void #### Parameters * metadata: [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountmetadata) #### Returns void ### nip04[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#nip04) * get nip04(): | undefined | {     decrypt: (pubkey: string, ciphertext: string) \=> Promise;     encrypt: (pubkey: string, plaintext: string) \=> Promise; } #### Returns     | undefined     | {         decrypt: (pubkey: string, ciphertext: string) \=> Promise;         encrypt: (pubkey: string, plaintext: string) \=> Promise;     } ### nip44[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#nip44) * get nip44(): | undefined | {     decrypt: (pubkey: string, ciphertext: string) \=> Promise;     encrypt: (pubkey: string, plaintext: string) \=> Promise; } #### Returns     | undefined     | {         decrypt: (pubkey: string, ciphertext: string) \=> Promise;         encrypt: (pubkey: string, plaintext: string) \=> Promise;     } ### type[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#type-1) * get type(): string #### Returns string Methods ------- ### abortQueue[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#abortqueue) * abortQueue(reason: Error): void[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#abortqueue-1) Aborts all pending requests in the queue #### Parameters * reason: Error #### Returns void ### getPublicKey[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#getpublickey) * getPublicKey(): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#getpublickey-1) Gets the pubkey from the signer #### Returns Promise ### `Protected`operation[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#operation) * operation<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#operationt) extends unknown\>(operation: () \=> Promise<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#operationt) \>): Promise<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#operationt) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#operation-1) A method that wraps any signer interaction, this allows the account to wait for unlock or queue requests #### Type Parameters * T extends unknown #### Parameters * operation: () \=> Promise<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#operationt) \> #### Returns Promise<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#operationt) \> ### `Protected`reduceQueue[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#reducequeue) * reduceQueue(): void[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#reducequeue-1) #### Returns void ### `Protected`saveCommonFields[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#savecommonfields) * saveCommonFields(     json: Omit<         [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) <[SignerData](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountsignerdata) , [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountmetadata) \>,         "id" | "type" | "metadata" | "pubkey",     \>, ): [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) <[NostrConnectAccountSignerData](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.Accounts.NostrConnectAccountSignerData.html) , [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#constructornostrconnectaccountmetadata) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#savecommonfields-1) Adds the common fields to the serialized output of a toJSON method #### Parameters * json: Omit<     [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) <[SignerData](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountsignerdata) , [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountmetadata) \>,     "id" | "type" | "metadata" | "pubkey", \> #### Returns [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) <[NostrConnectAccountSignerData](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.Accounts.NostrConnectAccountSignerData.html) , [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#constructornostrconnectaccountmetadata) \> ### signEvent[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#signevent) * signEvent(template: [EventTemplate](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.EventTemplate.html) ): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#signevent-1) sign the event and make sure its signed with the correct pubkey #### Parameters * template: [EventTemplate](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.EventTemplate.html) #### Returns Promise ### toJSON[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#tojson) * toJSON(): [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) <[NostrConnectAccountSignerData](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.Accounts.NostrConnectAccountSignerData.html) , [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#constructornostrconnectaccountmetadata) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#tojson-1) #### Returns [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) <[NostrConnectAccountSignerData](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.Accounts.NostrConnectAccountSignerData.html) , [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#constructornostrconnectaccountmetadata) \> ### `Protected`waitForQueue[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#waitforqueue) * waitForQueue<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#waitforqueuet) extends unknown\>(operation: () \=> Promise<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#waitforqueuet) \>): Promise<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#waitforqueuet) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#waitforqueue-1) #### Type Parameters * T extends unknown #### Parameters * operation: () \=> Promise<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#waitforqueuet) \> #### Returns Promise<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#waitforqueuet) \> ### `Static`fromJSON[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#fromjson) * fromJSON<[Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#fromjsonmetadata) extends unknown\>(     json: [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) <[NostrConnectAccountSignerData](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.Accounts.NostrConnectAccountSignerData.html) , [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#fromjsonmetadata) \>, ): [NostrConnectAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html) <[Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#fromjsonmetadata) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#fromjson-1) #### Type Parameters * Metadata extends unknown #### Parameters * json: [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) <[NostrConnectAccountSignerData](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.Accounts.NostrConnectAccountSignerData.html) , [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#fromjsonmetadata) \> #### Returns [NostrConnectAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html) <[Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#fromjsonmetadata) \> ### `Static`loadCommonFields[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#loadcommonfields) * loadCommonFields<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#loadcommonfieldst) extends [IAccount](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html) <[ISigner](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.ISigner.html) , any, any\>\>(     account: [T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#loadcommonfieldst) ,     json: [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) , ): [T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#loadcommonfieldst) [](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#loadcommonfields-1) Sets an accounts id and metadata. NOTE: This should only be used in fromJSON methods #### Type Parameters * T extends [IAccount](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html) <[ISigner](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.ISigner.html) , any, any\> #### Parameters * account: [T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#loadcommonfieldst) * json: [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) #### Returns [T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#loadcommonfieldst) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Constructors [constructor](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#constructor) Properties [abort](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#abort) [disableQueue](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#disablequeue) [id](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#id) [lock](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#lock) [metadata$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#metadata-1) [pubkey](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#pubkey) [queueLength](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#queuelength) [signer](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#signer) [type](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#type) Accessors [metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#metadata-2) [nip04](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#nip04) [nip44](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#nip44) [type](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#type-1) Methods [abortQueue](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#abortqueue) [getPublicKey](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#getpublickey) [operation](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#operation) [reduceQueue](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#reducequeue) [saveCommonFields](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#savecommonfields) [signEvent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#signevent) [toJSON](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#tojson) [waitForQueue](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#waitforqueue) [fromJSON](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#fromjson) [loadCommonFields](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html#loadcommonfields) --- # PasswordAccount | AppleSauce * [applesauce-accounts](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.html) * [Accounts](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.Accounts.html) * [PasswordAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html) Class PasswordAccount =============================== A base class for all accounts #### Type Parameters * Metadata extends unknown = unknown #### Hierarchy ([View Summary](https://hzrd149.github.io/applesauce/typedoc/hierarchy.html#applesauce-accounts.Accounts.PasswordAccount) ) * [BaseAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html) <[PasswordSigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html) , [PasswordAccountSignerData](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.Accounts.PasswordAccountSignerData.html) , [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#constructorpasswordaccountmetadata) \> * PasswordAccount ##### Index ### Constructors [constructor](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#constructor) ### Properties [abort](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#abort) [disableQueue?](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#disablequeue) [id](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#id) [lock](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#lock) [metadata$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#metadata-1) [pubkey](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#pubkey) [queueLength](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#queuelength) [signer](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#signer) [requestUnlockPassword?](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#requestunlockpassword) [type](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#type) ### Accessors [metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#metadata-2) [nip04](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#nip04) [nip44](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#nip44) [type](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#type-1) [unlocked](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#unlocked) ### Methods [abortQueue](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#abortqueue) [getPublicKey](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#getpublickey) [operation](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#operation) [reduceQueue](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#reducequeue) [saveCommonFields](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#savecommonfields) [signEvent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#signevent) [toJSON](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#tojson) [unlock](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#unlock) [waitForQueue](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#waitforqueue) [fromJSON](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#fromjson) [fromNcryptsec](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#fromncryptsec) [loadCommonFields](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#loadcommonfields) Constructors ------------ ### constructor[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#constructor) * new PasswordAccount<[Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#constructorpasswordaccountmetadata) extends unknown \= unknown\>(     pubkey: string,     signer: [PasswordSigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html) , ): [PasswordAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html) <[Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#constructorpasswordaccountmetadata) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#constructorpasswordaccount) #### Type Parameters * Metadata extends unknown = unknown #### Parameters * pubkey: string * signer: [PasswordSigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html) #### Returns [PasswordAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html) <[Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#constructorpasswordaccountmetadata) \> Properties ---------- ### `Protected`abort[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#abort) abort: null | AbortController = null ### `Optional`disableQueue[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#disablequeue) disableQueue?: boolean Disable request queueing ### id[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#id) id: string = ... ### `Protected`lock[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#lock) lock: null | Promise = null ### metadata$[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#metadata-1) metadata$: BehaviorSubject = ... ### pubkey[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#pubkey) pubkey: string ### `Protected`queueLength[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#queuelength) queueLength: number = 0 internal queue ### signer[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#signer) signer: [PasswordSigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html) ### `Static` `Optional`requestUnlockPassword[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#requestunlockpassword) requestUnlockPassword?: (account: [PasswordAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html) ) \=> Promise called when PasswordAccount.unlock is called without a password ### `Static` `Readonly`type[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#type) type: "ncryptsec" Accessors --------- ### metadata[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#metadata-2) * get metadata(): undefined | [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountmetadata) #### Returns undefined | [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountmetadata) * set metadata(metadata: [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountmetadata) ): void #### Parameters * metadata: [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountmetadata) #### Returns void ### nip04[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#nip04) * get nip04(): | undefined | {     decrypt: (pubkey: string, ciphertext: string) \=> Promise;     encrypt: (pubkey: string, plaintext: string) \=> Promise; } #### Returns     | undefined     | {         decrypt: (pubkey: string, ciphertext: string) \=> Promise;         encrypt: (pubkey: string, plaintext: string) \=> Promise;     } ### nip44[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#nip44) * get nip44(): | undefined | {     decrypt: (pubkey: string, ciphertext: string) \=> Promise;     encrypt: (pubkey: string, plaintext: string) \=> Promise; } #### Returns     | undefined     | {         decrypt: (pubkey: string, ciphertext: string) \=> Promise;         encrypt: (pubkey: string, plaintext: string) \=> Promise;     } ### type[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#type-1) * get type(): string #### Returns string ### unlocked[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#unlocked) * get unlocked(): boolean #### Returns boolean Methods ------- ### abortQueue[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#abortqueue) * abortQueue(reason: Error): void[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#abortqueue-1) Aborts all pending requests in the queue #### Parameters * reason: Error #### Returns void ### getPublicKey[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#getpublickey) * getPublicKey(): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#getpublickey-1) Gets the pubkey from the signer #### Returns Promise ### `Protected`operation[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#operation) * operation<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#operationt) extends unknown\>(operation: () \=> Promise<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#operationt) \>): Promise<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#operationt) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#operation-1) A method that wraps any signer interaction, this allows the account to wait for unlock or queue requests #### Type Parameters * T extends unknown #### Parameters * operation: () \=> Promise<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#operationt) \> #### Returns Promise<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#operationt) \> ### `Protected`reduceQueue[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#reducequeue) * reduceQueue(): void[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#reducequeue-1) #### Returns void ### `Protected`saveCommonFields[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#savecommonfields) * saveCommonFields(     json: Omit<         [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) <[SignerData](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountsignerdata) , [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountmetadata) \>,         "id" | "type" | "metadata" | "pubkey",     \>, ): [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) <[PasswordAccountSignerData](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.Accounts.PasswordAccountSignerData.html) , [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#constructorpasswordaccountmetadata) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#savecommonfields-1) Adds the common fields to the serialized output of a toJSON method #### Parameters * json: Omit<     [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) <[SignerData](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountsignerdata) , [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountmetadata) \>,     "id" | "type" | "metadata" | "pubkey", \> #### Returns [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) <[PasswordAccountSignerData](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.Accounts.PasswordAccountSignerData.html) , [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#constructorpasswordaccountmetadata) \> ### signEvent[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#signevent) * signEvent(template: [EventTemplate](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.EventTemplate.html) ): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#signevent-1) sign the event and make sure its signed with the correct pubkey #### Parameters * template: [EventTemplate](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.EventTemplate.html) #### Returns Promise ### toJSON[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#tojson) * toJSON(): [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) <[PasswordAccountSignerData](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.Accounts.PasswordAccountSignerData.html) , [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#constructorpasswordaccountmetadata) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#tojson-1) #### Returns [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) <[PasswordAccountSignerData](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.Accounts.PasswordAccountSignerData.html) , [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#constructorpasswordaccountmetadata) \> ### unlock[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#unlock) * unlock(password?: string): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#unlock-1) Attempt to unlock the signer with a password #### Parameters * `Optional`password: string #### Returns Promise #### Throws[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#throws) ### `Protected`waitForQueue[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#waitforqueue) * waitForQueue<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#waitforqueuet) extends unknown\>(operation: () \=> Promise<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#waitforqueuet) \>): Promise<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#waitforqueuet) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#waitforqueue-1) #### Type Parameters * T extends unknown #### Parameters * operation: () \=> Promise<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#waitforqueuet) \> #### Returns Promise<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#waitforqueuet) \> ### `Static`fromJSON[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#fromjson) * fromJSON<[Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#fromjsonmetadata) extends unknown\>(     json: [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) <[PasswordAccountSignerData](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.Accounts.PasswordAccountSignerData.html) , [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#fromjsonmetadata) \>, ): [PasswordAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html) <[Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#fromjsonmetadata) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#fromjson-1) #### Type Parameters * Metadata extends unknown #### Parameters * json: [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) <[PasswordAccountSignerData](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.Accounts.PasswordAccountSignerData.html) , [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#fromjsonmetadata) \> #### Returns [PasswordAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html) <[Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#fromjsonmetadata) \> ### `Static`fromNcryptsec[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#fromncryptsec) * fromNcryptsec<[Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#fromncryptsecmetadata) extends unknown\>(     pubkey: string,     ncryptsec: string, ): [PasswordAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html) <[Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#fromncryptsecmetadata) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#fromncryptsec-1) Creates a new PasswordAccount from a ncryptsec string #### Type Parameters * Metadata extends unknown #### Parameters * pubkey: string * ncryptsec: string #### Returns [PasswordAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html) <[Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#fromncryptsecmetadata) \> ### `Static`loadCommonFields[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#loadcommonfields) * loadCommonFields<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#loadcommonfieldst) extends [IAccount](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html) <[ISigner](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.ISigner.html) , any, any\>\>(     account: [T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#loadcommonfieldst) ,     json: [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) , ): [T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#loadcommonfieldst) [](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#loadcommonfields-1) Sets an accounts id and metadata. NOTE: This should only be used in fromJSON methods #### Type Parameters * T extends [IAccount](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html) <[ISigner](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.ISigner.html) , any, any\> #### Parameters * account: [T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#loadcommonfieldst) * json: [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) #### Returns [T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#loadcommonfieldst) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Constructors [constructor](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#constructor) Properties [abort](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#abort) [disableQueue](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#disablequeue) [id](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#id) [lock](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#lock) [metadata$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#metadata-1) [pubkey](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#pubkey) [queueLength](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#queuelength) [signer](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#signer) [requestUnlockPassword](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#requestunlockpassword) [type](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#type) Accessors [metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#metadata-2) [nip04](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#nip04) [nip44](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#nip44) [type](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#type-1) [unlocked](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#unlocked) Methods [abortQueue](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#abortqueue) [getPublicKey](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#getpublickey) [operation](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#operation) [reduceQueue](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#reducequeue) [saveCommonFields](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#savecommonfields) [signEvent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#signevent) [toJSON](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#tojson) [unlock](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#unlock) [waitForQueue](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#waitforqueue) [fromJSON](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#fromjson) [fromNcryptsec](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#fromncryptsec) [loadCommonFields](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html#loadcommonfields) --- # FactoryProvider | AppleSauce * [applesauce-react](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-react.html) * [FactoryProvider](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-react.FactoryProvider.html) Function FactoryProvider ======================== * FactoryProvider(     \_\_namedParameters: PropsWithChildren<{ factory?: [EventFactory](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html) }\>, ): Element[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-react.FactoryProvider.html#factoryprovider) Provides an [EventFactory](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html) to the component tree #### Parameters * \_\_namedParameters: PropsWithChildren<{ factory?: [EventFactory](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html) }\> #### Returns Element ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # isEvent | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [isEvent](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isEvent.html) Function isEvent ================ * isEvent(event: any): event is Event[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isEvent.html#isevent) Checks if an object is a nostr event NOTE: does not validate the signature on the event #### Parameters * event: any #### Returns event is Event ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # useEventStore | AppleSauce * [applesauce-react](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-react.html) * [Hooks](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-react.Hooks.html) * [useEventStore](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-react.Hooks.useEventStore.html) Function useEventStore ====================== * useEventStore(): [IEventStore](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-react.Hooks.useEventStore.html#useeventstore) Gets the EventStore from a parent [EventStoreProvider](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-react.EventStoreProvider.html) component If there is none it throws an error #### Returns [IEventStore](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # SimpleAccount | AppleSauce * [applesauce-accounts](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.html) * [Accounts](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.Accounts.html) * [SimpleAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html) Class SimpleAccount ============================= A base class for all accounts #### Type Parameters * Metadata extends unknown #### Hierarchy ([View Summary](https://hzrd149.github.io/applesauce/typedoc/hierarchy.html#applesauce-accounts.Accounts.SimpleAccount) ) * [BaseAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html) <[SimpleSigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SimpleSigner.html) , [SimpleAccountSignerData](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.Accounts.SimpleAccountSignerData.html) , [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#constructorsimpleaccountmetadata) \> * SimpleAccount ##### Index ### Constructors [constructor](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#constructor) ### Properties [abort](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#abort) [disableQueue?](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#disablequeue) [id](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#id) [lock](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#lock) [metadata$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#metadata-1) [pubkey](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#pubkey) [queueLength](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#queuelength) [signer](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#signer) [type](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#type) ### Accessors [metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#metadata-2) [nip04](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#nip04) [nip44](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#nip44) [type](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#type-1) ### Methods [abortQueue](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#abortqueue) [getPublicKey](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#getpublickey) [operation](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#operation) [reduceQueue](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#reducequeue) [saveCommonFields](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#savecommonfields) [signEvent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#signevent) [toJSON](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#tojson) [waitForQueue](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#waitforqueue) [fromJSON](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#fromjson) [fromKey](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#fromkey) [generateNew](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#generatenew) [loadCommonFields](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#loadcommonfields) Constructors ------------ ### constructor[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#constructor) * new SimpleAccount<[Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#constructorsimpleaccountmetadata) extends unknown\>(     pubkey: string,     signer: [SimpleSigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SimpleSigner.html) , ): [SimpleAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html) <[Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#constructorsimpleaccountmetadata) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#constructorsimpleaccount) #### Type Parameters * Metadata extends unknown #### Parameters * pubkey: string * signer: [SimpleSigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SimpleSigner.html) #### Returns [SimpleAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html) <[Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#constructorsimpleaccountmetadata) \> Properties ---------- ### `Protected`abort[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#abort) abort: null | AbortController = null ### `Optional`disableQueue[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#disablequeue) disableQueue?: boolean Disable request queueing ### id[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#id) id: string = ... ### `Protected`lock[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#lock) lock: null | Promise = null ### metadata$[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#metadata-1) metadata$: BehaviorSubject = ... ### pubkey[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#pubkey) pubkey: string ### `Protected`queueLength[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#queuelength) queueLength: number = 0 internal queue ### signer[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#signer) signer: [SimpleSigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SimpleSigner.html) ### `Static` `Readonly`type[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#type) type: "nsec" Accessors --------- ### metadata[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#metadata-2) * get metadata(): undefined | [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountmetadata) #### Returns undefined | [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountmetadata) * set metadata(metadata: [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountmetadata) ): void #### Parameters * metadata: [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountmetadata) #### Returns void ### nip04[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#nip04) * get nip04(): | undefined | {     decrypt: (pubkey: string, ciphertext: string) \=> Promise;     encrypt: (pubkey: string, plaintext: string) \=> Promise; } #### Returns     | undefined     | {         decrypt: (pubkey: string, ciphertext: string) \=> Promise;         encrypt: (pubkey: string, plaintext: string) \=> Promise;     } ### nip44[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#nip44) * get nip44(): | undefined | {     decrypt: (pubkey: string, ciphertext: string) \=> Promise;     encrypt: (pubkey: string, plaintext: string) \=> Promise; } #### Returns     | undefined     | {         decrypt: (pubkey: string, ciphertext: string) \=> Promise;         encrypt: (pubkey: string, plaintext: string) \=> Promise;     } ### type[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#type-1) * get type(): string #### Returns string Methods ------- ### abortQueue[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#abortqueue) * abortQueue(reason: Error): void[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#abortqueue-1) Aborts all pending requests in the queue #### Parameters * reason: Error #### Returns void ### getPublicKey[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#getpublickey) * getPublicKey(): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#getpublickey-1) Gets the pubkey from the signer #### Returns Promise ### `Protected`operation[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#operation) * operation<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#operationt) extends unknown\>(operation: () \=> Promise<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#operationt) \>): Promise<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#operationt) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#operation-1) A method that wraps any signer interaction, this allows the account to wait for unlock or queue requests #### Type Parameters * T extends unknown #### Parameters * operation: () \=> Promise<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#operationt) \> #### Returns Promise<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#operationt) \> ### `Protected`reduceQueue[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#reducequeue) * reduceQueue(): void[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#reducequeue-1) #### Returns void ### `Protected`saveCommonFields[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#savecommonfields) * saveCommonFields(     json: Omit<         [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) <[SignerData](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountsignerdata) , [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountmetadata) \>,         "id" | "type" | "metadata" | "pubkey",     \>, ): [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) <[SimpleAccountSignerData](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.Accounts.SimpleAccountSignerData.html) , [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#constructorsimpleaccountmetadata) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#savecommonfields-1) Adds the common fields to the serialized output of a toJSON method #### Parameters * json: Omit<     [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) <[SignerData](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountsignerdata) , [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountmetadata) \>,     "id" | "type" | "metadata" | "pubkey", \> #### Returns [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) <[SimpleAccountSignerData](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.Accounts.SimpleAccountSignerData.html) , [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#constructorsimpleaccountmetadata) \> ### signEvent[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#signevent) * signEvent(template: [EventTemplate](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.EventTemplate.html) ): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#signevent-1) sign the event and make sure its signed with the correct pubkey #### Parameters * template: [EventTemplate](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.EventTemplate.html) #### Returns Promise ### toJSON[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#tojson) * toJSON(): [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) <[SimpleAccountSignerData](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.Accounts.SimpleAccountSignerData.html) , [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#constructorsimpleaccountmetadata) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#tojson-1) #### Returns [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) <[SimpleAccountSignerData](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.Accounts.SimpleAccountSignerData.html) , [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#constructorsimpleaccountmetadata) \> ### `Protected`waitForQueue[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#waitforqueue) * waitForQueue<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#waitforqueuet) extends unknown\>(operation: () \=> Promise<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#waitforqueuet) \>): Promise<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#waitforqueuet) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#waitforqueue-1) #### Type Parameters * T extends unknown #### Parameters * operation: () \=> Promise<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#waitforqueuet) \> #### Returns Promise<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#waitforqueuet) \> ### `Static`fromJSON[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#fromjson) * fromJSON<[Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#fromjsonmetadata) extends unknown\>(     json: [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) <[SimpleAccountSignerData](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.Accounts.SimpleAccountSignerData.html) , [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#fromjsonmetadata) \>, ): [SimpleAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html) <[Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#fromjsonmetadata) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#fromjson-1) #### Type Parameters * Metadata extends unknown #### Parameters * json: [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) <[SimpleAccountSignerData](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.Accounts.SimpleAccountSignerData.html) , [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#fromjsonmetadata) \> #### Returns [SimpleAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html) <[Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#fromjsonmetadata) \> ### `Static`fromKey[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#fromkey) * fromKey<[Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#fromkeymetadata) extends unknown\>(     privateKey: string | Uint8Array, ): [SimpleAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html) <[Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#fromkeymetadata) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#fromkey-1) Creates a SimpleAccount from a hex private key or NIP-19 nsec #### Type Parameters * Metadata extends unknown #### Parameters * privateKey: string | Uint8Array #### Returns [SimpleAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html) <[Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#fromkeymetadata) \> ### `Static`generateNew[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#generatenew) * generateNew<[Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#generatenewmetadata) extends unknown\>(): [SimpleAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html) <[Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#generatenewmetadata) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#generatenew-1) Creates a new SimpleAccount with a random private key #### Type Parameters * Metadata extends unknown #### Returns [SimpleAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html) <[Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#generatenewmetadata) \> ### `Static`loadCommonFields[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#loadcommonfields) * loadCommonFields<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#loadcommonfieldst) extends [IAccount](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html) <[ISigner](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.ISigner.html) , any, any\>\>(     account: [T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#loadcommonfieldst) ,     json: [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) , ): [T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#loadcommonfieldst) [](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#loadcommonfields-1) Sets an accounts id and metadata. NOTE: This should only be used in fromJSON methods #### Type Parameters * T extends [IAccount](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html) <[ISigner](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.ISigner.html) , any, any\> #### Parameters * account: [T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#loadcommonfieldst) * json: [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) #### Returns [T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#loadcommonfieldst) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Constructors [constructor](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#constructor) Properties [abort](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#abort) [disableQueue](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#disablequeue) [id](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#id) [lock](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#lock) [metadata$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#metadata-1) [pubkey](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#pubkey) [queueLength](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#queuelength) [signer](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#signer) [type](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#type) Accessors [metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#metadata-2) [nip04](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#nip04) [nip44](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#nip44) [type](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#type-1) Methods [abortQueue](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#abortqueue) [getPublicKey](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#getpublickey) [operation](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#operation) [reduceQueue](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#reducequeue) [saveCommonFields](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#savecommonfields) [signEvent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#signevent) [toJSON](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#tojson) [waitForQueue](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#waitforqueue) [fromJSON](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#fromjson) [fromKey](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#fromkey) [generateNew](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#generatenew) [loadCommonFields](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html#loadcommonfields) --- # useObservableMemo | AppleSauce * [applesauce-react](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-react.html) * [Hooks](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-react.Hooks.html) * [useObservableMemo](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-react.Hooks.useObservableMemo.html) Function useObservableMemo ========================== * useObservableMemo<[T](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-react.Hooks.useObservableMemo.html#useobservablememot) \>(factory: () \=> BehaviorSubject<[T](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-react.Hooks.useObservableMemo.html#useobservablememot) \>, deps: any\[\]): [T](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-react.Hooks.useObservableMemo.html#useobservablememot) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-react.Hooks.useObservableMemo.html#useobservablememo) A hook that recreates an observable when the dependencies change #### Type Parameters * T #### Parameters * factory: () \=> BehaviorSubject<[T](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-react.Hooks.useObservableMemo.html#useobservablememot) \> * deps: any\[\] #### Returns [T](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-react.Hooks.useObservableMemo.html#useobservablememot) * useObservableMemo<[T](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-react.Hooks.useObservableMemo.html#useobservablememot-1) \>(     factory: () \=> undefined | Observable<[T](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-react.Hooks.useObservableMemo.html#useobservablememot-1) \>,     deps: any\[\], ): undefined | [T](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-react.Hooks.useObservableMemo.html#useobservablememot-1) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-react.Hooks.useObservableMemo.html#useobservablememo-1) A hook that recreates an observable when the dependencies change #### Type Parameters * T #### Parameters * factory: () \=> undefined | Observable<[T](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-react.Hooks.useObservableMemo.html#useobservablememot-1) \> * deps: any\[\] #### Returns undefined | [T](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-react.Hooks.useObservableMemo.html#useobservablememot-1) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # Action | AppleSauce * [applesauce-actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.html) * [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) Type Alias Action ================= Action: (     ctx: [ActionContext](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.ActionContext.html) , ) \=>     | Observable     | AsyncGenerator     | Generator An action that can be run in a context to preform an action #### Type declaration * * (     ctx: [ActionContext](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.ActionContext.html) , ):     | Observable     | AsyncGenerator     | Generator * #### Parameters * ctx: [ActionContext](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.ActionContext.html) #### Returns Observable | AsyncGenerator | Generator ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # createPTagFromProfilePointer | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html) * [createPTagFromProfilePointer](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.createPTagFromProfilePointer.html) Function createPTagFromProfilePointer ===================================== * createPTagFromProfilePointer(pointer: ProfilePointer): [NameValueTag](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.NameValueTag.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.createPTagFromProfilePointer.html#createptagfromprofilepointer) Returns a tag for an profile pointer #### Parameters * pointer: ProfilePointer #### Returns [NameValueTag](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.NameValueTag.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # EventStoreProvider | AppleSauce * [applesauce-react](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-react.html) * [EventStoreProvider](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-react.EventStoreProvider.html) Function EventStoreProvider =========================== * EventStoreProvider(     \_\_namedParameters: PropsWithChildren<{ eventStore: [IEventStore](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html) }\>, ): Element[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-react.EventStoreProvider.html#eventstoreprovider) Provides a EventStore to the component tree #### Parameters * \_\_namedParameters: PropsWithChildren<{ eventStore: [IEventStore](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html) }\> #### Returns Element ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # remarkNostrMentions | AppleSauce * [applesauce-content](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.html) * [Markdown](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Markdown.html) * [remarkNostrMentions](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-content.Markdown.remarkNostrMentions.html) Function remarkNostrMentions ============================ * remarkNostrMentions(): Transformer[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-content.Markdown.remarkNostrMentions.html#remarknostrmentions) #### Returns Transformer ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # getParsedContent | AppleSauce * [applesauce-content](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.html) * [Text](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Text.html) * [getParsedContent](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-content.Text.getParsedContent.html) Function getParsedContent ========================= * getParsedContent(     event: string | Event | EventTemplate,     content?: string,     transformers?: (() \=> Transformer<[Root](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Root.html) \>)\[\],     cacheKey?: undefined | null | symbol, ): [Root](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Root.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-content.Text.getParsedContent.html#getparsedcontent) Parsed and process a note with custom transformers #### Parameters * event: string | Event | EventTemplate * `Optional`content: string * transformers: (() \=> Transformer<[Root](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Root.html) \>)\[\] = textNoteTransformers * cacheKey: undefined | null | symbol = TextNoteContentSymbol #### Returns [Root](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Root.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # PasswordSigner | AppleSauce * [applesauce-signers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.html) * [PasswordSigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html) Class PasswordSigner ==================== A NIP-49 (Private Key Encryption) signer #### Implements * [ISigner](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.ISigner.html) ##### Index ### Constructors [constructor](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#constructor) ### Properties [key](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#key) [ncryptsec?](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#ncryptsec) [nip04](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#nip04) [nip44](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#nip44) [unlockPromise?](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#unlockpromise) ### Accessors [unlocked](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#unlocked) ### Methods [getPublicKey](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#getpublickey) [lock](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#lock) [nip04Decrypt](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#nip04decrypt) [nip04Encrypt](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#nip04encrypt) [nip44Decrypt](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#nip44decrypt) [nip44Encrypt](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#nip44encrypt) [requestUnlock](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#requestunlock) [setPassword](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#setpassword) [signEvent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#signevent) [testPassword](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#testpassword) [unlock](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#unlock) [fromNcryptsec](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#fromncryptsec) [fromPrivateKey](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#fromprivatekey) Constructors ------------ ### constructor[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#constructor) * new PasswordSigner(): [PasswordSigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html) [](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#constructorpasswordsigner) #### Returns [PasswordSigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html) Properties ---------- ### key[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#key) key: null | Uint8Array = null ### `Optional`ncryptsec[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#ncryptsec) ncryptsec?: string ### nip04[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#nip04) nip04: {     decrypt: (pubkey: string, ciphertext: string) \=> Promise;     encrypt: (pubkey: string, plaintext: string) \=> Promise; } ### nip44[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#nip44) nip44: {     decrypt: (pubkey: string, ciphertext: string) \=> Promise;     encrypt: (pubkey: string, plaintext: string) \=> Promise; } ### `Optional`unlockPromise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#unlockpromise) unlockPromise?: Deferred Accessors --------- ### unlocked[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#unlocked) * get unlocked(): boolean #### Returns boolean Methods ------- ### getPublicKey[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#getpublickey) * getPublicKey(): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#getpublickey-1) #### Returns Promise ### lock[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#lock) * lock(): void[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#lock-1) Locks the signer by removing the unencrypted key from memory #### Returns void ### nip04Decrypt[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#nip04decrypt) * nip04Decrypt(pubkey: string, ciphertext: string): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#nip04decrypt-1) #### Parameters * pubkey: string * ciphertext: string #### Returns Promise ### nip04Encrypt[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#nip04encrypt) * nip04Encrypt(pubkey: string, plaintext: string): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#nip04encrypt-1) #### Parameters * pubkey: string * plaintext: string #### Returns Promise ### nip44Decrypt[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#nip44decrypt) * nip44Decrypt(pubkey: string, ciphertext: string): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#nip44decrypt-1) #### Parameters * pubkey: string * ciphertext: string #### Returns Promise ### nip44Encrypt[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#nip44encrypt) * nip44Encrypt(pubkey: string, plaintext: string): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#nip44encrypt-1) #### Parameters * pubkey: string * plaintext: string #### Returns Promise ### `Protected`requestUnlock[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#requestunlock) * requestUnlock(): undefined | Deferred[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#requestunlock-1) #### Returns undefined | Deferred ### setPassword[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#setpassword) * setPassword(password: string): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#setpassword-1) Sets the ncryptsec from the key and password #### Parameters * password: string #### Returns Promise ### signEvent[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#signevent) * signEvent(event: EventTemplate): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#signevent-1) #### Parameters * event: EventTemplate #### Returns Promise ### testPassword[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#testpassword) * testPassword(password: string): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#testpassword-1) Tests if the provided password is correct by decrypting the ncryptsec #### Parameters * password: string #### Returns Promise ### unlock[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#unlock) * unlock(password: string): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#unlock-1) Unlocks the signer by decrypting the ncryptsec using the provided password #### Parameters * password: string #### Returns Promise ### `Static`fromNcryptsec[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#fromncryptsec) * fromNcryptsec(ncryptsec: string, password?: string): Promise<[PasswordSigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#fromncryptsec-1) Creates a PasswordSigner from a ncryptsec and unlocks it with the provided password #### Parameters * ncryptsec: string * `Optional`password: string #### Returns Promise<[PasswordSigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html) \> ### `Static`fromPrivateKey[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#fromprivatekey) * fromPrivateKey(     privateKey: string | Uint8Array,     password: string, ): Promise<[PasswordSigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#fromprivatekey-1) Creates a PasswordSigner from a hex private key or NIP-19 nsec and password #### Parameters * privateKey: string | Uint8Array * password: string #### Returns Promise<[PasswordSigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html) \> ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Constructors [constructor](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#constructor) Properties [key](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#key) [ncryptsec](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#ncryptsec) [nip04](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#nip04) [nip44](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#nip44) [unlockPromise](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#unlockpromise) Accessors [unlocked](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#unlocked) Methods [getPublicKey](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#getpublickey) [lock](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#lock) [nip04Decrypt](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#nip04decrypt) [nip04Encrypt](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#nip04encrypt) [nip44Decrypt](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#nip44decrypt) [nip44Encrypt](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#nip44encrypt) [requestUnlock](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#requestunlock) [setPassword](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#setpassword) [signEvent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#signevent) [testPassword](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#testpassword) [unlock](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#unlock) [fromNcryptsec](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#fromncryptsec) [fromPrivateKey](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.PasswordSigner.html#fromprivatekey) --- # unlockHiddenTags | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [unlockHiddenTags](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.unlockHiddenTags.html) Function unlockHiddenTags ========================= * unlockHiddenTags<[T](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.unlockHiddenTags.html#unlockhiddentagst) extends { content: string; kind: number; pubkey: string }\>(     event: [T](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.unlockHiddenTags.html#unlockhiddentagst) ,     signer: [HiddenContentSigner](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.Helpers.HiddenContentSigner.html) ,     override?: [EncryptionMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.EncryptionMethod.html) , ): Promise[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.unlockHiddenTags.html#unlockhiddentags) Decrypts the private list #### Type Parameters * T extends { content: string; kind: number; pubkey: string } #### Parameters * event: [T](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.unlockHiddenTags.html#unlockhiddentagst) The list event to decrypt * signer: [HiddenContentSigner](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.Helpers.HiddenContentSigner.html) A signer to use to decrypt the tags * `Optional`override: [EncryptionMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.EncryptionMethod.html) The encryption method to use instead of the default #### Returns Promise #### Throws[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.unlockHiddenTags.html#throws) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # ExtensionAccount | AppleSauce * [applesauce-accounts](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.html) * [Accounts](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.Accounts.html) * [ExtensionAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html) Class ExtensionAccount ================================ A base class for all accounts #### Type Parameters * Metadata extends unknown #### Hierarchy ([View Summary](https://hzrd149.github.io/applesauce/typedoc/hierarchy.html#applesauce-accounts.Accounts.ExtensionAccount) ) * [BaseAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html) <[ExtensionSigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ExtensionSigner.html) , void, [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#constructorextensionaccountmetadata) \> * ExtensionAccount ##### Index ### Constructors [constructor](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#constructor) ### Properties [abort](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#abort) [disableQueue?](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#disablequeue) [id](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#id) [lock](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#lock) [metadata$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#metadata-1) [pubkey](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#pubkey) [queueLength](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#queuelength) [signer](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#signer) [type](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#type) ### Accessors [metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#metadata-2) [nip04](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#nip04) [nip44](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#nip44) [type](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#type-1) ### Methods [abortQueue](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#abortqueue) [getPublicKey](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#getpublickey) [operation](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#operation) [reduceQueue](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#reducequeue) [saveCommonFields](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#savecommonfields) [signEvent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#signevent) [toJSON](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#tojson) [waitForQueue](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#waitforqueue) [fromExtension](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#fromextension) [fromJSON](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#fromjson) [loadCommonFields](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#loadcommonfields) Constructors ------------ ### constructor[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#constructor) * new ExtensionAccount<[Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#constructorextensionaccountmetadata) extends unknown\>(     pubkey: string,     signer: [ExtensionSigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ExtensionSigner.html) , ): [ExtensionAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html) <[Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#constructorextensionaccountmetadata) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#constructorextensionaccount) #### Type Parameters * Metadata extends unknown #### Parameters * pubkey: string * signer: [ExtensionSigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ExtensionSigner.html) #### Returns [ExtensionAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html) <[Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#constructorextensionaccountmetadata) \> Properties ---------- ### `Protected`abort[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#abort) abort: null | AbortController = null ### `Optional`disableQueue[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#disablequeue) disableQueue?: boolean Disable request queueing ### id[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#id) id: string = ... ### `Protected`lock[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#lock) lock: null | Promise = null ### metadata$[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#metadata-1) metadata$: BehaviorSubject = ... ### pubkey[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#pubkey) pubkey: string ### `Protected`queueLength[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#queuelength) queueLength: number = 0 internal queue ### signer[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#signer) signer: [ExtensionSigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.ExtensionSigner.html) ### `Static` `Readonly`type[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#type) type: "extension" Accessors --------- ### metadata[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#metadata-2) * get metadata(): undefined | [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountmetadata) #### Returns undefined | [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountmetadata) * set metadata(metadata: [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountmetadata) ): void #### Parameters * metadata: [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountmetadata) #### Returns void ### nip04[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#nip04) * get nip04(): | undefined | {     decrypt: (pubkey: string, ciphertext: string) \=> Promise;     encrypt: (pubkey: string, plaintext: string) \=> Promise; } #### Returns     | undefined     | {         decrypt: (pubkey: string, ciphertext: string) \=> Promise;         encrypt: (pubkey: string, plaintext: string) \=> Promise;     } ### nip44[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#nip44) * get nip44(): | undefined | {     decrypt: (pubkey: string, ciphertext: string) \=> Promise;     encrypt: (pubkey: string, plaintext: string) \=> Promise; } #### Returns     | undefined     | {         decrypt: (pubkey: string, ciphertext: string) \=> Promise;         encrypt: (pubkey: string, plaintext: string) \=> Promise;     } ### type[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#type-1) * get type(): string #### Returns string Methods ------- ### abortQueue[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#abortqueue) * abortQueue(reason: Error): void[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#abortqueue-1) Aborts all pending requests in the queue #### Parameters * reason: Error #### Returns void ### getPublicKey[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#getpublickey) * getPublicKey(): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#getpublickey-1) Gets the pubkey from the signer #### Returns Promise ### `Protected`operation[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#operation) * operation<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#operationt) extends unknown\>(operation: () \=> Promise<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#operationt) \>): Promise<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#operationt) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#operation-1) A method that wraps any signer interaction, this allows the account to wait for unlock or queue requests #### Type Parameters * T extends unknown #### Parameters * operation: () \=> Promise<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#operationt) \> #### Returns Promise<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#operationt) \> ### `Protected`reduceQueue[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#reducequeue) * reduceQueue(): void[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#reducequeue-1) #### Returns void ### `Protected`saveCommonFields[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#savecommonfields) * saveCommonFields(     json: Omit<         [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) <[SignerData](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountsignerdata) , [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountmetadata) \>,         "id" | "type" | "metadata" | "pubkey",     \>, ): [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) [](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#savecommonfields-1) Adds the common fields to the serialized output of a toJSON method #### Parameters * json: Omit<     [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) <[SignerData](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountsignerdata) , [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountmetadata) \>,     "id" | "type" | "metadata" | "pubkey", \> #### Returns [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) ### signEvent[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#signevent) * signEvent(template: [EventTemplate](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.EventTemplate.html) ): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#signevent-1) sign the event and make sure its signed with the correct pubkey #### Parameters * template: [EventTemplate](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.EventTemplate.html) #### Returns Promise ### toJSON[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#tojson) * toJSON(): [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) [](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#tojson-1) #### Returns [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) ### `Protected`waitForQueue[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#waitforqueue) * waitForQueue<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#waitforqueuet) extends unknown\>(operation: () \=> Promise<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#waitforqueuet) \>): Promise<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#waitforqueuet) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#waitforqueue-1) #### Type Parameters * T extends unknown #### Parameters * operation: () \=> Promise<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#waitforqueuet) \> #### Returns Promise<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#waitforqueuet) \> ### `Static`fromExtension[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#fromextension) * fromExtension(): Promise<[ExtensionAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#fromextension-1) Creates a new account from the NIP-07 extension #### Returns Promise<[ExtensionAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html) \> #### Throws[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#throws) if the extension is not installed ### `Static`fromJSON[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#fromjson) * fromJSON<[Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#fromjsonmetadata) extends unknown\>(     json: [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) , ): [ExtensionAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html) <[Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#fromjsonmetadata) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#fromjson-1) #### Type Parameters * Metadata extends unknown #### Parameters * json: [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) #### Returns [ExtensionAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html) <[Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#fromjsonmetadata) \> ### `Static`loadCommonFields[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#loadcommonfields) * loadCommonFields<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#loadcommonfieldst) extends [IAccount](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html) <[ISigner](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.ISigner.html) , any, any\>\>(     account: [T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#loadcommonfieldst) ,     json: [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) , ): [T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#loadcommonfieldst) [](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#loadcommonfields-1) Sets an accounts id and metadata. NOTE: This should only be used in fromJSON methods #### Type Parameters * T extends [IAccount](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html) <[ISigner](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.ISigner.html) , any, any\> #### Parameters * account: [T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#loadcommonfieldst) * json: [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) #### Returns [T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#loadcommonfieldst) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Constructors [constructor](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#constructor) Properties [abort](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#abort) [disableQueue](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#disablequeue) [id](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#id) [lock](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#lock) [metadata$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#metadata-1) [pubkey](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#pubkey) [queueLength](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#queuelength) [signer](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#signer) [type](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#type) Accessors [metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#metadata-2) [nip04](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#nip04) [nip44](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#nip44) [type](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#type-1) Methods [abortQueue](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#abortqueue) [getPublicKey](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#getpublickey) [operation](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#operation) [reduceQueue](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#reducequeue) [saveCommonFields](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#savecommonfields) [signEvent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#signevent) [toJSON](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#tojson) [waitForQueue](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#waitforqueue) [fromExtension](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#fromextension) [fromJSON](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#fromjson) [loadCommonFields](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html#loadcommonfields) --- # AccountManager | AppleSauce * [applesauce-accounts](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.html) * [AccountManager](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html) Class AccountManager ============================== #### Type Parameters * Metadata extends unknown = any ##### Index ### Constructors [constructor](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#constructor) ### Properties [accounts$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#accounts) [active$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#active) [disableQueue?](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#disablequeue) [signer](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#signer) [types](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#types) ### Accessors [accounts](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#accounts-1) [active](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#active-1) ### Methods [addAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#addaccount) [clearAccountMetadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#clearaccountmetadata) [clearActive](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#clearactive) [fromJSON](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#fromjson) [getAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#getaccount) [getAccountForPubkey](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#getaccountforpubkey) [getAccountMetadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#getaccountmetadata) [getAccountsForPubkey](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#getaccountsforpubkey) [getActive](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#getactive) [registerType](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#registertype) [removeAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#removeaccount) [replaceAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#replaceaccount) [setAccountMetadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#setaccountmetadata) [setActive](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#setactive) [toJSON](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#tojson) [unregisterType](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#unregistertype) Constructors ------------ ### constructor[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#constructor) * new AccountManager<[Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#constructoraccountmanagermetadata) extends unknown \= any\>(): [AccountManager](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html) <[Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#constructoraccountmanagermetadata) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#constructoraccountmanager) #### Type Parameters * Metadata extends unknown = any #### Returns [AccountManager](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html) <[Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#constructoraccountmanagermetadata) \> Properties ---------- ### accounts$[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#accounts) accounts$: BehaviorSubject<[IAccount](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html) \[\]\> = ... ### active$[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#active) active$: BehaviorSubject\> = ... ### `Optional`disableQueue[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#disablequeue) disableQueue?: boolean Disable request queueing for any accounts added to this manager ### signer[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#signer) signer: [ISigner](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.ISigner.html) Proxy signer for currently active account ### types[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#types) types: Map\> = ... Accessors --------- ### accounts[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#accounts-1) * get accounts(): [IAccount](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html) \[\] #### Returns [IAccount](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html) \[\] ### active[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#active-1) * get active(): undefined | [IAccount](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html) #### Returns undefined | [IAccount](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html) Methods ------- ### addAccount[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#addaccount) * addAccount(account: [IAccount](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html) ): void[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#addaccount-1) adds an account to the manager #### Parameters * account: [IAccount](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html) #### Returns void ### clearAccountMetadata[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#clearaccountmetadata) * clearAccountMetadata(id: string | [IAccount](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html) ): void[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#clearaccountmetadata-1) Removes all metadata on the account #### Parameters * id: string | [IAccount](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html) #### Returns void ### clearActive[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#clearactive) * clearActive(): void[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#clearactive-1) Clears the currently active account #### Returns void ### fromJSON[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#fromjson) * fromJSON(accounts: [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) \[\], quite?: boolean): void[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#fromjson-1) Restores all accounts from an array of serialized accounts NOTE: this will clear all existing accounts #### Parameters * accounts: [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) \[\] * quite: boolean = false #### Returns void ### getAccount[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#getaccount) * getAccount<[Signer](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#getaccountsigner) extends [ISigner](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.ISigner.html) \>(     id: string | [IAccount](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html) <[Signer](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#getaccountsigner) , any, [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#constructoraccountmanagermetadata) \>, ): undefined | [IAccount](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html) <[Signer](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#getaccountsigner) , any, [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#constructoraccountmanagermetadata) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#getaccount-1) gets an account in the manager #### Type Parameters * Signer extends [ISigner](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.ISigner.html) #### Parameters * id: string | [IAccount](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html) <[Signer](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#getaccountsigner) , any, [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#constructoraccountmanagermetadata) \> #### Returns undefined | [IAccount](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html) <[Signer](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#getaccountsigner) , any, [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#constructoraccountmanagermetadata) \> ### getAccountForPubkey[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#getaccountforpubkey) * getAccountForPubkey(pubkey: string): undefined | [IAccount](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html) [](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#getaccountforpubkey-1) Return the first account for a pubkey #### Parameters * pubkey: string #### Returns undefined | [IAccount](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html) ### getAccountMetadata[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#getaccountmetadata) * getAccountMetadata(     id: string | [IAccount](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html) , ): undefined | [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#constructoraccountmanagermetadata) [](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#getaccountmetadata-1) sets the metadata on an account #### Parameters * id: string | [IAccount](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html) #### Returns undefined | [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#constructoraccountmanagermetadata) ### getAccountsForPubkey[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#getaccountsforpubkey) * getAccountsForPubkey(pubkey: string): [IAccount](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html) \[\][](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#getaccountsforpubkey-1) Returns all accounts for a pubkey #### Parameters * pubkey: string #### Returns [IAccount](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html) \[\] ### getActive[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#getactive) * getActive(): undefined | [IAccount](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html) [](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#getactive-1) Returns the currently active account #### Returns undefined | [IAccount](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html) ### registerType[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#registertype) * registerType<[S](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#registertypes) extends [ISigner](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.ISigner.html) \>(     accountType: [IAccountConstructor](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccountConstructor.html) <[S](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#registertypes) , any, [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#constructoraccountmanagermetadata) \>, ): void[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#registertype-1) Add account type class #### Type Parameters * S extends [ISigner](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.ISigner.html) #### Parameters * accountType: [IAccountConstructor](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccountConstructor.html) <[S](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#registertypes) , any, [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#constructoraccountmanagermetadata) \> #### Returns void ### removeAccount[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#removeaccount) * removeAccount(account: string | [IAccount](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html) ): void[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#removeaccount-1) Removes an account from the manager #### Parameters * account: string | [IAccount](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html) #### Returns void ### replaceAccount[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#replaceaccount) * replaceAccount(     old: string | [IAccount](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html) ,     account: [IAccount](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html) , ): void[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#replaceaccount-1) Replaces an account with another #### Parameters * old: string | [IAccount](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html) * account: [IAccount](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html) #### Returns void ### setAccountMetadata[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#setaccountmetadata) * setAccountMetadata(     id: string | [IAccount](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html) ,     metadata: [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#constructoraccountmanagermetadata) , ): void[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#setaccountmetadata-1) sets the metadata on an account #### Parameters * id: string | [IAccount](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html) * metadata: [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#constructoraccountmanagermetadata) #### Returns void ### setActive[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#setactive) * setActive(id: string | [IAccount](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html) ): void[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#setactive-1) Sets the currently active account #### Parameters * id: string | [IAccount](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html) #### Returns void ### toJSON[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#tojson) * toJSON(quite?: boolean): [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) \[\][](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#tojson-1) Returns an array of serialized accounts #### Parameters * quite: boolean = false #### Returns [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) \[\] ### unregisterType[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#unregistertype) * unregisterType(type: string): void[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#unregistertype-1) Remove account type #### Parameters * type: string #### Returns void ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Constructors [constructor](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#constructor) Properties [accounts$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#accounts) [active$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#active) [disableQueue](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#disablequeue) [signer](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#signer) [types](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#types) Accessors [accounts](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#accounts-1) [active](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#active-1) Methods [addAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#addaccount) [clearAccountMetadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#clearaccountmetadata) [clearActive](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#clearactive) [fromJSON](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#fromjson) [getAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#getaccount) [getAccountForPubkey](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#getaccountforpubkey) [getAccountMetadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#getaccountmetadata) [getAccountsForPubkey](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#getaccountsforpubkey) [getActive](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#getactive) [registerType](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#registertype) [removeAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#removeaccount) [replaceAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#replaceaccount) [setAccountMetadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#setaccountmetadata) [setActive](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#setactive) [toJSON](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#tojson) [unregisterType](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html#unregistertype) --- # ActionHub | AppleSauce * [applesauce-actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.html) * [ActionHub](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-actions.ActionHub.html) Class ActionHub =============== The main class that runs actions ##### Index ### Constructors [constructor](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-actions.ActionHub.html#constructor) ### Properties [context](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-actions.ActionHub.html#context) [events](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-actions.ActionHub.html#events) [factory](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-actions.ActionHub.html#factory) [publish?](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-actions.ActionHub.html#publish) [saveToStore](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-actions.ActionHub.html#savetostore) ### Methods [exec](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-actions.ActionHub.html#exec) [getContext](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-actions.ActionHub.html#getcontext) [run](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-actions.ActionHub.html#run) [runAction](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-actions.ActionHub.html#runaction) Constructors ------------ ### constructor[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-actions.ActionHub.html#constructor) * new ActionHub(     events: [IEventStoreRead](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreRead.html) & [IEventStoreActions](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreActions.html) ,     factory: [EventFactory](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html) ,     publish?: [PublishMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.PublishMethod.html) , ): [ActionHub](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-actions.ActionHub.html) [](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-actions.ActionHub.html#constructoractionhub) #### Parameters * events: [IEventStoreRead](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreRead.html) & [IEventStoreActions](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreActions.html) * factory: [EventFactory](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html) * `Optional`publish: [PublishMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.PublishMethod.html) #### Returns [ActionHub](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-actions.ActionHub.html) Properties ---------- ### `Protected`context[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-actions.ActionHub.html#context) context: undefined | [ActionContext](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.ActionContext.html) = undefined ### events[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-actions.ActionHub.html#events) events: [IEventStoreRead](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreRead.html) & [IEventStoreActions](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreActions.html) ### factory[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-actions.ActionHub.html#factory) factory: [EventFactory](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html) ### `Optional`publish[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-actions.ActionHub.html#publish) publish?: [PublishMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.PublishMethod.html) ### saveToStore[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-actions.ActionHub.html#savetostore) saveToStore: boolean = true Whether to save all events created by actions to the event store Methods ------- ### exec[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-actions.ActionHub.html#exec) * exec<[Args](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-actions.ActionHub.html#execargs) extends any\[\]\>(     Action: [ActionConstructor](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.ActionConstructor.html) <[Args](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-actions.ActionHub.html#execargs) \>,     ...args: [Args](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-actions.ActionHub.html#execargs) , ): Observable[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-actions.ActionHub.html#exec-1) Run an action without publishing the events #### Type Parameters * Args extends any\[\] #### Parameters * Action: [ActionConstructor](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.ActionConstructor.html) <[Args](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-actions.ActionHub.html#execargs) \> * ...args: [Args](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-actions.ActionHub.html#execargs) #### Returns Observable ### `Protected`getContext[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-actions.ActionHub.html#getcontext) * getContext(): Promise<[ActionContext](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.ActionContext.html) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-actions.ActionHub.html#getcontext-1) #### Returns Promise<[ActionContext](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.ActionContext.html) \> ### run[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-actions.ActionHub.html#run) * run<[Args](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-actions.ActionHub.html#runargs) extends any\[\]\>(     Action: [ActionConstructor](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.ActionConstructor.html) <[Args](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-actions.ActionHub.html#runargs) \>,     ...args: [Args](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-actions.ActionHub.html#runargs) , ): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-actions.ActionHub.html#run-1) Run an action and publish events using the publish method #### Type Parameters * Args extends any\[\] #### Parameters * Action: [ActionConstructor](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.ActionConstructor.html) <[Args](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-actions.ActionHub.html#runargs) \> * ...args: [Args](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-actions.ActionHub.html#runargs) #### Returns Promise ### `Static`runAction[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-actions.ActionHub.html#runaction) * runAction(ctx: [ActionContext](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.ActionContext.html) , action: [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) ): Observable[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-actions.ActionHub.html#runaction-1) Runs an action in a ActionContext and converts the result to an Observable #### Parameters * ctx: [ActionContext](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.ActionContext.html) * action: [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) #### Returns Observable ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Constructors [constructor](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-actions.ActionHub.html#constructor) Properties [context](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-actions.ActionHub.html#context) [events](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-actions.ActionHub.html#events) [factory](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-actions.ActionHub.html#factory) [publish](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-actions.ActionHub.html#publish) [saveToStore](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-actions.ActionHub.html#savetostore) Methods [exec](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-actions.ActionHub.html#exec) [getContext](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-actions.ActionHub.html#getcontext) [run](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-actions.ActionHub.html#run) [runAction](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-actions.ActionHub.html#runaction) --- # Accounts | AppleSauce * [applesauce-accounts](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.html) * [Accounts](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.Accounts.html) Namespace Accounts ================== Classes ------- [AmberClipboardAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.Accounts.html#amberclipboardaccount) [ExtensionAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.Accounts.html#extensionaccount) [NostrConnectAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.Accounts.html#nostrconnectaccount) [PasswordAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.Accounts.html#passwordaccount) [ReadonlyAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.Accounts.html#readonlyaccount) [SerialPortAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.Accounts.html#serialportaccount) [SimpleAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.Accounts.html#simpleaccount) Type Aliases ------------ [NostrConnectAccountSignerData](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.Accounts.NostrConnectAccountSignerData.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.Accounts.html#nostrconnectaccountsignerdata) [PasswordAccountSignerData](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.Accounts.PasswordAccountSignerData.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.Accounts.html#passwordaccountsignerdata) [SimpleAccountSignerData](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.Accounts.SimpleAccountSignerData.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.Accounts.html#simpleaccountsignerdata) Functions --------- [registerCommonAccountTypes](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-accounts.Accounts.registerCommonAccountTypes.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.Accounts.html#registercommonaccounttypes) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Classes [AmberClipboardAccount](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.Accounts.html#amberclipboardaccount) [ExtensionAccount](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.Accounts.html#extensionaccount) [NostrConnectAccount](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.Accounts.html#nostrconnectaccount) [PasswordAccount](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.Accounts.html#passwordaccount) [ReadonlyAccount](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.Accounts.html#readonlyaccount) [SerialPortAccount](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.Accounts.html#serialportaccount) [SimpleAccount](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.Accounts.html#simpleaccount) Type Aliases [NostrConnectAccountSignerData](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.Accounts.html#nostrconnectaccountsignerdata) [PasswordAccountSignerData](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.Accounts.html#passwordaccountsignerdata) [SimpleAccountSignerData](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.Accounts.html#simpleaccountsignerdata) Functions [registerCommonAccountTypes](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.Accounts.html#registercommonaccounttypes) --- # NostrConnectSigner | AppleSauce * [applesauce-signers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.html) * [NostrConnectSigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html) Class NostrConnectSigner ======================== #### Implements * [ISigner](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.ISigner.html) ##### Index ### Constructors [constructor](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#constructor) ### Properties [auths](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#auths) [isConnected](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#isconnected) [listening](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#listening) [log](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#log) [nip04?](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#nip04) [nip44?](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#nip44) [onAuth](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#onauth) [pubkey?](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#pubkey) [publishMethod](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#publishmethod) [relays](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#relays) [remote?](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#remote) [req?](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#req) [requests](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#requests) [secret](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#secret) [signer](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#signer) [subscriptionMethod](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#subscriptionmethod) [verifyEvent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#verifyevent) [pool](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#pool) [publishMethod](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#publishmethod-1) [subscriptionMethod](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#subscriptionmethod-1) ### Accessors [clientPubkey](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#clientpubkey) ### Methods [close](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#close) [connect](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#connect) [createAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#createaccount) [createRequestEvent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#createrequestevent) [getNostrConnectURI](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#getnostrconnecturi) [getPublicKey](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#getpublickey) [handleEvent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#handleevent) [nip04Decrypt](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#nip04decrypt) [nip04Encrypt](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#nip04encrypt) [nip44Decrypt](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#nip44decrypt) [nip44Encrypt](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#nip44encrypt) [open](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#open) [requireConnection](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#requireconnection) [signEvent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#signevent) [waitForSigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#waitforsigner) [buildSigningPermissions](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#buildsigningpermissions) [fromBunkerURI](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#frombunkeruri) [parseBunkerURI](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#parsebunkeruri) Constructors ------------ ### constructor[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#constructor) * new NostrConnectSigner(opts: [NostrConnectSignerOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.NostrConnectSignerOptions.html) ): [NostrConnectSigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html) [](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#constructornostrconnectsigner) #### Parameters * opts: [NostrConnectSignerOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.NostrConnectSignerOptions.html) #### Returns [NostrConnectSigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html) Properties ---------- ### `Protected`auths[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#auths) auths: Set = ... ### isConnected[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#isconnected) isConnected: boolean = false Whether the signer is connected to the remote signer ### listening[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#listening) listening: boolean = false Whether the signer is listening for events ### `Protected`log[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#log) log: Debugger = ... ### `Optional`nip04[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#nip04) nip04?: {     decrypt: (pubkey: string, ciphertext: string) \=> Promise;     encrypt: (pubkey: string, plaintext: string) \=> Promise; } ### `Optional`nip44[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#nip44) nip44?: {     decrypt: (pubkey: string, ciphertext: string) \=> Promise;     encrypt: (pubkey: string, plaintext: string) \=> Promise; } ### onAuth[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#onauth) onAuth: (url: string) \=> Promise = defaultHandleAuth A method for handling "auth" requests ### `Protected` `Optional`pubkey[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#pubkey) pubkey?: string The users pubkey ### `Protected`publishMethod[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#publishmethod) publishMethod: [NostrPublishMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.NostrPublishMethod.html) A method that is called when an event needs to be published ### relays[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#relays) relays: string\[\] Relays to communicate over ### `Optional`remote[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#remote) remote?: string The remote signer pubkey ### `Protected` `Optional`req[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#req) req?: Unsubscribable The currently active REQ subscription ### `Protected`requests[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#requests) requests: Map\> = ... ### secret[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#secret) secret: string A secret used when initiating a connection from the client side ### signer[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#signer) signer: [SimpleSigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SimpleSigner.html) The local client signer ### `Protected`subscriptionMethod[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#subscriptionmethod) subscriptionMethod: [NostrSubscriptionMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.NostrSubscriptionMethod.html) The active nostr subscription ### verifyEvent[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#verifyevent) verifyEvent: (event: Event) \=> event is VerifiedEvent = verifyEvent ### `Static`pool[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#pool) pool: undefined | [NostrPool](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.NostrPool.html) = undefined A fallback pool to use if none is pass in when creating the signer ### `Static`publishMethod[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#publishmethod-1) publishMethod: undefined | [NostrPublishMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.NostrPublishMethod.html) = undefined A fallback method to use for publishMethod if none is pass in when creating the signer ### `Static`subscriptionMethod[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#subscriptionmethod-1) subscriptionMethod: undefined | [NostrSubscriptionMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.NostrSubscriptionMethod.html) = undefined A fallback method to use for subscriptionMethod if none is pass in when creating the signer Accessors --------- ### clientPubkey[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#clientpubkey) * get clientPubkey(): string Client pubkey #### Returns string Methods ------- ### close[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#close) * close(): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#close-1) Close the connection #### Returns Promise ### connect[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#connect) * connect(secret?: string, permissions?: string\[\]): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#connect-1) Connect to remote signer #### Parameters * `Optional`secret: string * `Optional`permissions: string\[\] #### Returns Promise ### createAccount[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#createaccount) * createAccount(     username: string,     domain: string,     email?: string,     permissions?: string\[\], ): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#createaccount-1) Request to create an account on the remote signer #### Parameters * username: string * domain: string * `Optional`email: string * `Optional`permissions: string\[\] #### Returns Promise ### `Protected`createRequestEvent[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#createrequestevent) * createRequestEvent(     content: string,     target?: undefined | string,     kind?: number, ): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#createrequestevent-1) #### Parameters * content: string * target: undefined | string = ... * kind: number = kinds.NostrConnect #### Returns Promise ### getNostrConnectURI[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#getnostrconnecturi) * getNostrConnectURI(metadata?: [NostrConnectAppMetadata](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.NostrConnectAppMetadata.html) ): string[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#getnostrconnecturi-1) Returns the nostrconnect:// URI for this signer #### Parameters * `Optional`metadata: [NostrConnectAppMetadata](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.NostrConnectAppMetadata.html) #### Returns string ### getPublicKey[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#getpublickey) * getPublicKey(): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#getpublickey-1) Get the users pubkey #### Returns Promise ### handleEvent[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#handleevent) * handleEvent(event: Event): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#handleevent-1) Call this method with incoming events #### Parameters * event: Event #### Returns Promise ### nip04Decrypt[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#nip04decrypt) * nip04Decrypt(pubkey: string, ciphertext: string): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#nip04decrypt-1) #### Parameters * pubkey: string * ciphertext: string #### Returns Promise ### nip04Encrypt[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#nip04encrypt) * nip04Encrypt(pubkey: string, plaintext: string): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#nip04encrypt-1) #### Parameters * pubkey: string * plaintext: string #### Returns Promise ### nip44Decrypt[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#nip44decrypt) * nip44Decrypt(pubkey: string, ciphertext: string): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#nip44decrypt-1) #### Parameters * pubkey: string * ciphertext: string #### Returns Promise ### nip44Encrypt[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#nip44encrypt) * nip44Encrypt(pubkey: string, plaintext: string): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#nip44encrypt-1) #### Parameters * pubkey: string * plaintext: string #### Returns Promise ### open[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#open) * open(): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#open-1) Open the connection #### Returns Promise ### requireConnection[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#requireconnection) * requireConnection(): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#requireconnection-1) Ensure the signer is connected to the remote signer #### Returns Promise ### signEvent[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#signevent) * signEvent(template: EventTemplate & { pubkey?: string }): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#signevent-1) Request to sign an event #### Parameters * template: EventTemplate & { pubkey?: string } #### Returns Promise ### waitForSigner[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#waitforsigner) * waitForSigner(abort?: AbortSignal): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#waitforsigner-1) Wait for a remote signer to connect #### Parameters * `Optional`abort: AbortSignal #### Returns Promise ### `Static`buildSigningPermissions[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#buildsigningpermissions) * buildSigningPermissions(kinds: number\[\]): string\[\][](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#buildsigningpermissions-1) Builds an array of signing permissions for event kinds #### Parameters * kinds: number\[\] #### Returns string\[\] ### `Static`fromBunkerURI[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#frombunkeruri) * fromBunkerURI(     uri: string,     options?: Omit<[NostrConnectSignerOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.NostrConnectSignerOptions.html) , "relays"\> & {         permissions?: string\[\];         signer?: [SimpleSigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SimpleSigner.html) ;     }, ): Promise<[NostrConnectSigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#frombunkeruri-1) Create a [NostrConnectSigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#) from a bunker:// URI #### Parameters * uri: string * `Optional`options: Omit<[NostrConnectSignerOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.NostrConnectSignerOptions.html) , "relays"\> & {     permissions?: string\[\];     signer?: [SimpleSigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.SimpleSigner.html) ; } #### Returns Promise<[NostrConnectSigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html) \> ### `Static`parseBunkerURI[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#parsebunkeruri) * parseBunkerURI(uri: string): [BunkerURI](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.BunkerURI.html) [](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#parsebunkeruri-1) Parses a bunker:// URI #### Parameters * uri: string #### Returns [BunkerURI](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.BunkerURI.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Constructors [constructor](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#constructor) Properties [auths](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#auths) [isConnected](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#isconnected) [listening](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#listening) [log](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#log) [nip04](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#nip04) [nip44](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#nip44) [onAuth](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#onauth) [pubkey](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#pubkey) [publishMethod](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#publishmethod) [relays](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#relays) [remote](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#remote) [req](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#req) [requests](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#requests) [secret](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#secret) [signer](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#signer) [subscriptionMethod](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#subscriptionmethod) [verifyEvent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#verifyevent) [pool](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#pool) [publishMethod](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#publishmethod-1) [subscriptionMethod](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#subscriptionmethod-1) Accessors [clientPubkey](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#clientpubkey) Methods [close](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#close) [connect](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#connect) [createAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#createaccount) [createRequestEvent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#createrequestevent) [getNostrConnectURI](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#getnostrconnecturi) [getPublicKey](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#getpublickey) [handleEvent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#handleevent) [nip04Decrypt](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#nip04decrypt) [nip04Encrypt](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#nip04encrypt) [nip44Decrypt](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#nip44decrypt) [nip44Encrypt](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#nip44encrypt) [open](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#open) [requireConnection](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#requireconnection) [signEvent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#signevent) [waitForSigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#waitforsigner) [buildSigningPermissions](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#buildsigningpermissions) [fromBunkerURI](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#frombunkeruri) [parseBunkerURI](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectSigner.html#parsebunkeruri) --- # Relay | AppleSauce * [applesauce-relay](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-relay.html) * [Relay](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay) Class Relay =========== #### Implements * [IRelay](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-relay.IRelay.html) ##### Index ### Constructors [constructor](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#constructor) ### Properties [\_nip11](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#_nip11) [attempts$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#attempts) [authenticated$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#authenticated) [authenticationResponse$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#authenticationresponse) [authRequiredForPublish$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#authrequiredforpublish) [authRequiredForRead$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#authrequiredforread) [challenge$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#challenge) [close$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#close) [closing$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#closing) [connected$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#connected) [eoseTimeout](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#eosetimeout) [error$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#error) [eventTimeout](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#eventtimeout) [information$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#information) [keepAlive](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#keepalive) [limitations$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#limitations) [log](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#log) [message$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#message) [notice$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#notice) [notices$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#notices) [open$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#open) [ready$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#ready) [receivedAuthRequiredForEvent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#receivedauthrequiredforevent) [receivedAuthRequiredForReq](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#receivedauthrequiredforreq) [reconnectTimer](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#reconnecttimer) [socket](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#socket) [url](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#url) [watchTower](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#watchtower) ### Accessors [authenticated](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#authenticated-1) [authenticationResponse](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#authenticationresponse-1) [challenge](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#challenge-1) [connected](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#connected-1) [information](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#information-1) [notices](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#notices-1) ### Methods [auth](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#auth) [authenticate](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#authenticate) [close](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#close-1) [customRepeatOperator](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#customrepeatoperator) [customRetryOperator](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#customretryoperator) [event](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#event) [multiplex](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#multiplex) [publish](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#publish) [req](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#req) [request](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#request) [resetState](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#resetstate) [send](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#send) [startReconnectTimer](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#startreconnecttimer) [subscription](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#subscription) [waitForAuth](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#waitforauth) [waitForReady](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#waitforready) [createReconnectTimer](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#createreconnecttimer) [fetchInformationDocument](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#fetchinformationdocument) Constructors ------------ ### constructor[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#constructor) * new Relay(url: string, opts?: [RelayOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.RelayOptions.html) ): [Relay](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay) [](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#constructorrelay) #### Parameters * url: string * `Optional`opts: [RelayOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.RelayOptions.html) #### Returns [Relay](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay) Properties ---------- ### `Protected`\_nip11[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#_nip11) \_nip11: null | RelayInformation = null ### attempts$[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#attempts) attempts$: BehaviorSubject = ... How many times the relay has tried to reconnect ### authenticated$[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#authenticated) authenticated$: Observable Boolean authentication state (will be false if auth failed) ### authenticationResponse$[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#authenticationresponse) authenticationResponse$: BehaviorSubject = ... The response to the last AUTH message sent to the relay ### authRequiredForPublish$[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#authrequiredforpublish) authRequiredForPublish$: Observable ### authRequiredForRead$[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#authrequiredforread) authRequiredForRead$: Observable ### challenge$[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#challenge) challenge$: BehaviorSubject = ... The authentication challenge string from the relay ### close$[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#close) close$: Subject = ... An observable that emits when underlying websocket is closed ### closing$[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#closing) closing$: Subject = ... An observable that emits when underlying websocket is closing due to unsubscription ### connected$[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#connected) connected$: BehaviorSubject = ... Whether the relay is connected ### eoseTimeout[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#eosetimeout) eoseTimeout: number = 10\_000 If an EOSE message is not seen in this time, emit one locally (default 10s) ### error$[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#error) error$: BehaviorSubject = ... The last connection error ### eventTimeout[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#eventtimeout) eventTimeout: number = 10\_000 How long to wait for an OK message from the relay (default 10s) ### information$[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#information) information$: Observable An observable that emits the NIP-11 information document for the relay ### keepAlive[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#keepalive) keepAlive: number = 30\_000 How long to keep the connection alive after nothing is subscribed (default 30s) ### limitations$[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#limitations) limitations$: Observable\> An observable that emits the limitations for the relay ### `Protected`log[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#log) log: Debugger = ... ### message$[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#message) message$: Observable A passive observable of all messages from the relay #### Note[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#note) Subscribing to this will not connect to the relay ### notice$[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#notice) notice$: Observable A passive observable of NOTICE messages from the relay #### Note[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#note-1) Subscribing to this will not connect to the relay ### notices$[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#notices) notices$: BehaviorSubject = ... The notices from the relay ### open$[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#open) open$: Subject = ... An observable that emits when underlying websocket is opened ### `Protected`ready$[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#ready) ready$: BehaviorSubject = ... Whether the relay is ready for subscriptions or event publishing. setting this to false will cause all .req and .event observables to hang until the relay is ready ### `Protected`receivedAuthRequiredForEvent[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#receivedauthrequiredforevent) receivedAuthRequiredForEvent: BehaviorSubject = ... ### `Protected`receivedAuthRequiredForReq[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#receivedauthrequiredforreq) receivedAuthRequiredForReq: BehaviorSubject = ... ### reconnectTimer[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#reconnecttimer) reconnectTimer: (     error: Error | CloseEvent,     attempts: number, ) \=> Observable A method that returns an Observable that emits when the relay should reconnect ### `Protected`socket[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#socket) socket: WebSocketSubject ### url[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#url) url: string ### `Protected`watchTower[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#watchtower) watchTower: Observable An internal observable that is responsible for watching all messages and updating state, subscribing to it will trigger a connection to the relay Accessors --------- ### authenticated[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#authenticated-1) * get authenticated(): boolean #### Returns boolean ### authenticationResponse[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#authenticationresponse-1) * get authenticationResponse(): null | [PublishResponse](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.PublishResponse.html) #### Returns null | [PublishResponse](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.PublishResponse.html) ### challenge[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#challenge-1) * get challenge(): null | string #### Returns null | string ### connected[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#connected-1) * get connected(): boolean #### Returns boolean ### information[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#information-1) * get information(): null | RelayInformation #### Returns null | RelayInformation ### notices[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#notices-1) * get notices(): string\[\] #### Returns string\[\] Methods ------- ### auth[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#auth) * auth(event: Event): Promise<[PublishResponse](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.PublishResponse.html) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#auth-1) send and AUTH message #### Parameters * event: Event #### Returns Promise<[PublishResponse](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.PublishResponse.html) \> ### authenticate[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#authenticate) * authenticate(signer: [AuthSigner](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.AuthSigner.html) ): Promise<[PublishResponse](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.PublishResponse.html) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#authenticate-1) Authenticate with the relay using a signer #### Parameters * signer: [AuthSigner](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.AuthSigner.html) #### Returns Promise<[PublishResponse](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.PublishResponse.html) \> ### close[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#close-1) * close(): void[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#close-2) Force close the connection #### Returns void ### `Protected`customRepeatOperator[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#customrepeatoperator) * customRepeatOperator<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#customrepeatoperatort) extends unknown \= unknown\>(     times: undefined | number | boolean | RepeatConfig, ): MonoTypeOperatorFunction<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#customrepeatoperatort) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#customrepeatoperator-1) Internal operator for creating the repeat() operator #### Type Parameters * T extends unknown = unknown #### Parameters * times: undefined | number | boolean | RepeatConfig #### Returns MonoTypeOperatorFunction<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#customrepeatoperatort) \> ### `Protected`customRetryOperator[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#customretryoperator) * customRetryOperator<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#customretryoperatort) extends unknown \= unknown\>(     times: number | RetryConfig, ): MonoTypeOperatorFunction<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#customretryoperatort) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#customretryoperator-1) Internal operator for creating the retry() operator #### Type Parameters * T extends unknown = unknown #### Parameters * times: number | RetryConfig #### Returns MonoTypeOperatorFunction<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#customretryoperatort) \> ### event[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#event) * event(event: Event, verb?: "EVENT" | "AUTH"): Observable<[PublishResponse](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.PublishResponse.html) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#event-1) Send an EVENT or AUTH message and return an observable of PublishResponse that completes or errors #### Parameters * event: Event * verb: "EVENT" | "AUTH" = "EVENT" #### Returns Observable<[PublishResponse](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.PublishResponse.html) \> ### multiplex[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#multiplex) * multiplex<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#multiplext) \>(     open: () \=> any,     close: () \=> any,     filter: (message: any) \=> boolean, ): Observable<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#multiplext) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#multiplex-1) Creates an Observable, that when subscribed to, sends a message, defined by the `subMsg` function, to the server over the socket to begin a subscription to data over that socket. Once data arrives, the `messageFilter` argument will be used to select the appropriate data for the resulting Observable. When finalization occurs, either due to unsubscription, completion, or error, a message defined by the `unsubMsg` argument will be sent to the server over the WebSocketSubject. #### Type Parameters * T #### Parameters * open: () \=> any A function to generate the subscription message to be sent to the server. This will still be processed by the serializer in the WebSocketSubject's config. (Which defaults to JSON serialization) * close: () \=> any A function to generate the unsubscription message to be sent to the server at finalization. This will still be processed by the serializer in the WebSocketSubject's config. * filter: (message: any) \=> boolean A predicate for selecting the appropriate messages from the server for the output stream. #### Returns Observable<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#multiplext) \> ### publish[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#publish) * publish(event: Event, opts?: [PublishOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.PublishOptions.html) ): Promise<[PublishResponse](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.PublishResponse.html) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#publish-1) Publishes an event to the relay and retries when relay errors or responds with auth-required ( default 3 retries ) #### Parameters * event: Event * `Optional`opts: [PublishOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.PublishOptions.html) #### Returns Promise<[PublishResponse](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.PublishResponse.html) \> ### req[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#req) * req(filters: [FilterInput](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.FilterInput.html) , id?: string): Observable<[SubscriptionResponse](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.SubscriptionResponse.html) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#req-1) Create a REQ observable that emits events or "EOSE" or errors #### Parameters * filters: [FilterInput](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.FilterInput.html) * id: string = ... #### Returns Observable<[SubscriptionResponse](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.SubscriptionResponse.html) \> ### request[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#request) * request(     filters: Filter | Filter\[\],     opts?: [SubscriptionOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.SubscriptionOptions.html) , ): Observable[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#request-1) Makes a single request that retires on errors and completes on EOSE #### Parameters * filters: Filter | Filter\[\] * `Optional`opts: [SubscriptionOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.SubscriptionOptions.html) #### Returns Observable ### `Protected`resetState[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#resetstate) * resetState(): void[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#resetstate-1) #### Returns void ### send[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#send) * send(message: any): void[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#send-1) Send a message to the relay #### Parameters * message: any #### Returns void ### `Protected`startReconnectTimer[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#startreconnecttimer) * startReconnectTimer(error: Error | CloseEvent): void[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#startreconnecttimer-1) Set ready = false and start the reconnect timer #### Parameters * error: Error | CloseEvent #### Returns void ### subscription[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#subscription) * subscription(     filters: Filter | Filter\[\],     opts?: [SubscriptionOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.SubscriptionOptions.html) , ): Observable<[SubscriptionResponse](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.SubscriptionResponse.html) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#subscription-1) Creates a REQ that retries when relay errors ( default 3 retries ) #### Parameters * filters: Filter | Filter\[\] * `Optional`opts: [SubscriptionOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.SubscriptionOptions.html) #### Returns Observable<[SubscriptionResponse](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.SubscriptionResponse.html) \> ### `Protected`waitForAuth[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#waitforauth) * waitForAuth<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#waitforautht) extends unknown \= unknown\>(     requireAuth: Observable,     observable: Observable<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#waitforautht) \>, ): Observable<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#waitforautht) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#waitforauth-1) Wait for authentication state, make connection and then wait for authentication if required #### Type Parameters * T extends unknown = unknown #### Parameters * requireAuth: Observable * observable: Observable<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#waitforautht) \> #### Returns Observable<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#waitforautht) \> ### `Protected`waitForReady[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#waitforready) * waitForReady<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#waitforreadyt) extends unknown \= unknown\>(     observable: Observable<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#waitforreadyt) \>, ): Observable<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#waitforreadyt) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#waitforready-1) Wait for the relay to be ready to accept connections #### Type Parameters * T extends unknown = unknown #### Parameters * observable: Observable<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#waitforreadyt) \> #### Returns Observable<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#waitforreadyt) \> ### `Static`createReconnectTimer[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#createreconnecttimer) * createReconnectTimer(     \_relay: string, ): (\_error?: Error | CloseEvent, tries?: number) \=> Observable<0\>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#createreconnecttimer-1) Static method to create a reconnection method for each relay #### Parameters * \_relay: string #### Returns (\_error?: Error | CloseEvent, tries?: number) \=> Observable<0\> ### `Static`fetchInformationDocument[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#fetchinformationdocument) * fetchInformationDocument(url: string): Observable[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#fetchinformationdocument-1) Static method to fetch the NIP-11 information document for a relay #### Parameters * url: string #### Returns Observable ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Constructors [constructor](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#constructor) Properties [\_nip11](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#_nip11) [attempts$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#attempts) [authenticated$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#authenticated) [authenticationResponse$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#authenticationresponse) [authRequiredForPublish$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#authrequiredforpublish) [authRequiredForRead$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#authrequiredforread) [challenge$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#challenge) [close$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#close) [closing$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#closing) [connected$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#connected) [eoseTimeout](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#eosetimeout) [error$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#error) [eventTimeout](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#eventtimeout) [information$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#information) [keepAlive](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#keepalive) [limitations$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#limitations) [log](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#log) [message$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#message) [notice$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#notice) [notices$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#notices) [open$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#open) [ready$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#ready) [receivedAuthRequiredForEvent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#receivedauthrequiredforevent) [receivedAuthRequiredForReq](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#receivedauthrequiredforreq) [reconnectTimer](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#reconnecttimer) [socket](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#socket) [url](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#url) [watchTower](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#watchtower) Accessors [authenticated](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#authenticated-1) [authenticationResponse](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#authenticationresponse-1) [challenge](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#challenge-1) [connected](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#connected-1) [information](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#information-1) [notices](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#notices-1) Methods [auth](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#auth) [authenticate](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#authenticate) [close](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#close-1) [customRepeatOperator](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#customrepeatoperator) [customRetryOperator](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#customretryoperator) [event](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#event) [multiplex](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#multiplex) [publish](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#publish) [req](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#req) [request](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#request) [resetState](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#resetstate) [send](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#send) [startReconnectTimer](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#startreconnecttimer) [subscription](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#subscription) [waitForAuth](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#waitforauth) [waitForReady](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#waitforready) [createReconnectTimer](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#createreconnecttimer) [fetchInformationDocument](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay#fetchinformationdocument) --- # NostrConnectProvider | AppleSauce * [applesauce-signers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.html) * [NostrConnectProvider](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html) Class NostrConnectProvider ========================== #### Implements * [ProviderAuthorization](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-signers.ProviderAuthorization.html) ##### Index ### Constructors [constructor](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#constructor) ### Properties [client?](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#client) [connected](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#connected) [listening](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#listening) [log](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#log) [onClientConnect?](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#onclientconnect) [onClientDisconnect?](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#onclientdisconnect) [onConnect?](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#onconnect) [onNip04Decrypt?](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#onnip04decrypt) [onNip04Encrypt?](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#onnip04encrypt) [onNip44Decrypt?](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#onnip44decrypt) [onNip44Encrypt?](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#onnip44encrypt) [onSignEvent?](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#onsignevent) [publishMethod](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#publishmethod) [relays](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#relays) [req?](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#req) [secret?](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#secret) [seen](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#seen) [signer](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#signer) [subscriptionMethod](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#subscriptionmethod) [upstream](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#upstream) [pool](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#pool) [publishMethod](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#publishmethod-1) [subscriptionMethod](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#subscriptionmethod-1) ### Methods [getBunkerURI](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#getbunkeruri) [handleConnect](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#handleconnect) [handleEvent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#handleevent) [handleNip04Decrypt](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#handlenip04decrypt) [handleNip04Encrypt](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#handlenip04encrypt) [handleNip44Decrypt](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#handlenip44decrypt) [handleNip44Encrypt](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#handlenip44encrypt) [handleNostrConnectURI](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#handlenostrconnecturi) [handleSignEvent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#handlesignevent) [sendErrorResponse](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#senderrorresponse) [sendMessage](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#sendmessage) [sendResponse](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#sendresponse) [start](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#start) [stop](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#stop) [updateSubscription](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#updatesubscription) [waitForClient](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#waitforclient) Constructors ------------ ### constructor[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#constructor) * new NostrConnectProvider(     opts: [NostrConnectProviderOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.NostrConnectProviderOptions.html) , ): [NostrConnectProvider](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html) [](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#constructornostrconnectprovider) #### Parameters * opts: [NostrConnectProviderOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.NostrConnectProviderOptions.html) #### Returns [NostrConnectProvider](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html) Properties ---------- ### `Optional`client[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#client) client?: string The connected client's public key ### connected[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#connected) connected: boolean = false Whether a client is connected (received a `connect` request) ### listening[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#listening) listening: boolean = false Whether the provider is listening for events ### `Protected`log[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#log) log: Debugger = ... Internal logger ### `Optional`onClientConnect[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#onclientconnect) onClientConnect?: (client: string) \=> any Callbacks ### `Optional`onClientDisconnect[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#onclientdisconnect) onClientDisconnect?: (client: string) \=> any ### `Optional`onConnect[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#onconnect) onConnect?: (     client: string,     permissions: string\[\], ) \=> boolean | Promise A method used to accept or reject `connect` requests ### `Optional`onNip04Decrypt[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#onnip04decrypt) onNip04Decrypt?: (     pubkey: string,     ciphertext: string,     client: string, ) \=> boolean | Promise A method used to accept or reject `nip04_decrypt` requests ### `Optional`onNip04Encrypt[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#onnip04encrypt) onNip04Encrypt?: (     pubkey: string,     plaintext: string,     client: string, ) \=> boolean | Promise A method used to accept or reject `nip04_encrypt` requests ### `Optional`onNip44Decrypt[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#onnip44decrypt) onNip44Decrypt?: (     pubkey: string,     ciphertext: string,     client: string, ) \=> boolean | Promise A method used to accept or reject `nip44_decrypt` requests ### `Optional`onNip44Encrypt[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#onnip44encrypt) onNip44Encrypt?: (     pubkey: string,     plaintext: string,     client: string, ) \=> boolean | Promise A method used to accept or reject `nip44_encrypt` requests ### `Optional`onSignEvent[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#onsignevent) onSignEvent?: (     draft: EventTemplate,     client: string, ) \=> boolean | Promise A method used to accept or reject `sign_event` requests ### `Protected`publishMethod[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#publishmethod) publishMethod: [NostrPublishMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.NostrPublishMethod.html) A method that is called when an event needs to be published ### `Readonly`relays[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#relays) relays: string\[\] Relays to communicate over ### `Protected` `Optional`req[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#req) req?: Unsubscribable The currently active REQ subscription ### `Optional`secret[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#secret) secret?: string The secret used to authorize clients to connect ### `Protected`seen[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#seen) seen: Set = ... A set of nostr requests that have been seen ### signer[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#signer) signer: [ISigner](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.ISigner.html) The identity signer (provider's identity) ### `Protected`subscriptionMethod[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#subscriptionmethod) subscriptionMethod: [NostrSubscriptionMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.NostrSubscriptionMethod.html) The active nostr subscription ### upstream[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#upstream) upstream: [ISigner](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.ISigner.html) The main signer for the actual signing operations ### `Static`pool[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#pool) pool: undefined | [NostrPool](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.NostrPool.html) = undefined A fallback pool to use if none is pass in when creating the provider ### `Static`publishMethod[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#publishmethod-1) publishMethod: undefined | [NostrPublishMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.NostrPublishMethod.html) = undefined A fallback method to use for publishMethod if none is passed in when creating the provider ### `Static`subscriptionMethod[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#subscriptionmethod-1) subscriptionMethod: undefined | [NostrSubscriptionMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.NostrSubscriptionMethod.html) = undefined A fallback method to use for subscriptionMethod if none is passed in when creating the provider Methods ------- ### getBunkerURI[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#getbunkeruri) * getBunkerURI(): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#getbunkeruri-1) Get the connection string that clients can use to connect #### Returns Promise ### `Protected`handleConnect[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#handleconnect) * handleConnect(     client: string,     \_\_namedParameters: \[string, string\] | \[string\] | \[string, string, string\], ): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#handleconnect-1) Handle connect request #### Parameters * client: string * \_\_namedParameters: \[string, string\] | \[string\] | \[string, string, string\] #### Returns Promise ### handleEvent[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#handleevent) * handleEvent(event: Event): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#handleevent-1) Call this method with incoming events #### Parameters * event: Event #### Returns Promise ### `Protected`handleNip04Decrypt[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#handlenip04decrypt) * handleNip04Decrypt(\_\_namedParameters: \[string, string\]): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#handlenip04decrypt-1) Handle NIP-04 decryption #### Parameters * \_\_namedParameters: \[string, string\] #### Returns Promise ### `Protected`handleNip04Encrypt[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#handlenip04encrypt) * handleNip04Encrypt(\_\_namedParameters: \[string, string\]): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#handlenip04encrypt-1) Handle NIP-04 encryption #### Parameters * \_\_namedParameters: \[string, string\] #### Returns Promise ### `Protected`handleNip44Decrypt[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#handlenip44decrypt) * handleNip44Decrypt(\_\_namedParameters: \[string, string\]): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#handlenip44decrypt-1) Handle NIP-44 decryption #### Parameters * \_\_namedParameters: \[string, string\] #### Returns Promise ### `Protected`handleNip44Encrypt[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#handlenip44encrypt) * handleNip44Encrypt(\_\_namedParameters: \[string, string\]): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#handlenip44encrypt-1) Handle NIP-44 encryption #### Parameters * \_\_namedParameters: \[string, string\] #### Returns Promise ### handleNostrConnectURI[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#handlenostrconnecturi) * handleNostrConnectURI(uri: string | [NostrConnectURI](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.NostrConnectURI.html) ): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#handlenostrconnecturi-1) Handle an initial NostrConnectURI #### Parameters * uri: string | [NostrConnectURI](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.NostrConnectURI.html) #### Returns Promise ### `Protected`handleSignEvent[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#handlesignevent) * handleSignEvent(\_\_namedParameters: \[string\]): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#handlesignevent-1) Handle sign event request #### Parameters * \_\_namedParameters: \[string\] #### Returns Promise ### `Protected`sendErrorResponse[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#senderrorresponse) * sendErrorResponse(event: Event, requestId: string, error: string): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#senderrorresponse-1) Send an error response to the client #### Parameters * event: Event * requestId: string * error: string #### Returns Promise ### `Protected`sendMessage[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#sendmessage) * sendMessage(     clientOrRequest: string | Event,     message: [NostrConnectResponse](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.NostrConnectResponse.html) , ): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#sendmessage-1) Send an encrypted message to the client #### Parameters * clientOrRequest: string | Event * message: [NostrConnectResponse](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.NostrConnectResponse.html) #### Returns Promise ### `Protected`sendResponse[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#sendresponse) * sendResponse<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#sendresponset) extends [NostrConnectMethod](https://hzrd149.github.io/applesauce/typedoc/enums/applesauce-signers.Helpers.NostrConnectMethod.html) \>(     clientOrRequest: string | Event,     requestId: string,     result: [ConnectResponseResults](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.ConnectResponseResults.html) \[[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#sendresponset)\ \], ): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#sendresponse-1) Send a response to the client #### Type Parameters * T extends [NostrConnectMethod](https://hzrd149.github.io/applesauce/typedoc/enums/applesauce-signers.Helpers.NostrConnectMethod.html) #### Parameters * clientOrRequest: string | Event The client pubkey or request event * requestId: string The id of the request * result: [ConnectResponseResults](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.ConnectResponseResults.html) \[[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#sendresponset)\ \] The result of the request #### Returns Promise ### start[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#start) * start(request?: string | Event | [NostrConnectURI](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.NostrConnectURI.html) ): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#start-1) Start the provider #### Parameters * `Optional`request: string | Event | [NostrConnectURI](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.NostrConnectURI.html) An inital `connect` request to respond to or a [NostrConnectURI](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.NostrConnectURI.html) #### Returns Promise ### stop[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#stop) * stop(): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#stop-1) Stop the provider #### Returns Promise ### `Protected`updateSubscription[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#updatesubscription) * updateSubscription(): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#updatesubscription-1) Updates the relay subscription to listen for request events #### Returns Promise ### waitForClient[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#waitforclient) * waitForClient(abort?: AbortSignal): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#waitforclient-1) Wait for a client to connect #### Parameters * `Optional`abort: AbortSignal #### Returns Promise ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Constructors [constructor](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#constructor) Properties [client](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#client) [connected](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#connected) [listening](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#listening) [log](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#log) [onClientConnect](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#onclientconnect) [onClientDisconnect](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#onclientdisconnect) [onConnect](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#onconnect) [onNip04Decrypt](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#onnip04decrypt) [onNip04Encrypt](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#onnip04encrypt) [onNip44Decrypt](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#onnip44decrypt) [onNip44Encrypt](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#onnip44encrypt) [onSignEvent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#onsignevent) [publishMethod](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#publishmethod) [relays](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#relays) [req](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#req) [secret](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#secret) [seen](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#seen) [signer](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#signer) [subscriptionMethod](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#subscriptionmethod) [upstream](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#upstream) [pool](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#pool) [publishMethod](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#publishmethod-1) [subscriptionMethod](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#subscriptionmethod-1) Methods [getBunkerURI](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#getbunkeruri) [handleConnect](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#handleconnect) [handleEvent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#handleevent) [handleNip04Decrypt](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#handlenip04decrypt) [handleNip04Encrypt](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#handlenip04encrypt) [handleNip44Decrypt](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#handlenip44decrypt) [handleNip44Encrypt](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#handlenip44encrypt) [handleNostrConnectURI](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#handlenostrconnecturi) [handleSignEvent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#handlesignevent) [sendErrorResponse](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#senderrorresponse) [sendMessage](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#sendmessage) [sendResponse](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#sendresponse) [start](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#start) [stop](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#stop) [updateSubscription](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#updatesubscription) [waitForClient](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-signers.NostrConnectProvider.html#waitforclient) --- # applesauce-relay | AppleSauce * [applesauce-relay](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-relay.html) Module applesauce-relay ======================= Applesauce Relay[](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-relay.html#applesauce-relay) ================================================================================================================ `applesauce-relay` is a nostr relay communication framework built on top of [RxJS](https://rxjs.dev/) Installation[](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-relay.html#installation) -------------------------------------------------------------------------------------------------------- npm install applesauce-relay Features[](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-relay.html#features) ------------------------------------------------------------------------------------------------ * \[x\] NIP-01 * \[x\] Relay pool and groups * \[x\] Fetch NIP-11 information before connecting * \[x\] NIP-11 `auth_required` limitation * \[ \] NIP-11 `max_subscriptions` limitation * \[x\] Client negentropy sync * \[x\] Reconnection backoff logic * \[x\] republish event on reconnect and auth-required * \[x\] Resubscribe on reconnect and auth-required * \[ \] NIP-45 COUNT Examples[](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-relay.html#examples) ------------------------------------------------------------------------------------------------ Read the [documentation](https://hzrd149.github.io/applesauce/overview/relays.html) for more detailed explanation of all methods ### Single Relay[](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-relay.html#single-relay) import { Relay } from "./relay";// Connect to a single relayconst relay = new Relay("wss://relay.example.com");// Subscribe to eventsrelay .req({ kinds: [1], limit: 10, }) .subscribe((response) => { if (response === "EOSE") { console.log("End of stored events"); } else { console.log("Received event:", response); } });// Publish an eventconst event = { kind: 1, content: "Hello Nostr!", created_at: Math.floor(Date.now() / 1000), tags: [], // ... other required fields};const response = await relay.publish(event);console.log(`Published:`, response.ok); ### Relay Pool[](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-relay.html#relay-pool) import { RelayPool } from "./pool";// Create a pool and connect to multiple relaysconst pool = new RelayPool();const relays = ["wss://relay1.example.com", "wss://relay2.example.com"];// Subscribe to events from multiple relayspool .req(relays, { kinds: [1], limit: 10, }) .subscribe((response) => { if (response === "EOSE") { console.log("End of stored events"); } else { console.log("Received event:", response); } });// Publish to multiple relaysconst responses = await pool.publish(relays, event);responses.forEach((response) => { console.log(`Published to ${response.from}:`, response.ok);}); ### Relay Group[](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-relay.html#relay-group) import { RelayPool } from "./pool";const pool = new RelayPool();const relays = ["wss://relay1.example.com", "wss://relay2.example.com"];// Create a group (automatically deduplicates events)const group = pool.group(relays);// Subscribe to eventsgroup .req({ kinds: [1], limit: 10, }) .subscribe((response) => { console.log("Received:", response); });// Publish to all relays in groupconst responses = await group.publish(event);responses.forEach((response) => { console.log(`Published to ${response.from}:`, response.ok);}); Classes ------- [Relay](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.Relay.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-relay.html#relay) [RelayGroup](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.RelayGroup.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-relay.html#relaygroup) [RelayPool](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.RelayPool.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-relay.html#relaypool) [ReqCloseError](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-relay.ReqCloseError.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-relay.html#reqcloseerror) Interfaces ---------- [IGroup](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-relay.IGroup.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-relay.html#igroup) [IPool](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-relay.IPool.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-relay.html#ipool) [IRelay](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-relay.IRelay.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-relay.html#irelay) Type Aliases ------------ [AuthSigner](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.AuthSigner.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-relay.html#authsigner) [FilterInput](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.FilterInput.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-relay.html#filterinput) [MultiplexWebSocket](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.MultiplexWebSocket.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-relay.html#multiplexwebsocket) [PublishOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.PublishOptions.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-relay.html#publishoptions) [PublishResponse](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.PublishResponse.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-relay.html#publishresponse) [RelayOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.RelayOptions.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-relay.html#relayoptions) [RequestOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.RequestOptions.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-relay.html#requestoptions) [SubscriptionOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.SubscriptionOptions.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-relay.html#subscriptionoptions) [SubscriptionResponse](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.SubscriptionResponse.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-relay.html#subscriptionresponse) Functions --------- [completeOnEose](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-relay.completeOnEose.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-relay.html#completeoneose) [markFromRelay](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-relay.markFromRelay.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-relay.html#markfromrelay) [onlyEvents](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-relay.onlyEvents.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-relay.html#onlyevents) [storeEvents](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-relay.storeEvents.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-relay.html#storeevents) [toEventStore](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-relay.toEventStore.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-relay.html#toeventstore) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page [Applesauce Relay](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-relay.html#applesauce-relay) * [Installation](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-relay.html#installation) * [Features](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-relay.html#features) * [Examples](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-relay.html#examples) * * [Single Relay](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-relay.html#single-relay) * [Relay Pool](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-relay.html#relay-pool) * [Relay Group](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-relay.html#relay-group) Classes [Relay](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-relay.html#relay) [RelayGroup](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-relay.html#relaygroup) [RelayPool](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-relay.html#relaypool) [ReqCloseError](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-relay.html#reqcloseerror) Interfaces [IGroup](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-relay.html#igroup) [IPool](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-relay.html#ipool) [IRelay](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-relay.html#irelay) Type Aliases [AuthSigner](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-relay.html#authsigner) [FilterInput](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-relay.html#filterinput) [MultiplexWebSocket](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-relay.html#multiplexwebsocket) [PublishOptions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-relay.html#publishoptions) [PublishResponse](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-relay.html#publishresponse) [RelayOptions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-relay.html#relayoptions) [RequestOptions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-relay.html#requestoptions) [SubscriptionOptions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-relay.html#subscriptionoptions) [SubscriptionResponse](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-relay.html#subscriptionresponse) Functions [completeOnEose](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-relay.html#completeoneose) [markFromRelay](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-relay.html#markfromrelay) [onlyEvents](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-relay.html#onlyevents) [storeEvents](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-relay.html#storeevents) [toEventStore](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-relay.html#toeventstore) --- # Actions | AppleSauce * [applesauce-wallet](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.html) * [Actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.Actions.html) Namespace Actions ================= Functions --------- [AddNutzapInfoMint](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet.Actions.AddNutzapInfoMint.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.Actions.html#addnutzapinfomint) [AddNutzapInfoRelay](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet.Actions.AddNutzapInfoRelay.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.Actions.html#addnutzapinforelay) [CompleteSpend](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet.Actions.CompleteSpend.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.Actions.html#completespend) [ConsolidateTokens](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet.Actions.ConsolidateTokens.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.Actions.html#consolidatetokens) [CreateWallet](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet.Actions.CreateWallet.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.Actions.html#createwallet) [NutzapEvent](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet.Actions.NutzapEvent.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.Actions.html#nutzapevent) [NutzapProfile](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet.Actions.NutzapProfile.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.Actions.html#nutzapprofile) [ReceiveToken](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet.Actions.ReceiveToken.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.Actions.html#receivetoken) [RemoveNutzapInfoMint](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet.Actions.RemoveNutzapInfoMint.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.Actions.html#removenutzapinfomint) [RemoveNutzapInfoRelay](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet.Actions.RemoveNutzapInfoRelay.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.Actions.html#removenutzapinforelay) [RolloverTokens](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet.Actions.RolloverTokens.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.Actions.html#rollovertokens) [SetNutzapInfoPubkey](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet.Actions.SetNutzapInfoPubkey.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.Actions.html#setnutzapinfopubkey) [UnlockWallet](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet.Actions.UnlockWallet.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.Actions.html#unlockwallet) [UpdateNutzapInfo](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet.Actions.UpdateNutzapInfo.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.Actions.html#updatenutzapinfo) [WalletAddPrivateKey](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet.Actions.WalletAddPrivateKey.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.Actions.html#walletaddprivatekey) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Functions [AddNutzapInfoMint](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.Actions.html#addnutzapinfomint) [AddNutzapInfoRelay](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.Actions.html#addnutzapinforelay) [CompleteSpend](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.Actions.html#completespend) [ConsolidateTokens](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.Actions.html#consolidatetokens) [CreateWallet](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.Actions.html#createwallet) [NutzapEvent](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.Actions.html#nutzapevent) [NutzapProfile](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.Actions.html#nutzapprofile) [ReceiveToken](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.Actions.html#receivetoken) [RemoveNutzapInfoMint](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.Actions.html#removenutzapinfomint) [RemoveNutzapInfoRelay](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.Actions.html#removenutzapinforelay) [RolloverTokens](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.Actions.html#rollovertokens) [SetNutzapInfoPubkey](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.Actions.html#setnutzapinfopubkey) [UnlockWallet](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.Actions.html#unlockwallet) [UpdateNutzapInfo](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.Actions.html#updatenutzapinfo) [WalletAddPrivateKey](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.Actions.html#walletaddprivatekey) --- # applesauce-wallet-connect | AppleSauce * [applesauce-wallet-connect](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html) Module applesauce-wallet-connect ================================ applesauce-wallet-connect[](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html#applesauce-wallet-connect) =========================================================================================================================================== NIP-47 Nostr Wallet Connect implementation for both clients and services. Features[](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html#features) --------------------------------------------------------------------------------------------------------- * **WalletConnect**: Client-side implementation for connecting to NIP-47 wallet services * **WalletService**: Service-side implementation for creating NIP-47 wallet services * Full support for all NIP-47 methods * TypeScript support with full type safety * RxJS-based reactive architecture * Support for both NIP-04 and NIP-44 encryption Installation[](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html#installation) ----------------------------------------------------------------------------------------------------------------- npm install applesauce-wallet-connect WalletConnect (Client)[](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html#walletconnect-client) ----------------------------------------------------------------------------------------------------------------------------------- Connect to a wallet service using a connection string: import { WalletConnect } from "applesauce-wallet-connect";const wallet = WalletConnect.fromConnectURI("nostr+walletconnect://relay.example.com?secret=...&pubkey=...");// Pay an invoiceconst result = await wallet.payInvoice("lnbc1...");console.log("Payment preimage:", result.preimage);// Get wallet balanceconst balance = await wallet.getBalance();console.log("Balance:", balance.balance, "msats"); WalletService (Service)[](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html#walletservice-service) ------------------------------------------------------------------------------------------------------------------------------------- Create a wallet service that handles NIP-47 requests: import { WalletService } from "applesauce-wallet-connect";import { SimpleSigner } from "applesauce-signers";// Create a signer for the serviceconst signer = new SimpleSigner();// Define method handlersconst handlers = { get_info: async () => ({ alias: "My Wallet", color: "#ff0000", pubkey: await signer.getPublicKey(), network: "mainnet" as const, block_height: 800000, block_hash: "0000...0000", methods: ["get_info", "get_balance", "pay_invoice"], }), get_balance: async () => ({ balance: 100000, // 100 sats in msats }), pay_invoice: async (params) => { // Implement your payment logic here console.log("Paying invoice:", params.invoice); return { preimage: "payment_preimage_here", fees_paid: 1000, }; },};// Create the serviceconst service = new WalletService({ subscriptionMethod: mySubscriptionMethod, publishMethod: myPublishMethod, relays: ["wss://relay.example.com"], signer, handlers, // Supported encryption methods will be set based on the signer});// Start the serviceawait service.start();console.log("Wallet service started");// Get the connection string for the wallet serviceconsole.log(service.getConnectURI());// Stop the service when doneservice.stop(); Supported Methods[](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html#supported-methods) --------------------------------------------------------------------------------------------------------------------------- Both WalletConnect and WalletService support all NIP-47 methods: * `get_info` - Get wallet information * `get_balance` - Get wallet balance * `pay_invoice` - Pay a Lightning invoice * `multi_pay_invoice` - Pay multiple invoices * `pay_keysend` - Send a keysend payment * `multi_pay_keysend` - Send multiple keysend payments * `make_invoice` - Create a new invoice * `lookup_invoice` - Look up an invoice * `list_transactions` - List transactions Documentation[](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html#documentation) ------------------------------------------------------------------------------------------------------------------- For more detailed documentation, visit [the docs](https://hzrd149.github.io/applesauce/) . Namespaces ---------- [Blueprints](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Blueprints.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html#blueprints) [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html#helpers) Classes ------- [WalletConnect](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html#walletconnect) [WalletService](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html#walletservice) Interfaces ---------- [WalletServiceHandlers](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceHandlers.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html#walletservicehandlers) [WalletServiceOptions](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceOptions.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html#walletserviceoptions) Type Aliases ------------ [GetBalanceHandler](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.GetBalanceHandler.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html#getbalancehandler) [GetInfoHandler](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.GetInfoHandler.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html#getinfohandler) [ListTransactionsHandler](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.ListTransactionsHandler.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html#listtransactionshandler) [LookupInvoiceHandler](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.LookupInvoiceHandler.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html#lookupinvoicehandler) [MakeInvoiceHandler](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.MakeInvoiceHandler.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html#makeinvoicehandler) [MultiPayInvoiceHandler](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.MultiPayInvoiceHandler.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html#multipayinvoicehandler) [MultiPayKeysendHandler](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.MultiPayKeysendHandler.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html#multipaykeysendhandler) [NostrPool](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.NostrPool.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html#nostrpool) [NostrPublishMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.NostrPublishMethod.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html#nostrpublishmethod) [NostrSubscriptionMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.NostrSubscriptionMethod.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html#nostrsubscriptionmethod) [PayInvoiceHandler](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.PayInvoiceHandler.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html#payinvoicehandler) [PayKeysendHandler](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.PayKeysendHandler.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html#paykeysendhandler) [SerializedWalletConnect](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.SerializedWalletConnect.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html#serializedwalletconnect) [SerializedWalletService](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.SerializedWalletService.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html#serializedwalletservice) [WalletConnectOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.WalletConnectOptions.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html#walletconnectoptions) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page [applesauce-wallet-connect](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html#applesauce-wallet-connect) * [Features](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html#features) * [Installation](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html#installation) * [WalletConnect (Client)](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html#walletconnect-client) * [WalletService (Service)](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html#walletservice-service) * [Supported Methods](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html#supported-methods) * [Documentation](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html#documentation) Namespaces [Blueprints](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html#blueprints) [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html#helpers) Classes [WalletConnect](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html#walletconnect) [WalletService](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html#walletservice) Interfaces [WalletServiceHandlers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html#walletservicehandlers) [WalletServiceOptions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html#walletserviceoptions) Type Aliases [GetBalanceHandler](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html#getbalancehandler) [GetInfoHandler](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html#getinfohandler) [ListTransactionsHandler](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html#listtransactionshandler) [LookupInvoiceHandler](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html#lookupinvoicehandler) [MakeInvoiceHandler](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html#makeinvoicehandler) [MultiPayInvoiceHandler](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html#multipayinvoicehandler) [MultiPayKeysendHandler](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html#multipaykeysendhandler) [NostrPool](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html#nostrpool) [NostrPublishMethod](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html#nostrpublishmethod) [NostrSubscriptionMethod](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html#nostrsubscriptionmethod) [PayInvoiceHandler](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html#payinvoicehandler) [PayKeysendHandler](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html#paykeysendhandler) [SerializedWalletConnect](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html#serializedwalletconnect) [SerializedWalletService](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html#serializedwalletservice) [WalletConnectOptions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html#walletconnectoptions) --- # WalletConnect | AppleSauce * [applesauce-wallet-connect](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html) * [WalletConnect](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html) Class WalletConnect =================== ##### Index ### Constructors [constructor](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#constructor) ### Properties [defaultTimeout](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#defaulttimeout) [encryption$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#encryption) [events$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#events) [notifications$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#notifications) [publishMethod](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#publishmethod) [relays](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#relays) [secret](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#secret) [service$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#service) [signer](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#signer) [subscriptionMethod](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#subscriptionmethod) [support$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#support) [waitForService$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#waitforservice) [pool](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#pool) [publishMethod](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#publishmethod-1) [subscriptionMethod](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#subscriptionmethod-1) ### Accessors [service](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#service-1) ### Methods [getAuthURI](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#getauthuri) [getBalance](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#getbalance) [getInfo](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#getinfo) [getSupport](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#getsupport) [handleNotificationEvent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#handlenotificationevent) [handleResponseEvent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#handleresponseevent) [listTransactions](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#listtransactions) [lookupInvoice](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#lookupinvoice) [makeInvoice](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#makeinvoice) [notification](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#notification) [payInvoice](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#payinvoice) [payKeysend](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#paykeysend) [payMultipleInvoices](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#paymultipleinvoices) [payMultipleKeysend](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#paymultiplekeysend) [request](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#request) [supportsMethod](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#supportsmethod) [supportsNotifications](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#supportsnotifications) [supportsNotificationType](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#supportsnotificationtype) [toJSON](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#tojson) [waitForService](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#waitforservice-1) [fromConnectURI](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#fromconnecturi) [fromJSON](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#fromjson) Constructors ------------ ### constructor[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#constructor) * new WalletConnect(options: [WalletConnectOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.WalletConnectOptions.html) ): [WalletConnect](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html) [](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#constructorwalletconnect) #### Parameters * options: [WalletConnectOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.WalletConnectOptions.html) #### Returns [WalletConnect](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html) Properties ---------- ### defaultTimeout[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#defaulttimeout) defaultTimeout: number Default timeout for requests ### encryption$[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#encryption) encryption$: Observable<[WalletConnectEncryptionMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.WalletConnectEncryptionMethod.html) \> The preferred encryption method for the wallet ### `Protected`events$[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#events) events$: Observable Shared observable for all wallet response events and notifications ### notifications$[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#notifications) notifications$: Observable<[WalletNotification](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.WalletNotification.html) \> Shared observable for all wallet notifications ### `Protected`publishMethod[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#publishmethod) publishMethod: [NostrPublishMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.NostrPublishMethod.html) A method that is called when an event needs to be published ### `Readonly`relays[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#relays) relays: string\[\] The relays to use for the connection ### `Readonly`secret[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#secret) secret: Uint8Array The local client signer ### service$[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#service) service$: BehaviorSubject = ... The wallet service public key ( unset if waiting for service ) ### `Protected` `Readonly`signer[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#signer) signer: [EventSigner](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EventSigner.html) ### `Protected`subscriptionMethod[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#subscriptionmethod) subscriptionMethod: [NostrSubscriptionMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.NostrSubscriptionMethod.html) The active nostr subscription method ### support$[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#support) support$: Observable Observable for wallet info updates ### `Protected`waitForService$[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#waitforservice) waitForService$: Observable An internal observable for listening for the wallet service to connect ### `Static`pool[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#pool) pool: undefined | [NostrPool](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.NostrPool.html) = undefined A fallback pool to use if none is pass in when creating the signer ### `Static`publishMethod[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#publishmethod-1) publishMethod: undefined | [NostrPublishMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.NostrPublishMethod.html) = undefined A fallback method to use for publishMethod if none is passed in when creating the client ### `Static`subscriptionMethod[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#subscriptionmethod-1) subscriptionMethod: undefined | [NostrSubscriptionMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.NostrSubscriptionMethod.html) = undefined A fallback method to use for subscriptionMethod if none is passed in when creating the client Accessors --------- ### service[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#service-1) * get service(): undefined | string #### Returns undefined | string Methods ------- ### getAuthURI[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#getauthuri) * getAuthURI(parts?: Omit<[WalletAuthURI](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletAuthURI.html) , "client" | "relays"\>): string[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#getauthuri-1) Gets the nostr+walletauth URI for the connection #### Parameters * `Optional`parts: Omit<[WalletAuthURI](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletAuthURI.html) , "client" | "relays"\> #### Returns string ### getBalance[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#getbalance) * getBalance(): Promise<[GetBalanceResult](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.GetBalanceResult.html) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#getbalance-1) Get wallet balance #### Returns Promise<[GetBalanceResult](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.GetBalanceResult.html) \> ### getInfo[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#getinfo) * getInfo(): Promise<[GetInfoResult](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.GetInfoResult.html) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#getinfo-1) Get wallet info #### Returns Promise<[GetInfoResult](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.GetInfoResult.html) \> ### getSupport[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#getsupport) * getSupport(): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#getsupport-1) Get the wallet support info #### Returns Promise ### `Protected`handleNotificationEvent[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#handlenotificationevent) * handleNotificationEvent(event: Event): Promise<[WalletNotification](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.WalletNotification.html) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#handlenotificationevent-1) Handle notification events #### Parameters * event: Event #### Returns Promise<[WalletNotification](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.WalletNotification.html) \> ### `Protected`handleResponseEvent[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#handleresponseevent) * handleResponseEvent(     event: Event,     encryption?: [EncryptionMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.EncryptionMethod.html) , ): Promise<[WalletResponse](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.WalletResponse.html) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#handleresponseevent-1) Process response events and return WalletResponse or throw error #### Parameters * event: Event * `Optional`encryption: [EncryptionMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.EncryptionMethod.html) #### Returns Promise<[WalletResponse](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.WalletResponse.html) \> ### listTransactions[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#listtransactions) * listTransactions(     params?: {         from?: number;         limit?: number;         offset?: number;         type?: "incoming" | "outgoing";         unpaid?: boolean;         until?: number;     }, ): Promise<[ListTransactionsResult](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.ListTransactionsResult.html) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#listtransactions-1) List transactions #### Parameters * `Optional`params: {     from?: number;     limit?: number;     offset?: number;     type?: "incoming" | "outgoing";     unpaid?: boolean;     until?: number; } #### Returns Promise<[ListTransactionsResult](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.ListTransactionsResult.html) \> ### lookupInvoice[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#lookupinvoice) * lookupInvoice(payment\_hash?: string, invoice?: string): Promise<[Transaction](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.Transaction.html) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#lookupinvoice-1) Look up an invoice by payment hash or invoice string #### Parameters * `Optional`payment\_hash: string * `Optional`invoice: string #### Returns Promise<[Transaction](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.Transaction.html) \> ### makeInvoice[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#makeinvoice) * makeInvoice(     amount: number,     options?: Omit<[MakeInvoiceParams](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.MakeInvoiceParams.html) , "amount"\>, ): Promise<[Transaction](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.Transaction.html) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#makeinvoice-1) Create a new invoice #### Parameters * amount: number * `Optional`options: Omit<[MakeInvoiceParams](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.MakeInvoiceParams.html) , "amount"\> #### Returns Promise<[Transaction](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.Transaction.html) \> ### notification[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#notification) * notification<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#notificationt) extends [WalletNotification](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.WalletNotification.html) \>(     type: [T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#notificationt) \["notification\_type"\],     listener: (notification: [T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#notificationt) \["notification"\]) \=> any, ): Subscription[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#notification-1) Listen for a type of notification #### Type Parameters * T extends [WalletNotification](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.WalletNotification.html) #### Parameters * type: [T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#notificationt) \["notification\_type"\] * listener: (notification: [T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#notificationt) \["notification"\]) \=> any #### Returns Subscription a method to unsubscribe the listener ### payInvoice[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#payinvoice) * payInvoice(invoice: string, amount?: number): Promise<[PayInvoiceResult](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.PayInvoiceResult.html) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#payinvoice-1) Pay a lightning invoice #### Parameters * invoice: string * `Optional`amount: number #### Returns Promise<[PayInvoiceResult](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.PayInvoiceResult.html) \> ### payKeysend[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#paykeysend) * payKeysend(     pubkey: string,     amount: number,     preimage?: string,     tlv\_records?: { type: number; value: string }\[\], ): Promise<[PayKeysendResult](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.PayKeysendResult.html) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#paykeysend-1) Send a keysend payment #### Parameters * pubkey: string * amount: number * `Optional`preimage: string * `Optional`tlv\_records: { type: number; value: string }\[\] #### Returns Promise<[PayKeysendResult](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.PayKeysendResult.html) \> ### payMultipleInvoices[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#paymultipleinvoices) * payMultipleInvoices(     invoices: { amount?: number; id?: string; invoice: string }\[\], ): Promise<[PayInvoiceResult](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.PayInvoiceResult.html) \[\]\>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#paymultipleinvoices-1) Pay multiple lightning invoices #### Parameters * invoices: { amount?: number; id?: string; invoice: string }\[\] #### Returns Promise<[PayInvoiceResult](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.PayInvoiceResult.html) \[\]\> ### payMultipleKeysend[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#paymultiplekeysend) * payMultipleKeysend(     keysends: {         amount: number;         id?: string;         preimage?: string;         pubkey: string;         tlv\_records?: { type: number; value: string }\[\];     }\[\], ): Promise<[PayKeysendResult](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.PayKeysendResult.html) \[\]\>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#paymultiplekeysend-1) Send multiple keysend payments #### Parameters * keysends: {     amount: number;     id?: string;     preimage?: string;     pubkey: string;     tlv\_records?: { type: number; value: string }\[\]; }\[\] #### Returns Promise<[PayKeysendResult](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.PayKeysendResult.html) \[\]\> ### request[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#request) * request(     request: [WalletRequest](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.WalletRequest.html) ,     options?: { timeout?: number }, ): Observable<[WalletResponse](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.WalletResponse.html) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#request-1) Core RPC method that makes a request and returns the response #### Parameters * request: [WalletRequest](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.WalletRequest.html) * options: { timeout?: number } = {} #### Returns Observable<[WalletResponse](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.WalletResponse.html) \> ### supportsMethod[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#supportsmethod) * supportsMethod(method: [WalletMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.WalletMethod.html) ): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#supportsmethod-1) Check if the wallet supports a method #### Parameters * method: [WalletMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.WalletMethod.html) #### Returns Promise ### supportsNotifications[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#supportsnotifications) * supportsNotifications(): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#supportsnotifications-1) Check if the wallet supports notifications #### Returns Promise ### supportsNotificationType[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#supportsnotificationtype) * supportsNotificationType(type: [NotificationType](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.NotificationType.html) ): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#supportsnotificationtype-1) Check if the wallet supports a notification type #### Parameters * type: [NotificationType](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.NotificationType.html) #### Returns Promise ### toJSON[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#tojson) * toJSON(): [WalletConnectURI](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletConnectURI.html) [](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#tojson-1) Serialize the WalletConnect instance #### Returns [WalletConnectURI](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletConnectURI.html) ### waitForService[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#waitforservice-1) * waitForService(abortSignal?: AbortSignal): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#waitforservice-2) Wait for the wallet service to connect #### Parameters * `Optional`abortSignal: AbortSignal #### Returns Promise ### `Static`fromConnectURI[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#fromconnecturi) * fromConnectURI(     connectionString: string,     options?: Omit<[WalletConnectOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.WalletConnectOptions.html) , "secret" | "relays" | "service"\>, ): [WalletConnect](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html) [](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#fromconnecturi-1) Create a new WalletConnect instance from a connection string #### Parameters * connectionString: string * `Optional`options: Omit<[WalletConnectOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.WalletConnectOptions.html) , "secret" | "relays" | "service"\> #### Returns [WalletConnect](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html) ### `Static`fromJSON[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#fromjson) * fromJSON(     json: [WalletConnectURI](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletConnectURI.html) ,     options?: Omit<[WalletConnectOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.WalletConnectOptions.html) , "secret" | "relays" | "service"\>, ): [WalletConnect](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html) [](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#fromjson-1) Create a new WalletConnect instance from a serialized object #### Parameters * json: [WalletConnectURI](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletConnectURI.html) * `Optional`options: Omit<[WalletConnectOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.WalletConnectOptions.html) , "secret" | "relays" | "service"\> #### Returns [WalletConnect](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Constructors [constructor](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#constructor) Properties [defaultTimeout](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#defaulttimeout) [encryption$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#encryption) [events$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#events) [notifications$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#notifications) [publishMethod](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#publishmethod) [relays](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#relays) [secret](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#secret) [service$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#service) [signer](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#signer) [subscriptionMethod](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#subscriptionmethod) [support$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#support) [waitForService$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#waitforservice) [pool](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#pool) [publishMethod](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#publishmethod-1) [subscriptionMethod](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#subscriptionmethod-1) Accessors [service](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#service-1) Methods [getAuthURI](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#getauthuri) [getBalance](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#getbalance) [getInfo](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#getinfo) [getSupport](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#getsupport) [handleNotificationEvent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#handlenotificationevent) [handleResponseEvent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#handleresponseevent) [listTransactions](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#listtransactions) [lookupInvoice](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#lookupinvoice) [makeInvoice](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#makeinvoice) [notification](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#notification) [payInvoice](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#payinvoice) [payKeysend](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#paykeysend) [payMultipleInvoices](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#paymultipleinvoices) [payMultipleKeysend](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#paymultiplekeysend) [request](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#request) [supportsMethod](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#supportsmethod) [supportsNotifications](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#supportsnotifications) [supportsNotificationType](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#supportsnotificationtype) [toJSON](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#tojson) [waitForService](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#waitforservice-1) [fromConnectURI](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#fromconnecturi) [fromJSON](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletConnect.html#fromjson) --- # Helpers | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html) Namespace Helpers ================= Type Aliases ------------ [Nip10TagMarker](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Helpers.Nip10TagMarker.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html#nip10tagmarker) Functions --------- [createATagFromAddressPointer](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.createATagFromAddressPointer.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html#createatagfromaddresspointer) [createCommentTagsForEvent](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.createCommentTagsForEvent.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html#createcommenttagsforevent) [createCommentTagsFromCommentPointer](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.createCommentTagsFromCommentPointer.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html#createcommenttagsfromcommentpointer) [createETagFromEventPointer](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.createETagFromEventPointer.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html#createetagfromeventpointer) [createETagWithMarkerFromEventPointer](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.createETagWithMarkerFromEventPointer.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html#createetagwithmarkerfromeventpointer) [createGroupHTagFromGroupPointer](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.createGroupHTagFromGroupPointer.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html#creategrouphtagfromgrouppointer) [createGroupTagFromGroupPointer](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.createGroupTagFromGroupPointer.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html#creategrouptagfromgrouppointer) [createPTagFromProfilePointer](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.createPTagFromProfilePointer.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html#createptagfromprofilepointer) [createQTagFromEventPointer](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.createQTagFromEventPointer.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html#createqtagfromeventpointer) [ensureAddressPointerTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.ensureAddressPointerTag.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html#ensureaddresspointertag) [ensureEventPointerTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.ensureEventPointerTag.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html#ensureeventpointertag) [ensureKTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.ensureKTag.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html#ensurektag) [ensureMarkedAddressPointerTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.ensureMarkedAddressPointerTag.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html#ensuremarkedaddresspointertag) [ensureMarkedEventPointerTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.ensureMarkedEventPointerTag.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html#ensuremarkedeventpointertag) [ensureMarkedProfilePointerTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.ensureMarkedProfilePointerTag.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html#ensuremarkedprofilepointertag) [ensureNamedValueTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.ensureNamedValueTag.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html#ensurenamedvaluetag) [ensureProfilePointerTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.ensureProfilePointerTag.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html#ensureprofilepointertag) [ensureQuoteEventPointerTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.ensureQuoteEventPointerTag.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html#ensurequoteeventpointertag) [ensureSingletonTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.ensureSingletonTag.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html#ensuresingletontag) [eventPipe](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.eventPipe.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html#eventpipe) [fillAndTrimTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.fillAndTrimTag.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html#fillandtrimtag) [getContentPointers](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.getContentPointers.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html#getcontentpointers) [identity](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.identity.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html#identity) [pipeFromAsyncArray](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.pipeFromAsyncArray.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html#pipefromasyncarray) [skip](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.skip.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html#skip) [tagPipe](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.tagPipe.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html#tagpipe) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Type Aliases [Nip10TagMarker](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html#nip10tagmarker) Functions [createATagFromAddressPointer](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html#createatagfromaddresspointer) [createCommentTagsForEvent](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html#createcommenttagsforevent) [createCommentTagsFromCommentPointer](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html#createcommenttagsfromcommentpointer) [createETagFromEventPointer](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html#createetagfromeventpointer) [createETagWithMarkerFromEventPointer](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html#createetagwithmarkerfromeventpointer) [createGroupHTagFromGroupPointer](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html#creategrouphtagfromgrouppointer) [createGroupTagFromGroupPointer](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html#creategrouptagfromgrouppointer) [createPTagFromProfilePointer](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html#createptagfromprofilepointer) [createQTagFromEventPointer](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html#createqtagfromeventpointer) [ensureAddressPointerTag](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html#ensureaddresspointertag) [ensureEventPointerTag](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html#ensureeventpointertag) [ensureKTag](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html#ensurektag) [ensureMarkedAddressPointerTag](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html#ensuremarkedaddresspointertag) [ensureMarkedEventPointerTag](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html#ensuremarkedeventpointertag) [ensureMarkedProfilePointerTag](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html#ensuremarkedprofilepointertag) [ensureNamedValueTag](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html#ensurenamedvaluetag) [ensureProfilePointerTag](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html#ensureprofilepointertag) [ensureQuoteEventPointerTag](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html#ensurequoteeventpointertag) [ensureSingletonTag](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html#ensuresingletontag) [eventPipe](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html#eventpipe) [fillAndTrimTag](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html#fillandtrimtag) [getContentPointers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html#getcontentpointers) [identity](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html#identity) [pipeFromAsyncArray](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html#pipefromasyncarray) [skip](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html#skip) [tagPipe](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html#tagpipe) --- # TagOperations | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Operations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html) * [TagOperations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html) Namespace TagOperations ======================= Variables --------- [addCoordinateTag](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-factory.Operations.TagOperations.addCoordinateTag.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html#addcoordinatetag) [removeCoordinateTag](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-factory.Operations.TagOperations.removeCoordinateTag.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html#removecoordinatetag) Functions --------- [addAddressTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.addAddressTag.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html#addaddresstag) [addBlossomServerTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.addBlossomServerTag.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html#addblossomservertag) [addEventBookmarkTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.addEventBookmarkTag.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html#addeventbookmarktag) [addEventTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.addEventTag.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html#addeventtag) [addGroupTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.addGroupTag.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html#addgrouptag) [addHashtag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.addHashtag.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html#addhashtag) [addInboxRelay](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.addInboxRelay.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html#addinboxrelay) [addMailboxRelay](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.addMailboxRelay.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html#addmailboxrelay) [addNameValueTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.addNameValueTag.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html#addnamevaluetag) [addOutboxRelay](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.addOutboxRelay.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html#addoutboxrelay) [addPubkeyTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.addPubkeyTag.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html#addpubkeytag) [addRelayTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.addRelayTag.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html#addrelaytag) [removeAddressTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.removeAddressTag.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html#removeaddresstag) [removeBlossomServerTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.removeBlossomServerTag.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html#removeblossomservertag) [removeEventBookmarkTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.removeEventBookmarkTag.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html#removeeventbookmarktag) [removeEventTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.removeEventTag.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html#removeeventtag) [removeGroupTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.removeGroupTag.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html#removegrouptag) [removeHashtag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.removeHashtag.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html#removehashtag) [removeInboxRelay](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.removeInboxRelay.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html#removeinboxrelay) [removeMailboxRelay](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.removeMailboxRelay.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html#removemailboxrelay) [removeNameValueTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.removeNameValueTag.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html#removenamevaluetag) [removeOutboxRelay](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.removeOutboxRelay.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html#removeoutboxrelay) [removePubkeyTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.removePubkeyTag.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html#removepubkeytag) [removeRelayTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.removeRelayTag.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html#removerelaytag) [removeSingletonTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.removeSingletonTag.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html#removesingletontag) [setSingletonTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.setSingletonTag.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html#setsingletontag) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Variables [addCoordinateTag](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html#addcoordinatetag) [removeCoordinateTag](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html#removecoordinatetag) Functions [addAddressTag](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html#addaddresstag) [addBlossomServerTag](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html#addblossomservertag) [addEventBookmarkTag](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html#addeventbookmarktag) [addEventTag](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html#addeventtag) [addGroupTag](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html#addgrouptag) [addHashtag](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html#addhashtag) [addInboxRelay](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html#addinboxrelay) [addMailboxRelay](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html#addmailboxrelay) [addNameValueTag](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html#addnamevaluetag) [addOutboxRelay](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html#addoutboxrelay) [addPubkeyTag](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html#addpubkeytag) [addRelayTag](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html#addrelaytag) [removeAddressTag](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html#removeaddresstag) [removeBlossomServerTag](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html#removeblossomservertag) [removeEventBookmarkTag](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html#removeeventbookmarktag) [removeEventTag](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html#removeeventtag) [removeGroupTag](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html#removegrouptag) [removeHashtag](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html#removehashtag) [removeInboxRelay](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html#removeinboxrelay) [removeMailboxRelay](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html#removemailboxrelay) [removeNameValueTag](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html#removenamevaluetag) [removeOutboxRelay](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html#removeoutboxrelay) [removePubkeyTag](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html#removepubkeytag) [removeRelayTag](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html#removerelaytag) [removeSingletonTag](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html#removesingletontag) [setSingletonTag](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html#setsingletontag) --- # Blueprints | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Blueprints](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html) Namespace Blueprints ==================== Interfaces ---------- [PollOption](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.Blueprints.PollOption.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#polloption) Type Aliases ------------ [CommentBlueprintOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Blueprints.CommentBlueprintOptions.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#commentblueprintoptions) [FileMetadataBlueprintOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Blueprints.FileMetadataBlueprintOptions.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#filemetadatablueprintoptions) [GroupMessageBlueprintOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Blueprints.GroupMessageBlueprintOptions.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#groupmessageblueprintoptions) [HighlightBlueprintOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Blueprints.HighlightBlueprintOptions.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#highlightblueprintoptions) [LegacyMessageBlueprintOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Blueprints.LegacyMessageBlueprintOptions.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#legacymessageblueprintoptions) [LiveChatMessageBlueprintOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Blueprints.LiveChatMessageBlueprintOptions.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#livechatmessageblueprintoptions) [NoteBlueprintOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Blueprints.NoteBlueprintOptions.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#noteblueprintoptions) [PicturePostBlueprintOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Blueprints.PicturePostBlueprintOptions.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#picturepostblueprintoptions) [PollBlueprintOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Blueprints.PollBlueprintOptions.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#pollblueprintoptions) [PollResponseBlueprintOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Blueprints.PollResponseBlueprintOptions.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#pollresponseblueprintoptions) [ShareBlueprintOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Blueprints.ShareBlueprintOptions.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#shareblueprintoptions) [WrappedMessageBlueprintOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Blueprints.WrappedMessageBlueprintOptions.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#wrappedmessageblueprintoptions) Functions --------- [CalendarBlueprint](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.CalendarBlueprint.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#calendarblueprint) [ChannelMessageBlueprint](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.ChannelMessageBlueprint.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#channelmessageblueprint) [ChannelMessageReplyBlueprint](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.ChannelMessageReplyBlueprint.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#channelmessagereplyblueprint) [CommentBlueprint](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.CommentBlueprint.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#commentblueprint) [DeleteBlueprint](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.DeleteBlueprint.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#deleteblueprint) [FileMetadataBlueprint](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.FileMetadataBlueprint.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#filemetadatablueprint) [FollowSetBlueprint](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.FollowSetBlueprint.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#followsetblueprint) [GiftWrapBlueprint](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.GiftWrapBlueprint.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#giftwrapblueprint) [GroupMessageBlueprint](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.GroupMessageBlueprint.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#groupmessageblueprint) [HighlightBlueprint](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.HighlightBlueprint.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#highlightblueprint) [LegacyMessageBlueprint](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.LegacyMessageBlueprint.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#legacymessageblueprint) [LegacyMessageReplyBlueprint](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.LegacyMessageReplyBlueprint.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#legacymessagereplyblueprint) [LiveChatMessageBlueprint](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.LiveChatMessageBlueprint.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#livechatmessageblueprint) [NoteBlueprint](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.NoteBlueprint.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#noteblueprint) [NoteReplyBlueprint](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.NoteReplyBlueprint.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#notereplyblueprint) [PicturePostBlueprint](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.PicturePostBlueprint.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#picturepostblueprint) [PollBlueprint](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.PollBlueprint.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#pollblueprint) [PollResponseBlueprint](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.PollResponseBlueprint.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#pollresponseblueprint) [ReactionBlueprint](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.ReactionBlueprint.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#reactionblueprint) [ShareBlueprint](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.ShareBlueprint.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#shareblueprint) [SingleChoicePollResponseBlueprint](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.SingleChoicePollResponseBlueprint.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#singlechoicepollresponseblueprint) [StreamChatMessage](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.StreamChatMessage.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#streamchatmessage) [WrappedMessageBlueprint](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.WrappedMessageBlueprint.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#wrappedmessageblueprint) [WrappedMessageReplyBlueprint](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.WrappedMessageReplyBlueprint.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#wrappedmessagereplyblueprint) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Interfaces [PollOption](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#polloption) Type Aliases [CommentBlueprintOptions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#commentblueprintoptions) [FileMetadataBlueprintOptions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#filemetadatablueprintoptions) [GroupMessageBlueprintOptions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#groupmessageblueprintoptions) [HighlightBlueprintOptions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#highlightblueprintoptions) [LegacyMessageBlueprintOptions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#legacymessageblueprintoptions) [LiveChatMessageBlueprintOptions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#livechatmessageblueprintoptions) [NoteBlueprintOptions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#noteblueprintoptions) [PicturePostBlueprintOptions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#picturepostblueprintoptions) [PollBlueprintOptions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#pollblueprintoptions) [PollResponseBlueprintOptions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#pollresponseblueprintoptions) [ShareBlueprintOptions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#shareblueprintoptions) [WrappedMessageBlueprintOptions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#wrappedmessageblueprintoptions) Functions [CalendarBlueprint](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#calendarblueprint) [ChannelMessageBlueprint](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#channelmessageblueprint) [ChannelMessageReplyBlueprint](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#channelmessagereplyblueprint) [CommentBlueprint](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#commentblueprint) [DeleteBlueprint](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#deleteblueprint) [FileMetadataBlueprint](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#filemetadatablueprint) [FollowSetBlueprint](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#followsetblueprint) [GiftWrapBlueprint](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#giftwrapblueprint) [GroupMessageBlueprint](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#groupmessageblueprint) [HighlightBlueprint](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#highlightblueprint) [LegacyMessageBlueprint](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#legacymessageblueprint) [LegacyMessageReplyBlueprint](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#legacymessagereplyblueprint) [LiveChatMessageBlueprint](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#livechatmessageblueprint) [NoteBlueprint](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#noteblueprint) [NoteReplyBlueprint](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#notereplyblueprint) [PicturePostBlueprint](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#picturepostblueprint) [PollBlueprint](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#pollblueprint) [PollResponseBlueprint](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#pollresponseblueprint) [ReactionBlueprint](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#reactionblueprint) [ShareBlueprint](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#shareblueprint) [SingleChoicePollResponseBlueprint](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#singlechoicepollresponseblueprint) [StreamChatMessage](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#streamchatmessage) [WrappedMessageBlueprint](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#wrappedmessageblueprint) [WrappedMessageReplyBlueprint](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html#wrappedmessagereplyblueprint) --- # Models | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Models](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html) Namespace Models ================ Type Aliases ------------ [Thread](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Models.Thread.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#thread) [ThreadItem](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Models.ThreadItem.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#threaditem) [ThreadModelOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Models.ThreadModelOptions.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#threadmodeloptions) Functions --------- [BlockedRelaysModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.BlockedRelaysModel.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#blockedrelaysmodel) [CalendarEventRSVPsModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.CalendarEventRSVPsModel.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#calendareventrsvpsmodel) [CalendarEventsModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.CalendarEventsModel.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#calendareventsmodel) [ChannelHiddenModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.ChannelHiddenModel.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#channelhiddenmodel) [ChannelMessagesModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.ChannelMessagesModel.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#channelmessagesmodel) [ChannelMetadataModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.ChannelMetadataModel.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#channelmetadatamodel) [ChannelMutedModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.ChannelMutedModel.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#channelmutedmodel) [CommentsModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.CommentsModel.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#commentsmodel) [ContactsModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.ContactsModel.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#contactsmodel) [EncryptedContentModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.EncryptedContentModel.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#encryptedcontentmodel) [EventModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.EventModel.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#eventmodel) [EventsModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.EventsModel.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#eventsmodel) [EventZapsModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.EventZapsModel.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#eventzapsmodel) [FavoriteRelaySetsModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.FavoriteRelaySetsModel.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#favoriterelaysetsmodel) [FavoriteRelaysModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.FavoriteRelaysModel.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#favoriterelaysmodel) [GiftWrapRumorModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.GiftWrapRumorModel.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#giftwraprumormodel) [GiftWrapsModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.GiftWrapsModel.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#giftwrapsmodel) [HiddenContactsModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.HiddenContactsModel.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#hiddencontactsmodel) [HiddenMuteModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.HiddenMuteModel.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#hiddenmutemodel) [LegacyMessageReplies](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.LegacyMessageReplies.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#legacymessagereplies) [LegacyMessagesGroup](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.LegacyMessagesGroup.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#legacymessagesgroup) [LegacyMessagesGroups](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.LegacyMessagesGroups.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#legacymessagesgroups) [LegacyMessageThreads](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.LegacyMessageThreads.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#legacymessagethreads) [MailboxesModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.MailboxesModel.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#mailboxesmodel) [MuteModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.MuteModel.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#mutemodel) [ProfileModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.ProfileModel.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#profilemodel) [PublicContactsModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.PublicContactsModel.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#publiccontactsmodel) [PublicMuteModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.PublicMuteModel.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#publicmutemodel) [ReactionsModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.ReactionsModel.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#reactionsmodel) [ReceivedZapsModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.ReceivedZapsModel.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#receivedzapsmodel) [ReplaceableModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.ReplaceableModel.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#replaceablemodel) [ReplaceableSetModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.ReplaceableSetModel.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#replaceablesetmodel) [RepliesModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.RepliesModel.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#repliesmodel) [SearchRelaysModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.SearchRelaysModel.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#searchrelaysmodel) [SentZapsModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.SentZapsModel.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#sentzapsmodel) [ThreadModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.ThreadModel.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#threadmodel) [TimelineModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.TimelineModel.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#timelinemodel) [UserBlossomServersModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.UserBlossomServersModel.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#userblossomserversmodel) [UserBookmarkModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.UserBookmarkModel.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#userbookmarkmodel) [UserHiddenBookmarkModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.UserHiddenBookmarkModel.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#userhiddenbookmarkmodel) [UserPinnedModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.UserPinnedModel.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#userpinnedmodel) [UserPublicBookmarkModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.UserPublicBookmarkModel.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#userpublicbookmarkmodel) [WrappedMessageReplies](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.WrappedMessageReplies.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#wrappedmessagereplies) [WrappedMessagesGroup](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.WrappedMessagesGroup.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#wrappedmessagesgroup) [WrappedMessagesGroups](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.WrappedMessagesGroups.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#wrappedmessagesgroups) [WrappedMessagesModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.WrappedMessagesModel.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#wrappedmessagesmodel) [WrappedMessageThreads](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.WrappedMessageThreads.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#wrappedmessagethreads) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Type Aliases [Thread](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#thread) [ThreadItem](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#threaditem) [ThreadModelOptions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#threadmodeloptions) Functions [BlockedRelaysModel](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#blockedrelaysmodel) [CalendarEventRSVPsModel](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#calendareventrsvpsmodel) [CalendarEventsModel](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#calendareventsmodel) [ChannelHiddenModel](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#channelhiddenmodel) [ChannelMessagesModel](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#channelmessagesmodel) [ChannelMetadataModel](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#channelmetadatamodel) [ChannelMutedModel](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#channelmutedmodel) [CommentsModel](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#commentsmodel) [ContactsModel](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#contactsmodel) [EncryptedContentModel](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#encryptedcontentmodel) [EventModel](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#eventmodel) [EventsModel](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#eventsmodel) [EventZapsModel](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#eventzapsmodel) [FavoriteRelaySetsModel](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#favoriterelaysetsmodel) [FavoriteRelaysModel](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#favoriterelaysmodel) [GiftWrapRumorModel](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#giftwraprumormodel) [GiftWrapsModel](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#giftwrapsmodel) [HiddenContactsModel](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#hiddencontactsmodel) [HiddenMuteModel](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#hiddenmutemodel) [LegacyMessageReplies](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#legacymessagereplies) [LegacyMessagesGroup](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#legacymessagesgroup) [LegacyMessagesGroups](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#legacymessagesgroups) [LegacyMessageThreads](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#legacymessagethreads) [MailboxesModel](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#mailboxesmodel) [MuteModel](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#mutemodel) [ProfileModel](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#profilemodel) [PublicContactsModel](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#publiccontactsmodel) [PublicMuteModel](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#publicmutemodel) [ReactionsModel](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#reactionsmodel) [ReceivedZapsModel](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#receivedzapsmodel) [ReplaceableModel](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#replaceablemodel) [ReplaceableSetModel](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#replaceablesetmodel) [RepliesModel](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#repliesmodel) [SearchRelaysModel](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#searchrelaysmodel) [SentZapsModel](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#sentzapsmodel) [ThreadModel](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#threadmodel) [TimelineModel](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#timelinemodel) [UserBlossomServersModel](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#userblossomserversmodel) [UserBookmarkModel](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#userbookmarkmodel) [UserHiddenBookmarkModel](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#userhiddenbookmarkmodel) [UserPinnedModel](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#userpinnedmodel) [UserPublicBookmarkModel](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#userpublicbookmarkmodel) [WrappedMessageReplies](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#wrappedmessagereplies) [WrappedMessagesGroup](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#wrappedmessagesgroup) [WrappedMessagesGroups](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#wrappedmessagesgroups) [WrappedMessagesModel](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#wrappedmessagesmodel) [WrappedMessageThreads](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html#wrappedmessagethreads) --- # Operations | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Operations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html) Namespace Operations ==================== Namespaces ---------- [Calendar](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Calendar.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#calendar) [CalendarEvent](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.CalendarEvent.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#calendarevent) [CalendarRsvp](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.CalendarRsvp.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#calendarrsvp) [Channel](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Channel.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#channel) [Client](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Client.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#client) [Comment](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Comment.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#comment) [Content](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Content.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#content) [Delete](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Delete.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#delete) [Geohash](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Geohash.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#geohash) [GiftWrap](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.GiftWrap.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#giftwrap) [Groups](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Groups.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#groups) [Hashtags](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Hashtags.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#hashtags) [Highlight](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Highlight.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#highlight) [LegacyMessage](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.LegacyMessage.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#legacymessage) [List](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.List.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#list) [LiveStream](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.LiveStream.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#livestream) [Mailboxes](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Mailboxes.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#mailboxes) [Note](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Note.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#note) [PicturePost](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.PicturePost.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#picturepost) [Poll](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Poll.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#poll) [PollResponse](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.PollResponse.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#pollresponse) [Profile](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Profile.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#profile) [Reaction](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Reaction.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#reaction) [Stream](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Stream.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#stream) [StreamChat](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.StreamChat.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#streamchat) [TagOperations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#tagoperations) [WrappedMessage](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.WrappedMessage.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#wrappedmessage) [Zap](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Zap.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#zap) Type Aliases ------------ [MetaTagOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Operations.MetaTagOptions.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#metatagoptions) [ModifyTagsOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Operations.ModifyTagsOptions.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#modifytagsoptions) Functions --------- [includeAltTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.includeAltTag.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#includealttag) [includeNameValueTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.includeNameValueTag.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#includenamevaluetag) [includeReplaceableIdentifier](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.includeReplaceableIdentifier.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#includereplaceableidentifier) [includeSingletonTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.includeSingletonTag.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#includesingletontag) [modifyHiddenTags](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.modifyHiddenTags.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#modifyhiddentags) [modifyPublicTags](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.modifyPublicTags.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#modifypublictags) [modifyTags](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.modifyTags.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#modifytags) [setExpirationTimestamp](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.setExpirationTimestamp.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#setexpirationtimestamp) [setMetaTags](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.setMetaTags.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#setmetatags) [setProtected](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.setProtected.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#setprotected) [sign](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.sign.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#sign) [stamp](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.stamp.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#stamp) [stripSignature](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.stripSignature.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#stripsignature) [stripStamp](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.stripStamp.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#stripstamp) [stripSymbols](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.stripSymbols.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#stripsymbols) [updateCreatedAt](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.updateCreatedAt.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#updatecreatedat) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Namespaces [Calendar](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#calendar) [CalendarEvent](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#calendarevent) [CalendarRsvp](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#calendarrsvp) [Channel](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#channel) [Client](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#client) [Comment](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#comment) [Content](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#content) [Delete](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#delete) [Geohash](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#geohash) [GiftWrap](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#giftwrap) [Groups](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#groups) [Hashtags](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#hashtags) [Highlight](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#highlight) [LegacyMessage](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#legacymessage) [List](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#list) [LiveStream](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#livestream) [Mailboxes](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#mailboxes) [Note](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#note) [PicturePost](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#picturepost) [Poll](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#poll) [PollResponse](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#pollresponse) [Profile](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#profile) [Reaction](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#reaction) [Stream](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#stream) [StreamChat](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#streamchat) [TagOperations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#tagoperations) [WrappedMessage](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#wrappedmessage) [Zap](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#zap) Type Aliases [MetaTagOptions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#metatagoptions) [ModifyTagsOptions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#modifytagsoptions) Functions [includeAltTag](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#includealttag) [includeNameValueTag](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#includenamevaluetag) [includeReplaceableIdentifier](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#includereplaceableidentifier) [includeSingletonTag](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#includesingletontag) [modifyHiddenTags](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#modifyhiddentags) [modifyPublicTags](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#modifypublictags) [modifyTags](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#modifytags) [setExpirationTimestamp](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#setexpirationtimestamp) [setMetaTags](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#setmetatags) [setProtected](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#setprotected) [sign](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#sign) [stamp](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#stamp) [stripSignature](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#stripsignature) [stripStamp](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#stripstamp) [stripSymbols](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#stripsymbols) [updateCreatedAt](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html#updatecreatedat) --- # Actions | AppleSauce * [applesauce-actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.html) * [Actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html) Namespace Actions ================= Variables --------- [ALLOWED\_PIN\_KINDS](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-actions.Actions.ALLOWED_PIN_KINDS.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#allowed_pin_kinds) Functions --------- [AddBlockedRelay](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.AddBlockedRelay.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#addblockedrelay) [AddBlossomServer](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.AddBlossomServer.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#addblossomserver) [AddDMRelay](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.AddDMRelay.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#adddmrelay) [AddEventToCalendar](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.AddEventToCalendar.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#addeventtocalendar) [AddFavoriteRelay](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.AddFavoriteRelay.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#addfavoriterelay) [AddFavoriteRelaySet](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.AddFavoriteRelaySet.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#addfavoriterelayset) [AddInboxRelay](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.AddInboxRelay.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#addinboxrelay) [AddOutboxRelay](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.AddOutboxRelay.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#addoutboxrelay) [AddRelayToRelaySet](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.AddRelayToRelaySet.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#addrelaytorelayset) [AddSearchRelay](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.AddSearchRelay.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#addsearchrelay) [AddUserToFollowSet](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.AddUserToFollowSet.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#addusertofollowset) [BookmarkEvent](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.BookmarkEvent.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#bookmarkevent) [CreateBookmarkList](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.CreateBookmarkList.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#createbookmarklist) [CreateBookmarkSet](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.CreateBookmarkSet.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#createbookmarkset) [CreateFollowSet](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.CreateFollowSet.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#createfollowset) [CreateMailboxes](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.CreateMailboxes.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#createmailboxes) [CreatePinList](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.CreatePinList.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#createpinlist) [CreateProfile](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.CreateProfile.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#createprofile) [CreateRelaySet](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.CreateRelaySet.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#createrelayset) [FollowUser](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.FollowUser.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#followuser) [MuteHashtag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.MuteHashtag.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#mutehashtag) [MuteThread](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.MuteThread.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#mutethread) [MuteUser](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.MuteUser.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#muteuser) [MuteWord](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.MuteWord.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#muteword) [NewBlockedRelays](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.NewBlockedRelays.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#newblockedrelays) [NewBlossomServers](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.NewBlossomServers.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#newblossomservers) [NewContacts](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.NewContacts.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#newcontacts) [NewDMRelays](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.NewDMRelays.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#newdmrelays) [NewFavoriteRelays](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.NewFavoriteRelays.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#newfavoriterelays) [NewSearchRelays](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.NewSearchRelays.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#newsearchrelays) [PinNote](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.PinNote.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#pinnote) [RemoveBlockedRelay](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.RemoveBlockedRelay.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#removeblockedrelay) [RemoveBlossomServer](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.RemoveBlossomServer.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#removeblossomserver) [RemoveDMRelay](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.RemoveDMRelay.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#removedmrelay) [RemoveEventFromCalendar](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.RemoveEventFromCalendar.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#removeeventfromcalendar) [RemoveFavoriteRelay](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.RemoveFavoriteRelay.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#removefavoriterelay) [RemoveFavoriteRelaySet](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.RemoveFavoriteRelaySet.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#removefavoriterelayset) [RemoveInboxRelay](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.RemoveInboxRelay.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#removeinboxrelay) [RemoveOutboxRelay](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.RemoveOutboxRelay.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#removeoutboxrelay) [RemoveRelayFromRelaySet](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.RemoveRelayFromRelaySet.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#removerelayfromrelayset) [RemoveSearchRelay](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.RemoveSearchRelay.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#removesearchrelay) [RemoveUserFromFollowSet](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.RemoveUserFromFollowSet.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#removeuserfromfollowset) [ReplyToLegacyMessage](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.ReplyToLegacyMessage.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#replytolegacymessage) [ReplyToWrappedMessage](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.ReplyToWrappedMessage.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#replytowrappedmessage) [SendLegacyMessage](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.SendLegacyMessage.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#sendlegacymessage) [SendWrappedMessage](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.SendWrappedMessage.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#sendwrappedmessage) [SetDefaultBlossomServer](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.SetDefaultBlossomServer.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#setdefaultblossomserver) [SetListMetadata](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.SetListMetadata.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#setlistmetadata) [UnbookmarkEvent](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.UnbookmarkEvent.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#unbookmarkevent) [UnfollowUser](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.UnfollowUser.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#unfollowuser) [UnmuteHashtag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.UnmuteHashtag.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#unmutehashtag) [UnmuteThread](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.UnmuteThread.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#unmutethread) [UnmuteUser](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.UnmuteUser.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#unmuteuser) [UnmuteWord](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.UnmuteWord.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#unmuteword) [UnpinNote](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.UnpinNote.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#unpinnote) [UpdateFollowSetInformation](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.UpdateFollowSetInformation.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#updatefollowsetinformation) [UpdateProfile](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.UpdateProfile.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#updateprofile) [UpdateRelaySetInformation](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.UpdateRelaySetInformation.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#updaterelaysetinformation) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Variables [ALLOWED\_PIN\_KINDS](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#allowed_pin_kinds) Functions [AddBlockedRelay](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#addblockedrelay) [AddBlossomServer](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#addblossomserver) [AddDMRelay](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#adddmrelay) [AddEventToCalendar](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#addeventtocalendar) [AddFavoriteRelay](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#addfavoriterelay) [AddFavoriteRelaySet](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#addfavoriterelayset) [AddInboxRelay](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#addinboxrelay) [AddOutboxRelay](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#addoutboxrelay) [AddRelayToRelaySet](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#addrelaytorelayset) [AddSearchRelay](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#addsearchrelay) [AddUserToFollowSet](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#addusertofollowset) [BookmarkEvent](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#bookmarkevent) [CreateBookmarkList](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#createbookmarklist) [CreateBookmarkSet](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#createbookmarkset) [CreateFollowSet](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#createfollowset) [CreateMailboxes](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#createmailboxes) [CreatePinList](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#createpinlist) [CreateProfile](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#createprofile) [CreateRelaySet](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#createrelayset) [FollowUser](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#followuser) [MuteHashtag](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#mutehashtag) [MuteThread](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#mutethread) [MuteUser](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#muteuser) [MuteWord](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#muteword) [NewBlockedRelays](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#newblockedrelays) [NewBlossomServers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#newblossomservers) [NewContacts](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#newcontacts) [NewDMRelays](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#newdmrelays) [NewFavoriteRelays](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#newfavoriterelays) [NewSearchRelays](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#newsearchrelays) [PinNote](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#pinnote) [RemoveBlockedRelay](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#removeblockedrelay) [RemoveBlossomServer](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#removeblossomserver) [RemoveDMRelay](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#removedmrelay) [RemoveEventFromCalendar](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#removeeventfromcalendar) [RemoveFavoriteRelay](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#removefavoriterelay) [RemoveFavoriteRelaySet](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#removefavoriterelayset) [RemoveInboxRelay](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#removeinboxrelay) [RemoveOutboxRelay](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#removeoutboxrelay) [RemoveRelayFromRelaySet](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#removerelayfromrelayset) [RemoveSearchRelay](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#removesearchrelay) [RemoveUserFromFollowSet](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#removeuserfromfollowset) [ReplyToLegacyMessage](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#replytolegacymessage) [ReplyToWrappedMessage](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#replytowrappedmessage) [SendLegacyMessage](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#sendlegacymessage) [SendWrappedMessage](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#sendwrappedmessage) [SetDefaultBlossomServer](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#setdefaultblossomserver) [SetListMetadata](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#setlistmetadata) [UnbookmarkEvent](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#unbookmarkevent) [UnfollowUser](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#unfollowuser) [UnmuteHashtag](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#unmutehashtag) [UnmuteThread](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#unmutethread) [UnmuteUser](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#unmuteuser) [UnmuteWord](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#unmuteword) [UnpinNote](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#unpinnote) [UpdateFollowSetInformation](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#updatefollowsetinformation) [UpdateProfile](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#updateprofile) [UpdateRelaySetInformation](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html#updaterelaysetinformation) --- # Helpers | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) Namespace Helpers ================= Enumerations ------------ [ReportReason](https://hzrd149.github.io/applesauce/typedoc/enums/applesauce-core.Helpers.ReportReason.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#reportreason) Classes ------- [LRU](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#lru) Interfaces ---------- [EncryptedContentCache](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.Helpers.EncryptedContentCache.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#encryptedcontentcache) [EncryptedContentSigner](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.Helpers.EncryptedContentSigner.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#encryptedcontentsigner) [EncryptionMethods](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.Helpers.EncryptionMethods.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#encryptionmethods) [HiddenContentSigner](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.Helpers.HiddenContentSigner.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#hiddencontentsigner) [PollOption](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.Helpers.PollOption.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#polloption) Type Aliases ------------ [AddressPointerWithoutD](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.AddressPointerWithoutD.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#addresspointerwithoutd) [Bookmarks](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.Bookmarks.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#bookmarks) [CalendarEventParticipant](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.CalendarEventParticipant.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#calendareventparticipant) [ChannelMetadataContent](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ChannelMetadataContent.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#channelmetadatacontent) [CommentAddressPointer](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.CommentAddressPointer.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#commentaddresspointer) [CommentEventPointer](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.CommentEventPointer.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#commenteventpointer) [CommentExternalPointer](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.CommentExternalPointer.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#commentexternalpointer) [CommentPointer](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.CommentPointer.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#commentpointer) [DecodeResult](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.DecodeResult.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#decoderesult) [Emoji](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.Emoji.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#emoji) [EncryptionMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.EncryptionMethod.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#encryptionmethod) [ExternalIdentifiers](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ExternalIdentifiers.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#externalidentifiers) [ExternalPointer](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ExternalPointer.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#externalpointer) [FileMetadata](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.FileMetadata.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#filemetadata) [GroupPointer](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.GroupPointer.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#grouppointer) [HandlerLinkPlatform](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.HandlerLinkPlatform.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#handlerlinkplatform) [HandlerLinkType](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.HandlerLinkType.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#handlerlinktype) [HighlightAttribution](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.HighlightAttribution.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#highlightattribution) [HighlightAttributionRole](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.HighlightAttributionRole.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#highlightattributionrole) [MediaAttachment](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.MediaAttachment.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#mediaattachment) [Mutes](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.Mutes.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#mutes) [NameValueTag](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.NameValueTag.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#namevaluetag) [ParsedInvoice](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ParsedInvoice.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#parsedinvoice) [ParseResult](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ParseResult.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#parseresult) [PollType](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.PollType.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#polltype) [ProfileContent](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ProfileContent.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#profilecontent) [ReadListTags](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ReadListTags.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#readlisttags) [ReportedEvent](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ReportedEvent.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#reportedevent) [ReportedUser](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ReportedUser.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#reporteduser) [RSVPFreeBusy](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.RSVPFreeBusy.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#rsvpfreebusy) [RSVPStatus](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.RSVPStatus.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#rsvpstatus) [Rumor](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.Rumor.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#rumor) [StreamRole](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.StreamRole.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#streamrole) [StreamStatus](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.StreamStatus.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#streamstatus) [ThreadReferences](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ThreadReferences.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#threadreferences) [UserStatusPointer](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.UserStatusPointer.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#userstatuspointer) [ZapSplit](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ZapSplit.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#zapsplit) Variables --------- [AUDIO\_EXT](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.AUDIO_EXT.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#audio_ext) [BLOSSOM\_SERVER\_LIST\_KIND](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.BLOSSOM_SERVER_LIST_KIND.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#blossom_server_list_kind) [BookmarkHiddenSymbol](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.BookmarkHiddenSymbol.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#bookmarkhiddensymbol) [BookmarkPublicSymbol](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.BookmarkPublicSymbol.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#bookmarkpublicsymbol) [CALENDAR\_EVENT\_RSVP\_KIND](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.CALENDAR_EVENT_RSVP_KIND.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#calendar_event_rsvp_kind) [CalendarEventGeohashSymbol](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.CalendarEventGeohashSymbol.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#calendareventgeohashsymbol) [CalendarEventHashtagsSymbol](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.CalendarEventHashtagsSymbol.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#calendareventhashtagssymbol) [CalendarEventLocationsSymbol](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.CalendarEventLocationsSymbol.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#calendareventlocationssymbol) [CalendarEventParticipantsSymbol](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.CalendarEventParticipantsSymbol.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#calendareventparticipantssymbol) [CalendarEventReferencesSymbol](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.CalendarEventReferencesSymbol.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#calendareventreferencessymbol) [ChannelMetadataSymbol](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.ChannelMetadataSymbol.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#channelmetadatasymbol) [COMMENT\_KIND](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.COMMENT_KIND.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#comment_kind) [CommentReplyPointerSymbol](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.CommentReplyPointerSymbol.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#commentreplypointersymbol) [CommentRootPointerSymbol](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.CommentRootPointerSymbol.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#commentrootpointersymbol) [ContactsRelaysSymbol](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.ContactsRelaysSymbol.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#contactsrelayssymbol) [DATE\_BASED\_CALENDAR\_EVENT\_KIND](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.DATE_BASED_CALENDAR_EVENT_KIND.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#date_based_calendar_event_kind) [EncryptedContentFromCacheSymbol](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.EncryptedContentFromCacheSymbol.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#encryptedcontentfromcachesymbol) [EncryptedContentSymbol](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.EncryptedContentSymbol.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#encryptedcontentsymbol) [EventContentEncryptionMethod](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.EventContentEncryptionMethod.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#eventcontentencryptionmethod) [EventIndexableTagsSymbol](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.EventIndexableTagsSymbol.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#eventindexabletagssymbol) [EventStoreSymbol](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.EventStoreSymbol.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#eventstoresymbol) [EventUIDSymbol](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.EventUIDSymbol.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#eventuidsymbol) [ExpirationTimestampSymbol](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.ExpirationTimestampSymbol.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#expirationtimestampsymbol) [FAVORITE\_RELAYS\_KIND](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.FAVORITE_RELAYS_KIND.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#favorite_relays_kind) [FromCacheSymbol](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.FromCacheSymbol.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#fromcachesymbol) [getHiddenContentEncryptionMethods](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.getHiddenContentEncryptionMethods.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#gethiddencontentencryptionmethods) [getReplaceableUID](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.getReplaceableUID.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getreplaceableuid) [GiftWrapSymbol](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.GiftWrapSymbol.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#giftwrapsymbol) [GROUP\_MESSAGE\_KIND](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.GROUP_MESSAGE_KIND.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#group_message_kind) [GROUPS\_LIST\_KIND](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.GROUPS_LIST_KIND.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#groups_list_kind) [GroupsHiddenSymbol](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.GroupsHiddenSymbol.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#groupshiddensymbol) [GroupsPublicSymbol](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.GroupsPublicSymbol.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#groupspublicsymbol) [HiddenContactsSymbol](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.HiddenContactsSymbol.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#hiddencontactssymbol) [HiddenContentKinds](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.HiddenContentKinds.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#hiddencontentkinds) [HiddenContentSymbol](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.HiddenContentSymbol.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#hiddencontentsymbol) [HiddenTagsKinds](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.HiddenTagsKinds.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#hiddentagskinds) [HiddenTagsSymbol](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.HiddenTagsSymbol.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#hiddentagssymbol) [HighlightAttributionSymbol](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.HighlightAttributionSymbol.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#highlightattributionsymbol) [HighlightSourceAddressPointerSymbol](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.HighlightSourceAddressPointerSymbol.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#highlightsourceaddresspointersymbol) [HighlightSourceEventPointerSymbol](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.HighlightSourceEventPointerSymbol.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#highlightsourceeventpointersymbol) [IMAGE\_EXT](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.IMAGE_EXT.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#image_ext) [INDEXABLE\_TAGS](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.INDEXABLE_TAGS.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#indexable_tags) [internalGiftWrapEvents](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.internalGiftWrapEvents.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#internalgiftwrapevents) [isNip05](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.isNip05.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#isnip05) [MailboxesInboxesSymbol](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.MailboxesInboxesSymbol.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#mailboxesinboxessymbol) [MailboxesOutboxesSymbol](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.MailboxesOutboxesSymbol.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#mailboxesoutboxessymbol) [MediaAttachmentsSymbol](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.MediaAttachmentsSymbol.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#mediaattachmentssymbol) [MuteHiddenSymbol](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.MuteHiddenSymbol.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#mutehiddensymbol) [MutePublicSymbol](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.MutePublicSymbol.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#mutepublicsymbol) [NIP05\_REGEX](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.NIP05_REGEX.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#nip05_regex) [Nip10ThreadRefsSymbol](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.Nip10ThreadRefsSymbol.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#nip10threadrefssymbol) [ParsedReportSymbol](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.ParsedReportSymbol.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#parsedreportsymbol) [parseSharedEvent](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.parseSharedEvent.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#parsesharedevent) [PICTURE\_POST\_KIND](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.PICTURE_POST_KIND.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#picture_post_kind) [POLL\_KIND](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.POLL_KIND.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#poll_kind) [POLL\_RESPONSE\_KIND](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.POLL_RESPONSE_KIND.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#poll_response_kind) [PollOptionsSymbol](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.PollOptionsSymbol.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#polloptionssymbol) [processTags](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.processTags.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#processtags) [ProfileContentSymbol](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.ProfileContentSymbol.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#profilecontentsymbol) [PublicContactsSymbol](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.PublicContactsSymbol.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#publiccontactssymbol) [ReactionAddressPointerSymbol](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.ReactionAddressPointerSymbol.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#reactionaddresspointersymbol) [ReactionEventPointerSymbol](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.ReactionEventPointerSymbol.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#reactioneventpointersymbol) [ReplaceableAddressSymbol](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.ReplaceableAddressSymbol.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#replaceableaddresssymbol) [ReplaceableIdentifierSymbol](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.ReplaceableIdentifierSymbol.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#replaceableidentifiersymbol) [RumorSymbol](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.RumorSymbol.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#rumorsymbol) [SealSymbol](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.SealSymbol.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#sealsymbol) [SeenRelaysSymbol](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.SeenRelaysSymbol.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#seenrelayssymbol) [SharedAddressPointerSymbol](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.SharedAddressPointerSymbol.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#sharedaddresspointersymbol) [SharedEventPointerSymbol](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.SharedEventPointerSymbol.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#sharedeventpointersymbol) [SharedEventSymbol](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.SharedEventSymbol.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#sharedeventsymbol) [STREAM\_EXT](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.STREAM_EXT.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#stream_ext) [TIME\_BASED\_CALENDAR\_EVENT\_KIND](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.TIME_BASED_CALENDAR_EVENT_KIND.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#time_based_calendar_event_kind) [UserStatusPointerSymbol](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.UserStatusPointerSymbol.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#userstatuspointersymbol) [VIDEO\_EXT](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.VIDEO_EXT.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#video_ext) [ZapAddressPointerSymbol](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.ZapAddressPointerSymbol.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#zapaddresspointersymbol) [ZapEventPointerSymbol](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.ZapEventPointerSymbol.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#zapeventpointersymbol) [ZapInvoiceSymbol](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.ZapInvoiceSymbol.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#zapinvoicesymbol) [ZapReceiverSymbol](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.ZapReceiverSymbol.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#zapreceiversymbol) [ZapRequestSymbol](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.ZapRequestSymbol.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#zaprequestsymbol) [ZapSenderSymbol](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-core.Helpers.ZapSenderSymbol.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#zapsendersymbol) Functions --------- [addRelayHintsToPointer](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.addRelayHintsToPointer.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#addrelayhintstopointer) [addSeenRelay](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.addSeenRelay.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#addseenrelay) [areBlossomServersEqual](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.areBlossomServersEqual.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#areblossomserversequal) [canHaveEncryptedContent](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.canHaveEncryptedContent.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#canhaveencryptedcontent) [canHaveHiddenContent](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.canHaveHiddenContent.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#canhavehiddencontent) [canHaveHiddenTags](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.canHaveHiddenTags.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#canhavehiddentags) [convertToUrl](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.convertToUrl.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#converttourl) [createConversationIdentifier](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.createConversationIdentifier.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#createconversationidentifier) [createHandlerAddressLink](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.createHandlerAddressLink.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#createhandleraddresslink) [createHandlerEventLink](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.createHandlerEventLink.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#createhandlereventlink) [createHandlerLink](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.createHandlerLink.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#createhandlerlink) [createHandlerProfileLink](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.createHandlerProfileLink.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#createhandlerprofilelink) [createMutedWordsRegExp](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.createMutedWordsRegExp.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#createmutedwordsregexp) [createReplaceableAddress](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.createReplaceableAddress.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#createreplaceableaddress) [decodeGroupPointer](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.decodeGroupPointer.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#decodegrouppointer) [decodeLNURL](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.decodeLNURL.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#decodelnurl) [encodeDecodeResult](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.encodeDecodeResult.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#encodedecoderesult) [encodeGroupPointer](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.encodeGroupPointer.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#encodegrouppointer) [ensureHttpURL](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.ensureHttpURL.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#ensurehttpurl) [ensureProtocol](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.ensureProtocol.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#ensureprotocol) [ensureWebSocketURL](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.ensureWebSocketURL.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#ensurewebsocketurl) [fakeVerifyEvent](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.fakeVerifyEvent.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#fakeverifyevent) [getAddressPointerForEvent](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getAddressPointerForEvent.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getaddresspointerforevent) [getAddressPointerFromATag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getAddressPointerFromATag.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getaddresspointerfromatag) [getAddressPointersFromList](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getAddressPointersFromList.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getaddresspointersfromlist) [getArticleImage](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getArticleImage.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getarticleimage) [getArticlePublished](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getArticlePublished.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getarticlepublished) [getArticleSummary](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getArticleSummary.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getarticlesummary) [getArticleTitle](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getArticleTitle.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getarticletitle) [getBlossomServersFromList](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getBlossomServersFromList.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getblossomserversfromlist) [getBookmarks](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getBookmarks.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getbookmarks) [getCachedValue](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getCachedValue.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getcachedvalue) [getCalendarAddressPointers](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getCalendarAddressPointers.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getcalendaraddresspointers) [getCalendarEventEnd](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getCalendarEventEnd.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getcalendareventend) [getCalendarEventEndTimezone](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getCalendarEventEndTimezone.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getcalendareventendtimezone) [getCalendarEventGeohash](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getCalendarEventGeohash.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getcalendareventgeohash) [getCalendarEventHashtags](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getCalendarEventHashtags.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getcalendareventhashtags) [getCalendarEventImage](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getCalendarEventImage.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getcalendareventimage) [getCalendarEventLocations](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getCalendarEventLocations.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getcalendareventlocations) [getCalendarEventParticipants](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getCalendarEventParticipants.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getcalendareventparticipants) [getCalendarEventReferences](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getCalendarEventReferences.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getcalendareventreferences) [getCalendarEventStart](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getCalendarEventStart.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getcalendareventstart) [getCalendarEventStartTimezone](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getCalendarEventStartTimezone.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getcalendareventstarttimezone) [getCalendarEventSummary](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getCalendarEventSummary.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getcalendareventsummary) [getCalendarEventTitle](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getCalendarEventTitle.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getcalendareventtitle) [getCalendarTitle](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getCalendarTitle.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getcalendartitle) [getChannelMetadataContent](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getChannelMetadataContent.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getchannelmetadatacontent) [getChannelPointer](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getChannelPointer.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getchannelpointer) [getCommentAddressPointer](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getCommentAddressPointer.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getcommentaddresspointer) [getCommentEventPointer](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getCommentEventPointer.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getcommenteventpointer) [getCommentExternalPointer](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getCommentExternalPointer.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getcommentexternalpointer) [getCommentReplyPointer](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getCommentReplyPointer.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getcommentreplypointer) [getCommentRootPointer](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getCommentRootPointer.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getcommentrootpointer) [getContacts](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getContacts.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getcontacts) [getContentWarning](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getContentWarning.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getcontentwarning) [getConversationIdentifierFromMessage](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getConversationIdentifierFromMessage.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getconversationidentifierfrommessage) [getConversationParticipants](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getConversationParticipants.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getconversationparticipants) [getCoordinateFromAddressPointer](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getCoordinateFromAddressPointer.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getcoordinatefromaddresspointer) [getDeleteCoordinates](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getDeleteCoordinates.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getdeletecoordinates) [getDeleteIds](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getDeleteIds.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getdeleteids) [getDisplayName](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getDisplayName.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getdisplayname) [getEmbededSharedEvent](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getEmbededSharedEvent.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getembededsharedevent) [getEmojiFromTags](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getEmojiFromTags.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getemojifromtags) [getEmojis](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getEmojis.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getemojis) [getEmojiTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getEmojiTag.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getemojitag) [getEncryptedContent](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getEncryptedContent.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getencryptedcontent) [getEncryptedContentEncryptionMethods](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getEncryptedContentEncryptionMethods.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getencryptedcontentencryptionmethods) [getEventPointerForEvent](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getEventPointerForEvent.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#geteventpointerforevent) [getEventPointerFromETag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getEventPointerFromETag.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#geteventpointerfrometag) [getEventPointerFromQTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getEventPointerFromQTag.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#geteventpointerfromqtag) [getEventPointerFromThreadTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getEventPointerFromThreadTag.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#geteventpointerfromthreadtag) [getEventPointersFromList](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getEventPointersFromList.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#geteventpointersfromlist) [getEventUID](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getEventUID.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#geteventuid) [getExpirationTimestamp](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getExpirationTimestamp.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getexpirationtimestamp) [getExternalPointerFromTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getExternalPointerFromTag.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getexternalpointerfromtag) [getFileMetadata](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getFileMetadata.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getfilemetadata) [getFileMetadataFromImetaTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getFileMetadataFromImetaTag.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getfilemetadatafromimetatag) [getGiftWrapRumor](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getGiftWrapRumor.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getgiftwraprumor) [getGiftWrapSeal](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getGiftWrapSeal.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getgiftwrapseal) [getGroupPointerFromGroupTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getGroupPointerFromGroupTag.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getgrouppointerfromgrouptag) [getGroupPointerFromHTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getGroupPointerFromHTag.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getgrouppointerfromhtag) [getHandlerDescription](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getHandlerDescription.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#gethandlerdescription) [getHandlerLinkTemplate](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getHandlerLinkTemplate.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#gethandlerlinktemplate) [getHandlerName](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getHandlerName.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#gethandlername) [getHandlerPicture](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getHandlerPicture.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#gethandlerpicture) [getHandlerSupportedKinds](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getHandlerSupportedKinds.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#gethandlersupportedkinds) [getHashtagTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getHashtagTag.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#gethashtagtag) [getHiddenBookmarks](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getHiddenBookmarks.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#gethiddenbookmarks) [getHiddenContacts](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getHiddenContacts.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#gethiddencontacts) [getHiddenContent](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getHiddenContent.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#gethiddencontent) [getHiddenGroups](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getHiddenGroups.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#gethiddengroups) [getHiddenMutedThings](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getHiddenMutedThings.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#gethiddenmutedthings) [getHiddenTags](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getHiddenTags.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#gethiddentags) [getHiddenTagsEncryptionMethods](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getHiddenTagsEncryptionMethods.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#gethiddentagsencryptionmethods) [getHighlightAttributions](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getHighlightAttributions.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#gethighlightattributions) [getHighlightComment](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getHighlightComment.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#gethighlightcomment) [getHighlightContext](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getHighlightContext.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#gethighlightcontext) [getHighlightSourceAddressPointer](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getHighlightSourceAddressPointer.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#gethighlightsourceaddresspointer) [getHighlightSourceEventPointer](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getHighlightSourceEventPointer.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#gethighlightsourceeventpointer) [getHighlightSourceUrl](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getHighlightSourceUrl.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#gethighlightsourceurl) [getHighlightText](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getHighlightText.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#gethighlighttext) [getInboxes](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getInboxes.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getinboxes) [getIndexableTags](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getIndexableTags.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getindexabletags) [getInvoice](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getInvoice.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getinvoice) [getLegacyMessageCorraspondant](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getLegacyMessageCorraspondant.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getlegacymessagecorraspondant) [getLegacyMessageParent](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getLegacyMessageParent.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getlegacymessageparent) [getListTags](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getListTags.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getlisttags) [getMediaAttachments](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getMediaAttachments.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getmediaattachments) [getMutedThings](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getMutedThings.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getmutedthings) [getNip10References](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getNip10References.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getnip10references) [getOrComputeCachedValue](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getOrComputeCachedValue.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getorcomputecachedvalue) [getOutboxes](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getOutboxes.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getoutboxes) [getPackName](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getPackName.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getpackname) [getParentEventStore](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getParentEventStore.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getparenteventstore) [getPicturePostAttachments](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getPicturePostAttachments.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getpicturepostattachments) [getPointerForEvent](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getPointerForEvent.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getpointerforevent) [getPollEndsAt](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getPollEndsAt.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getpollendsat) [getPollOptions](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getPollOptions.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getpolloptions) [getPollQuestion](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getPollQuestion.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getpollquestion) [getPollRelays](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getPollRelays.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getpollrelays) [getPollResponseOptions](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getPollResponseOptions.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getpollresponseoptions) [getPollResponsePollId](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getPollResponsePollId.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getpollresponsepollid) [getPollResponseVotes](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getPollResponseVotes.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getpollresponsevotes) [getPollType](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getPollType.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getpolltype) [getProfileContent](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getProfileContent.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getprofilecontent) [getProfilePicture](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getProfilePicture.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getprofilepicture) [getProfilePointerFromPTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getProfilePointerFromPTag.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getprofilepointerfromptag) [getProfilePointersFromList](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getProfilePointersFromList.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getprofilepointersfromlist) [getPubkeyFromDecodeResult](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getPubkeyFromDecodeResult.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getpubkeyfromdecoderesult) [getPublicBookmarks](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getPublicBookmarks.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getpublicbookmarks) [getPublicContacts](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getPublicContacts.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getpubliccontacts) [getPublicGroups](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getPublicGroups.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getpublicgroups) [getPublicMutedThings](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getPublicMutedThings.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getpublicmutedthings) [getReactionAddressPointer](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getReactionAddressPointer.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getreactionaddresspointer) [getReactionEmoji](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getReactionEmoji.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getreactionemoji) [getReactionEventPointer](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getReactionEventPointer.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getreactioneventpointer) [getRelaysFromContactsEvent](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getRelaysFromContactsEvent.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getrelaysfromcontactsevent) [getRelaysFromList](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getRelaysFromList.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getrelaysfromlist) [getReplaceableAddress](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getReplaceableAddress.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getreplaceableaddress) [getReplaceableIdentifier](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getReplaceableIdentifier.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getreplaceableidentifier) [getReported](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getReported.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getreported) [getRSVPAddressPointer](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getRSVPAddressPointer.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getrsvpaddresspointer) [getRSVPEventPointer](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getRSVPEventPointer.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getrsvpeventpointer) [getRSVPFreeBusy](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getRSVPFreeBusy.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getrsvpfreebusy) [getRSVPProfilePointer](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getRSVPProfilePointer.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getrsvpprofilepointer) [getRSVPStatus](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getRSVPStatus.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getrsvpstatus) [getRumorGiftWraps](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getRumorGiftWraps.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getrumorgiftwraps) [getRumorSeals](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getRumorSeals.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getrumorseals) [getSealGiftWrap](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getSealGiftWrap.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getsealgiftwrap) [getSealRumor](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getSealRumor.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getsealrumor) [getSeenRelays](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getSeenRelays.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getseenrelays) [getSha256FromURL](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getSha256FromURL.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getsha256fromurl) [getSharedAddressPointer](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getSharedAddressPointer.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getsharedaddresspointer) [getSharedEventPointer](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getSharedEventPointer.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getsharedeventpointer) [getStreamChatMessageStream](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getStreamChatMessageStream.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getstreamchatmessagestream) [getStreamEndTime](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getStreamEndTime.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getstreamendtime) [getStreamGoalPointer](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getStreamGoalPointer.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getstreamgoalpointer) [getStreamHashtags](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getStreamHashtags.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getstreamhashtags) [getStreamHost](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getStreamHost.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getstreamhost) [getStreamImage](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getStreamImage.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getstreamimage) [getStreamMaxViewers](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getStreamMaxViewers.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getstreammaxviewers) [getStreamParticipants](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getStreamParticipants.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getstreamparticipants) [getStreamRecording](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getStreamRecording.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getstreamrecording) [getStreamRelays](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getStreamRelays.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getstreamrelays) [getStreamStartTime](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getStreamStartTime.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getstreamstarttime) [getStreamStatus](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getStreamStatus.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getstreamstatus) [getStreamStreamingURLs](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getStreamStreamingURLs.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getstreamstreamingurls) [getStreamSummary](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getStreamSummary.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getstreamsummary) [getStreamTitle](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getStreamTitle.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getstreamtitle) [getStreamViewers](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getStreamViewers.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getstreamviewers) [getTagValue](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getTagValue.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#gettagvalue) [getURLFilename](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getURLFilename.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#geturlfilename) [getUserStatusPointer](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getUserStatusPointer.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getuserstatuspointer) [getWrappedMessageParent](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getWrappedMessageParent.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getwrappedmessageparent) [getWrappedMessageSubject](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getWrappedMessageSubject.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getwrappedmessagesubject) [getZapAddressPointer](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getZapAddressPointer.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getzapaddresspointer) [getZapEventPointer](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getZapEventPointer.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getzapeventpointer) [getZapPayment](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getZapPayment.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getzappayment) [getZapPreimage](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getZapPreimage.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getzappreimage) [getZapRecipient](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getZapRecipient.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getzaprecipient) [getZapRequest](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getZapRequest.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getzaprequest) [getZapSender](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getZapSender.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getzapsender) [getZapSplits](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.getZapSplits.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getzapsplits) [groupMessageEvents](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.groupMessageEvents.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#groupmessageevents) [hasEncryptedContent](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.hasEncryptedContent.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#hasencryptedcontent) [hasHiddenContent](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.hasHiddenContent.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#hashiddencontent) [hasHiddenTags](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.hasHiddenTags.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#hashiddentags) [hasHighlightSource](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.hasHighlightSource.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#hashighlightsource) [interpretThreadTags](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.interpretThreadTags.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#interpretthreadtags) [isAddressPointer](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isAddressPointer.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#isaddresspointer) [isAddressPointerInList](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isAddressPointerInList.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#isaddresspointerinlist) [isATag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isATag.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#isatag) [isAudioURL](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isAudioURL.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#isaudiourl) [isCommentAddressPointer](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isCommentAddressPointer.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#iscommentaddresspointer) [isCommentEventPointer](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isCommentEventPointer.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#iscommenteventpointer) [isDTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isDTag.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#isdtag) [isEncryptedContentFromCache](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isEncryptedContentFromCache.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#isencryptedcontentfromcache) [isEncryptedContentLocked](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isEncryptedContentLocked.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#isencryptedcontentlocked) [isETag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isETag.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#isetag) [isEvent](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isEvent.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#isevent) [isEventInList](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isEventInList.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#iseventinlist) [isEventPointer](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isEventPointer.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#iseventpointer) [isEventPointerInList](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isEventPointerInList.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#iseventpointerinlist) [isExpired](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isExpired.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#isexpired) [isFilterEqual](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isFilterEqual.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#isfilterequal) [isFromCache](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isFromCache.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#isfromcache) [isGiftWrapLocked](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isGiftWrapLocked.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#isgiftwraplocked) [isHex](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isHex.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#ishex) [isHexKey](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isHexKey.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#ishexkey) [isHiddenContentLocked](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isHiddenContentLocked.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#ishiddencontentlocked) [isHiddenTagsLocked](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isHiddenTagsLocked.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#ishiddentagslocked) [isImageURL](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isImageURL.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#isimageurl) [isLegacyMessageLocked](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isLegacyMessageLocked.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#islegacymessagelocked) [isNameValueTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isNameValueTag.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#isnamevaluetag) [isNIP04Encrypted](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isNIP04Encrypted.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#isnip04encrypted) [isProfilePointerInList](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isProfilePointerInList.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#isprofilepointerinlist) [isProtectedEvent](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isProtectedEvent.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#isprotectedevent) [isPTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isPTag.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#isptag) [isReplaceable](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isReplaceable.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#isreplaceable) [isRTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isRTag.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#isrtag) [isRumor](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isRumor.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#isrumor) [isSafeRelayURL](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isSafeRelayURL.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#issaferelayurl) [isSameURL](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isSameURL.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#issameurl) [isSealLocked](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isSealLocked.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#isseallocked) [isSha256](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isSha256.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#issha256) [isStreamURL](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isStreamURL.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#isstreamurl) [isTTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isTTag.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#isttag) [isValidList](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isValidList.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#isvalidlist) [isValidProfile](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isValidProfile.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#isvalidprofile) [isValidZap](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isValidZap.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#isvalidzap) [isVideoURL](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.isVideoURL.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#isvideourl) [lockEncryptedContent](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.lockEncryptedContent.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#lockencryptedcontent) [lockGiftWrap](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.lockGiftWrap.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#lockgiftwrap) [lockHiddenContent](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.lockHiddenContent.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#lockhiddencontent) [lockHiddenTags](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.lockHiddenTags.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#lockhiddentags) [lockLegacyMessage](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.lockLegacyMessage.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#locklegacymessage) [markEncryptedContentFromCache](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.markEncryptedContentFromCache.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#markencryptedcontentfromcache) [markFromCache](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.markFromCache.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#markfromcache) [matchFilter](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.matchFilter.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#matchfilter) [matchFilters](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.matchFilters.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#matchfilters) [matchMutes](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.matchMutes.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#matchmutes) [mergeAddressPointers](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.mergeAddressPointers.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#mergeaddresspointers) [mergeBlossomServers](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.mergeBlossomServers.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#mergeblossomservers) [mergeBookmarks](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.mergeBookmarks.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#mergebookmarks) [mergeContacts](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.mergeContacts.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#mergecontacts) [mergeEventPointers](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.mergeEventPointers.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#mergeeventpointers) [mergeFilters](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.mergeFilters.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#mergefilters) [mergeMutes](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.mergeMutes.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#mergemutes) [mergeProfilePointers](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.mergeProfilePointers.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#mergeprofilepointers) [mergeRelaySets](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.mergeRelaySets.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#mergerelaysets) [normalizeToPubkey](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.normalizeToPubkey.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#normalizetopubkey) [normalizeToSecretKey](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.normalizeToSecretKey.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#normalizetosecretkey) [normalizeURL](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.normalizeURL.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#normalizeurl) [notifyEventUpdate](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.notifyEventUpdate.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#notifyeventupdate) [parseBolt11](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.parseBolt11.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#parsebolt11) [parseBookmarkTags](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.parseBookmarkTags.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#parsebookmarktags) [parseCoordinate](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.parseCoordinate.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#parsecoordinate) [parseExternalPointer](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.parseExternalPointer.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#parseexternalpointer) [parseFileMetadataTags](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.parseFileMetadataTags.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#parsefilemetadatatags) [parseLightningAddress](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.parseLightningAddress.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#parselightningaddress) [parseLNURLOrAddress](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.parseLNURLOrAddress.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#parselnurloraddress) [parseMutedTags](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.parseMutedTags.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#parsemutedtags) [parseNIP05Address](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.parseNIP05Address.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#parsenip05address) [persistEncryptedContent](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.persistEncryptedContent.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#persistencryptedcontent) [presistEventsToCache](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.presistEventsToCache.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#presisteventstocache) [safeParse](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.safeParse.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#safeparse) [setCachedValue](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.setCachedValue.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#setcachedvalue) [setEncryptedContentCache](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.setEncryptedContentCache.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#setencryptedcontentcache) [setEncryptedContentEncryptionMethod](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.setEncryptedContentEncryptionMethod.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#setencryptedcontentencryptionmethod) [setHiddenContentCache](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.setHiddenContentCache.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#sethiddencontentcache) [setHiddenContentEncryptionMethod](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.setHiddenContentEncryptionMethod.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#sethiddencontentencryptionmethod) [setHiddenTagsCache](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.setHiddenTagsCache.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#sethiddentagscache) [setHiddenTagsEncryptionMethod](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.setHiddenTagsEncryptionMethod.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#sethiddentagsencryptionmethod) [stripInvisibleChar](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.stripInvisibleChar.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#stripinvisiblechar) [unixNow](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.unixNow.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#unixnow) [unlockEncryptedContent](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.unlockEncryptedContent.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#unlockencryptedcontent) [unlockGiftWrap](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.unlockGiftWrap.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#unlockgiftwrap) [unlockHiddenContent](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.unlockHiddenContent.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#unlockhiddencontent) [unlockHiddenTags](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.unlockHiddenTags.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#unlockhiddentags) [unlockLegacyMessage](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.unlockLegacyMessage.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#unlocklegacymessage) [unlockSeal](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Helpers.unlockSeal.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#unlockseal) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Enumerations [ReportReason](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#reportreason) Classes [LRU](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#lru) Interfaces [EncryptedContentCache](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#encryptedcontentcache) [EncryptedContentSigner](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#encryptedcontentsigner) [EncryptionMethods](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#encryptionmethods) [HiddenContentSigner](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#hiddencontentsigner) [PollOption](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#polloption) Type Aliases [AddressPointerWithoutD](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#addresspointerwithoutd) [Bookmarks](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#bookmarks) [CalendarEventParticipant](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#calendareventparticipant) [ChannelMetadataContent](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#channelmetadatacontent) [CommentAddressPointer](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#commentaddresspointer) [CommentEventPointer](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#commenteventpointer) [CommentExternalPointer](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#commentexternalpointer) [CommentPointer](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#commentpointer) [DecodeResult](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#decoderesult) [Emoji](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#emoji) [EncryptionMethod](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#encryptionmethod) [ExternalIdentifiers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#externalidentifiers) [ExternalPointer](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#externalpointer) [FileMetadata](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#filemetadata) [GroupPointer](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#grouppointer) [HandlerLinkPlatform](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#handlerlinkplatform) [HandlerLinkType](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#handlerlinktype) [HighlightAttribution](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#highlightattribution) [HighlightAttributionRole](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#highlightattributionrole) [MediaAttachment](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#mediaattachment) [Mutes](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#mutes) [NameValueTag](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#namevaluetag) [ParsedInvoice](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#parsedinvoice) [ParseResult](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#parseresult) [PollType](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#polltype) [ProfileContent](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#profilecontent) [ReadListTags](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#readlisttags) [ReportedEvent](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#reportedevent) [ReportedUser](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#reporteduser) [RSVPFreeBusy](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#rsvpfreebusy) [RSVPStatus](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#rsvpstatus) [Rumor](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#rumor) [StreamRole](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#streamrole) [StreamStatus](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#streamstatus) [ThreadReferences](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#threadreferences) [UserStatusPointer](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#userstatuspointer) [ZapSplit](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#zapsplit) Variables [AUDIO\_EXT](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#audio_ext) [BLOSSOM\_SERVER\_LIST\_KIND](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#blossom_server_list_kind) [BookmarkHiddenSymbol](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#bookmarkhiddensymbol) [BookmarkPublicSymbol](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#bookmarkpublicsymbol) [CALENDAR\_EVENT\_RSVP\_KIND](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#calendar_event_rsvp_kind) [CalendarEventGeohashSymbol](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#calendareventgeohashsymbol) [CalendarEventHashtagsSymbol](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#calendareventhashtagssymbol) [CalendarEventLocationsSymbol](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#calendareventlocationssymbol) [CalendarEventParticipantsSymbol](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#calendareventparticipantssymbol) [CalendarEventReferencesSymbol](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#calendareventreferencessymbol) [ChannelMetadataSymbol](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#channelmetadatasymbol) [COMMENT\_KIND](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#comment_kind) [CommentReplyPointerSymbol](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#commentreplypointersymbol) [CommentRootPointerSymbol](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#commentrootpointersymbol) [ContactsRelaysSymbol](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#contactsrelayssymbol) [DATE\_BASED\_CALENDAR\_EVENT\_KIND](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#date_based_calendar_event_kind) [EncryptedContentFromCacheSymbol](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#encryptedcontentfromcachesymbol) [EncryptedContentSymbol](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#encryptedcontentsymbol) [EventContentEncryptionMethod](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#eventcontentencryptionmethod) [EventIndexableTagsSymbol](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#eventindexabletagssymbol) [EventStoreSymbol](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#eventstoresymbol) [EventUIDSymbol](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#eventuidsymbol) [ExpirationTimestampSymbol](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#expirationtimestampsymbol) [FAVORITE\_RELAYS\_KIND](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#favorite_relays_kind) [FromCacheSymbol](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#fromcachesymbol) [getHiddenContentEncryptionMethods](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#gethiddencontentencryptionmethods) [getReplaceableUID](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getreplaceableuid) [GiftWrapSymbol](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#giftwrapsymbol) [GROUP\_MESSAGE\_KIND](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#group_message_kind) [GROUPS\_LIST\_KIND](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#groups_list_kind) [GroupsHiddenSymbol](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#groupshiddensymbol) [GroupsPublicSymbol](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#groupspublicsymbol) [HiddenContactsSymbol](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#hiddencontactssymbol) [HiddenContentKinds](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#hiddencontentkinds) [HiddenContentSymbol](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#hiddencontentsymbol) [HiddenTagsKinds](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#hiddentagskinds) [HiddenTagsSymbol](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#hiddentagssymbol) [HighlightAttributionSymbol](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#highlightattributionsymbol) [HighlightSourceAddressPointerSymbol](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#highlightsourceaddresspointersymbol) [HighlightSourceEventPointerSymbol](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#highlightsourceeventpointersymbol) [IMAGE\_EXT](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#image_ext) [INDEXABLE\_TAGS](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#indexable_tags) [internalGiftWrapEvents](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#internalgiftwrapevents) [isNip05](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#isnip05) [MailboxesInboxesSymbol](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#mailboxesinboxessymbol) [MailboxesOutboxesSymbol](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#mailboxesoutboxessymbol) [MediaAttachmentsSymbol](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#mediaattachmentssymbol) [MuteHiddenSymbol](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#mutehiddensymbol) [MutePublicSymbol](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#mutepublicsymbol) [NIP05\_REGEX](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#nip05_regex) [Nip10ThreadRefsSymbol](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#nip10threadrefssymbol) [ParsedReportSymbol](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#parsedreportsymbol) [parseSharedEvent](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#parsesharedevent) [PICTURE\_POST\_KIND](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#picture_post_kind) [POLL\_KIND](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#poll_kind) [POLL\_RESPONSE\_KIND](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#poll_response_kind) [PollOptionsSymbol](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#polloptionssymbol) [processTags](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#processtags) [ProfileContentSymbol](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#profilecontentsymbol) [PublicContactsSymbol](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#publiccontactssymbol) [ReactionAddressPointerSymbol](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#reactionaddresspointersymbol) [ReactionEventPointerSymbol](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#reactioneventpointersymbol) [ReplaceableAddressSymbol](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#replaceableaddresssymbol) [ReplaceableIdentifierSymbol](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#replaceableidentifiersymbol) [RumorSymbol](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#rumorsymbol) [SealSymbol](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#sealsymbol) [SeenRelaysSymbol](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#seenrelayssymbol) [SharedAddressPointerSymbol](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#sharedaddresspointersymbol) [SharedEventPointerSymbol](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#sharedeventpointersymbol) [SharedEventSymbol](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#sharedeventsymbol) [STREAM\_EXT](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#stream_ext) [TIME\_BASED\_CALENDAR\_EVENT\_KIND](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#time_based_calendar_event_kind) [UserStatusPointerSymbol](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#userstatuspointersymbol) [VIDEO\_EXT](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#video_ext) [ZapAddressPointerSymbol](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#zapaddresspointersymbol) [ZapEventPointerSymbol](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#zapeventpointersymbol) [ZapInvoiceSymbol](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#zapinvoicesymbol) [ZapReceiverSymbol](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#zapreceiversymbol) [ZapRequestSymbol](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#zaprequestsymbol) [ZapSenderSymbol](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#zapsendersymbol) Functions [addRelayHintsToPointer](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#addrelayhintstopointer) [addSeenRelay](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#addseenrelay) [areBlossomServersEqual](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#areblossomserversequal) [canHaveEncryptedContent](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#canhaveencryptedcontent) [canHaveHiddenContent](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#canhavehiddencontent) [canHaveHiddenTags](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#canhavehiddentags) [convertToUrl](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#converttourl) [createConversationIdentifier](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#createconversationidentifier) [createHandlerAddressLink](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#createhandleraddresslink) [createHandlerEventLink](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#createhandlereventlink) [createHandlerLink](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#createhandlerlink) [createHandlerProfileLink](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#createhandlerprofilelink) [createMutedWordsRegExp](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#createmutedwordsregexp) [createReplaceableAddress](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#createreplaceableaddress) [decodeGroupPointer](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#decodegrouppointer) [decodeLNURL](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#decodelnurl) [encodeDecodeResult](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#encodedecoderesult) [encodeGroupPointer](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#encodegrouppointer) [ensureHttpURL](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#ensurehttpurl) [ensureProtocol](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#ensureprotocol) [ensureWebSocketURL](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#ensurewebsocketurl) [fakeVerifyEvent](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#fakeverifyevent) [getAddressPointerForEvent](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getaddresspointerforevent) [getAddressPointerFromATag](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getaddresspointerfromatag) [getAddressPointersFromList](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getaddresspointersfromlist) [getArticleImage](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getarticleimage) [getArticlePublished](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getarticlepublished) [getArticleSummary](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getarticlesummary) [getArticleTitle](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getarticletitle) [getBlossomServersFromList](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getblossomserversfromlist) [getBookmarks](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getbookmarks) [getCachedValue](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getcachedvalue) [getCalendarAddressPointers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getcalendaraddresspointers) [getCalendarEventEnd](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getcalendareventend) [getCalendarEventEndTimezone](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getcalendareventendtimezone) [getCalendarEventGeohash](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getcalendareventgeohash) [getCalendarEventHashtags](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getcalendareventhashtags) [getCalendarEventImage](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getcalendareventimage) [getCalendarEventLocations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getcalendareventlocations) [getCalendarEventParticipants](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getcalendareventparticipants) [getCalendarEventReferences](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getcalendareventreferences) [getCalendarEventStart](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getcalendareventstart) [getCalendarEventStartTimezone](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getcalendareventstarttimezone) [getCalendarEventSummary](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getcalendareventsummary) [getCalendarEventTitle](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getcalendareventtitle) [getCalendarTitle](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getcalendartitle) [getChannelMetadataContent](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getchannelmetadatacontent) [getChannelPointer](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getchannelpointer) [getCommentAddressPointer](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getcommentaddresspointer) [getCommentEventPointer](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getcommenteventpointer) [getCommentExternalPointer](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getcommentexternalpointer) [getCommentReplyPointer](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getcommentreplypointer) [getCommentRootPointer](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getcommentrootpointer) [getContacts](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getcontacts) [getContentWarning](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getcontentwarning) [getConversationIdentifierFromMessage](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getconversationidentifierfrommessage) [getConversationParticipants](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getconversationparticipants) [getCoordinateFromAddressPointer](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getcoordinatefromaddresspointer) [getDeleteCoordinates](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getdeletecoordinates) [getDeleteIds](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getdeleteids) [getDisplayName](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getdisplayname) [getEmbededSharedEvent](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getembededsharedevent) [getEmojiFromTags](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getemojifromtags) [getEmojis](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getemojis) [getEmojiTag](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getemojitag) [getEncryptedContent](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getencryptedcontent) [getEncryptedContentEncryptionMethods](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getencryptedcontentencryptionmethods) [getEventPointerForEvent](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#geteventpointerforevent) [getEventPointerFromETag](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#geteventpointerfrometag) [getEventPointerFromQTag](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#geteventpointerfromqtag) [getEventPointerFromThreadTag](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#geteventpointerfromthreadtag) [getEventPointersFromList](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#geteventpointersfromlist) [getEventUID](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#geteventuid) [getExpirationTimestamp](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getexpirationtimestamp) [getExternalPointerFromTag](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getexternalpointerfromtag) [getFileMetadata](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getfilemetadata) [getFileMetadataFromImetaTag](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getfilemetadatafromimetatag) [getGiftWrapRumor](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getgiftwraprumor) [getGiftWrapSeal](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getgiftwrapseal) [getGroupPointerFromGroupTag](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getgrouppointerfromgrouptag) [getGroupPointerFromHTag](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getgrouppointerfromhtag) [getHandlerDescription](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#gethandlerdescription) [getHandlerLinkTemplate](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#gethandlerlinktemplate) [getHandlerName](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#gethandlername) [getHandlerPicture](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#gethandlerpicture) [getHandlerSupportedKinds](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#gethandlersupportedkinds) [getHashtagTag](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#gethashtagtag) [getHiddenBookmarks](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#gethiddenbookmarks) [getHiddenContacts](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#gethiddencontacts) [getHiddenContent](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#gethiddencontent) [getHiddenGroups](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#gethiddengroups) [getHiddenMutedThings](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#gethiddenmutedthings) [getHiddenTags](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#gethiddentags) [getHiddenTagsEncryptionMethods](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#gethiddentagsencryptionmethods) [getHighlightAttributions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#gethighlightattributions) [getHighlightComment](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#gethighlightcomment) [getHighlightContext](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#gethighlightcontext) [getHighlightSourceAddressPointer](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#gethighlightsourceaddresspointer) [getHighlightSourceEventPointer](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#gethighlightsourceeventpointer) [getHighlightSourceUrl](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#gethighlightsourceurl) [getHighlightText](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#gethighlighttext) [getInboxes](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getinboxes) [getIndexableTags](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getindexabletags) [getInvoice](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getinvoice) [getLegacyMessageCorraspondant](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getlegacymessagecorraspondant) [getLegacyMessageParent](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getlegacymessageparent) [getListTags](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getlisttags) [getMediaAttachments](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getmediaattachments) [getMutedThings](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getmutedthings) [getNip10References](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getnip10references) [getOrComputeCachedValue](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getorcomputecachedvalue) [getOutboxes](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getoutboxes) [getPackName](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getpackname) [getParentEventStore](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getparenteventstore) [getPicturePostAttachments](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getpicturepostattachments) [getPointerForEvent](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getpointerforevent) [getPollEndsAt](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getpollendsat) [getPollOptions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getpolloptions) [getPollQuestion](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getpollquestion) [getPollRelays](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getpollrelays) [getPollResponseOptions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getpollresponseoptions) [getPollResponsePollId](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getpollresponsepollid) [getPollResponseVotes](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getpollresponsevotes) [getPollType](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getpolltype) [getProfileContent](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getprofilecontent) [getProfilePicture](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getprofilepicture) [getProfilePointerFromPTag](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getprofilepointerfromptag) [getProfilePointersFromList](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getprofilepointersfromlist) [getPubkeyFromDecodeResult](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getpubkeyfromdecoderesult) [getPublicBookmarks](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getpublicbookmarks) [getPublicContacts](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getpubliccontacts) [getPublicGroups](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getpublicgroups) [getPublicMutedThings](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getpublicmutedthings) [getReactionAddressPointer](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getreactionaddresspointer) [getReactionEmoji](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getreactionemoji) [getReactionEventPointer](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getreactioneventpointer) [getRelaysFromContactsEvent](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getrelaysfromcontactsevent) [getRelaysFromList](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getrelaysfromlist) [getReplaceableAddress](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getreplaceableaddress) [getReplaceableIdentifier](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getreplaceableidentifier) [getReported](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getreported) [getRSVPAddressPointer](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getrsvpaddresspointer) [getRSVPEventPointer](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getrsvpeventpointer) [getRSVPFreeBusy](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getrsvpfreebusy) [getRSVPProfilePointer](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getrsvpprofilepointer) [getRSVPStatus](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getrsvpstatus) [getRumorGiftWraps](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getrumorgiftwraps) [getRumorSeals](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getrumorseals) [getSealGiftWrap](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getsealgiftwrap) [getSealRumor](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getsealrumor) [getSeenRelays](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getseenrelays) [getSha256FromURL](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getsha256fromurl) [getSharedAddressPointer](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getsharedaddresspointer) [getSharedEventPointer](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getsharedeventpointer) [getStreamChatMessageStream](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getstreamchatmessagestream) [getStreamEndTime](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getstreamendtime) [getStreamGoalPointer](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getstreamgoalpointer) [getStreamHashtags](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getstreamhashtags) [getStreamHost](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getstreamhost) [getStreamImage](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getstreamimage) [getStreamMaxViewers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getstreammaxviewers) [getStreamParticipants](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getstreamparticipants) [getStreamRecording](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getstreamrecording) [getStreamRelays](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getstreamrelays) [getStreamStartTime](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getstreamstarttime) [getStreamStatus](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getstreamstatus) [getStreamStreamingURLs](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getstreamstreamingurls) [getStreamSummary](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getstreamsummary) [getStreamTitle](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getstreamtitle) [getStreamViewers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getstreamviewers) [getTagValue](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#gettagvalue) [getURLFilename](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#geturlfilename) [getUserStatusPointer](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getuserstatuspointer) [getWrappedMessageParent](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getwrappedmessageparent) [getWrappedMessageSubject](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getwrappedmessagesubject) [getZapAddressPointer](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getzapaddresspointer) [getZapEventPointer](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getzapeventpointer) [getZapPayment](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getzappayment) [getZapPreimage](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getzappreimage) [getZapRecipient](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getzaprecipient) [getZapRequest](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getzaprequest) [getZapSender](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getzapsender) [getZapSplits](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#getzapsplits) [groupMessageEvents](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#groupmessageevents) [hasEncryptedContent](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#hasencryptedcontent) [hasHiddenContent](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#hashiddencontent) [hasHiddenTags](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#hashiddentags) [hasHighlightSource](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#hashighlightsource) [interpretThreadTags](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#interpretthreadtags) [isAddressPointer](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#isaddresspointer) [isAddressPointerInList](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#isaddresspointerinlist) [isATag](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#isatag) [isAudioURL](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#isaudiourl) [isCommentAddressPointer](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#iscommentaddresspointer) [isCommentEventPointer](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#iscommenteventpointer) [isDTag](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#isdtag) [isEncryptedContentFromCache](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#isencryptedcontentfromcache) [isEncryptedContentLocked](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#isencryptedcontentlocked) [isETag](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#isetag) [isEvent](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#isevent) [isEventInList](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#iseventinlist) [isEventPointer](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#iseventpointer) [isEventPointerInList](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#iseventpointerinlist) [isExpired](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#isexpired) [isFilterEqual](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#isfilterequal) [isFromCache](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#isfromcache) [isGiftWrapLocked](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#isgiftwraplocked) [isHex](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#ishex) [isHexKey](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#ishexkey) [isHiddenContentLocked](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#ishiddencontentlocked) [isHiddenTagsLocked](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#ishiddentagslocked) [isImageURL](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#isimageurl) [isLegacyMessageLocked](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#islegacymessagelocked) [isNameValueTag](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#isnamevaluetag) [isNIP04Encrypted](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#isnip04encrypted) [isProfilePointerInList](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#isprofilepointerinlist) [isProtectedEvent](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#isprotectedevent) [isPTag](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#isptag) [isReplaceable](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#isreplaceable) [isRTag](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#isrtag) [isRumor](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#isrumor) [isSafeRelayURL](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#issaferelayurl) [isSameURL](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#issameurl) [isSealLocked](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#isseallocked) [isSha256](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#issha256) [isStreamURL](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#isstreamurl) [isTTag](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#isttag) [isValidList](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#isvalidlist) [isValidProfile](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#isvalidprofile) [isValidZap](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#isvalidzap) [isVideoURL](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#isvideourl) [lockEncryptedContent](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#lockencryptedcontent) [lockGiftWrap](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#lockgiftwrap) [lockHiddenContent](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#lockhiddencontent) [lockHiddenTags](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#lockhiddentags) [lockLegacyMessage](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#locklegacymessage) [markEncryptedContentFromCache](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#markencryptedcontentfromcache) [markFromCache](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#markfromcache) [matchFilter](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#matchfilter) [matchFilters](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#matchfilters) [matchMutes](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#matchmutes) [mergeAddressPointers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#mergeaddresspointers) [mergeBlossomServers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#mergeblossomservers) [mergeBookmarks](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#mergebookmarks) [mergeContacts](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#mergecontacts) [mergeEventPointers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#mergeeventpointers) [mergeFilters](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#mergefilters) [mergeMutes](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#mergemutes) [mergeProfilePointers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#mergeprofilepointers) [mergeRelaySets](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#mergerelaysets) [normalizeToPubkey](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#normalizetopubkey) [normalizeToSecretKey](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#normalizetosecretkey) [normalizeURL](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#normalizeurl) [notifyEventUpdate](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#notifyeventupdate) [parseBolt11](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#parsebolt11) [parseBookmarkTags](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#parsebookmarktags) [parseCoordinate](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#parsecoordinate) [parseExternalPointer](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#parseexternalpointer) [parseFileMetadataTags](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#parsefilemetadatatags) [parseLightningAddress](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#parselightningaddress) [parseLNURLOrAddress](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#parselnurloraddress) [parseMutedTags](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#parsemutedtags) [parseNIP05Address](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#parsenip05address) [persistEncryptedContent](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#persistencryptedcontent) [presistEventsToCache](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#presisteventstocache) [safeParse](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#safeparse) [setCachedValue](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#setcachedvalue) [setEncryptedContentCache](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#setencryptedcontentcache) [setEncryptedContentEncryptionMethod](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#setencryptedcontentencryptionmethod) [setHiddenContentCache](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#sethiddencontentcache) [setHiddenContentEncryptionMethod](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#sethiddencontentencryptionmethod) [setHiddenTagsCache](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#sethiddentagscache) [setHiddenTagsEncryptionMethod](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#sethiddentagsencryptionmethod) [stripInvisibleChar](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#stripinvisiblechar) [unixNow](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#unixnow) [unlockEncryptedContent](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#unlockencryptedcontent) [unlockGiftWrap](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#unlockgiftwrap) [unlockHiddenContent](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#unlockhiddencontent) [unlockHiddenTags](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#unlockhiddentags) [unlockLegacyMessage](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#unlocklegacymessage) [unlockSeal](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html#unlockseal) --- # ProxySigner | AppleSauce * [applesauce-accounts](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.html) * [ProxySigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.ProxySigner.html) Class ProxySigner ==================== A signer class that proxies requests to another signer that isn't created yet #### Type Parameters * T extends [ISigner](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.ISigner.html) #### Implements * [ISigner](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.ISigner.html) ##### Index ### Constructors [constructor](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.ProxySigner.html#constructor) ### Properties [error?](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.ProxySigner.html#error) [upstream](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.ProxySigner.html#upstream) ### Accessors [nip04](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.ProxySigner.html#nip04) [nip44](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.ProxySigner.html#nip44) [signer](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.ProxySigner.html#signer) ### Methods [getPublicKey](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.ProxySigner.html#getpublickey) [signEvent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.ProxySigner.html#signevent) Constructors ------------ ### constructor[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.ProxySigner.html#constructor) * new ProxySigner<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.ProxySigner.html#constructorproxysignert) extends [ISigner](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.ISigner.html) \>(     upstream: Observable,     error?: string, ): [ProxySigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.ProxySigner.html) <[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.ProxySigner.html#constructorproxysignert) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.ProxySigner.html#constructorproxysigner) #### Type Parameters * T extends [ISigner](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.ISigner.html) #### Parameters * upstream: Observable * `Optional`error: string #### Returns [ProxySigner](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.ProxySigner.html) <[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.ProxySigner.html#constructorproxysignert) \> Properties ---------- ### `Protected` `Optional`error[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.ProxySigner.html#error) error?: string ### `Protected`upstream[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.ProxySigner.html#upstream) upstream: Observable Accessors --------- ### nip04[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.ProxySigner.html#nip04) * get nip04(): {     decrypt: (pubkey: string, ciphertext: string) \=> Promise;     encrypt: (pubkey: string, plaintext: string) \=> Promise; } #### Returns {     decrypt: (pubkey: string, ciphertext: string) \=> Promise;     encrypt: (pubkey: string, plaintext: string) \=> Promise; } ### nip44[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.ProxySigner.html#nip44) * get nip44(): {     decrypt: (pubkey: string, ciphertext: string) \=> Promise;     encrypt: (pubkey: string, plaintext: string) \=> Promise; } #### Returns {     decrypt: (pubkey: string, ciphertext: string) \=> Promise;     encrypt: (pubkey: string, plaintext: string) \=> Promise; } ### `Protected`signer[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.ProxySigner.html#signer) * get signer(): [T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.ProxySigner.html#constructorproxysignert) #### Returns [T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.ProxySigner.html#constructorproxysignert) Methods ------- ### getPublicKey[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.ProxySigner.html#getpublickey) * getPublicKey(): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.ProxySigner.html#getpublickey-1) #### Returns Promise ### signEvent[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.ProxySigner.html#signevent) * signEvent(template: EventTemplate): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.ProxySigner.html#signevent-1) #### Parameters * template: EventTemplate #### Returns Promise ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Constructors [constructor](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.ProxySigner.html#constructor) Properties [error](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.ProxySigner.html#error) [upstream](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.ProxySigner.html#upstream) Accessors [nip04](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.ProxySigner.html#nip04) [nip44](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.ProxySigner.html#nip44) [signer](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.ProxySigner.html#signer) Methods [getPublicKey](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.ProxySigner.html#getpublickey) [signEvent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.ProxySigner.html#signevent) --- # SignerMismatchError | AppleSauce * [applesauce-accounts](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.html) * [SignerMismatchError](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.SignerMismatchError.html) Class SignerMismatchError ========================= An error thrown when a signer is used with the wrong pubkey #### Hierarchy * Error * SignerMismatchError ##### Index ### Constructors [constructor](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.SignerMismatchError.html#constructor) ### Properties [cause?](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.SignerMismatchError.html#cause) [message](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.SignerMismatchError.html#message) [name](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.SignerMismatchError.html#name) [stack?](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.SignerMismatchError.html#stack) Constructors ------------ ### constructor[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.SignerMismatchError.html#constructor) * new SignerMismatchError(message?: string): [SignerMismatchError](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.SignerMismatchError.html) [](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.SignerMismatchError.html#constructorsignermismatcherror) #### Parameters * `Optional`message: string #### Returns [SignerMismatchError](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.SignerMismatchError.html) * new SignerMismatchError(     message?: string,     options?: ErrorOptions, ): [SignerMismatchError](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.SignerMismatchError.html) [](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.SignerMismatchError.html#constructorsignermismatcherror-1) #### Parameters * `Optional`message: string * `Optional`options: ErrorOptions #### Returns [SignerMismatchError](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.SignerMismatchError.html) Properties ---------- ### `Optional`cause[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.SignerMismatchError.html#cause) cause?: unknown ### message[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.SignerMismatchError.html#message) message: string ### name[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.SignerMismatchError.html#name) name: string ### `Optional`stack[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.SignerMismatchError.html#stack) stack?: string ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Constructors [constructor](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.SignerMismatchError.html#constructor) Properties [cause](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.SignerMismatchError.html#cause) [message](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.SignerMismatchError.html#message) [name](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.SignerMismatchError.html#name) [stack](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.SignerMismatchError.html#stack) --- # DecryptionCache | AppleSauce * [applesauce-accounts](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.html) * [DecryptionCache](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.DecryptionCache.html) Interface DecryptionCache ========================= An interface for caching decrypted content of events interface DecryptionCache {     [getContent](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.DecryptionCache.html#getcontent-1) (event: Event): Promise;     [setContent](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.DecryptionCache.html#setcontent-1) (event: Event, content: string): Promise; } ##### Index ### Methods [getContent](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.DecryptionCache.html#getcontent) [setContent](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.DecryptionCache.html#setcontent) Methods ------- ### getContent[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.DecryptionCache.html#getcontent) * getContent(event: Event): Promise[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.DecryptionCache.html#getcontent-1) #### Parameters * event: Event #### Returns Promise ### setContent[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.DecryptionCache.html#setcontent) * setContent(event: Event, content: string): Promise[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.DecryptionCache.html#setcontent-1) #### Parameters * event: Event * content: string #### Returns Promise ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Methods [getContent](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.DecryptionCache.html#getcontent) [setContent](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.DecryptionCache.html#setcontent) --- # SerializedAccount | AppleSauce * [applesauce-accounts](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.html) * [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) Type Alias SerializedAccount ================================================== A type for serializing an account type SerializedAccount<[SignerData](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html#signerdata) , [Metadata](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html#metadata) extends unknown\> \= {     [id](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html#id) : string;     [metadata](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html#metadata-1) ?: [Metadata](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html#metadata) ;     [pubkey](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html#pubkey) : string;     [signer](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html#signer) : [SignerData](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html#signerdata) ;     [type](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html#type) : string; } #### Type Parameters * SignerData * Metadata extends unknown ##### Index ### Properties [id](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html#id) [metadata?](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html#metadata-1) [pubkey](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html#pubkey) [signer](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html#signer) [type](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html#type) Properties ---------- ### id[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html#id) id: string Internal account ID ### `Optional`metadata[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html#metadata-1) metadata?: [Metadata](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html#metadata) Extra application specific account metadata ### pubkey[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html#pubkey) pubkey: string pubkey of the account ### signer[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html#signer) signer: [SignerData](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html#signerdata) Signer data ### type[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html#type) type: string account type ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [id](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html#id) [metadata](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html#metadata-1) [pubkey](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html#pubkey) [signer](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html#signer) [type](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html#type) --- # EventTemplate | AppleSauce * [applesauce-accounts](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.html) * [EventTemplate](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.EventTemplate.html) Type Alias EventTemplate ======================== type EventTemplate \= {     [content](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.EventTemplate.html#content) : string;     [created\_at](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.EventTemplate.html#created_at) : number;     [kind](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.EventTemplate.html#kind) : number;     [tags](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.EventTemplate.html#tags) : string\[\]\[\]; } ##### Index ### Properties [content](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.EventTemplate.html#content) [created\_at](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.EventTemplate.html#created_at) [kind](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.EventTemplate.html#kind) [tags](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.EventTemplate.html#tags) Properties ---------- ### content[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.EventTemplate.html#content) content: string ### created\_at[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.EventTemplate.html#created_at) created\_at: number ### kind[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.EventTemplate.html#kind) kind: number ### tags[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.EventTemplate.html#tags) tags: string\[\]\[\] ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [content](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.EventTemplate.html#content) [created\_at](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.EventTemplate.html#created_at) [kind](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.EventTemplate.html#kind) [tags](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.EventTemplate.html#tags) --- # IAccountConstructor | AppleSauce * [applesauce-accounts](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.html) * [IAccountConstructor](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccountConstructor.html) Interface IAccountConstructor =========================================================== A constructor for an account interface IAccountConstructor<     [Signer](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccountConstructor.html#signer) extends [ISigner](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.ISigner.html) ,     [SignerData](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccountConstructor.html#signerdata) ,     [Metadata](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccountConstructor.html#metadata) extends unknown, \> {     new [IAccountConstructor](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccountConstructor.html#constructoriaccountconstructor) (         pubkey: string,         signer: [Signer](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccountConstructor.html#signer) ,     ): [IAccount](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html) <[Signer](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccountConstructor.html#signer) , [SignerData](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccountConstructor.html#signerdata) , [Metadata](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccountConstructor.html#metadata) \>;     [type](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccountConstructor.html#type) : string;     [fromJSON](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccountConstructor.html#fromjson-1) (         json: [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) <[SignerData](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccountConstructor.html#signerdata) , [Metadata](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccountConstructor.html#metadata) \>,     ): [IAccount](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html) <[Signer](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccountConstructor.html#signer) , [SignerData](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccountConstructor.html#signerdata) , [Metadata](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccountConstructor.html#metadata) \>; } #### Type Parameters * Signer extends [ISigner](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.ISigner.html) * SignerData * Metadata extends unknown ##### Index ### Constructors [constructor](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccountConstructor.html#constructor) ### Properties [type](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccountConstructor.html#type) ### Methods [fromJSON](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccountConstructor.html#fromjson) Constructors ------------ ### constructor[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccountConstructor.html#constructor) * new IAccountConstructor(     pubkey: string,     signer: [Signer](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccountConstructor.html#signer) , ): [IAccount](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html) <[Signer](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccountConstructor.html#signer) , [SignerData](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccountConstructor.html#signerdata) , [Metadata](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccountConstructor.html#metadata) \>[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccountConstructor.html#constructoriaccountconstructor) #### Parameters * pubkey: string * signer: [Signer](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccountConstructor.html#signer) #### Returns [IAccount](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html) <[Signer](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccountConstructor.html#signer) , [SignerData](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccountConstructor.html#signerdata) , [Metadata](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccountConstructor.html#metadata) \> Properties ---------- ### `Readonly`type[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccountConstructor.html#type) type: string Methods ------- ### fromJSON[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccountConstructor.html#fromjson) * fromJSON(     json: [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) <[SignerData](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccountConstructor.html#signerdata) , [Metadata](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccountConstructor.html#metadata) \>, ): [IAccount](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html) <[Signer](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccountConstructor.html#signer) , [SignerData](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccountConstructor.html#signerdata) , [Metadata](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccountConstructor.html#metadata) \>[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccountConstructor.html#fromjson-1) #### Parameters * json: [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) <[SignerData](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccountConstructor.html#signerdata) , [Metadata](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccountConstructor.html#metadata) \> #### Returns [IAccount](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html) <[Signer](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccountConstructor.html#signer) , [SignerData](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccountConstructor.html#signerdata) , [Metadata](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccountConstructor.html#metadata) \> ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Constructors [constructor](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccountConstructor.html#constructor) Properties [type](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccountConstructor.html#type) Methods [fromJSON](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccountConstructor.html#fromjson) --- # BaseAccount | AppleSauce * [applesauce-accounts](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.html) * [BaseAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html) Class BaseAccount =============================================== A base class for all accounts #### Type Parameters * Signer extends [ISigner](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.ISigner.html) * SignerData * Metadata extends unknown #### Hierarchy ([View Summary](https://hzrd149.github.io/applesauce/typedoc/hierarchy.html#applesauce-accounts.BaseAccount) ) * BaseAccount * [AmberClipboardAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.AmberClipboardAccount.html) * [ExtensionAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ExtensionAccount.html) * [PasswordAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.PasswordAccount.html) * [ReadonlyAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.ReadonlyAccount.html) * [SerialPortAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SerialPortAccount.html) * [SimpleAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.SimpleAccount.html) * [NostrConnectAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.Accounts.NostrConnectAccount.html) #### Implements * [IAccount](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html) <[Signer](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountsigner) , [SignerData](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountsignerdata) , [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountmetadata) \> ##### Index ### Constructors [constructor](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructor) ### Properties [abort](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#abort) [disableQueue?](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#disablequeue) [id](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#id) [lock](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#lock) [metadata$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#metadata-1) [pubkey](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#pubkey) [queueLength](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#queuelength) [signer](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#signer-1) ### Accessors [metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#metadata-2) [nip04](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#nip04) [nip44](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#nip44) [type](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#type) ### Methods [abortQueue](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#abortqueue) [getPublicKey](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#getpublickey) [operation](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#operation) [reduceQueue](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#reducequeue) [saveCommonFields](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#savecommonfields) [signEvent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#signevent) [toJSON](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#tojson) [waitForQueue](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#waitforqueue) [loadCommonFields](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#loadcommonfields) Constructors ------------ ### constructor[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructor) * new BaseAccount<[Signer](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountsigner) extends [ISigner](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.ISigner.html) , [SignerData](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountsignerdata) , [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountmetadata) extends unknown\>(     pubkey: string,     signer: [Signer](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountsigner) , ): [BaseAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html) <[Signer](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountsigner) , [SignerData](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountsignerdata) , [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountmetadata) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccount) #### Type Parameters * Signer extends [ISigner](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.ISigner.html) * SignerData * Metadata extends unknown #### Parameters * pubkey: string * signer: [Signer](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountsigner) #### Returns [BaseAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html) <[Signer](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountsigner) , [SignerData](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountsignerdata) , [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountmetadata) \> Properties ---------- ### `Protected`abort[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#abort) abort: null | AbortController = null ### `Optional`disableQueue[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#disablequeue) disableQueue?: boolean Disable request queueing ### id[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#id) id: string = ... ### `Protected`lock[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#lock) lock: null | Promise = null ### metadata$[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#metadata-1) metadata$: BehaviorSubject = ... ### pubkey[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#pubkey) pubkey: string ### `Protected`queueLength[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#queuelength) queueLength: number = 0 internal queue ### signer[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#signer-1) signer: [Signer](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountsigner) Accessors --------- ### metadata[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#metadata-2) * get metadata(): undefined | [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountmetadata) #### Returns undefined | [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountmetadata) * set metadata(metadata: [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountmetadata) ): void #### Parameters * metadata: [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountmetadata) #### Returns void ### nip04[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#nip04) * get nip04(): | undefined | {     decrypt: (pubkey: string, ciphertext: string) \=> Promise;     encrypt: (pubkey: string, plaintext: string) \=> Promise; } #### Returns     | undefined     | {         decrypt: (pubkey: string, ciphertext: string) \=> Promise;         encrypt: (pubkey: string, plaintext: string) \=> Promise;     } ### nip44[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#nip44) * get nip44(): | undefined | {     decrypt: (pubkey: string, ciphertext: string) \=> Promise;     encrypt: (pubkey: string, plaintext: string) \=> Promise; } #### Returns     | undefined     | {         decrypt: (pubkey: string, ciphertext: string) \=> Promise;         encrypt: (pubkey: string, plaintext: string) \=> Promise;     } ### type[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#type) * get type(): string #### Returns string Methods ------- ### abortQueue[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#abortqueue) * abortQueue(reason: Error): void[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#abortqueue-1) Aborts all pending requests in the queue #### Parameters * reason: Error #### Returns void ### getPublicKey[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#getpublickey) * getPublicKey(): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#getpublickey-1) Gets the pubkey from the signer #### Returns Promise ### `Protected`operation[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#operation) * operation<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#operationt) extends unknown\>(operation: () \=> Promise<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#operationt) \>): Promise<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#operationt) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#operation-1) A method that wraps any signer interaction, this allows the account to wait for unlock or queue requests #### Type Parameters * T extends unknown #### Parameters * operation: () \=> Promise<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#operationt) \> #### Returns Promise<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#operationt) \> ### `Protected`reduceQueue[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#reducequeue) * reduceQueue(): void[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#reducequeue-1) #### Returns void ### `Protected`saveCommonFields[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#savecommonfields) * saveCommonFields(     json: Omit<         [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) <[SignerData](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountsignerdata) , [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountmetadata) \>,         "id" | "type" | "metadata" | "pubkey",     \>, ): [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) <[SignerData](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountsignerdata) , [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountmetadata) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#savecommonfields-1) Adds the common fields to the serialized output of a toJSON method #### Parameters * json: Omit<     [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) <[SignerData](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountsignerdata) , [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountmetadata) \>,     "id" | "type" | "metadata" | "pubkey", \> #### Returns [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) <[SignerData](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountsignerdata) , [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountmetadata) \> ### signEvent[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#signevent) * signEvent(template: [EventTemplate](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.EventTemplate.html) ): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#signevent-1) sign the event and make sure its signed with the correct pubkey #### Parameters * template: [EventTemplate](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.EventTemplate.html) #### Returns Promise ### toJSON[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#tojson) * toJSON(): [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) <[SignerData](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountsignerdata) , [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountmetadata) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#tojson-1) #### Returns [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) <[SignerData](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountsignerdata) , [Metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructorbaseaccountmetadata) \> ### `Protected`waitForQueue[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#waitforqueue) * waitForQueue<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#waitforqueuet) extends unknown\>(operation: () \=> Promise<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#waitforqueuet) \>): Promise<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#waitforqueuet) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#waitforqueue-1) #### Type Parameters * T extends unknown #### Parameters * operation: () \=> Promise<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#waitforqueuet) \> #### Returns Promise<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#waitforqueuet) \> ### `Static`loadCommonFields[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#loadcommonfields) * loadCommonFields<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#loadcommonfieldst) extends [IAccount](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html) <[ISigner](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.ISigner.html) , any, any\>\>(     account: [T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#loadcommonfieldst) ,     json: [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) , ): [T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#loadcommonfieldst) [](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#loadcommonfields-1) Sets an accounts id and metadata. NOTE: This should only be used in fromJSON methods #### Type Parameters * T extends [IAccount](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html) <[ISigner](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.ISigner.html) , any, any\> #### Parameters * account: [T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#loadcommonfieldst) * json: [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) #### Returns [T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#loadcommonfieldst) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Constructors [constructor](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#constructor) Properties [abort](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#abort) [disableQueue](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#disablequeue) [id](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#id) [lock](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#lock) [metadata$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#metadata-1) [pubkey](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#pubkey) [queueLength](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#queuelength) [signer](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#signer-1) Accessors [metadata](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#metadata-2) [nip04](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#nip04) [nip44](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#nip44) [type](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#type) Methods [abortQueue](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#abortqueue) [getPublicKey](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#getpublickey) [operation](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#operation) [reduceQueue](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#reducequeue) [saveCommonFields](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#savecommonfields) [signEvent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#signevent) [toJSON](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#tojson) [waitForQueue](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#waitforqueue) [loadCommonFields](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html#loadcommonfields) --- # IAccount | AppleSauce * [applesauce-accounts](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.html) * [IAccount](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html) Interface IAccount ================================================ An interface for an account interface IAccount<     [Signer](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html#signer) extends [ISigner](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.ISigner.html) \= [ISigner](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.ISigner.html) ,     [SignerData](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html#signerdata) \= any,     [Metadata](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html#metadata) extends unknown \= any, \> {     [disableQueue](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html#disablequeue) ?: boolean;     [getPublicKey](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html#getpublickey) : () \=> Promise;     [id](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html#id) : string;     [metadata](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html#metadata-1) ?: [Metadata](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html#metadata) ;     [name](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html#name) ?: string;     [nip04](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html#nip04) ?: {         decrypt: (pubkey: string, ciphertext: string) \=> Promise;         encrypt: (pubkey: string, plaintext: string) \=> Promise;     };     [nip44](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html#nip44) ?: {         decrypt: (pubkey: string, ciphertext: string) \=> Promise;         encrypt: (pubkey: string, plaintext: string) \=> Promise;     };     [pubkey](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html#pubkey) : string;     [signer](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html#signer-1) : [Signer](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html#signer) ;     [signEvent](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html#signevent) : (template: EventTemplate) \=> Promise;     [type](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html#type) : string;     [toJSON](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html#tojson-1) (): [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) <[SignerData](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html#signerdata) , [Metadata](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html#metadata) \>; } #### Type Parameters * Signer extends [ISigner](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.ISigner.html) = [ISigner](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.ISigner.html) * SignerData = any * Metadata extends unknown = any #### Hierarchy ([View Summary](https://hzrd149.github.io/applesauce/typedoc/hierarchy.html#applesauce-accounts.IAccount) ) * [ISigner](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.ISigner.html) * IAccount #### Implemented by * [BaseAccount](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.BaseAccount.html) ##### Index ### Properties [disableQueue?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html#disablequeue) [getPublicKey](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html#getpublickey) [id](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html#id) [metadata?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html#metadata-1) [name?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html#name) [nip04?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html#nip04) [nip44?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html#nip44) [pubkey](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html#pubkey) [signer](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html#signer-1) [signEvent](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html#signevent) [type](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html#type) ### Methods [toJSON](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html#tojson) Properties ---------- ### `Optional`disableQueue[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html#disablequeue) disableQueue?: boolean ### getPublicKey[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html#getpublickey) getPublicKey: () \=> Promise ### id[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html#id) id: string ### `Optional`metadata[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html#metadata-1) metadata?: [Metadata](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html#metadata) ### `Optional`name[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html#name) name?: string ### `Optional`nip04[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html#nip04) nip04?: {     decrypt: (pubkey: string, ciphertext: string) \=> Promise;     encrypt: (pubkey: string, plaintext: string) \=> Promise; } ### `Optional`nip44[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html#nip44) nip44?: {     decrypt: (pubkey: string, ciphertext: string) \=> Promise;     encrypt: (pubkey: string, plaintext: string) \=> Promise; } ### pubkey[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html#pubkey) pubkey: string ### signer[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html#signer-1) signer: [Signer](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html#signer) ### signEvent[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html#signevent) signEvent: (template: EventTemplate) \=> Promise ### type[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html#type) type: string Methods ------- ### toJSON[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html#tojson) * toJSON(): [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) <[SignerData](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html#signerdata) , [Metadata](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html#metadata) \>[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html#tojson-1) #### Returns [SerializedAccount](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-accounts.SerializedAccount.html) <[SignerData](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html#signerdata) , [Metadata](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html#metadata) \> ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [disableQueue](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html#disablequeue) [getPublicKey](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html#getpublickey) [id](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html#id) [metadata](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html#metadata-1) [name](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html#name) [nip04](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html#nip04) [nip44](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html#nip44) [pubkey](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html#pubkey) [signer](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html#signer-1) [signEvent](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html#signevent) [type](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html#type) Methods [toJSON](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-accounts.IAccount.html#tojson) --- # ActionConstructor | AppleSauce * [applesauce-actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.html) * [ActionConstructor](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.ActionConstructor.html) Type Alias ActionConstructor ================================== ActionConstructor: (...args: [Args](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.ActionConstructor.html#args) ) \=> [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) #### Type Parameters * Args extends any\[\] #### Type declaration * * (...args: [Args](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.ActionConstructor.html#args) ): [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) * #### Parameters * ...args: [Args](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.ActionConstructor.html#args) #### Returns [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # ActionContext | AppleSauce * [applesauce-actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.html) * [ActionContext](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.ActionContext.html) Type Alias ActionContext ======================== The context that is passed to actions for them to use to preform actions type ActionContext \= {     [events](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.ActionContext.html#events) : [IEventStoreRead](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreRead.html) ;     [factory](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.ActionContext.html#factory) : [EventFactory](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html) ;     [self](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.ActionContext.html#self) : string; } ##### Index ### Properties [events](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.ActionContext.html#events) [factory](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.ActionContext.html#factory) [self](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.ActionContext.html#self) Properties ---------- ### events[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.ActionContext.html#events) events: [IEventStoreRead](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreRead.html) The event store to load events from ### factory[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.ActionContext.html#factory) factory: [EventFactory](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html) The event factory used to build and modify events ### self[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.ActionContext.html#self) self: string The pubkey of the signer in the event factory ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [events](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.ActionContext.html#events) [factory](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.ActionContext.html#factory) [self](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.ActionContext.html#self) --- # PublishMethod | AppleSauce * [applesauce-actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.html) * [PublishMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.PublishMethod.html) Type Alias PublishMethod ======================== PublishMethod: (event: NostrEvent) \=> void | Promise A callback used to tell the upstream app to publish an event #### Type declaration * * (event: NostrEvent): void | Promise * #### Parameters * event: NostrEvent #### Returns void | Promise ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # Helpers | AppleSauce * [applesauce-content](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Helpers.html) Namespace Helpers ================= Variables --------- [Expressions](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-content.Helpers.Expressions.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Helpers.html#expressions) [Tokens](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-content.Helpers.Tokens.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Helpers.html#tokens) Functions --------- [getMediaAttachmentURLsFromContent](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-content.Helpers.getMediaAttachmentURLsFromContent.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Helpers.html#getmediaattachmenturlsfromcontent) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Variables [Expressions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Helpers.html#expressions) [Tokens](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Helpers.html#tokens) Functions [getMediaAttachmentURLsFromContent](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Helpers.html#getmediaattachmenturlsfromcontent) --- # Markdown | AppleSauce * [applesauce-content](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.html) * [Markdown](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Markdown.html) Namespace Markdown ================== Interfaces ---------- [NostrMention](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Markdown.NostrMention.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Markdown.html#nostrmention) Functions --------- [remarkNostrMentions](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-content.Markdown.remarkNostrMentions.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Markdown.html#remarknostrmentions) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Interfaces [NostrMention](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Markdown.html#nostrmention) Functions [remarkNostrMentions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Markdown.html#remarknostrmentions) --- # Nast | AppleSauce * [applesauce-content](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.html) * [Nast](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Nast.html) Namespace Nast ============== Interfaces ---------- [CashuToken](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.CashuToken.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Nast.html#cashutoken) [CommonData](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.CommonData.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Nast.html#commondata) [ContentMap](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.ContentMap.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Nast.html#contentmap) [Emoji](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Emoji.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Nast.html#emoji) [Gallery](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Gallery.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Nast.html#gallery) [Hashtag](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Hashtag.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Nast.html#hashtag) [LightningInvoice](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.LightningInvoice.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Nast.html#lightninginvoice) [Link](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Link.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Nast.html#link) [Mention](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Mention.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Nast.html#mention) [Node](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Node.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Nast.html#node) [Root](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Root.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Nast.html#root) [Text](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-content.Nast.Text.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Nast.html#text) Type Aliases ------------ [Content](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-content.Nast.Content.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Nast.html#content) Functions --------- [eolMetadata](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-content.Nast.eolMetadata.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Nast.html#eolmetadata) [findAndReplace](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-content.Nast.findAndReplace.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Nast.html#findandreplace) [truncateContent](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-content.Nast.truncateContent.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Nast.html#truncatecontent) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Interfaces [CashuToken](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Nast.html#cashutoken) [CommonData](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Nast.html#commondata) [ContentMap](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Nast.html#contentmap) [Emoji](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Nast.html#emoji) [Gallery](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Nast.html#gallery) [Hashtag](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Nast.html#hashtag) [LightningInvoice](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Nast.html#lightninginvoice) [Link](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Nast.html#link) [Mention](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Nast.html#mention) [Node](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Nast.html#node) [Root](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Nast.html#root) [Text](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Nast.html#text) Type Aliases [Content](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Nast.html#content) Functions [eolMetadata](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Nast.html#eolmetadata) [findAndReplace](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Nast.html#findandreplace) [truncateContent](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Nast.html#truncatecontent) --- # Text | AppleSauce * [applesauce-content](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.html) * [Text](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Text.html) Namespace Text ============== Variables --------- [createTextNoteATS](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-content.Text.createTextNoteATS.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Text.html#createtextnoteats) [TextNoteContentSymbol](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-content.Text.TextNoteContentSymbol.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Text.html#textnotecontentsymbol) [textNoteTransformers](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-content.Text.textNoteTransformers.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Text.html#textnotetransformers) Functions --------- [cashuTokens](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-content.Text.cashuTokens.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Text.html#cashutokens) [createEventContentTree](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-content.Text.createEventContentTree.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Text.html#createeventcontenttree) [emojis](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-content.Text.emojis.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Text.html#emojis) [galleries](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-content.Text.galleries.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Text.html#galleries) [getParsedContent](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-content.Text.getParsedContent.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Text.html#getparsedcontent) [hashtags](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-content.Text.hashtags.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Text.html#hashtags) [lightningInvoices](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-content.Text.lightningInvoices.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Text.html#lightninginvoices) [links](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-content.Text.links.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Text.html#links) [nostrMentions](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-content.Text.nostrMentions.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Text.html#nostrmentions) [removeParsedTextContent](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-content.Text.removeParsedTextContent.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Text.html#removeparsedtextcontent) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Variables [createTextNoteATS](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Text.html#createtextnoteats) [TextNoteContentSymbol](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Text.html#textnotecontentsymbol) [textNoteTransformers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Text.html#textnotetransformers) Functions [cashuTokens](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Text.html#cashutokens) [createEventContentTree](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Text.html#createeventcontenttree) [emojis](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Text.html#emojis) [galleries](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Text.html#galleries) [getParsedContent](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Text.html#getparsedcontent) [hashtags](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Text.html#hashtags) [lightningInvoices](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Text.html#lightninginvoices) [links](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Text.html#links) [nostrMentions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Text.html#nostrmentions) [removeParsedTextContent](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-content.Text.html#removeparsedtextcontent) --- # TimeoutError | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [TimeoutError](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.TimeoutError.html) Class TimeoutError ================== #### Hierarchy * Error * TimeoutError ##### Index ### Constructors [constructor](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.TimeoutError.html#constructor) ### Properties [cause?](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.TimeoutError.html#cause) [message](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.TimeoutError.html#message) [name](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.TimeoutError.html#name) [stack?](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.TimeoutError.html#stack) Constructors ------------ ### constructor[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.TimeoutError.html#constructor) * new TimeoutError(message?: string): [TimeoutError](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.TimeoutError.html) [](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.TimeoutError.html#constructortimeouterror) #### Parameters * `Optional`message: string #### Returns [TimeoutError](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.TimeoutError.html) * new TimeoutError(message?: string, options?: ErrorOptions): [TimeoutError](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.TimeoutError.html) [](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.TimeoutError.html#constructortimeouterror-1) #### Parameters * `Optional`message: string * `Optional`options: ErrorOptions #### Returns [TimeoutError](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.TimeoutError.html) Properties ---------- ### `Optional`cause[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.TimeoutError.html#cause) cause?: unknown ### message[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.TimeoutError.html#message) message: string ### name[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.TimeoutError.html#name) name: string ### `Optional`stack[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.TimeoutError.html#stack) stack?: string ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Constructors [constructor](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.TimeoutError.html#constructor) Properties [cause](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.TimeoutError.html#cause) [message](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.TimeoutError.html#message) [name](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.TimeoutError.html#name) [stack](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.TimeoutError.html#stack) --- # EventSet | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [EventSet](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html) Class EventSet ============== A set of nostr events that can be queried and subscribed to NOTE: does not handle replaceable events or any deletion logic #### Implements * [IEventSet](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html) ##### Index ### Constructors [constructor](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#constructor) ### Properties [authors](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#authors) [claims](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#claims) [created\_at](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#created_at) [events](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#events) [insert$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#insert) [kinds](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#kinds) [log](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#log) [onBeforeInsert?](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#onbeforeinsert) [remove$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#remove) [replaceable](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#replaceable) [tags](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#tags) [update$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#update) ### Accessors [size](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#size) ### Methods [add](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#add) [claim](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#claim) [clearClaim](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#clearclaim) [getAuthorsIndex](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#getauthorsindex) [getByFilters](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#getbyfilters) [getEvent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#getevent) [getEventsForFilter](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#geteventsforfilter) [getEventsForFilters](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#geteventsforfilters) [getKindIndex](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#getkindindex) [getReplaceable](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#getreplaceable) [getReplaceableHistory](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#getreplaceablehistory) [getTagIndex](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#gettagindex) [getTimeline](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#gettimeline) [hasEvent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#hasevent) [hasReplaceable](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#hasreplaceable) [isClaimed](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#isclaimed) [iterateAuthors](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#iterateauthors) [iterateIds](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#iterateids) [iterateKinds](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#iteratekinds) [iterateTag](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#iteratetag) [iterateTime](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#iteratetime) [prune](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#prune) [remove](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#remove-1) [removeClaim](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#removeclaim) [reset](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#reset) [touch](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#touch) [update](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#update-1) Constructors ------------ ### constructor[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#constructor) * new EventSet(): [EventSet](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html) [](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#constructoreventset) #### Returns [EventSet](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html) Properties ---------- ### `Protected`authors[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#authors) authors: Map\> = ... ### `Protected`claims[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#claims) claims: WeakMap = ... A weak map of events that are claimed by other things ### `Protected`created\_at[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#created_at) created\_at: Event\[\] = \[\] ### events[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#events) events: [LRU](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html) = ... LRU cache of last events touched ### insert$[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#insert) insert$: Subject = ... A stream of events inserted into the database ### `Protected`kinds[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#kinds) kinds: Map\> = ... Indexes ### `Protected`log[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#log) log: Debugger = ... ### `Optional`onBeforeInsert[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#onbeforeinsert) onBeforeInsert?: (event: Event) \=> boolean A method thats called before a new event is inserted ### remove$[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#remove) remove$: Subject = ... A stream of events removed from the database ### `Protected`replaceable[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#replaceable) replaceable: Map = ... A sorted array of replaceable events by address ### `Protected`tags[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#tags) tags: [LRU](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html) \> = ... ### update$[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#update) update$: Subject = ... A stream of events that have been updated Accessors --------- ### size[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#size) * get size(): number The number of events in the event set #### Returns number Methods ------- ### add[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#add) * add(event: Event): null | Event[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#add-1) Inserts an event into the database and notifies all subscriptions #### Parameters * event: Event #### Returns null | Event ### claim[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#claim) * claim(event: Event, claim: any): void[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#claim-1) Sets the claim on the event and touches it #### Parameters * event: Event * claim: any #### Returns void ### clearClaim[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#clearclaim) * clearClaim(event: Event): void[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#clearclaim-1) Removes all claims on an event #### Parameters * event: Event #### Returns void ### `Protected`getAuthorsIndex[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#getauthorsindex) * getAuthorsIndex(author: string): Set[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#getauthorsindex-1) #### Parameters * author: string #### Returns Set ### getByFilters[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#getbyfilters) * getByFilters(filters: Filter | Filter\[\]): Set[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#getbyfilters-1) Gets all events that match the filters #### Parameters * filters: Filter | Filter\[\] #### Returns Set ### getEvent[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#getevent) * getEvent(id: string): undefined | Event[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#getevent-1) Gets a single event based on id #### Parameters * id: string #### Returns undefined | Event ### getEventsForFilter[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#geteventsforfilter) * getEventsForFilter(filter: Filter): Set[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#geteventsforfilter-1) Returns all events that match the filter #### Parameters * filter: Filter #### Returns Set ### getEventsForFilters[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#geteventsforfilters) * getEventsForFilters(filters: Filter\[\]): Set[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#geteventsforfilters-1) Returns all events that match the filters #### Parameters * filters: Filter\[\] #### Returns Set ### `Protected`getKindIndex[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#getkindindex) * getKindIndex(kind: number): Set[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#getkindindex-1) Index helper methods #### Parameters * kind: number #### Returns Set ### getReplaceable[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#getreplaceable) * getReplaceable(     kind: number,     pubkey: string,     identifier?: string, ): undefined | Event[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#getreplaceable-1) Gets the latest replaceable event #### Parameters * kind: number * pubkey: string * `Optional`identifier: string #### Returns undefined | Event ### getReplaceableHistory[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#getreplaceablehistory) * getReplaceableHistory(     kind: number,     pubkey: string,     identifier?: string, ): undefined | Event\[\][](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#getreplaceablehistory-1) Gets the history of a replaceable event #### Parameters * kind: number * pubkey: string * `Optional`identifier: string #### Returns undefined | Event\[\] ### `Protected`getTagIndex[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#gettagindex) * getTagIndex(tagAndValue: string): Set[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#gettagindex-1) #### Parameters * tagAndValue: string #### Returns Set ### getTimeline[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#gettimeline) * getTimeline(filters: Filter | Filter\[\]): Event\[\][](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#gettimeline-1) Gets a timeline of events that match the filters #### Parameters * filters: Filter | Filter\[\] #### Returns Event\[\] ### hasEvent[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#hasevent) * hasEvent(id: string): boolean[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#hasevent-1) Checks if the database contains an event without touching it #### Parameters * id: string #### Returns boolean ### hasReplaceable[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#hasreplaceable) * hasReplaceable(kind: number, pubkey: string, identifier?: string): boolean[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#hasreplaceable-1) Checks if the event set has a replaceable event #### Parameters * kind: number * pubkey: string * `Optional`identifier: string #### Returns boolean ### isClaimed[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#isclaimed) * isClaimed(event: Event): boolean[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#isclaimed-1) Checks if an event is claimed by anything #### Parameters * event: Event #### Returns boolean ### iterateAuthors[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#iterateauthors) * iterateAuthors(authors: Iterable): Generator[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#iterateauthors-1) Iterates over all events by author #### Parameters * authors: Iterable #### Returns Generator ### iterateIds[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#iterateids) * iterateIds(ids: Iterable): Generator[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#iterateids-1) Iterates over all events by id #### Parameters * ids: Iterable #### Returns Generator ### iterateKinds[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#iteratekinds) * iterateKinds(kinds: Iterable): Generator[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#iteratekinds-1) Iterates over all events by kind #### Parameters * kinds: Iterable #### Returns Generator ### iterateTag[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#iteratetag) * iterateTag(tag: string, values: Iterable): Generator[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#iteratetag-1) Iterates over all events by indexable tag and value #### Parameters * tag: string * values: Iterable #### Returns Generator ### iterateTime[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#iteratetime) * iterateTime(     since: undefined | number,     until: undefined | number, ): Generator[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#iteratetime-1) Iterates over all events by time #### Parameters * since: undefined | number * until: undefined | number #### Returns Generator ### prune[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#prune) * prune(limit?: number): number[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#prune-1) Remove the oldest events that are not claimed #### Parameters * limit: number = 1000 #### Returns number ### remove[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#remove-1) * remove(eventOrId: string | Event): boolean[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#remove-2) Removes an event from the database and notifies all subscriptions #### Parameters * eventOrId: string | Event #### Returns boolean ### removeClaim[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#removeclaim) * removeClaim(event: Event, claim: any): void[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#removeclaim-1) Removes a claim from an event #### Parameters * event: Event * claim: any #### Returns void ### reset[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#reset) * reset(): void[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#reset-1) Resets the event set #### Returns void ### touch[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#touch) * touch(event: Event): void[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#touch-1) Moves an event to the top of the LRU cache #### Parameters * event: Event #### Returns void ### update[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#update-1) * update(event: Event): boolean[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#update-2) Inserts and event into the database and notifies all subscriptions that the event has updated #### Parameters * event: Event #### Returns boolean ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Constructors [constructor](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#constructor) Properties [authors](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#authors) [claims](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#claims) [created\_at](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#created_at) [events](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#events) [insert$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#insert) [kinds](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#kinds) [log](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#log) [onBeforeInsert](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#onbeforeinsert) [remove$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#remove) [replaceable](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#replaceable) [tags](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#tags) [update$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#update) Accessors [size](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#size) Methods [add](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#add) [claim](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#claim) [clearClaim](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#clearclaim) [getAuthorsIndex](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#getauthorsindex) [getByFilters](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#getbyfilters) [getEvent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#getevent) [getEventsForFilter](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#geteventsforfilter) [getEventsForFilters](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#geteventsforfilters) [getKindIndex](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#getkindindex) [getReplaceable](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#getreplaceable) [getReplaceableHistory](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#getreplaceablehistory) [getTagIndex](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#gettagindex) [getTimeline](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#gettimeline) [hasEvent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#hasevent) [hasReplaceable](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#hasreplaceable) [isClaimed](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#isclaimed) [iterateAuthors](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#iterateauthors) [iterateIds](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#iterateids) [iterateKinds](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#iteratekinds) [iterateTag](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#iteratetag) [iterateTime](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#iteratetime) [prune](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#prune) [remove](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#remove-1) [removeClaim](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#removeclaim) [reset](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#reset) [touch](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#touch) [update](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html#update-1) --- # IEventClaims | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [IEventClaims](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventClaims.html) Interface IEventClaims ====================== The claim interface for an event store interface IEventClaims {     [claim](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventClaims.html#claim-1) (event: Event, claim: any): void;     [clearClaim](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventClaims.html#clearclaim-1) (event: Event): void;     [isClaimed](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventClaims.html#isclaimed-1) (event: Event): boolean;     [removeClaim](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventClaims.html#removeclaim-1) (event: Event, claim: any): void; } #### Hierarchy ([View Summary](https://hzrd149.github.io/applesauce/typedoc/hierarchy.html#applesauce-core.IEventClaims) ) * IEventClaims * [IEventSet](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html) * [IEventStore](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html) ##### Index ### Methods [claim](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventClaims.html#claim) [clearClaim](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventClaims.html#clearclaim) [isClaimed](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventClaims.html#isclaimed) [removeClaim](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventClaims.html#removeclaim) Methods ------- ### claim[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventClaims.html#claim) * claim(event: Event, claim: any): void[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventClaims.html#claim-1) Sets the claim on the event and touches it #### Parameters * event: Event * claim: any #### Returns void ### clearClaim[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventClaims.html#clearclaim) * clearClaim(event: Event): void[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventClaims.html#clearclaim-1) Removes all claims on an event #### Parameters * event: Event #### Returns void ### isClaimed[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventClaims.html#isclaimed) * isClaimed(event: Event): boolean[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventClaims.html#isclaimed-1) Checks if an event is claimed by anything #### Parameters * event: Event #### Returns boolean ### removeClaim[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventClaims.html#removeclaim) * removeClaim(event: Event, claim: any): void[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventClaims.html#removeclaim-1) Removes a claim from an event #### Parameters * event: Event * claim: any #### Returns void ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Methods [claim](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventClaims.html#claim) [clearClaim](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventClaims.html#clearclaim) [isClaimed](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventClaims.html#isclaimed) [removeClaim](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventClaims.html#removeclaim) --- # IEventStoreActions | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [IEventStoreActions](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreActions.html) Interface IEventStoreActions ============================ The actions for an event store interface IEventStoreActions {     [add](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreActions.html#add-1) (event: Event): null | Event;     [remove](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreActions.html#remove-1) (event: string | Event): boolean;     [update](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreActions.html#update-1) (event: Event): void; } #### Hierarchy ([View Summary](https://hzrd149.github.io/applesauce/typedoc/hierarchy.html#applesauce-core.IEventStoreActions) ) * IEventStoreActions * [IEventSet](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html) * [IEventStore](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html) ##### Index ### Methods [add](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreActions.html#add) [remove](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreActions.html#remove) [update](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreActions.html#update) Methods ------- ### add[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreActions.html#add) * add(event: Event): null | Event[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreActions.html#add-1) Add an event to the store #### Parameters * event: Event #### Returns null | Event ### remove[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreActions.html#remove) * remove(event: string | Event): boolean[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreActions.html#remove-1) Remove an event from the store #### Parameters * event: string | Event #### Returns boolean ### update[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreActions.html#update) * update(event: Event): void[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreActions.html#update-1) Notify the store that an event has updated #### Parameters * event: Event #### Returns void ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Methods [add](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreActions.html#add) [remove](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreActions.html#remove) [update](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreActions.html#update) --- # IEventSet | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [IEventSet](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html) Interface IEventSet =================== The base interface for a set of events interface IEventSet {     [events](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#events) : [LRU](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html) ;     [insert$](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#insert) : Observable;     [remove$](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#remove) : Observable;     [update$](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#update) : Observable;     [add](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#add-1) (event: Event): null | Event;     [claim](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#claim-1) (event: Event, claim: any): void;     [clearClaim](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#clearclaim-1) (event: Event): void;     [getByFilters](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#getbyfilters-1) (filters: Filter | Filter\[\]): Set;     [getEvent](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#getevent-1) (id: string): undefined | Event;     [getReplaceable](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#getreplaceable-1) (         kind: number,         pubkey: string,         identifier?: string,     ): undefined | Event;     [getReplaceableHistory](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#getreplaceablehistory-1) (         kind: number,         pubkey: string,         identifier?: string,     ): undefined | Event\[\];     [getTimeline](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#gettimeline-1) (filters: Filter | Filter\[\]): Event\[\];     [hasEvent](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#hasevent-1) (id: string): boolean;     [hasReplaceable](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#hasreplaceable-1) (kind: number, pubkey: string, identifier?: string): boolean;     [isClaimed](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#isclaimed-1) (event: Event): boolean;     [remove](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#remove-2) (event: string | Event): boolean;     [removeClaim](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#removeclaim-1) (event: Event, claim: any): void;     [update](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#update-2) (event: Event): void; } #### Hierarchy ([View Summary](https://hzrd149.github.io/applesauce/typedoc/hierarchy.html#applesauce-core.IEventSet) ) * [IEventStoreRead](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreRead.html) * [IEventStoreStreams](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreStreams.html) * [IEventStoreActions](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreActions.html) * [IEventClaims](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventClaims.html) * IEventSet #### Implemented by * [EventSet](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html) ##### Index ### Properties [events](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#events) [insert$](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#insert) [remove$](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#remove) [update$](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#update) ### Methods [add](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#add) [claim](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#claim) [clearClaim](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#clearclaim) [getByFilters](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#getbyfilters) [getEvent](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#getevent) [getReplaceable](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#getreplaceable) [getReplaceableHistory](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#getreplaceablehistory) [getTimeline](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#gettimeline) [hasEvent](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#hasevent) [hasReplaceable](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#hasreplaceable) [isClaimed](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#isclaimed) [remove](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#remove-1) [removeClaim](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#removeclaim) [update](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#update-1) Properties ---------- ### events[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#events) events: [LRU](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html) ### insert$[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#insert) insert$: Observable A stream of new events added to the store ### remove$[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#remove) remove$: Observable A stream of events that have been removed ### update$[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#update) update$: Observable A stream of events that have been updated Methods ------- ### add[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#add) * add(event: Event): null | Event[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#add-1) Add an event to the store #### Parameters * event: Event #### Returns null | Event ### claim[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#claim) * claim(event: Event, claim: any): void[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#claim-1) Sets the claim on the event and touches it #### Parameters * event: Event * claim: any #### Returns void ### clearClaim[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#clearclaim) * clearClaim(event: Event): void[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#clearclaim-1) Removes all claims on an event #### Parameters * event: Event #### Returns void ### getByFilters[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#getbyfilters) * getByFilters(filters: Filter | Filter\[\]): Set[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#getbyfilters-1) Get all events that match the filters #### Parameters * filters: Filter | Filter\[\] #### Returns Set ### getEvent[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#getevent) * getEvent(id: string): undefined | Event[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#getevent-1) Get an event by id #### Parameters * id: string #### Returns undefined | Event ### getReplaceable[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#getreplaceable) * getReplaceable(     kind: number,     pubkey: string,     identifier?: string, ): undefined | Event[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#getreplaceable-1) Get a replaceable event #### Parameters * kind: number * pubkey: string * `Optional`identifier: string #### Returns undefined | Event ### getReplaceableHistory[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#getreplaceablehistory) * getReplaceableHistory(     kind: number,     pubkey: string,     identifier?: string, ): undefined | Event\[\][](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#getreplaceablehistory-1) Get the history of a replaceable event #### Parameters * kind: number * pubkey: string * `Optional`identifier: string #### Returns undefined | Event\[\] ### getTimeline[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#gettimeline) * getTimeline(filters: Filter | Filter\[\]): Event\[\][](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#gettimeline-1) Get a timeline of events that match the filters #### Parameters * filters: Filter | Filter\[\] #### Returns Event\[\] ### hasEvent[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#hasevent) * hasEvent(id: string): boolean[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#hasevent-1) Check if the event store has an event with id #### Parameters * id: string #### Returns boolean ### hasReplaceable[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#hasreplaceable) * hasReplaceable(kind: number, pubkey: string, identifier?: string): boolean[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#hasreplaceable-1) Check if the event store has a replaceable event #### Parameters * kind: number * pubkey: string * `Optional`identifier: string #### Returns boolean ### isClaimed[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#isclaimed) * isClaimed(event: Event): boolean[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#isclaimed-1) Checks if an event is claimed by anything #### Parameters * event: Event #### Returns boolean ### remove[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#remove-1) * remove(event: string | Event): boolean[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#remove-2) Remove an event from the store #### Parameters * event: string | Event #### Returns boolean ### removeClaim[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#removeclaim) * removeClaim(event: Event, claim: any): void[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#removeclaim-1) Removes a claim from an event #### Parameters * event: Event * claim: any #### Returns void ### update[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#update-1) * update(event: Event): void[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#update-2) Notify the store that an event has updated #### Parameters * event: Event #### Returns void ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [events](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#events) [insert$](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#insert) [remove$](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#remove) [update$](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#update) Methods [add](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#add) [claim](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#claim) [clearClaim](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#clearclaim) [getByFilters](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#getbyfilters) [getEvent](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#getevent) [getReplaceable](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#getreplaceable) [getReplaceableHistory](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#getreplaceablehistory) [getTimeline](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#gettimeline) [hasEvent](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#hasevent) [hasReplaceable](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#hasreplaceable) [isClaimed](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#isclaimed) [remove](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#remove-1) [removeClaim](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#removeclaim) [update](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html#update-1) --- # EventStore | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [EventStore](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html) Class EventStore ================ An extended [EventSet](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html) that handles replaceable events, delets, and models #### Implements * [IEventStore](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html) ##### Index ### Constructors [constructor](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#constructor) ### Properties [addressableLoader?](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#addressableloader) [database](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#database) [deletedCoords](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#deletedcoords) [deletedIds](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#deletedids) [eventLoader?](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#eventloader) [expirations](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#expirations) [expirationTimeout](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#expirationtimeout) [insert$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#insert) [keepExpired](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#keepexpired) [keepOldVersions](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#keepoldversions) [modelKeepWarm](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#modelkeepwarm) [models](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#models) [nextExpirationCheck](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#nextexpirationcheck) [remove$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#remove) [replaceableLoader?](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#replaceableloader) [update$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#update) [verifyEvent?](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#verifyevent) ### Methods [add](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#add) [addExpiration](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#addexpiration) [addressable](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#addressable) [blossomServers](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#blossomservers) [checkDeleted](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#checkdeleted) [claim](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#claim) [clearClaim](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#clearclaim) [comments](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#comments) [contacts](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#contacts) [event](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#event) [events](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#events) [filters](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#filters) [getByFilters](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#getbyfilters) [getEvent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#getevent) [getReplaceable](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#getreplaceable) [getReplaceableHistory](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#getreplaceablehistory) [getTimeline](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#gettimeline) [handleDeleteEvent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#handledeleteevent) [handleExpiringEvent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#handleexpiringevent) [hasEvent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#hasevent) [hasReplaceable](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#hasreplaceable) [isClaimed](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#isclaimed) [mailboxes](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#mailboxes) [model](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#model) [mutes](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#mutes) [profile](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#profile) [prune](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#prune) [pruneExpired](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#pruneexpired) [reactions](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#reactions) [remove](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#remove-1) [removeClaim](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#removeclaim) [removed](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#removed) [replaceable](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#replaceable) [replaceableSet](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#replaceableset) [thread](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#thread) [timeline](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#timeline) [update](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#update-1) [updated](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#updated) [mergeDuplicateEvent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#mergeduplicateevent) Constructors ------------ ### constructor[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#constructor) * new EventStore(): [EventStore](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html) [](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#constructoreventstore) #### Returns [EventStore](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html) Properties ---------- ### `Optional` `Experimental`addressableLoader[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#addressableloader) addressableLoader?: (     pointer: AddressPointer, ) \=> Observable | Promise A method that will be called when an addressable event isn't found in the store ### database[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#database) database: [EventSet](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventSet.html) ### `Protected`deletedCoords[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#deletedcoords) deletedCoords: Map = ... ### `Protected`deletedIds[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#deletedids) deletedIds: Set = ... ### `Optional` `Experimental`eventLoader[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#eventloader) eventLoader?: (     pointer: EventPointer, ) \=> Observable | Promise A method that will be called when an event isn't found in the store ### `Protected`expirations[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#expirations) expirations: Map = ... ### `Protected`expirationTimeout[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#expirationtimeout) expirationTimeout: null | number = null ### insert$[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#insert) insert$: Observable A stream of new events added to the store ### keepExpired[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#keepexpired) keepExpired: boolean = false Enable this to keep expired events ### keepOldVersions[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#keepoldversions) keepOldVersions: boolean = false Enable this to keep old versions of replaceable events ### modelKeepWarm[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#modelkeepwarm) modelKeepWarm: number = 60\_000 How long a model should be kept "warm" while nothing is subscribed to it ### `Protected`models[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#models) models: Map<[ModelConstructor](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.ModelConstructor.html) , Map\>\> = ... A directory of all active models ### `Protected`nextExpirationCheck[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#nextexpirationcheck) nextExpirationCheck: null | number = null ### remove$[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#remove) remove$: Observable A stream of events that have been removed ### `Optional` `Experimental`replaceableLoader[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#replaceableloader) replaceableLoader?: (     pointer: [AddressPointerWithoutD](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.AddressPointerWithoutD.html) , ) \=> Observable | Promise A method that will be called when a replaceable event isn't found in the store ### update$[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#update) update$: Observable A stream of events that have been updated ### `Optional`verifyEvent[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#verifyevent) verifyEvent?: (event: Event) \=> boolean A method used to verify new events before added them #### Type declaration * * (event: Event): boolean * #### Parameters * event: Event #### Returns boolean true if the event is valid, false if it should be ignored Methods ------- ### add[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#add) * add(event: Event, fromRelay?: string): null | Event[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#add-1) Adds an event to the store and update subscriptions #### Parameters * event: Event * `Optional`fromRelay: string #### Returns null | Event The existing event or the event that was added, if it was ignored returns null ### `Protected`addExpiration[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#addexpiration) * addExpiration(event: Event): void[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#addexpiration-1) Adds an event to the expiration map #### Parameters * event: Event #### Returns void ### addressable[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#addressable) * addressable(pointer: AddressPointer): Observable[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#addressable-1) Subscribe to an addressable event by pointer #### Parameters * pointer: AddressPointer #### Returns Observable ### blossomServers[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#blossomservers) * blossomServers(user: string | ProfilePointer): Observable[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#blossomservers-1) Subscribe to a users blossom servers #### Parameters * user: string | ProfilePointer #### Returns Observable ### `Protected`checkDeleted[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#checkdeleted) * checkDeleted(event: string | Event): boolean[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#checkdeleted-1) #### Parameters * event: string | Event #### Returns boolean ### claim[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#claim) * claim(event: Event, claim: any): void[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#claim-1) Sets the claim on the event and touches it #### Parameters * event: Event * claim: any #### Returns void ### clearClaim[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#clearclaim) * clearClaim(event: Event): void[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#clearclaim-1) Removes all claims on an event #### Parameters * event: Event #### Returns void ### comments[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#comments) * comments(event: Event): Observable[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#comments-1) Subscribe to a event's comments #### Parameters * event: Event #### Returns Observable ### contacts[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#contacts) * contacts(user: string | ProfilePointer): Observable[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#contacts-1) Subscribe to a users contacts #### Parameters * user: string | ProfilePointer #### Returns Observable ### event[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#event) * event(pointer: string | EventPointer): Observable[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#event-1) Creates a [EventModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.EventModel.html) #### Parameters * pointer: string | EventPointer #### Returns Observable ### events[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#events) * events(ids: string\[\]): Observable\>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#events-1) #### Parameters * ids: string\[\] #### Returns Observable\> #### Deprecated[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#deprecated) use multiple [EventModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.EventModel.html) instead ### filters[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#filters) * filters(filters: Filter | Filter\[\], onlyNew?: boolean): Observable[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#filters-1) Creates an observable that streams all events that match the filter #### Parameters * filters: Filter | Filter\[\] * `Optional`onlyNew: boolean = false Only subscribe to new events #### Returns Observable ### getByFilters[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#getbyfilters) * getByFilters(filters: Filter | Filter\[\]): Set[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#getbyfilters-1) Get all events matching a filter #### Parameters * filters: Filter | Filter\[\] #### Returns Set ### getEvent[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#getevent) * getEvent(id: string): undefined | Event[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#getevent-1) Get an event by id from the store #### Parameters * id: string #### Returns undefined | Event ### getReplaceable[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#getreplaceable) * getReplaceable(     kind: number,     pubkey: string,     identifier?: string, ): undefined | Event[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#getreplaceable-1) Gets the latest version of a replaceable event #### Parameters * kind: number * pubkey: string * `Optional`identifier: string #### Returns undefined | Event ### getReplaceableHistory[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#getreplaceablehistory) * getReplaceableHistory(     kind: number,     pubkey: string,     identifier?: string, ): undefined | Event\[\][](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#getreplaceablehistory-1) Returns all versions of a replaceable event #### Parameters * kind: number * pubkey: string * `Optional`identifier: string #### Returns undefined | Event\[\] ### getTimeline[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#gettimeline) * getTimeline(filters: Filter | Filter\[\]): Event\[\][](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#gettimeline-1) Returns a timeline of events that match filters #### Parameters * filters: Filter | Filter\[\] #### Returns Event\[\] ### `Protected`handleDeleteEvent[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#handledeleteevent) * handleDeleteEvent(deleteEvent: Event): void[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#handledeleteevent-1) #### Parameters * deleteEvent: Event #### Returns void ### `Protected`handleExpiringEvent[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#handleexpiringevent) * handleExpiringEvent(event: Event): void[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#handleexpiringevent-1) #### Parameters * event: Event #### Returns void ### hasEvent[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#hasevent) * hasEvent(id: string): boolean[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#hasevent-1) Check if the store has an event by id #### Parameters * id: string #### Returns boolean ### hasReplaceable[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#hasreplaceable) * hasReplaceable(kind: number, pubkey: string, d?: string): boolean[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#hasreplaceable-1) Check if the store has a replaceable event #### Parameters * kind: number * pubkey: string * `Optional`d: string #### Returns boolean ### isClaimed[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#isclaimed) * isClaimed(event: Event): boolean[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#isclaimed-1) Checks if an event is claimed by anything #### Parameters * event: Event #### Returns boolean ### mailboxes[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#mailboxes) * mailboxes(     user: string | ProfilePointer, ): Observable[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#mailboxes-1) Subscribe to a users NIP-65 mailboxes #### Parameters * user: string | ProfilePointer #### Returns Observable ### model[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#model) * model<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#modelt) extends unknown, [Args](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#modelargs) extends any\[\]\>(     constructor: [ModelConstructor](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.ModelConstructor.html) <[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#modelt) , [Args](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#modelargs) \>,     ...args: [Args](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#modelargs) , ): Observable<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#modelt) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#model-1) Get or create a model on the event store #### Type Parameters * T extends unknown * Args extends any\[\] #### Parameters * constructor: [ModelConstructor](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.ModelConstructor.html) <[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#modelt) , [Args](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#modelargs) \> * ...args: [Args](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#modelargs) #### Returns Observable<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#modelt) \> ### mutes[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#mutes) * mutes(user: string | ProfilePointer): Observable[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#mutes-1) Subscribe to a users mutes #### Parameters * user: string | ProfilePointer #### Returns Observable ### profile[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#profile) * profile(user: string | ProfilePointer): Observable[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#profile-1) Subscribe to a users profile #### Parameters * user: string | ProfilePointer #### Returns Observable ### prune[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#prune) * prune(max?: number): number[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#prune-1) Removes any event that is not being used by a subscription #### Parameters * `Optional`max: number #### Returns number ### `Protected`pruneExpired[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#pruneexpired) * pruneExpired(): void[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#pruneexpired-1) Remove expired events from the store #### Returns void ### reactions[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#reactions) * reactions(event: Event): Observable[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#reactions-1) Subscribe to an event's reactions #### Parameters * event: Event #### Returns Observable ### remove[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#remove-1) * remove(event: string | Event): boolean[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#remove-2) Removes an event from the database and updates subscriptions #### Parameters * event: string | Event #### Returns boolean ### removeClaim[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#removeclaim) * removeClaim(event: Event, claim: any): void[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#removeclaim-1) Removes a claim from an event #### Parameters * event: Event * claim: any #### Returns void ### removed[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#removed) * removed(id: string): Observable[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#removed-1) Returns an observable that completes when an event is removed #### Parameters * id: string #### Returns Observable ### replaceable[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#replaceable) * replaceable(     pointer: AddressPointer | [AddressPointerWithoutD](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.AddressPointerWithoutD.html) , ): Observable[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#replaceable-1) Creates a [ReplaceableModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.ReplaceableModel.html) #### Parameters * pointer: AddressPointer | [AddressPointerWithoutD](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.AddressPointerWithoutD.html) #### Returns Observable * replaceable(     kind: number,     pubkey: string,     identifier?: string, ): Observable[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#replaceable-2) Creates a [ReplaceableModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.ReplaceableModel.html) #### Parameters * kind: number * pubkey: string * `Optional`identifier: string #### Returns Observable ### replaceableSet[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#replaceableset) * replaceableSet(     pointers: { identifier?: string; kind: number; pubkey: string }\[\], ): Observable\>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#replaceableset-1) #### Parameters * pointers: { identifier?: string; kind: number; pubkey: string }\[\] #### Returns Observable\> #### Deprecated[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#deprecated-1) use multiple [ReplaceableModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.ReplaceableModel.html) instead ### thread[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#thread) * thread(root: string | EventPointer | AddressPointer): Observable<[Thread](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Models.Thread.html) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#thread-1) Subscribe to a thread #### Parameters * root: string | EventPointer | AddressPointer #### Returns Observable<[Thread](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Models.Thread.html) \> ### timeline[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#timeline) * timeline(     filters: Filter | Filter\[\],     includeOldVersion?: boolean, ): Observable[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#timeline-1) Creates a [TimelineModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.TimelineModel.html) #### Parameters * filters: Filter | Filter\[\] * includeOldVersion: boolean = false #### Returns Observable ### update[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#update-1) * update(event: Event): boolean[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#update-2) Add an event to the store and notifies all subscribes it has updated #### Parameters * event: Event #### Returns boolean ### updated[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#updated) * updated(event: string | Event): Observable[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#updated-1) Creates an observable that emits when event is updated #### Parameters * event: string | Event #### Returns Observable ### `Static`mergeDuplicateEvent[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#mergeduplicateevent) * mergeDuplicateEvent(source: Event, dest: Event): void[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#mergeduplicateevent-1) Copies important metadata from and identical event to another #### Parameters * source: Event * dest: Event #### Returns void ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Constructors [constructor](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#constructor) Properties [addressableLoader](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#addressableloader) [database](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#database) [deletedCoords](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#deletedcoords) [deletedIds](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#deletedids) [eventLoader](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#eventloader) [expirations](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#expirations) [expirationTimeout](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#expirationtimeout) [insert$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#insert) [keepExpired](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#keepexpired) [keepOldVersions](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#keepoldversions) [modelKeepWarm](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#modelkeepwarm) [models](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#models) [nextExpirationCheck](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#nextexpirationcheck) [remove$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#remove) [replaceableLoader](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#replaceableloader) [update$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#update) [verifyEvent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#verifyevent) Methods [add](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#add) [addExpiration](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#addexpiration) [addressable](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#addressable) [blossomServers](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#blossomservers) [checkDeleted](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#checkdeleted) [claim](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#claim) [clearClaim](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#clearclaim) [comments](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#comments) [contacts](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#contacts) [event](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#event) [events](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#events) [filters](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#filters) [getByFilters](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#getbyfilters) [getEvent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#getevent) [getReplaceable](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#getreplaceable) [getReplaceableHistory](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#getreplaceablehistory) [getTimeline](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#gettimeline) [handleDeleteEvent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#handledeleteevent) [handleExpiringEvent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#handleexpiringevent) [hasEvent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#hasevent) [hasReplaceable](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#hasreplaceable) [isClaimed](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#isclaimed) [mailboxes](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#mailboxes) [model](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#model) [mutes](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#mutes) [profile](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#profile) [prune](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#prune) [pruneExpired](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#pruneexpired) [reactions](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#reactions) [remove](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#remove-1) [removeClaim](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#removeclaim) [removed](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#removed) [replaceable](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#replaceable) [replaceableSet](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#replaceableset) [thread](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#thread) [timeline](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#timeline) [update](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#update-1) [updated](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#updated) [mergeDuplicateEvent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html#mergeduplicateevent) --- # IEventStoreModels | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [IEventStoreModels](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreModels.html) Interface IEventStoreModels =========================== Methods for creating common models interface IEventStoreModels {     [addressable](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreModels.html#addressable-1) (pointer: AddressPointer): Observable;     [event](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreModels.html#event-1) (id: string): Observable;     [events](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreModels.html#events-1) (ids: string\[\]): Observable\>;     [model](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreModels.html#model-1) <[T](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreModels.html#modelt) extends unknown, [Args](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreModels.html#modelargs) extends any\[\]\>(         constructor: [ModelConstructor](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.ModelConstructor.html) <[T](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreModels.html#modelt) , [Args](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreModels.html#modelargs) \>,         ...args: [Args](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreModels.html#modelargs) ,     ): Observable<[T](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreModels.html#modelt) \>;     [replaceable](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreModels.html#replaceable-1) (pointer: [AddressPointerWithoutD](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.AddressPointerWithoutD.html) ): Observable;     [replaceableSet](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreModels.html#replaceableset-1) (         pointers: (AddressPointer | [AddressPointerWithoutD](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.AddressPointerWithoutD.html) )\[\],     ): Observable\>;     [timeline](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreModels.html#timeline-1) (         filters: Filter | Filter\[\],         includeOldVersion?: boolean,     ): Observable; } #### Hierarchy ([View Summary](https://hzrd149.github.io/applesauce/typedoc/hierarchy.html#applesauce-core.IEventStoreModels) ) * IEventStoreModels * [IEventStore](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html) ##### Index ### Methods [addressable](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreModels.html#addressable) [event](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreModels.html#event) [events](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreModels.html#events) [model](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreModels.html#model) [replaceable](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreModels.html#replaceable) [replaceableSet](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreModels.html#replaceableset) [timeline](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreModels.html#timeline) Methods ------- ### addressable[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreModels.html#addressable) * addressable(pointer: AddressPointer): Observable[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreModels.html#addressable-1) #### Parameters * pointer: AddressPointer #### Returns Observable ### event[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreModels.html#event) * event(id: string): Observable[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreModels.html#event-1) #### Parameters * id: string #### Returns Observable ### events[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreModels.html#events) * events(ids: string\[\]): Observable\>[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreModels.html#events-1) #### Parameters * ids: string\[\] #### Returns Observable\> ### model[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreModels.html#model) * model<[T](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreModels.html#modelt) extends unknown, [Args](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreModels.html#modelargs) extends any\[\]\>(     constructor: [ModelConstructor](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.ModelConstructor.html) <[T](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreModels.html#modelt) , [Args](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreModels.html#modelargs) \>,     ...args: [Args](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreModels.html#modelargs) , ): Observable<[T](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreModels.html#modelt) \>[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreModels.html#model-1) #### Type Parameters * T extends unknown * Args extends any\[\] #### Parameters * constructor: [ModelConstructor](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.ModelConstructor.html) <[T](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreModels.html#modelt) , [Args](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreModels.html#modelargs) \> * ...args: [Args](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreModels.html#modelargs) #### Returns Observable<[T](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreModels.html#modelt) \> ### replaceable[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreModels.html#replaceable) * replaceable(pointer: [AddressPointerWithoutD](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.AddressPointerWithoutD.html) ): Observable[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreModels.html#replaceable-1) #### Parameters * pointer: [AddressPointerWithoutD](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.AddressPointerWithoutD.html) #### Returns Observable ### replaceableSet[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreModels.html#replaceableset) * replaceableSet(     pointers: (AddressPointer | [AddressPointerWithoutD](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.AddressPointerWithoutD.html) )\[\], ): Observable\>[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreModels.html#replaceableset-1) #### Parameters * pointers: (AddressPointer | [AddressPointerWithoutD](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.AddressPointerWithoutD.html) )\[\] #### Returns Observable\> ### timeline[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreModels.html#timeline) * timeline(     filters: Filter | Filter\[\],     includeOldVersion?: boolean, ): Observable[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreModels.html#timeline-1) #### Parameters * filters: Filter | Filter\[\] * `Optional`includeOldVersion: boolean #### Returns Observable ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Methods [addressable](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreModels.html#addressable) [event](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreModels.html#event) [events](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreModels.html#events) [model](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreModels.html#model) [replaceable](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreModels.html#replaceable) [replaceableSet](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreModels.html#replaceableset) [timeline](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreModels.html#timeline) --- # PublishMethod | AppleSauce * [applesauce-dvm](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-dvm.html) * [PublishMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-dvm.PublishMethod.html) Type Alias PublishMethod ======================== PublishMethod: (relays: string\[\], event: NostrEvent) \=> Promise #### Type declaration * * (relays: string\[\], event: NostrEvent): Promise * #### Parameters * relays: string\[\] * event: NostrEvent #### Returns Promise ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # DVMClient | AppleSauce * [applesauce-dvm](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-dvm.html) * [DVMClient](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-dvm.DVMClient.html) Class DVMClient =============== ##### Index ### Constructors [constructor](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-dvm.DVMClient.html#constructor) ### Properties [factory](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-dvm.DVMClient.html#factory) [log](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-dvm.DVMClient.html#log) [publish](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-dvm.DVMClient.html#publish) [relays](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-dvm.DVMClient.html#relays) [subscribe](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-dvm.DVMClient.html#subscribe) ### Methods [request](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-dvm.DVMClient.html#request) [translate](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-dvm.DVMClient.html#translate) Constructors ------------ ### constructor[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-dvm.DVMClient.html#constructor) * new DVMClient(     factory: [EventFactory](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html) ,     relays: string\[\],     publish: [PublishMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-dvm.PublishMethod.html) ,     subscribe: [SubscriptionMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-dvm.SubscriptionMethod.html) , ): [DVMClient](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-dvm.DVMClient.html) [](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-dvm.DVMClient.html#constructordvmclient) #### Parameters * factory: [EventFactory](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html) * relays: string\[\] * publish: [PublishMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-dvm.PublishMethod.html) * subscribe: [SubscriptionMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-dvm.SubscriptionMethod.html) #### Returns [DVMClient](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-dvm.DVMClient.html) Properties ---------- ### factory[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-dvm.DVMClient.html#factory) factory: [EventFactory](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html) ### `Protected`log[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-dvm.DVMClient.html#log) log: Debugger = ... ### publish[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-dvm.DVMClient.html#publish) publish: [PublishMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-dvm.PublishMethod.html) ### relays[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-dvm.DVMClient.html#relays) relays: string\[\] ### subscribe[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-dvm.DVMClient.html#subscribe) subscribe: [SubscriptionMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-dvm.SubscriptionMethod.html) Methods ------- ### request[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-dvm.DVMClient.html#request) * request(     kind: number,     options?: {         dvms?: string\[\];         inputs?: [RequestInput](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-dvm.Helpers.RequestInput.html) \[\];         params?: Record;         relays?: string\[\];     }, ): Observable[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-dvm.DVMClient.html#request-1) Makes a request to the DVM and returns an observable for the responses #### Parameters * kind: number The kind of request to send * `Optional`options: {     dvms?: string\[\];     inputs?: [RequestInput](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-dvm.Helpers.RequestInput.html) \[\];     params?: Record;     relays?: string\[\]; } The options for the request * ##### `Optional`dvms?: string\[\] The DVMs to tag for this request * ##### `Optional`inputs?: [RequestInput](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-dvm.Helpers.RequestInput.html) \[\] Inputs for this request * ##### `Optional`params?: Record A directory of parameters for the request * ##### `Optional`relays?: string\[\] The specific relays to use for this request #### Returns Observable An observable for the responses ### translate[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-dvm.DVMClient.html#translate) * translate(text: string | Event, language?: string): Observable[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-dvm.DVMClient.html#translate-1) Make a translation request to a target language #### Parameters * text: string | Event * language: string = "en" #### Returns Observable ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Constructors [constructor](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-dvm.DVMClient.html#constructor) Properties [factory](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-dvm.DVMClient.html#factory) [log](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-dvm.DVMClient.html#log) [publish](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-dvm.DVMClient.html#publish) [relays](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-dvm.DVMClient.html#relays) [subscribe](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-dvm.DVMClient.html#subscribe) Methods [request](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-dvm.DVMClient.html#request) [translate](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-dvm.DVMClient.html#translate) --- # IEventStoreRead | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [IEventStoreRead](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreRead.html) Interface IEventStoreRead ========================= The read interface for an event store interface IEventStoreRead {     [getByFilters](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreRead.html#getbyfilters-1) (filters: Filter | Filter\[\]): Set;     [getEvent](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreRead.html#getevent-1) (id: string): undefined | Event;     [getReplaceable](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreRead.html#getreplaceable-1) (         kind: number,         pubkey: string,         identifier?: string,     ): undefined | Event;     [getReplaceableHistory](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreRead.html#getreplaceablehistory-1) (         kind: number,         pubkey: string,         identifier?: string,     ): undefined | Event\[\];     [getTimeline](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreRead.html#gettimeline-1) (filters: Filter | Filter\[\]): Event\[\];     [hasEvent](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreRead.html#hasevent-1) (id: string): boolean;     [hasReplaceable](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreRead.html#hasreplaceable-1) (kind: number, pubkey: string, identifier?: string): boolean; } #### Hierarchy ([View Summary](https://hzrd149.github.io/applesauce/typedoc/hierarchy.html#applesauce-core.IEventStoreRead) ) * IEventStoreRead * [IEventSet](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html) * [IEventStore](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html) ##### Index ### Methods [getByFilters](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreRead.html#getbyfilters) [getEvent](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreRead.html#getevent) [getReplaceable](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreRead.html#getreplaceable) [getReplaceableHistory](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreRead.html#getreplaceablehistory) [getTimeline](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreRead.html#gettimeline) [hasEvent](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreRead.html#hasevent) [hasReplaceable](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreRead.html#hasreplaceable) Methods ------- ### getByFilters[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreRead.html#getbyfilters) * getByFilters(filters: Filter | Filter\[\]): Set[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreRead.html#getbyfilters-1) Get all events that match the filters #### Parameters * filters: Filter | Filter\[\] #### Returns Set ### getEvent[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreRead.html#getevent) * getEvent(id: string): undefined | Event[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreRead.html#getevent-1) Get an event by id #### Parameters * id: string #### Returns undefined | Event ### getReplaceable[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreRead.html#getreplaceable) * getReplaceable(     kind: number,     pubkey: string,     identifier?: string, ): undefined | Event[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreRead.html#getreplaceable-1) Get a replaceable event #### Parameters * kind: number * pubkey: string * `Optional`identifier: string #### Returns undefined | Event ### getReplaceableHistory[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreRead.html#getreplaceablehistory) * getReplaceableHistory(     kind: number,     pubkey: string,     identifier?: string, ): undefined | Event\[\][](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreRead.html#getreplaceablehistory-1) Get the history of a replaceable event #### Parameters * kind: number * pubkey: string * `Optional`identifier: string #### Returns undefined | Event\[\] ### getTimeline[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreRead.html#gettimeline) * getTimeline(filters: Filter | Filter\[\]): Event\[\][](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreRead.html#gettimeline-1) Get a timeline of events that match the filters #### Parameters * filters: Filter | Filter\[\] #### Returns Event\[\] ### hasEvent[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreRead.html#hasevent) * hasEvent(id: string): boolean[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreRead.html#hasevent-1) Check if the event store has an event with id #### Parameters * id: string #### Returns boolean ### hasReplaceable[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreRead.html#hasreplaceable) * hasReplaceable(kind: number, pubkey: string, identifier?: string): boolean[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreRead.html#hasreplaceable-1) Check if the event store has a replaceable event #### Parameters * kind: number * pubkey: string * `Optional`identifier: string #### Returns boolean ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Methods [getByFilters](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreRead.html#getbyfilters) [getEvent](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreRead.html#getevent) [getReplaceable](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreRead.html#getreplaceable) [getReplaceableHistory](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreRead.html#getreplaceablehistory) [getTimeline](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreRead.html#gettimeline) [hasEvent](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreRead.html#hasevent) [hasReplaceable](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreRead.html#hasreplaceable) --- # IEventStore | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [IEventStore](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html) Interface IEventStore ===================== The read interface for an event store interface IEventStore {     [addressableLoader](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#addressableloader) ?: (         pointer: AddressPointer,     ) \=> Observable | Promise;     [eventLoader](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#eventloader) ?: (         pointer: EventPointer,     ) \=> Observable | Promise;     [insert$](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#insert) : Observable;     [keepExpired](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#keepexpired) : boolean;     [keepOldVersions](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#keepoldversions) : boolean;     [remove$](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#remove) : Observable;     [replaceableLoader](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#replaceableloader) ?: (         pointer: [AddressPointerWithoutD](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.AddressPointerWithoutD.html) ,     ) \=> Observable | Promise;     [update$](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#update) : Observable;     [add](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#add-1) (event: Event): null | Event;     [addressable](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#addressable-1) (pointer: AddressPointer): Observable;     [blossomServers](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#blossomservers-1) (user: string | ProfilePointer): Observable;     [claim](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#claim-1) (event: Event, claim: any): void;     [clearClaim](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#clearclaim-1) (event: Event): void;     [contacts](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#contacts-1) (user: string | ProfilePointer): Observable;     [event](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#event-1) (id: string): Observable;     [events](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#events-1) (ids: string\[\]): Observable\>;     [filters](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#filters-1) (filters: Filter | Filter\[\]): Observable;     [getByFilters](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#getbyfilters-1) (filters: Filter | Filter\[\]): Set;     [getEvent](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#getevent-1) (id: string): undefined | Event;     [getReplaceable](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#getreplaceable-1) (         kind: number,         pubkey: string,         identifier?: string,     ): undefined | Event;     [getReplaceableHistory](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#getreplaceablehistory-1) (         kind: number,         pubkey: string,         identifier?: string,     ): undefined | Event\[\];     [getTimeline](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#gettimeline-1) (filters: Filter | Filter\[\]): Event\[\];     [hasEvent](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#hasevent-1) (id: string): boolean;     [hasReplaceable](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#hasreplaceable-1) (kind: number, pubkey: string, identifier?: string): boolean;     [isClaimed](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#isclaimed-1) (event: Event): boolean;     [mailboxes](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#mailboxes-1) (         user: string | ProfilePointer,     ): Observable;     [model](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#model-1) <[T](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#modelt) extends unknown, [Args](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#modelargs) extends any\[\]\>(         constructor: [ModelConstructor](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.ModelConstructor.html) <[T](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreModels.html#modelt) , [Args](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreModels.html#modelargs) \>,         ...args: [Args](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreModels.html#modelargs) ,     ): Observable<[T](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreModels.html#modelt) \>;     [mutes](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#mutes-1) (user: string | ProfilePointer): Observable;     [profile](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#profile-1) (         user: string | ProfilePointer,     ): Observable;     [reactions](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#reactions-1) (event: Event): Observable;     [remove](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#remove-2) (event: string | Event): boolean;     [removeClaim](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#removeclaim-1) (event: Event, claim: any): void;     [removed](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#removed-1) (id: string): Observable;     [replaceable](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#replaceable-1) (         kind: number,         pubkey: string,         identifier?: string,     ): Observable;     [replaceable](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#replaceable-2) (pointer: [AddressPointerWithoutD](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.AddressPointerWithoutD.html) ): Observable;     [replaceableSet](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#replaceableset-1) (         pointers: (AddressPointer | [AddressPointerWithoutD](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.AddressPointerWithoutD.html) )\[\],     ): Observable\>;     [thread](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#thread-1) (root: string | EventPointer | AddressPointer): Observable<[Thread](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Models.Thread.html) \>;     [timeline](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#timeline-1) (         filters: Filter | Filter\[\],         includeOldVersion?: boolean,     ): Observable;     [update](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#update-2) (event: Event): void;     [updated](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#updated-1) (id: string | Event): Observable; } #### Hierarchy ([View Summary](https://hzrd149.github.io/applesauce/typedoc/hierarchy.html#applesauce-core.IEventStore) ) * [IEventStoreRead](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreRead.html) * [IEventStoreStreams](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreStreams.html) * [IEventStoreActions](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreActions.html) * [IEventStoreModels](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreModels.html) * [IEventClaims](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventClaims.html) * IEventStore #### Implemented by * [EventStore](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.EventStore.html) ##### Index ### Properties [addressableLoader?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#addressableloader) [eventLoader?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#eventloader) [insert$](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#insert) [keepExpired](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#keepexpired) [keepOldVersions](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#keepoldversions) [remove$](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#remove) [replaceableLoader?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#replaceableloader) [update$](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#update) ### Methods [add](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#add) [addressable](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#addressable) [blossomServers](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#blossomservers) [claim](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#claim) [clearClaim](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#clearclaim) [contacts](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#contacts) [event](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#event) [events](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#events) [filters](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#filters) [getByFilters](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#getbyfilters) [getEvent](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#getevent) [getReplaceable](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#getreplaceable) [getReplaceableHistory](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#getreplaceablehistory) [getTimeline](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#gettimeline) [hasEvent](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#hasevent) [hasReplaceable](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#hasreplaceable) [isClaimed](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#isclaimed) [mailboxes](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#mailboxes) [model](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#model) [mutes](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#mutes) [profile](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#profile) [reactions](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#reactions) [remove](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#remove-1) [removeClaim](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#removeclaim) [removed](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#removed) [replaceable](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#replaceable) [replaceableSet](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#replaceableset) [thread](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#thread) [timeline](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#timeline) [update](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#update-1) [updated](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#updated) Properties ---------- ### `Optional`addressableLoader[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#addressableloader) addressableLoader?: (     pointer: AddressPointer, ) \=> Observable | Promise ### `Optional`eventLoader[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#eventloader) eventLoader?: (     pointer: EventPointer, ) \=> Observable | Promise ### insert$[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#insert) insert$: Observable A stream of new events added to the store ### keepExpired[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#keepexpired) keepExpired: boolean Enable this to keep expired events ### keepOldVersions[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#keepoldversions) keepOldVersions: boolean Enable this to keep old versions of replaceable events ### remove$[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#remove) remove$: Observable A stream of events that have been removed ### `Optional`replaceableLoader[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#replaceableloader) replaceableLoader?: (     pointer: [AddressPointerWithoutD](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.AddressPointerWithoutD.html) , ) \=> Observable | Promise ### update$[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#update) update$: Observable A stream of events that have been updated Methods ------- ### add[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#add) * add(event: Event): null | Event[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#add-1) Add an event to the store #### Parameters * event: Event #### Returns null | Event ### addressable[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#addressable) * addressable(pointer: AddressPointer): Observable[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#addressable-1) #### Parameters * pointer: AddressPointer #### Returns Observable ### blossomServers[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#blossomservers) * blossomServers(user: string | ProfilePointer): Observable[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#blossomservers-1) #### Parameters * user: string | ProfilePointer #### Returns Observable ### claim[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#claim) * claim(event: Event, claim: any): void[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#claim-1) Sets the claim on the event and touches it #### Parameters * event: Event * claim: any #### Returns void ### clearClaim[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#clearclaim) * clearClaim(event: Event): void[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#clearclaim-1) Removes all claims on an event #### Parameters * event: Event #### Returns void ### contacts[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#contacts) * contacts(user: string | ProfilePointer): Observable[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#contacts-1) #### Parameters * user: string | ProfilePointer #### Returns Observable ### event[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#event) * event(id: string): Observable[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#event-1) #### Parameters * id: string #### Returns Observable ### events[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#events) * events(ids: string\[\]): Observable\>[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#events-1) #### Parameters * ids: string\[\] #### Returns Observable\> ### filters[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#filters) * filters(filters: Filter | Filter\[\]): Observable[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#filters-1) #### Parameters * filters: Filter | Filter\[\] #### Returns Observable ### getByFilters[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#getbyfilters) * getByFilters(filters: Filter | Filter\[\]): Set[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#getbyfilters-1) Get all events that match the filters #### Parameters * filters: Filter | Filter\[\] #### Returns Set ### getEvent[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#getevent) * getEvent(id: string): undefined | Event[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#getevent-1) Get an event by id #### Parameters * id: string #### Returns undefined | Event ### getReplaceable[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#getreplaceable) * getReplaceable(     kind: number,     pubkey: string,     identifier?: string, ): undefined | Event[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#getreplaceable-1) Get a replaceable event #### Parameters * kind: number * pubkey: string * `Optional`identifier: string #### Returns undefined | Event ### getReplaceableHistory[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#getreplaceablehistory) * getReplaceableHistory(     kind: number,     pubkey: string,     identifier?: string, ): undefined | Event\[\][](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#getreplaceablehistory-1) Get the history of a replaceable event #### Parameters * kind: number * pubkey: string * `Optional`identifier: string #### Returns undefined | Event\[\] ### getTimeline[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#gettimeline) * getTimeline(filters: Filter | Filter\[\]): Event\[\][](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#gettimeline-1) Get a timeline of events that match the filters #### Parameters * filters: Filter | Filter\[\] #### Returns Event\[\] ### hasEvent[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#hasevent) * hasEvent(id: string): boolean[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#hasevent-1) Check if the event store has an event with id #### Parameters * id: string #### Returns boolean ### hasReplaceable[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#hasreplaceable) * hasReplaceable(kind: number, pubkey: string, identifier?: string): boolean[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#hasreplaceable-1) Check if the event store has a replaceable event #### Parameters * kind: number * pubkey: string * `Optional`identifier: string #### Returns boolean ### isClaimed[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#isclaimed) * isClaimed(event: Event): boolean[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#isclaimed-1) Checks if an event is claimed by anything #### Parameters * event: Event #### Returns boolean ### mailboxes[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#mailboxes) * mailboxes(     user: string | ProfilePointer, ): Observable[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#mailboxes-1) #### Parameters * user: string | ProfilePointer #### Returns Observable ### model[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#model) * model<[T](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#modelt) extends unknown, [Args](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#modelargs) extends any\[\]\>(     constructor: [ModelConstructor](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.ModelConstructor.html) <[T](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreModels.html#modelt) , [Args](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreModels.html#modelargs) \>,     ...args: [Args](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreModels.html#modelargs) , ): Observable<[T](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreModels.html#modelt) \>[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#model-1) #### Type Parameters * T extends unknown * Args extends any\[\] #### Parameters * constructor: [ModelConstructor](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.ModelConstructor.html) <[T](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreModels.html#modelt) , [Args](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreModels.html#modelargs) \> * ...args: [Args](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreModels.html#modelargs) #### Returns Observable<[T](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreModels.html#modelt) \> ### mutes[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#mutes) * mutes(user: string | ProfilePointer): Observable[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#mutes-1) #### Parameters * user: string | ProfilePointer #### Returns Observable ### profile[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#profile) * profile(user: string | ProfilePointer): Observable[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#profile-1) #### Parameters * user: string | ProfilePointer #### Returns Observable ### reactions[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#reactions) * reactions(event: Event): Observable[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#reactions-1) #### Parameters * event: Event #### Returns Observable ### remove[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#remove-1) * remove(event: string | Event): boolean[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#remove-2) Remove an event from the store #### Parameters * event: string | Event #### Returns boolean ### removeClaim[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#removeclaim) * removeClaim(event: Event, claim: any): void[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#removeclaim-1) Removes a claim from an event #### Parameters * event: Event * claim: any #### Returns void ### removed[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#removed) * removed(id: string): Observable[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#removed-1) #### Parameters * id: string #### Returns Observable ### replaceable[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#replaceable) * replaceable(     kind: number,     pubkey: string,     identifier?: string, ): Observable[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#replaceable-1) #### Parameters * kind: number * pubkey: string * `Optional`identifier: string #### Returns Observable * replaceable(pointer: [AddressPointerWithoutD](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.AddressPointerWithoutD.html) ): Observable[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#replaceable-2) #### Parameters * pointer: [AddressPointerWithoutD](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.AddressPointerWithoutD.html) #### Returns Observable ### replaceableSet[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#replaceableset) * replaceableSet(     pointers: (AddressPointer | [AddressPointerWithoutD](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.AddressPointerWithoutD.html) )\[\], ): Observable\>[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#replaceableset-1) #### Parameters * pointers: (AddressPointer | [AddressPointerWithoutD](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.AddressPointerWithoutD.html) )\[\] #### Returns Observable\> ### thread[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#thread) * thread(root: string | EventPointer | AddressPointer): Observable<[Thread](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Models.Thread.html) \>[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#thread-1) #### Parameters * root: string | EventPointer | AddressPointer #### Returns Observable<[Thread](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Models.Thread.html) \> ### timeline[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#timeline) * timeline(     filters: Filter | Filter\[\],     includeOldVersion?: boolean, ): Observable[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#timeline-1) #### Parameters * filters: Filter | Filter\[\] * `Optional`includeOldVersion: boolean #### Returns Observable ### update[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#update-1) * update(event: Event): void[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#update-2) Notify the store that an event has updated #### Parameters * event: Event #### Returns void ### updated[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#updated) * updated(id: string | Event): Observable[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#updated-1) #### Parameters * id: string | Event #### Returns Observable ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [addressableLoader](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#addressableloader) [eventLoader](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#eventloader) [insert$](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#insert) [keepExpired](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#keepexpired) [keepOldVersions](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#keepoldversions) [remove$](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#remove) [replaceableLoader](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#replaceableloader) [update$](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#update) Methods [add](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#add) [addressable](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#addressable) [blossomServers](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#blossomservers) [claim](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#claim) [clearClaim](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#clearclaim) [contacts](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#contacts) [event](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#event) [events](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#events) [filters](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#filters) [getByFilters](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#getbyfilters) [getEvent](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#getevent) [getReplaceable](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#getreplaceable) [getReplaceableHistory](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#getreplaceablehistory) [getTimeline](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#gettimeline) [hasEvent](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#hasevent) [hasReplaceable](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#hasreplaceable) [isClaimed](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#isclaimed) [mailboxes](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#mailboxes) [model](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#model) [mutes](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#mutes) [profile](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#profile) [reactions](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#reactions) [remove](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#remove-1) [removeClaim](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#removeclaim) [removed](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#removed) [replaceable](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#replaceable) [replaceableSet](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#replaceableset) [thread](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#thread) [timeline](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#timeline) [update](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#update-1) [updated](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html#updated) --- # ClientPointerContext | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [ClientPointerContext](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.ClientPointerContext.html) Interface ClientPointerContext ============================== A context with an optional NIP-89 app pointer interface ClientPointerContext {     [client](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.ClientPointerContext.html#client) ?: [EventFactoryClient](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EventFactoryClient.html) ; } #### Hierarchy ([View Summary](https://hzrd149.github.io/applesauce/typedoc/hierarchy.html#applesauce-factory.ClientPointerContext) ) * ClientPointerContext * [EventFactoryContext](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EventFactoryContext.html) ##### Index ### Properties [client?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.ClientPointerContext.html#client) Properties ---------- ### `Optional`client[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.ClientPointerContext.html#client) client?: [EventFactoryClient](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EventFactoryClient.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [client](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.ClientPointerContext.html#client) --- # EventFactory | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [EventFactory](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html) Class EventFactory ================== ##### Index ### Constructors [constructor](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html#constructor) ### Properties [context](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html#context) ### Methods [build](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html#build) [comment](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html#comment) [create](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html#create) [delete](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html#delete) [modify](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html#modify) [modifyTags](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html#modifytags) [note](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html#note) [noteReply](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html#notereply) [reaction](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html#reaction) [share](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html#share) [sign](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html#sign) [stamp](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html#stamp) Constructors ------------ ### constructor[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html#constructor) * new EventFactory(context?: [EventFactoryContext](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EventFactoryContext.html) ): [EventFactory](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html) [](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html#constructoreventfactory) #### Parameters * context: [EventFactoryContext](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EventFactoryContext.html) = {} #### Returns [EventFactory](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html) Properties ---------- ### context[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html#context) context: [EventFactoryContext](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EventFactoryContext.html) = {} Methods ------- ### build[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html#build) * build(     template: [EventFactoryTemplate](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventFactoryTemplate.html) ,     ...operations: (undefined | [EventOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventOperation.html) )\[\], ): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html#build-1) Build an event template with operations #### Parameters * template: [EventFactoryTemplate](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventFactoryTemplate.html) * ...operations: (undefined | [EventOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventOperation.html) )\[\] #### Returns Promise ### comment[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html#comment) * comment(     ...args: \[ \         parent: Event, \         content: string, \         options?: [CommentBlueprintOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Blueprints.CommentBlueprintOptions.html)\ , \     \], ): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html#comment-1) Create a NIP-22 comment #### Parameters * ...args: \[parent: Event, content: string, options?: [CommentBlueprintOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Blueprints.CommentBlueprintOptions.html)\ \] #### Returns Promise ### create[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html#create) * create<[Args](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html#createargs) extends any\[\], [T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html#createt) extends Event | EventTemplate | UnsignedEvent\>(     blueprintConstructor: (...args: [Args](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html#createargs) ) \=> [EventBlueprint](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventBlueprint.html) <[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html#createt) \>,     ...args: [Args](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html#createargs) , ): Promise<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html#createt) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html#create-1) Create an event from a blueprint #### Type Parameters * Args extends any\[\] * T extends Event | EventTemplate | UnsignedEvent #### Parameters * blueprintConstructor: (...args: [Args](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html#createargs) ) \=> [EventBlueprint](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventBlueprint.html) <[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html#createt) \> * ...args: [Args](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html#createargs) #### Returns Promise<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html#createt) \> ### delete[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html#delete) * delete(...args: \[events: Event\[\], reason?: string\]): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html#delete-1) Creates a delete event #### Parameters * ...args: \[events: Event\[\], reason?: string\] #### Returns Promise ### modify[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html#modify) * modify(     draft: Event | EventTemplate | UnsignedEvent,     ...operations: (undefined | [EventOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventOperation.html) )\[\], ): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html#modify-1) Modify an existing event with operations and updated the created\_at #### Parameters * draft: Event | EventTemplate | UnsignedEvent * ...operations: (undefined | [EventOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventOperation.html) )\[\] #### Returns Promise ### modifyTags[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html#modifytags) * modifyTags(     event: Event | EventTemplate | UnsignedEvent,     tagOperations?: [ModifyTagsOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Operations.ModifyTagsOptions.html) ,     eventOperations?: [EventOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventOperation.html) | (undefined | [EventOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventOperation.html) )\[\], ): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html#modifytags-1) Modify a lists public and hidden tags and updated the created\_at #### Parameters * event: Event | EventTemplate | UnsignedEvent * `Optional`tagOperations: [ModifyTagsOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Operations.ModifyTagsOptions.html) * `Optional`eventOperations: [EventOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventOperation.html) | (undefined | [EventOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventOperation.html) )\[\] #### Returns Promise ### note[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html#note) * note(     ...args: \[content: string, options?: [NoteBlueprintOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Blueprints.NoteBlueprintOptions.html)\ \], ): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html#note-1) Creates a short text note #### Parameters * ...args: \[content: string, options?: [NoteBlueprintOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Blueprints.NoteBlueprintOptions.html)\ \] #### Returns Promise ### noteReply[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html#notereply) * noteReply(     ...args: \[parent: Event, content: string, options?: [TextContentOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Operations.Content.TextContentOptions.html)\ \], ): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html#notereply-1) Creates a short text note reply #### Parameters * ...args: \[parent: Event, content: string, options?: [TextContentOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Operations.Content.TextContentOptions.html)\ \] #### Returns Promise ### reaction[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html#reaction) * reaction(     ...args: \[event: Event, emoji: string | [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html)\ .[Emoji](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.Emoji.html)\ \], ): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html#reaction-1) Creates a reaction event #### Parameters * ...args: \[event: Event, emoji: string | [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html)\ .[Emoji](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.Emoji.html)\ \] #### Returns Promise * share(     ...args: \[event: Event, options?: [ShareBlueprintOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Blueprints.ShareBlueprintOptions.html)\ \], ): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html#share-1) Creates a share event #### Parameters * ...args: \[event: Event, options?: [ShareBlueprintOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Blueprints.ShareBlueprintOptions.html)\ \] #### Returns Promise ### sign[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html#sign) * sign(draft: EventTemplate | UnsignedEvent): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html#sign-1) Signs a event template with the signer #### Parameters * draft: EventTemplate | UnsignedEvent #### Returns Promise ### stamp[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html#stamp) * stamp(draft: EventTemplate | UnsignedEvent): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html#stamp-1) Attaches the signers pubkey to an event template #### Parameters * draft: EventTemplate | UnsignedEvent #### Returns Promise ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Constructors [constructor](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html#constructor) Properties [context](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html#context) Methods [build](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html#build) [comment](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html#comment) [create](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html#create) [delete](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html#delete) [modify](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html#modify) [modifyTags](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html#modifytags) [note](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html#note) [noteReply](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html#notereply) [reaction](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html#reaction) [share](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html#share) [sign](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html#sign) [stamp](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-factory.EventFactory.html#stamp) --- # Getting Started | applesauce [Skip to content](https://hzrd149.github.io/applesauce/introduction/getting-started#VPContent) Return to top Getting Started [​](https://hzrd149.github.io/applesauce/introduction/getting-started#getting-started) ======================================================================================================= Ready to build reactive Nostr applications with applesauce? Follow our step-by-step tutorial that will teach you everything you need to know. 📚 [Complete Tutorial](https://hzrd149.github.io/applesauce/tutorial/00-introduction.html) [​](https://hzrd149.github.io/applesauce/introduction/getting-started#%F0%9F%93%9A-complete-tutorial) -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Our beginner-friendly tutorial covers: 1. **[Event Store](https://hzrd149.github.io/applesauce/tutorial/01-event-store.html) ** - The reactive database at the heart of applesauce 2. **[Helpers](https://hzrd149.github.io/applesauce/tutorial/02-helpers.html) ** - Extract and parse data from Nostr events 3. **[Models](https://hzrd149.github.io/applesauce/tutorial/03-models.html) ** - Build reactive UI components 4. **[Relay Pool](https://hzrd149.github.io/applesauce/tutorial/04-relays.html) ** - Connect to Nostr relays and receive events 5. **[Loaders](https://hzrd149.github.io/applesauce/tutorial/05-loaders.html) ** - Load specific events on-demand 6. **[Event Factory](https://hzrd149.github.io/applesauce/tutorial/06-event-factory.html) ** - Create and sign events 7. **[Publishing](https://hzrd149.github.io/applesauce/tutorial/07-publishing.html) ** - Publish events to relays 8. **[Actions](https://hzrd149.github.io/applesauce/tutorial/08-actions.html) ** - Run complex actions like following users Each section includes complete code examples and builds toward a working social media application. Quick Overview [​](https://hzrd149.github.io/applesauce/introduction/getting-started#quick-overview) ----------------------------------------------------------------------------------------------------- Applesauce consists of several key components that work together: ### EventStore [​](https://hzrd149.github.io/applesauce/introduction/getting-started#eventstore) A reactive in-memory database that stores Nostr events and notifies your UI when data changes. ts import { EventStore } from "applesauce-core"; const eventStore = new EventStore(); // Subscribe to timeline updates eventStore.timeline({ kinds: [1] }).subscribe((notes) => { console.log(`Timeline updated with ${notes.length} notes`); }); ### Helpers [​](https://hzrd149.github.io/applesauce/introduction/getting-started#helpers) Utility functions that extract useful data from raw Nostr events. ts import { getProfileContent, getDisplayName } from "applesauce-core/helpers"; const profile = getProfileContent(profileEvent); const name = getDisplayName(profile); ### Models [​](https://hzrd149.github.io/applesauce/introduction/getting-started#models) Pre-built subscriptions that combine EventStore with helpers for reactive UI components. ts import { ProfileModel } from "applesauce-core/models"; // Automatically parses and updates when profile changes eventStore.model(ProfileModel, pubkey).subscribe((profile) => { console.log("Profile updated:", profile); }); ### RelayPool [​](https://hzrd149.github.io/applesauce/introduction/getting-started#relaypool) Manages connections to Nostr relays and provides reactive subscriptions. ts import { RelayPool, onlyEvents } from "applesauce-relay"; const pool = new RelayPool(); pool .relay("wss://relay.damus.io") .subscription({ kinds: [1] }) .pipe(onlyEvents()) .subscribe((event) => { eventStore.add(event); }); ### EventFactory [​](https://hzrd149.github.io/applesauce/introduction/getting-started#eventfactory) Creates and signs Nostr events using pre-built blueprints. ts import { EventFactory } from "applesauce-factory"; import { NoteBlueprint } from "applesauce-factory/blueprints"; const factory = new EventFactory({ signer }); const note = await factory.create(NoteBlueprint, "Hello Nostr!"); const signed = await factory.sign(note); Next Steps [​](https://hzrd149.github.io/applesauce/introduction/getting-started#next-steps) --------------------------------------------------------------------------------------------- * **Start with the [tutorial](https://hzrd149.github.io/applesauce/tutorial/00-introduction.html) ** to learn step-by-step * **Browse the [examples](https://hzrd149.github.io/applesauce/examples) ** to see whats possible * **Check the [API documentation](https://hzrd149.github.io/applesauce/typedoc/) ** for detailed reference --- # Blueprints | AppleSauce * [applesauce-dvm](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-dvm.html) * [Blueprints](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-dvm.Blueprints.html) Namespace Blueprints ==================== Functions --------- [includeRequestInputs](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-dvm.Blueprints.includeRequestInputs.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-dvm.Blueprints.html#includerequestinputs) [includeRequestParams](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-dvm.Blueprints.includeRequestParams.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-dvm.Blueprints.html#includerequestparams) [MachinePaymentStatusBlueprint](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-dvm.Blueprints.MachinePaymentStatusBlueprint.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-dvm.Blueprints.html#machinepaymentstatusblueprint) [MachineRequestBlueprint](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-dvm.Blueprints.MachineRequestBlueprint.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-dvm.Blueprints.html#machinerequestblueprint) [MachineResultBlueprint](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-dvm.Blueprints.MachineResultBlueprint.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-dvm.Blueprints.html#machineresultblueprint) [MachineStatusBlueprint](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-dvm.Blueprints.MachineStatusBlueprint.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-dvm.Blueprints.html#machinestatusblueprint) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Functions [includeRequestInputs](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-dvm.Blueprints.html#includerequestinputs) [includeRequestParams](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-dvm.Blueprints.html#includerequestparams) [MachinePaymentStatusBlueprint](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-dvm.Blueprints.html#machinepaymentstatusblueprint) [MachineRequestBlueprint](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-dvm.Blueprints.html#machinerequestblueprint) [MachineResultBlueprint](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-dvm.Blueprints.html#machineresultblueprint) [MachineStatusBlueprint](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-dvm.Blueprints.html#machinestatusblueprint) --- # Helpers | AppleSauce * [applesauce-dvm](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-dvm.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-dvm.Helpers.html) Namespace Helpers ================= Enumerations ------------ [JobStatus](https://hzrd149.github.io/applesauce/typedoc/enums/applesauce-dvm.Helpers.JobStatus.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-dvm.Helpers.html#jobstatus) Type Aliases ------------ [RequestEventInput](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-dvm.Helpers.RequestEventInput.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-dvm.Helpers.html#requesteventinput) [RequestInput](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-dvm.Helpers.RequestInput.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-dvm.Helpers.html#requestinput) [RequestJobInput](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-dvm.Helpers.RequestJobInput.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-dvm.Helpers.html#requestjobinput) [RequestTextInput](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-dvm.Helpers.RequestTextInput.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-dvm.Helpers.html#requesttextinput) [RequestURLInput](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-dvm.Helpers.RequestURLInput.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-dvm.Helpers.html#requesturlinput) Variables --------- [DVM\_REQUEST\_KINDS](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-dvm.Helpers.DVM_REQUEST_KINDS.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-dvm.Helpers.html#dvm_request_kinds) [DVM\_RESPONSE\_KINDS](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-dvm.Helpers.DVM_RESPONSE_KINDS.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-dvm.Helpers.html#dvm_response_kinds) [DVM\_STATUS\_KIND](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-dvm.Helpers.DVM_STATUS_KIND.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-dvm.Helpers.html#dvm_status_kind) Functions --------- [getRequestInputs](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-dvm.Helpers.getRequestInputs.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-dvm.Helpers.html#getrequestinputs) [getRequestOutputType](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-dvm.Helpers.getRequestOutputType.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-dvm.Helpers.html#getrequestoutputtype) [getRequestParam](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-dvm.Helpers.getRequestParam.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-dvm.Helpers.html#getrequestparam) [getRequestParams](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-dvm.Helpers.getRequestParams.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-dvm.Helpers.html#getrequestparams) [getRequestRelays](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-dvm.Helpers.getRequestRelays.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-dvm.Helpers.html#getrequestrelays) [getStatusType](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-dvm.Helpers.getStatusType.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-dvm.Helpers.html#getstatustype) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Enumerations [JobStatus](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-dvm.Helpers.html#jobstatus) Type Aliases [RequestEventInput](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-dvm.Helpers.html#requesteventinput) [RequestInput](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-dvm.Helpers.html#requestinput) [RequestJobInput](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-dvm.Helpers.html#requestjobinput) [RequestTextInput](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-dvm.Helpers.html#requesttextinput) [RequestURLInput](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-dvm.Helpers.html#requesturlinput) Variables [DVM\_REQUEST\_KINDS](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-dvm.Helpers.html#dvm_request_kinds) [DVM\_RESPONSE\_KINDS](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-dvm.Helpers.html#dvm_response_kinds) [DVM\_STATUS\_KIND](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-dvm.Helpers.html#dvm_status_kind) Functions [getRequestInputs](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-dvm.Helpers.html#getrequestinputs) [getRequestOutputType](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-dvm.Helpers.html#getrequestoutputtype) [getRequestParam](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-dvm.Helpers.html#getrequestparam) [getRequestParams](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-dvm.Helpers.html#getrequestparams) [getRequestRelays](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-dvm.Helpers.html#getrequestrelays) [getStatusType](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-dvm.Helpers.html#getstatustype) --- # SubscriptionMethod | AppleSauce * [applesauce-dvm](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-dvm.html) * [SubscriptionMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-dvm.SubscriptionMethod.html) Type Alias SubscriptionMethod ============================= SubscriptionMethod: (     relays: string\[\],     filters: Filter\[\], ) \=> Observable #### Type declaration * * (relays: string\[\], filters: Filter\[\]): Observable * #### Parameters * relays: string\[\] * filters: Filter\[\] #### Returns Observable ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # IEventStoreStreams | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [IEventStoreStreams](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreStreams.html) Interface IEventStoreStreams ============================ The stream interface for an event store interface IEventStoreStreams {     [insert$](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreStreams.html#insert) : Observable;     [remove$](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreStreams.html#remove) : Observable;     [update$](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreStreams.html#update) : Observable; } #### Hierarchy ([View Summary](https://hzrd149.github.io/applesauce/typedoc/hierarchy.html#applesauce-core.IEventStoreStreams) ) * IEventStoreStreams * [IEventSet](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventSet.html) * [IEventStore](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html) ##### Index ### Properties [insert$](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreStreams.html#insert) [remove$](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreStreams.html#remove) [update$](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreStreams.html#update) Properties ---------- ### insert$[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreStreams.html#insert) insert$: Observable A stream of new events added to the store ### remove$[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreStreams.html#remove) remove$: Observable A stream of events that have been removed ### update$[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreStreams.html#update) update$: Observable A stream of events that have been updated ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [insert$](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreStreams.html#insert) [remove$](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreStreams.html#remove) [update$](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreStreams.html#update) --- # EmojiContext | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [EmojiContext](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EmojiContext.html) Interface EmojiContext ====================== interface EmojiContext {     [emojis](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EmojiContext.html#emojis) ?: [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) .[Emoji](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.Emoji.html) \[\]; } #### Hierarchy ([View Summary](https://hzrd149.github.io/applesauce/typedoc/hierarchy.html#applesauce-factory.EmojiContext) ) * EmojiContext * [EventFactoryContext](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EventFactoryContext.html) ##### Index ### Properties [emojis?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EmojiContext.html#emojis) Properties ---------- ### `Optional`emojis[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EmojiContext.html#emojis) emojis?: [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) .[Emoji](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.Emoji.html) \[\] An array of custom emojis that will be used for text notes ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [emojis](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EmojiContext.html#emojis) --- # IEventStoreSubscriptions | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [IEventStoreSubscriptions](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreSubscriptions.html) Interface IEventStoreSubscriptions ================================== An event store that can be subscribed to interface IEventStoreSubscriptions {     [addressable](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreSubscriptions.html#addressable-1) (pointer: AddressPointer): Observable;     [event](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreSubscriptions.html#event-1) (id: string | EventPointer): Observable;     [filter](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreSubscriptions.html#filter-1) (filters: Filter | Filter\[\]): Observable;     [replaceable](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreSubscriptions.html#replaceable-1) (pointer: [AddressPointerWithoutD](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.AddressPointerWithoutD.html) ): Observable; } ##### Index ### Methods [addressable](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreSubscriptions.html#addressable) [event](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreSubscriptions.html#event) [filter](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreSubscriptions.html#filter) [replaceable](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreSubscriptions.html#replaceable) Methods ------- ### addressable[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreSubscriptions.html#addressable) * addressable(pointer: AddressPointer): Observable[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreSubscriptions.html#addressable-1) Subscribe to an addressable event by pointer #### Parameters * pointer: AddressPointer #### Returns Observable ### event[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreSubscriptions.html#event) * event(id: string | EventPointer): Observable[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreSubscriptions.html#event-1) Susbscribe to an event by id #### Parameters * id: string | EventPointer #### Returns Observable ### filter[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreSubscriptions.html#filter) * filter(filters: Filter | Filter\[\]): Observable[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreSubscriptions.html#filter-1) Subscribe to a batch of events that match the filters #### Parameters * filters: Filter | Filter\[\] #### Returns Observable ### replaceable[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreSubscriptions.html#replaceable) * replaceable(pointer: [AddressPointerWithoutD](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.AddressPointerWithoutD.html) ): Observable[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreSubscriptions.html#replaceable-1) Subscribe to a replaceable event by pointer #### Parameters * pointer: [AddressPointerWithoutD](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.AddressPointerWithoutD.html) #### Returns Observable ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Methods [addressable](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreSubscriptions.html#addressable) [event](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreSubscriptions.html#event) [filter](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreSubscriptions.html#filter) [replaceable](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStoreSubscriptions.html#replaceable) --- # EventFactoryClient | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [EventFactoryClient](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EventFactoryClient.html) Interface EventFactoryClient ============================ interface EventFactoryClient {     [address](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EventFactoryClient.html#address) ?: Omit;     [name](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EventFactoryClient.html#name) : string; } ##### Index ### Properties [address?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EventFactoryClient.html#address) [name](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EventFactoryClient.html#name) Properties ---------- ### `Optional`address[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EventFactoryClient.html#address) address?: Omit ### name[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EventFactoryClient.html#name) name: string ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [address](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EventFactoryClient.html#address) [name](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EventFactoryClient.html#name) --- # EventFactoryContext | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [EventFactoryContext](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EventFactoryContext.html) Interface EventFactoryContext ============================= All options that can be passed when building an event interface EventFactoryContext {     [client](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EventFactoryContext.html#client) ?: [EventFactoryClient](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EventFactoryClient.html) ;     [emojis](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EventFactoryContext.html#emojis) ?: [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) .[Emoji](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.Emoji.html) \[\];     [getEventRelayHint](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EventFactoryContext.html#geteventrelayhint) ?: (         event: string,     ) \=> undefined | string | Promise | Promise;     [getPubkeyRelayHint](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EventFactoryContext.html#getpubkeyrelayhint) ?: (         pubkey: string,     ) \=> undefined | string | Promise | Promise;     [signer](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EventFactoryContext.html#signer) ?: [EventSigner](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EventSigner.html) ; } #### Hierarchy ([View Summary](https://hzrd149.github.io/applesauce/typedoc/hierarchy.html#applesauce-factory.EventFactoryContext) ) * [ClientPointerContext](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.ClientPointerContext.html) * [EventSignerContext](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EventSignerContext.html) * [RelayHintContext](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.RelayHintContext.html) * [EmojiContext](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EmojiContext.html) * EventFactoryContext ##### Index ### Properties [client?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EventFactoryContext.html#client) [emojis?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EventFactoryContext.html#emojis) [getEventRelayHint?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EventFactoryContext.html#geteventrelayhint) [getPubkeyRelayHint?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EventFactoryContext.html#getpubkeyrelayhint) [signer?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EventFactoryContext.html#signer) Properties ---------- ### `Optional`client[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EventFactoryContext.html#client) client?: [EventFactoryClient](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EventFactoryClient.html) ### `Optional`emojis[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EventFactoryContext.html#emojis) emojis?: [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) .[Emoji](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.Emoji.html) \[\] An array of custom emojis that will be used for text notes ### `Optional`getEventRelayHint[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EventFactoryContext.html#geteventrelayhint) getEventRelayHint?: (     event: string, ) \=> undefined | string | Promise | Promise ### `Optional`getPubkeyRelayHint[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EventFactoryContext.html#getpubkeyrelayhint) getPubkeyRelayHint?: (     pubkey: string, ) \=> undefined | string | Promise | Promise ### `Optional`signer[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EventFactoryContext.html#signer) signer?: [EventSigner](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EventSigner.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [client](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EventFactoryContext.html#client) [emojis](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EventFactoryContext.html#emojis) [getEventRelayHint](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EventFactoryContext.html#geteventrelayhint) [getPubkeyRelayHint](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EventFactoryContext.html#getpubkeyrelayhint) [signer](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EventFactoryContext.html#signer) --- # ModelConstructor | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [ModelConstructor](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.ModelConstructor.html) Type Alias ModelConstructor ==================================== ModelConstructor: (...args: [Args](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.ModelConstructor.html#args) ) \=> [Model](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Model.html) <[T](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.ModelConstructor.html#t) \> & {     getKey?: (...args: [Args](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.ModelConstructor.html#args) ) \=> string; } A constructor for a [Model](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Model.html) #### Type Parameters * T extends unknown * Args extends any\[\] ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # EventSigner | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [EventSigner](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EventSigner.html) Interface EventSigner ===================== Nostr event signer interface EventSigner {     [getPublicKey](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EventSigner.html#getpublickey) : () \=> string | Promise;     [nip04](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EventSigner.html#nip04) ?: {         decrypt: (             pubkey: string,             ciphertext: string,         ) \=> string | Promise;         encrypt: (pubkey: string, plaintext: string) \=> string | Promise;     };     [nip44](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EventSigner.html#nip44) ?: {         decrypt: (             pubkey: string,             ciphertext: string,         ) \=> string | Promise;         encrypt: (pubkey: string, plaintext: string) \=> string | Promise;     };     [signEvent](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EventSigner.html#signevent) : (template: EventTemplate) \=> Event | Promise; } ##### Index ### Properties [getPublicKey](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EventSigner.html#getpublickey) [nip04?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EventSigner.html#nip04) [nip44?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EventSigner.html#nip44) [signEvent](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EventSigner.html#signevent) Properties ---------- ### getPublicKey[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EventSigner.html#getpublickey) getPublicKey: () \=> string | Promise ### `Optional`nip04[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EventSigner.html#nip04) nip04?: {     decrypt: (         pubkey: string,         ciphertext: string,     ) \=> string | Promise;     encrypt: (pubkey: string, plaintext: string) \=> string | Promise; } ### `Optional`nip44[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EventSigner.html#nip44) nip44?: {     decrypt: (         pubkey: string,         ciphertext: string,     ) \=> string | Promise;     encrypt: (pubkey: string, plaintext: string) \=> string | Promise; } ### signEvent[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EventSigner.html#signevent) signEvent: (template: EventTemplate) \=> Event | Promise ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [getPublicKey](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EventSigner.html#getpublickey) [nip04](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EventSigner.html#nip04) [nip44](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EventSigner.html#nip44) [signEvent](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EventSigner.html#signevent) --- # Emoji | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [Emoji](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.Emoji.html) Type Alias Emoji ================ type Emoji \= {     [shortcode](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.Emoji.html#shortcode) : string;     [url](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.Emoji.html#url) : string; } ##### Index ### Properties [shortcode](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.Emoji.html#shortcode) [url](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.Emoji.html#url) Properties ---------- ### shortcode[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.Emoji.html#shortcode) shortcode: string The emoji shortcode (without the ::) ### url[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.Emoji.html#url) url: string The URL to the emoji image ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [shortcode](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.Emoji.html#shortcode) [url](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.Emoji.html#url) --- # PublishOptions | AppleSauce * [applesauce-relay](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-relay.html) * [PublishOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.PublishOptions.html) Type Alias PublishOptions ========================= Options for the publish method on the pool and relay type PublishOptions \= {     [reconnect](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.PublishOptions.html#reconnect) ?: boolean | Parameters\[0\];     [retries](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.PublishOptions.html#retries) ?: number | Parameters\[0\]; } ##### Index ### Properties [reconnect?](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.PublishOptions.html#reconnect) [retries?](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.PublishOptions.html#retries) Properties ---------- ### `Optional`reconnect[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.PublishOptions.html#reconnect) reconnect?: boolean | Parameters\[0\] Whether to reconnect when socket is closed. A number of times or true for infinite. default is false #### See[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.PublishOptions.html#see) [https://rxjs.dev/api/index/function/repeat](https://rxjs.dev/api/index/function/repeat) ### `Optional`retries[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.PublishOptions.html#retries) retries?: number | Parameters\[0\] Number of times to retry the publish. default is 3 #### See[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.PublishOptions.html#see-1) [https://rxjs.dev/api/index/function/retry](https://rxjs.dev/api/index/function/retry) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [reconnect](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.PublishOptions.html#reconnect) [retries](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.PublishOptions.html#retries) --- # NameValueTag | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [NameValueTag](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.NameValueTag.html) Type Alias NameValueTag ============================= NameValueTag: \[[Name](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.NameValueTag.html#name)\ , string, ...string\[\]\] A tag with at least two indexes, the first being the name, the second the value #### Type Parameters * Name extends string = string ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # PublishResponse | AppleSauce * [applesauce-relay](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-relay.html) * [PublishResponse](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.PublishResponse.html) Type Alias PublishResponse ========================== type PublishResponse \= {     [from](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.PublishResponse.html#from) : string;     [message](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.PublishResponse.html#message) ?: string;     [ok](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.PublishResponse.html#ok) : boolean; } ##### Index ### Properties [from](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.PublishResponse.html#from) [message?](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.PublishResponse.html#message) [ok](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.PublishResponse.html#ok) Properties ---------- ### from[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.PublishResponse.html#from) from: string ### `Optional`message[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.PublishResponse.html#message) message?: string ### ok[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.PublishResponse.html#ok) ok: boolean ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [from](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.PublishResponse.html#from) [message](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.PublishResponse.html#message) [ok](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.PublishResponse.html#ok) --- # AddNutzapInfoMint | AppleSauce * [applesauce-wallet](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.html) * [Actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.Actions.html) * [AddNutzapInfoMint](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet.Actions.AddNutzapInfoMint.html) Function AddNutzapInfoMint ========================== * AddNutzapInfoMint(     mint:         | { units?: string\[\]; url: string }         | { units?: string\[\]; url: string }\[\], ): [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet.Actions.AddNutzapInfoMint.html#addnutzapinfomint) An action to add a mint to the kind 10019 nutzap info event #### Parameters * mint: { units?: string\[\]; url: string } | { units?: string\[\]; url: string }\[\] #### Returns [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # createATagFromAddressPointer | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html) * [createATagFromAddressPointer](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.createATagFromAddressPointer.html) Function createATagFromAddressPointer ===================================== * createATagFromAddressPointer(pointer: AddressPointer): [NameValueTag](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.NameValueTag.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.createATagFromAddressPointer.html#createatagfromaddresspointer) Returns a tag for an address pointer #### Parameters * pointer: AddressPointer #### Returns [NameValueTag](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.NameValueTag.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # ChannelHiddenModel | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Models](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html) * [ChannelHiddenModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.ChannelHiddenModel.html) Function ChannelHiddenModel =========================== * ChannelHiddenModel(     channel: Event,     authors?: string\[\], ): [Model](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Model.html) \>[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.ChannelHiddenModel.html#channelhiddenmodel) A model that returns a map of hidden messages Map #### Parameters * channel: Event * authors: string\[\] = \[\] #### Returns [Model](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Model.html) \> ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # createCommentTagsFromCommentPointer | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html) * [createCommentTagsFromCommentPointer](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.createCommentTagsFromCommentPointer.html) Function createCommentTagsFromCommentPointer ============================================ * createCommentTagsFromCommentPointer(     pointer: [CommentPointer](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.CommentPointer.html) ,     root?: boolean, ): string\[\]\[\][](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.createCommentTagsFromCommentPointer.html#createcommenttagsfromcommentpointer) Create a set fo tags for a single CommentPointer #### Parameters * pointer: [CommentPointer](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.CommentPointer.html) * root: boolean = false #### Returns string\[\]\[\] ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # WalletConnectEncryptionMethod | AppleSauce * [applesauce-wallet-connect](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html) * [WalletConnectEncryptionMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.WalletConnectEncryptionMethod.html) Type Alias WalletConnectEncryptionMethod ======================================== WalletConnectEncryptionMethod: "nip44\_v2" | "nip04" Supported encryption methods ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # SubscriptionOptions | AppleSauce * [applesauce-relay](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-relay.html) * [SubscriptionOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.SubscriptionOptions.html) Type Alias SubscriptionOptions ============================== Options for the subscription method on the pool and relay type SubscriptionOptions \= {     [id](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.SubscriptionOptions.html#id) ?: string;     [reconnect](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.SubscriptionOptions.html#reconnect) ?: boolean | Parameters\[0\];     [retries](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.SubscriptionOptions.html#retries) ?: number | Parameters\[0\]; } ##### Index ### Properties [id?](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.SubscriptionOptions.html#id) [reconnect?](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.SubscriptionOptions.html#reconnect) [retries?](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.SubscriptionOptions.html#retries) Properties ---------- ### `Optional`id[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.SubscriptionOptions.html#id) id?: string Custom REQ id for the subscription ### `Optional`reconnect[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.SubscriptionOptions.html#reconnect) reconnect?: boolean | Parameters\[0\] Whether to reconnect when socket is closed. A number of times or true for infinite. default is false #### See[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.SubscriptionOptions.html#see) [https://rxjs.dev/api/index/function/repeat](https://rxjs.dev/api/index/function/repeat) ### `Optional`retries[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.SubscriptionOptions.html#retries) retries?: number | Parameters\[0\] Number of times to retry a request. default is 3 #### See[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.SubscriptionOptions.html#see-1) [https://rxjs.dev/api/index/function/retry](https://rxjs.dev/api/index/function/retry) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [id](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.SubscriptionOptions.html#id) [reconnect](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.SubscriptionOptions.html#reconnect) [retries](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.SubscriptionOptions.html#retries) --- # BunkerURI | AppleSauce * [applesauce-signers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.Helpers.html) * [BunkerURI](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.BunkerURI.html) Type Alias BunkerURI ==================== A bunker:// URI type BunkerURI \= {     [relays](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.BunkerURI.html#relays) : string\[\];     [remote](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.BunkerURI.html#remote) : string;     [secret](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.BunkerURI.html#secret) ?: string; } ##### Index ### Properties [relays](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.BunkerURI.html#relays) [remote](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.BunkerURI.html#remote) [secret?](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.BunkerURI.html#secret) Properties ---------- ### relays[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.BunkerURI.html#relays) relays: string\[\] ### remote[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.BunkerURI.html#remote) remote: string ### `Optional`secret[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.BunkerURI.html#secret) secret?: string ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [relays](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.BunkerURI.html#relays) [remote](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.BunkerURI.html#remote) [secret](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.BunkerURI.html#secret) --- # PicturePostBlueprintOptions | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Blueprints](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html) * [PicturePostBlueprintOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Blueprints.PicturePostBlueprintOptions.html) Type Alias PicturePostBlueprintOptions ====================================== PicturePostBlueprintOptions: [TextContentOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Operations.Content.TextContentOptions.html) & [MetaTagOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Operations.MetaTagOptions.html) & {     hashtags?: string\[\]; } ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # AddBlossomServer | AppleSauce * [applesauce-actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.html) * [Actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html) * [AddBlossomServer](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.AddBlossomServer.html) Function AddBlossomServer ========================= * AddBlossomServer(server: string | URL | (string | URL)\[\]): [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.AddBlossomServer.html#addblossomserver) An action that adds a server to the Blossom servers event #### Parameters * server: string | URL | (string | URL)\[\] #### Returns [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # ConsolidateTokens | AppleSauce * [applesauce-wallet](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.html) * [Actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.Actions.html) * [ConsolidateTokens](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet.Actions.ConsolidateTokens.html) Function ConsolidateTokens ========================== * ConsolidateTokens(opts?: { ignoreLocked?: boolean }): [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet.Actions.ConsolidateTokens.html#consolidatetokens) Combines all unlocked token events into a single event per mint #### Parameters * `Optional`opts: { ignoreLocked?: boolean } #### Returns [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # addBlossomServerTag | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Operations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html) * [TagOperations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html) * [addBlossomServerTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.addBlossomServerTag.html) Function addBlossomServerTag ============================ * addBlossomServerTag(url: string | URL, replace?: boolean): [TagOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.TagOperation.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.addBlossomServerTag.html#addblossomservertag) Adds a server tag to a 10063 event #### Parameters * url: string | URL * replace: boolean = true #### Returns [TagOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.TagOperation.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # NostrConnectResponse | AppleSauce * [applesauce-signers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.Helpers.html) * [NostrConnectResponse](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.NostrConnectResponse.html) Type Alias NostrConnectResponse ================================== type NostrConnectResponse<[N](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.NostrConnectResponse.html#n) extends [NostrConnectMethod](https://hzrd149.github.io/applesauce/typedoc/enums/applesauce-signers.Helpers.NostrConnectMethod.html) \> \= {     [error](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.NostrConnectResponse.html#error) ?: string;     [id](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.NostrConnectResponse.html#id) : string;     [result](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.NostrConnectResponse.html#result) : [ConnectResponseResults](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.ConnectResponseResults.html) \[[N](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.NostrConnectResponse.html#n)\ \]; } #### Type Parameters * N extends [NostrConnectMethod](https://hzrd149.github.io/applesauce/typedoc/enums/applesauce-signers.Helpers.NostrConnectMethod.html) ##### Index ### Properties [error?](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.NostrConnectResponse.html#error) [id](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.NostrConnectResponse.html#id) [result](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.NostrConnectResponse.html#result) Properties ---------- ### `Optional`error[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.NostrConnectResponse.html#error) error?: string ### id[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.NostrConnectResponse.html#id) id: string ### result[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.NostrConnectResponse.html#result) result: [ConnectResponseResults](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.ConnectResponseResults.html) \[[N](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.NostrConnectResponse.html#n)\ \] ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [error](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.NostrConnectResponse.html#error) [id](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.NostrConnectResponse.html#id) [result](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.NostrConnectResponse.html#result) --- # ChannelMessagesModel | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Models](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html) * [ChannelMessagesModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.ChannelMessagesModel.html) Function ChannelMessagesModel ============================= * ChannelMessagesModel(channel: Event): [Model](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Model.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.ChannelMessagesModel.html#channelmessagesmodel) A model that returns all messages in a channel #### Parameters * channel: Event #### Returns [Model](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Model.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # createETagFromEventPointer | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html) * [createETagFromEventPointer](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.createETagFromEventPointer.html) Function createETagFromEventPointer =================================== * createETagFromEventPointer(pointer: EventPointer): [NameValueTag](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.NameValueTag.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.createETagFromEventPointer.html#createetagfromeventpointer) Returns a tag for an event pointer without a marker #### Parameters * pointer: EventPointer #### Returns [NameValueTag](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.NameValueTag.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # ReportReason | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [ReportReason](https://hzrd149.github.io/applesauce/typedoc/enums/applesauce-core.Helpers.ReportReason.html) Enumeration ReportReason ======================== ##### Index ### Enumeration Members [illegal](https://hzrd149.github.io/applesauce/typedoc/enums/applesauce-core.Helpers.ReportReason.html#illegal) [impersonation](https://hzrd149.github.io/applesauce/typedoc/enums/applesauce-core.Helpers.ReportReason.html#impersonation) [malware](https://hzrd149.github.io/applesauce/typedoc/enums/applesauce-core.Helpers.ReportReason.html#malware) [nudity](https://hzrd149.github.io/applesauce/typedoc/enums/applesauce-core.Helpers.ReportReason.html#nudity) [other](https://hzrd149.github.io/applesauce/typedoc/enums/applesauce-core.Helpers.ReportReason.html#other) [profanity](https://hzrd149.github.io/applesauce/typedoc/enums/applesauce-core.Helpers.ReportReason.html#profanity) [spam](https://hzrd149.github.io/applesauce/typedoc/enums/applesauce-core.Helpers.ReportReason.html#spam) Enumeration Members ------------------- ### illegal[](https://hzrd149.github.io/applesauce/typedoc/enums/applesauce-core.Helpers.ReportReason.html#illegal) illegal: "illegal" ### impersonation[](https://hzrd149.github.io/applesauce/typedoc/enums/applesauce-core.Helpers.ReportReason.html#impersonation) impersonation: "impersonation" ### malware[](https://hzrd149.github.io/applesauce/typedoc/enums/applesauce-core.Helpers.ReportReason.html#malware) malware: "malware" ### nudity[](https://hzrd149.github.io/applesauce/typedoc/enums/applesauce-core.Helpers.ReportReason.html#nudity) nudity: "nudity" ### other[](https://hzrd149.github.io/applesauce/typedoc/enums/applesauce-core.Helpers.ReportReason.html#other) other: "other" ### profanity[](https://hzrd149.github.io/applesauce/typedoc/enums/applesauce-core.Helpers.ReportReason.html#profanity) profanity: "profanity" ### spam[](https://hzrd149.github.io/applesauce/typedoc/enums/applesauce-core.Helpers.ReportReason.html#spam) spam: "spam" ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Enumeration Members [illegal](https://hzrd149.github.io/applesauce/typedoc/enums/applesauce-core.Helpers.ReportReason.html#illegal) [impersonation](https://hzrd149.github.io/applesauce/typedoc/enums/applesauce-core.Helpers.ReportReason.html#impersonation) [malware](https://hzrd149.github.io/applesauce/typedoc/enums/applesauce-core.Helpers.ReportReason.html#malware) [nudity](https://hzrd149.github.io/applesauce/typedoc/enums/applesauce-core.Helpers.ReportReason.html#nudity) [other](https://hzrd149.github.io/applesauce/typedoc/enums/applesauce-core.Helpers.ReportReason.html#other) [profanity](https://hzrd149.github.io/applesauce/typedoc/enums/applesauce-core.Helpers.ReportReason.html#profanity) [spam](https://hzrd149.github.io/applesauce/typedoc/enums/applesauce-core.Helpers.ReportReason.html#spam) --- # CalendarRsvp | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Operations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html) * [CalendarRsvp](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.CalendarRsvp.html) Namespace CalendarRsvp ====================== Functions --------- [setCalendarEvent](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.CalendarRsvp.setCalendarEvent.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.CalendarRsvp.html#setcalendarevent) [setFreeBusy](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.CalendarRsvp.setFreeBusy.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.CalendarRsvp.html#setfreebusy) [setStatus](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.CalendarRsvp.setStatus.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.CalendarRsvp.html#setstatus) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Functions [setCalendarEvent](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.CalendarRsvp.html#setcalendarevent) [setFreeBusy](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.CalendarRsvp.html#setfreebusy) [setStatus](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.CalendarRsvp.html#setstatus) --- # SubscriptionResponse | AppleSauce * [applesauce-relay](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-relay.html) * [SubscriptionResponse](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.SubscriptionResponse.html) Type Alias SubscriptionResponse =============================== SubscriptionResponse: NostrEvent | "EOSE" ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # PollBlueprintOptions | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Blueprints](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html) * [PollBlueprintOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Blueprints.PollBlueprintOptions.html) Type Alias PollBlueprintOptions =============================== PollBlueprintOptions: [MetaTagOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Operations.MetaTagOptions.html) & [ZapOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Operations.Zap.ZapOptions.html) & {     endsAt?: number;     pollType?: [PollType](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.PollType.html) ;     relays?: string\[\]; } #### Type declaration * ##### `Optional`endsAt?: number Unix timestamp when the poll ends * ##### `Optional`pollType?: [PollType](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.PollType.html) Poll type - singlechoice or multiplechoice. Defaults to singlechoice * ##### `Optional`relays?: string\[\] Relay URLs where responses should be published ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # WalletNotification | AppleSauce * [applesauce-wallet-connect](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html) * [WalletNotification](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.WalletNotification.html) Type Alias WalletNotification ============================= WalletNotification: [PaymentReceivedNotification](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.PaymentReceivedNotification.html) | [PaymentSentNotification](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.PaymentSentNotification.html) Union type for all NIP-47 notification types ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # AddDMRelay | AppleSauce * [applesauce-actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.html) * [Actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html) * [AddDMRelay](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.AddDMRelay.html) Function AddDMRelay =================== * AddDMRelay(relay: string | string\[\]): [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.AddDMRelay.html#adddmrelay) An action that adds a relay to the 10050 DM relays event #### Parameters * relay: string | string\[\] #### Returns [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # WalletService | AppleSauce * [applesauce-wallet-connect](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html) * [WalletService](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html) Class WalletService =================== NIP-47 Wallet Service implementation ##### Index ### Constructors [constructor](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#constructor) ### Properties [client](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#client) [events$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#events) [handlers](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#handlers) [log](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#log) [pubkey](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#pubkey) [publishMethod](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#publishmethod) [relays](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#relays) [running](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#running) [secret](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#secret) [signer](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#signer) [subscription](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#subscription) [subscriptionMethod](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#subscriptionmethod) [support](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#support) [pool](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#pool) [publishMethod](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#publishmethod-1) [subscriptionMethod](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#subscriptionmethod-1) ### Methods [getConnectURI](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#getconnecturi) [handleRequestEvent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#handlerequestevent) [isRunning](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#isrunning) [notify](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#notify) [processRequest](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#processrequest) [publishSupportEvent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#publishsupportevent) [sendErrorResponse](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#senderrorresponse) [sendResponse](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#sendresponse) [sendSuccessResponse](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#sendsuccessresponse) [start](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#start) [stop](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#stop) [fromAuthURI](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#fromauthuri) Constructors ------------ ### constructor[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#constructor) * new WalletService(options: [WalletServiceOptions](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceOptions.html) ): [WalletService](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html) [](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#constructorwalletservice) #### Parameters * options: [WalletServiceOptions](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceOptions.html) #### Returns [WalletService](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html) Properties ---------- ### client[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#client) client: string The client's public key ### `Protected`events$[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#events) events$: null | Observable = null Shared observable for all wallet request events ### `Protected` `Readonly`handlers[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#handlers) handlers: [WalletServiceHandlers](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceHandlers.html) Map of method handlers ### `Protected`log[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#log) log: Debugger = ... ### pubkey[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#pubkey) pubkey: null | string = null The service's public key ### `Protected` `Readonly`publishMethod[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#publishmethod) publishMethod: [NostrPublishMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.NostrPublishMethod.html) A method for publishing events ### `Readonly`relays[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#relays) relays: string\[\] The relays to use for the service ### running[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#running) running: boolean = false Whether the service is currently running ### `Protected`secret[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#secret) secret: Uint8Array The client's secret key ### `Protected` `Readonly`signer[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#signer) signer: [EventSigner](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EventSigner.html) The signer used for creating and unlocking events ### `Protected`subscription[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#subscription) subscription: null | Subscription = null Subscription to the events observable ### `Protected` `Readonly`subscriptionMethod[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#subscriptionmethod) subscriptionMethod: [NostrSubscriptionMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.NostrSubscriptionMethod.html) A method for subscribing to relays ### `Protected` `Readonly`support[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#support) support: [WalletSupport](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletSupport.html) Wallet support information ### `Static`pool[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#pool) pool: undefined | [NostrPool](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.NostrPool.html) = undefined A fallback pool to use if none is pass in when creating the signer ### `Static`publishMethod[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#publishmethod-1) publishMethod: undefined | [NostrPublishMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.NostrPublishMethod.html) = undefined A fallback method to use for publishMethod if none is passed in when creating the client ### `Static`subscriptionMethod[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#subscriptionmethod-1) subscriptionMethod: undefined | [NostrSubscriptionMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.NostrSubscriptionMethod.html) = undefined A fallback method to use for subscriptionMethod if none is passed in when creating the client Methods ------- ### getConnectURI[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#getconnecturi) * getConnectURI(): string[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#getconnecturi-1) Get the connection URI for the service #### Returns string ### `Protected`handleRequestEvent[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#handlerequestevent) * handleRequestEvent(requestEvent: Event): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#handlerequestevent-1) Handle a wallet request event #### Parameters * requestEvent: Event #### Returns Promise ### isRunning[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#isrunning) * isRunning(): boolean[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#isrunning-1) Check if the service is running #### Returns boolean ### notify[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#notify) * notify<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#notifyt) extends [WalletNotification](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.WalletNotification.html) \>(     type: [T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#notifyt) \["notification\_type"\],     notification: [T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#notifyt) \["notification"\],     legacy?: boolean, ): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#notify-1) Send a notification to the client #### Type Parameters * T extends [WalletNotification](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.WalletNotification.html) #### Parameters * type: [T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#notifyt) \["notification\_type"\] * notification: [T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#notifyt) \["notification"\] * legacy: boolean = false #### Returns Promise ### `Protected`processRequest[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#processrequest) * processRequest(requestEvent: Event, request: [WalletRequest](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.WalletRequest.html) ): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#processrequest-1) Process a decrypted wallet request #### Parameters * requestEvent: Event * request: [WalletRequest](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.WalletRequest.html) #### Returns Promise ### `Protected`publishSupportEvent[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#publishsupportevent) * publishSupportEvent(): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#publishsupportevent-1) Publish the wallet support event #### Returns Promise ### `Protected`sendErrorResponse[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#senderrorresponse) * sendErrorResponse(     requestEvent: Event,     errorType: WalletErrorCode,     errorMessage: string, ): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#senderrorresponse-1) Send an error response #### Parameters * requestEvent: Event * errorType: WalletErrorCode * errorMessage: string #### Returns Promise ### `Protected`sendResponse[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#sendresponse) * sendResponse(requestEvent: Event, response: [WalletResponse](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.WalletResponse.html) ): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#sendresponse-1) Send a response event #### Parameters * requestEvent: Event * response: [WalletResponse](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.WalletResponse.html) #### Returns Promise ### `Protected`sendSuccessResponse[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#sendsuccessresponse) * sendSuccessResponse<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#sendsuccessresponset) extends [WalletResponse](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.WalletResponse.html) \>(     requestEvent: Event,     method: [T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#sendsuccessresponset) \["result\_type"\],     result: [T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#sendsuccessresponset) \["result"\], ): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#sendsuccessresponse-1) Send a success response #### Type Parameters * T extends [WalletResponse](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.WalletResponse.html) #### Parameters * requestEvent: Event * method: [T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#sendsuccessresponset) \["result\_type"\] * result: [T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#sendsuccessresponset) \["result"\] #### Returns Promise ### start[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#start) * start(): Promise[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#start-1) Start the wallet service #### Returns Promise ### stop[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#stop) * stop(): void[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#stop-1) Stop the wallet service #### Returns void ### `Static`fromAuthURI[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#fromauthuri) * fromAuthURI(     uri: string | [WalletAuthURI](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletAuthURI.html) ,     options: Omit<[WalletServiceOptions](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceOptions.html) , "relays"\>, ): [WalletService](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html) [](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#fromauthuri-1) Creates a service for a nostr+walletauth URI #### Parameters * uri: string | [WalletAuthURI](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletAuthURI.html) * options: Omit<[WalletServiceOptions](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceOptions.html) , "relays"\> #### Returns [WalletService](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Constructors [constructor](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#constructor) Properties [client](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#client) [events$](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#events) [handlers](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#handlers) [log](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#log) [pubkey](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#pubkey) [publishMethod](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#publishmethod) [relays](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#relays) [running](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#running) [secret](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#secret) [signer](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#signer) [subscription](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#subscription) [subscriptionMethod](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#subscriptionmethod) [support](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#support) [pool](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#pool) [publishMethod](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#publishmethod-1) [subscriptionMethod](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#subscriptionmethod-1) Methods [getConnectURI](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#getconnecturi) [handleRequestEvent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#handlerequestevent) [isRunning](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#isrunning) [notify](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#notify) [processRequest](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#processrequest) [publishSupportEvent](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#publishsupportevent) [sendErrorResponse](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#senderrorresponse) [sendResponse](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#sendresponse) [sendSuccessResponse](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#sendsuccessresponse) [start](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#start) [stop](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#stop) [fromAuthURI](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-wallet-connect.WalletService.html#fromauthuri) --- # CreateWallet | AppleSauce * [applesauce-wallet](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.html) * [Actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.Actions.html) * [CreateWallet](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet.Actions.CreateWallet.html) Function CreateWallet ===================== * CreateWallet(mints: string\[\], privateKey?: Uint8Array): [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet.Actions.CreateWallet.html#createwallet) An action that creates a new 17375 wallet event and 375 wallet backup #### Parameters * mints: string\[\] * `Optional`privateKey: Uint8Array #### Returns [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # Channel | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Operations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html) * [Channel](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Channel.html) Namespace Channel ================= Functions --------- [includeChannelPointerTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.Channel.includeChannelPointerTag.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Channel.html#includechannelpointertag) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Functions [includeChannelPointerTag](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Channel.html#includechannelpointertag) --- # addEventBookmarkTag | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Operations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html) * [TagOperations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html) * [addEventBookmarkTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.addEventBookmarkTag.html) Function addEventBookmarkTag ============================ * addEventBookmarkTag(event: Event): [TagOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.TagOperation.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.addEventBookmarkTag.html#addeventbookmarktag) Adds an "e" or "a" tag to a bookmark list or set #### Parameters * event: Event #### Returns [TagOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.TagOperation.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # NostrConnectMethod | AppleSauce * [applesauce-signers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.Helpers.html) * [NostrConnectMethod](https://hzrd149.github.io/applesauce/typedoc/enums/applesauce-signers.Helpers.NostrConnectMethod.html) Enumeration NostrConnectMethod ============================== ##### Index ### Enumeration Members [Connect](https://hzrd149.github.io/applesauce/typedoc/enums/applesauce-signers.Helpers.NostrConnectMethod.html#connect) [CreateAccount](https://hzrd149.github.io/applesauce/typedoc/enums/applesauce-signers.Helpers.NostrConnectMethod.html#createaccount) [GetPublicKey](https://hzrd149.github.io/applesauce/typedoc/enums/applesauce-signers.Helpers.NostrConnectMethod.html#getpublickey) [Nip04Decrypt](https://hzrd149.github.io/applesauce/typedoc/enums/applesauce-signers.Helpers.NostrConnectMethod.html#nip04decrypt) [Nip04Encrypt](https://hzrd149.github.io/applesauce/typedoc/enums/applesauce-signers.Helpers.NostrConnectMethod.html#nip04encrypt) [Nip44Decrypt](https://hzrd149.github.io/applesauce/typedoc/enums/applesauce-signers.Helpers.NostrConnectMethod.html#nip44decrypt) [Nip44Encrypt](https://hzrd149.github.io/applesauce/typedoc/enums/applesauce-signers.Helpers.NostrConnectMethod.html#nip44encrypt) [SignEvent](https://hzrd149.github.io/applesauce/typedoc/enums/applesauce-signers.Helpers.NostrConnectMethod.html#signevent) Enumeration Members ------------------- ### Connect[](https://hzrd149.github.io/applesauce/typedoc/enums/applesauce-signers.Helpers.NostrConnectMethod.html#connect) Connect: "connect" ### CreateAccount[](https://hzrd149.github.io/applesauce/typedoc/enums/applesauce-signers.Helpers.NostrConnectMethod.html#createaccount) CreateAccount: "create\_account" ### GetPublicKey[](https://hzrd149.github.io/applesauce/typedoc/enums/applesauce-signers.Helpers.NostrConnectMethod.html#getpublickey) GetPublicKey: "get\_public\_key" ### Nip04Decrypt[](https://hzrd149.github.io/applesauce/typedoc/enums/applesauce-signers.Helpers.NostrConnectMethod.html#nip04decrypt) Nip04Decrypt: "nip04\_decrypt" ### Nip04Encrypt[](https://hzrd149.github.io/applesauce/typedoc/enums/applesauce-signers.Helpers.NostrConnectMethod.html#nip04encrypt) Nip04Encrypt: "nip04\_encrypt" ### Nip44Decrypt[](https://hzrd149.github.io/applesauce/typedoc/enums/applesauce-signers.Helpers.NostrConnectMethod.html#nip44decrypt) Nip44Decrypt: "nip44\_decrypt" ### Nip44Encrypt[](https://hzrd149.github.io/applesauce/typedoc/enums/applesauce-signers.Helpers.NostrConnectMethod.html#nip44encrypt) Nip44Encrypt: "nip44\_encrypt" ### SignEvent[](https://hzrd149.github.io/applesauce/typedoc/enums/applesauce-signers.Helpers.NostrConnectMethod.html#signevent) SignEvent: "sign\_event" ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Enumeration Members [Connect](https://hzrd149.github.io/applesauce/typedoc/enums/applesauce-signers.Helpers.NostrConnectMethod.html#connect) [CreateAccount](https://hzrd149.github.io/applesauce/typedoc/enums/applesauce-signers.Helpers.NostrConnectMethod.html#createaccount) [GetPublicKey](https://hzrd149.github.io/applesauce/typedoc/enums/applesauce-signers.Helpers.NostrConnectMethod.html#getpublickey) [Nip04Decrypt](https://hzrd149.github.io/applesauce/typedoc/enums/applesauce-signers.Helpers.NostrConnectMethod.html#nip04decrypt) [Nip04Encrypt](https://hzrd149.github.io/applesauce/typedoc/enums/applesauce-signers.Helpers.NostrConnectMethod.html#nip04encrypt) [Nip44Decrypt](https://hzrd149.github.io/applesauce/typedoc/enums/applesauce-signers.Helpers.NostrConnectMethod.html#nip44decrypt) [Nip44Encrypt](https://hzrd149.github.io/applesauce/typedoc/enums/applesauce-signers.Helpers.NostrConnectMethod.html#nip44encrypt) [SignEvent](https://hzrd149.github.io/applesauce/typedoc/enums/applesauce-signers.Helpers.NostrConnectMethod.html#signevent) --- # ChannelMetadataModel | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Models](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html) * [ChannelMetadataModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.ChannelMetadataModel.html) Function ChannelMetadataModel ============================= * ChannelMetadataModel(channel: Event): [Model](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Model.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.ChannelMetadataModel.html#channelmetadatamodel) A model that returns the latest parsed metadata #### Parameters * channel: Event #### Returns [Model](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Model.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # createETagWithMarkerFromEventPointer | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html) * [createETagWithMarkerFromEventPointer](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.createETagWithMarkerFromEventPointer.html) Function createETagWithMarkerFromEventPointer ============================================= * createETagWithMarkerFromEventPointer(     pointer: EventPointer,     marker?: [Nip10TagMarker](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Helpers.Nip10TagMarker.html) , ): [NameValueTag](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.NameValueTag.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.createETagWithMarkerFromEventPointer.html#createetagwithmarkerfromeventpointer) Returns a tag for an event pointer with a marker #### Parameters * pointer: EventPointer * `Optional`marker: [Nip10TagMarker](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Helpers.Nip10TagMarker.html) #### Returns [NameValueTag](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.NameValueTag.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # NostrPublishMethod | AppleSauce * [applesauce-wallet-connect](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html) * [NostrPublishMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.NostrPublishMethod.html) Type Alias NostrPublishMethod ============================= NostrPublishMethod: (     relays: string\[\],     event: NostrEvent, ) \=> Promise | Observable A method used for publishing an event, can return a Promise that completes when published or an Observable that completes when published #### Type declaration * * (relays: string\[\], event: NostrEvent): Promise | Observable * #### Parameters * relays: string\[\] * event: NostrEvent #### Returns Promise | Observable ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # LRU | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [LRU](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html) Class LRU ============ Copied from tiny-lru and modified to support typescript #### See[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#see) [https://github.com/avoidwork/tiny-lru/blob/master/src/lru.js](https://github.com/avoidwork/tiny-lru/blob/master/src/lru.js) #### Type Parameters * T extends unknown ##### Index ### Constructors [constructor](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#constructor) ### Properties [first](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#first) [items](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#items) [last](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#last) [max](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#max) [resetTtl](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#resetttl) [size](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#size) [ttl](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#ttl) ### Methods [clear](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#clear) [delete](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#delete) [entries](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#entries) [evict](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#evict) [expiresAt](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#expiresat) [get](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#get) [has](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#has) [keys](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#keys) [set](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#set) [values](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#values) Constructors ------------ ### constructor[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#constructor) * new LRU<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#constructorlrut) extends unknown\>(     max?: number,     ttl?: number,     resetTtl?: boolean, ): [LRU](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html) <[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#constructorlrut) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#constructorlru) #### Type Parameters * T extends unknown #### Parameters * max: number = 0 * ttl: number = 0 * resetTtl: boolean = false #### Returns [LRU](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html) <[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#constructorlrut) \> Properties ---------- ### first[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#first) first: null | Item<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#constructorlrut) \> = null ### items[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#items) items: Record\> = ... ### last[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#last) last: null | Item<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#constructorlrut) \> = null ### max[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#max) max: number ### resetTtl[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#resetttl) resetTtl: boolean ### size[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#size) size: number ### ttl[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#ttl) ttl: number Methods ------- ### clear[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#clear) * clear(): [LRU](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html) <[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#constructorlrut) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#clear-1) #### Returns [LRU](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html) <[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#constructorlrut) \> ### delete[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#delete) * delete(key: string): [LRU](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html) <[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#constructorlrut) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#delete-1) #### Parameters * key: string #### Returns [LRU](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html) <[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#constructorlrut) \> ### entries[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#entries) * entries(keys?: string\[\]): (undefined | string | [T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#constructorlrut) )\[\]\[\][](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#entries-1) #### Parameters * keys: string\[\] = ... #### Returns (undefined | string | [T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#constructorlrut) )\[\]\[\] ### evict[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#evict) * evict(bypass?: boolean): [LRU](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html) <[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#constructorlrut) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#evict-1) #### Parameters * bypass: boolean = false #### Returns [LRU](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html) <[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#constructorlrut) \> ### expiresAt[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#expiresat) * expiresAt(key: string): undefined | number[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#expiresat-1) #### Parameters * key: string #### Returns undefined | number ### get[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#get) * get(key: string): undefined | [T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#constructorlrut) [](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#get-1) #### Parameters * key: string #### Returns undefined | [T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#constructorlrut) ### has[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#has) * has(key: string): boolean[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#has-1) #### Parameters * key: string #### Returns boolean ### keys[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#keys) * keys(): string\[\][](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#keys-1) #### Returns string\[\] ### set[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#set) * set(key: string, value: [T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#constructorlrut) , bypass?: boolean, resetTtl?: boolean): [LRU](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html) <[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#constructorlrut) \>[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#set-1) #### Parameters * key: string * value: [T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#constructorlrut) * bypass: boolean = false * resetTtl: boolean = ... #### Returns [LRU](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html) <[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#constructorlrut) \> ### values[](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#values) * values(keys?: string\[\]): NonNullable<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#constructorlrut) \>\[\][](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#values-1) #### Parameters * keys: string\[\] = ... #### Returns NonNullable<[T](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#constructorlrut) \>\[\] ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Constructors [constructor](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#constructor) Properties [first](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#first) [items](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#items) [last](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#last) [max](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#max) [resetTtl](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#resetttl) [size](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#size) [ttl](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#ttl) Methods [clear](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#clear) [delete](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#delete) [entries](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#entries) [evict](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#evict) [expiresAt](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#expiresat) [get](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#get) [has](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#has) [keys](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#keys) [set](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#set) [values](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-core.Helpers.LRU.html#values) --- # PollResponseBlueprintOptions | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Blueprints](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html) * [PollResponseBlueprintOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Blueprints.PollResponseBlueprintOptions.html) Type Alias PollResponseBlueprintOptions ======================================= PollResponseBlueprintOptions: [MetaTagOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Operations.MetaTagOptions.html) & { comment?: string } ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # completeOnEose | AppleSauce * [applesauce-relay](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-relay.html) * [completeOnEose](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-relay.completeOnEose.html) Function completeOnEose ======================= * completeOnEose(     includeEose: true, ): MonoTypeOperatorFunction<[SubscriptionResponse](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.SubscriptionResponse.html) \>[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-relay.completeOnEose.html#completeoneose) #### Parameters * includeEose: true #### Returns MonoTypeOperatorFunction<[SubscriptionResponse](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.SubscriptionResponse.html) \> * completeOnEose(): OperatorFunction<[SubscriptionResponse](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.SubscriptionResponse.html) , Event\>[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-relay.completeOnEose.html#completeoneose-1) #### Returns OperatorFunction<[SubscriptionResponse](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.SubscriptionResponse.html) , Event\> * completeOnEose(     includeEose: false, ): OperatorFunction<[SubscriptionResponse](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.SubscriptionResponse.html) , Event\>[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-relay.completeOnEose.html#completeoneose-2) #### Parameters * includeEose: false #### Returns OperatorFunction<[SubscriptionResponse](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.SubscriptionResponse.html) , Event\> ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # WalletServiceHandlers | AppleSauce * [applesauce-wallet-connect](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html) * [WalletServiceHandlers](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceHandlers.html) Interface WalletServiceHandlers =============================== Map of method handlers for the wallet service interface WalletServiceHandlers {     [get\_balance](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceHandlers.html#get_balance) ?: [GetBalanceHandler](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.GetBalanceHandler.html) ;     [get\_info](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceHandlers.html#get_info) ?: [GetInfoHandler](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.GetInfoHandler.html) ;     [list\_transactions](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceHandlers.html#list_transactions) ?: [ListTransactionsHandler](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.ListTransactionsHandler.html) ;     [lookup\_invoice](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceHandlers.html#lookup_invoice) ?: [LookupInvoiceHandler](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.LookupInvoiceHandler.html) ;     [make\_invoice](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceHandlers.html#make_invoice) ?: [MakeInvoiceHandler](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.MakeInvoiceHandler.html) ;     [multi\_pay\_invoice](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceHandlers.html#multi_pay_invoice) ?: [MultiPayInvoiceHandler](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.MultiPayInvoiceHandler.html) ;     [multi\_pay\_keysend](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceHandlers.html#multi_pay_keysend) ?: [MultiPayKeysendHandler](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.MultiPayKeysendHandler.html) ;     [pay\_invoice](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceHandlers.html#pay_invoice) ?: [PayInvoiceHandler](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.PayInvoiceHandler.html) ;     [pay\_keysend](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceHandlers.html#pay_keysend) ?: [PayKeysendHandler](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.PayKeysendHandler.html) ; } ##### Index ### Properties [get\_balance?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceHandlers.html#get_balance) [get\_info?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceHandlers.html#get_info) [list\_transactions?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceHandlers.html#list_transactions) [lookup\_invoice?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceHandlers.html#lookup_invoice) [make\_invoice?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceHandlers.html#make_invoice) [multi\_pay\_invoice?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceHandlers.html#multi_pay_invoice) [multi\_pay\_keysend?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceHandlers.html#multi_pay_keysend) [pay\_invoice?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceHandlers.html#pay_invoice) [pay\_keysend?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceHandlers.html#pay_keysend) Properties ---------- ### `Optional`get\_balance[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceHandlers.html#get_balance) get\_balance?: [GetBalanceHandler](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.GetBalanceHandler.html) ### `Optional`get\_info[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceHandlers.html#get_info) get\_info?: [GetInfoHandler](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.GetInfoHandler.html) ### `Optional`list\_transactions[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceHandlers.html#list_transactions) list\_transactions?: [ListTransactionsHandler](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.ListTransactionsHandler.html) ### `Optional`lookup\_invoice[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceHandlers.html#lookup_invoice) lookup\_invoice?: [LookupInvoiceHandler](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.LookupInvoiceHandler.html) ### `Optional`make\_invoice[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceHandlers.html#make_invoice) make\_invoice?: [MakeInvoiceHandler](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.MakeInvoiceHandler.html) ### `Optional`multi\_pay\_invoice[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceHandlers.html#multi_pay_invoice) multi\_pay\_invoice?: [MultiPayInvoiceHandler](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.MultiPayInvoiceHandler.html) ### `Optional`multi\_pay\_keysend[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceHandlers.html#multi_pay_keysend) multi\_pay\_keysend?: [MultiPayKeysendHandler](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.MultiPayKeysendHandler.html) ### `Optional`pay\_invoice[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceHandlers.html#pay_invoice) pay\_invoice?: [PayInvoiceHandler](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.PayInvoiceHandler.html) ### `Optional`pay\_keysend[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceHandlers.html#pay_keysend) pay\_keysend?: [PayKeysendHandler](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.PayKeysendHandler.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [get\_balance](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceHandlers.html#get_balance) [get\_info](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceHandlers.html#get_info) [list\_transactions](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceHandlers.html#list_transactions) [lookup\_invoice](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceHandlers.html#lookup_invoice) [make\_invoice](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceHandlers.html#make_invoice) [multi\_pay\_invoice](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceHandlers.html#multi_pay_invoice) [multi\_pay\_keysend](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceHandlers.html#multi_pay_keysend) [pay\_invoice](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceHandlers.html#pay_invoice) [pay\_keysend](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceHandlers.html#pay_keysend) --- # AddEventToCalendar | AppleSauce * [applesauce-actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.html) * [Actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html) * [AddEventToCalendar](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.AddEventToCalendar.html) Function AddEventToCalendar =========================== * AddEventToCalendar(calendar: Event, event: Event): [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.AddEventToCalendar.html#addeventtocalendar) Adds a calendar event to a calendar #### Parameters * calendar: Event * event: Event #### Returns [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # NutzapEvent | AppleSauce * [applesauce-wallet](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.html) * [Actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.Actions.html) * [NutzapEvent](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet.Actions.NutzapEvent.html) Function NutzapEvent ==================== * NutzapEvent(event: Event, token: Token, comment?: string): [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet.Actions.NutzapEvent.html#nutzapevent) Creates a NIP-61 nutzap event for an event with a token #### Parameters * event: Event * token: Token * `Optional`comment: string #### Returns [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # Client | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Operations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html) * [Client](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Client.html) Namespace Client ================ Functions --------- [setClient](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.Client.setClient.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Client.html#setclient) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Functions [setClient](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Client.html#setclient) --- # addEventTag | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Operations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html) * [TagOperations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html) * [addEventTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.addEventTag.html) Function addEventTag ==================== * addEventTag(id: string | EventPointer, replace?: boolean): [TagOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.TagOperation.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.addEventTag.html#addeventtag) Adds a a single "e" tag for an EventPointer #### Parameters * id: string | EventPointer * replace: boolean = true #### Returns [TagOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.TagOperation.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # ConnectResponseResults | AppleSauce * [applesauce-signers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.Helpers.html) * [ConnectResponseResults](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.ConnectResponseResults.html) Type Alias ConnectResponseResults ================================= type ConnectResponseResults \= {     [connect](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.ConnectResponseResults.html#connect) : "ack" | string;     [create\_account](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.ConnectResponseResults.html#create_account) : string;     [get\_public\_key](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.ConnectResponseResults.html#get_public_key) : string;     [nip04\_decrypt](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.ConnectResponseResults.html#nip04_decrypt) : string;     [nip04\_encrypt](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.ConnectResponseResults.html#nip04_encrypt) : string;     [nip44\_decrypt](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.ConnectResponseResults.html#nip44_decrypt) : string;     [nip44\_encrypt](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.ConnectResponseResults.html#nip44_encrypt) : string;     [sign\_event](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.ConnectResponseResults.html#sign_event) : string; } ##### Index ### Properties [connect](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.ConnectResponseResults.html#connect) [create\_account](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.ConnectResponseResults.html#create_account) [get\_public\_key](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.ConnectResponseResults.html#get_public_key) [nip04\_decrypt](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.ConnectResponseResults.html#nip04_decrypt) [nip04\_encrypt](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.ConnectResponseResults.html#nip04_encrypt) [nip44\_decrypt](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.ConnectResponseResults.html#nip44_decrypt) [nip44\_encrypt](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.ConnectResponseResults.html#nip44_encrypt) [sign\_event](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.ConnectResponseResults.html#sign_event) Properties ---------- ### connect[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.ConnectResponseResults.html#connect) connect: "ack" | string ### create\_account[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.ConnectResponseResults.html#create_account) create\_account: string ### get\_public\_key[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.ConnectResponseResults.html#get_public_key) get\_public\_key: string ### nip04\_decrypt[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.ConnectResponseResults.html#nip04_decrypt) nip04\_decrypt: string ### nip04\_encrypt[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.ConnectResponseResults.html#nip04_encrypt) nip04\_encrypt: string ### nip44\_decrypt[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.ConnectResponseResults.html#nip44_decrypt) nip44\_decrypt: string ### nip44\_encrypt[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.ConnectResponseResults.html#nip44_encrypt) nip44\_encrypt: string ### sign\_event[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.ConnectResponseResults.html#sign_event) sign\_event: string ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [connect](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.ConnectResponseResults.html#connect) [create\_account](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.ConnectResponseResults.html#create_account) [get\_public\_key](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.ConnectResponseResults.html#get_public_key) [nip04\_decrypt](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.ConnectResponseResults.html#nip04_decrypt) [nip04\_encrypt](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.ConnectResponseResults.html#nip04_encrypt) [nip44\_decrypt](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.ConnectResponseResults.html#nip44_decrypt) [nip44\_encrypt](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.ConnectResponseResults.html#nip44_encrypt) [sign\_event](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.ConnectResponseResults.html#sign_event) --- # ChannelMutedModel | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Models](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html) * [ChannelMutedModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.ChannelMutedModel.html) Function ChannelMutedModel ========================== * ChannelMutedModel(     channel: Event,     authors?: string\[\], ): [Model](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Model.html) \>[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.ChannelMutedModel.html#channelmutedmodel) A model that returns a map of muted users Map #### Parameters * channel: Event * authors: string\[\] = \[\] #### Returns [Model](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Model.html) \> ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # createGroupHTagFromGroupPointer | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html) * [createGroupHTagFromGroupPointer](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.createGroupHTagFromGroupPointer.html) Function createGroupHTagFromGroupPointer ======================================== * createGroupHTagFromGroupPointer(group: [GroupPointer](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.GroupPointer.html) ): [NameValueTag](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.NameValueTag.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.createGroupHTagFromGroupPointer.html#creategrouphtagfromgrouppointer) Creates a "h" tag for chat messages from a [GroupPointer](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.GroupPointer.html) #### Parameters * group: [GroupPointer](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.GroupPointer.html) #### Returns [NameValueTag](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.NameValueTag.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # EncryptedContentCache | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [EncryptedContentCache](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.Helpers.EncryptedContentCache.html) Interface EncryptedContentCache =============================== An interface that is used to cache encrypted content on events interface EncryptedContentCache {     [getItem](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.Helpers.EncryptedContentCache.html#getitem) : (key: string) \=> Promise;     [setItem](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.Helpers.EncryptedContentCache.html#setitem) : (key: string, value: string) \=> Promise; } ##### Index ### Properties [getItem](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.Helpers.EncryptedContentCache.html#getitem) [setItem](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.Helpers.EncryptedContentCache.html#setitem) Properties ---------- ### getItem[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.Helpers.EncryptedContentCache.html#getitem) getItem: (key: string) \=> Promise ### setItem[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.Helpers.EncryptedContentCache.html#setitem) setItem: (key: string, value: string) \=> Promise ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [getItem](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.Helpers.EncryptedContentCache.html#getitem) [setItem](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.Helpers.EncryptedContentCache.html#setitem) --- # NostrSubscriptionMethod | AppleSauce * [applesauce-wallet-connect](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html) * [NostrSubscriptionMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.NostrSubscriptionMethod.html) Type Alias NostrSubscriptionMethod ================================== NostrSubscriptionMethod: (     relays: string\[\],     filters: Filter\[\], ) \=> Observable A method used to subscribe to events on a set of relays #### Type declaration * * (relays: string\[\], filters: Filter\[\]): Observable * #### Parameters * relays: string\[\] * filters: Filter\[\] #### Returns Observable ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # markFromRelay | AppleSauce * [applesauce-relay](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-relay.html) * [markFromRelay](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-relay.markFromRelay.html) Function markFromRelay ====================== * markFromRelay(relay: string): MonoTypeOperatorFunction<[SubscriptionResponse](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.SubscriptionResponse.html) \>[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-relay.markFromRelay.html#markfromrelay) Marks all events as from the relay #### Parameters * relay: string #### Returns MonoTypeOperatorFunction<[SubscriptionResponse](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.SubscriptionResponse.html) \> ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # WalletServiceOptions | AppleSauce * [applesauce-wallet-connect](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html) * [WalletServiceOptions](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceOptions.html) Interface WalletServiceOptions ============================== Options for creating a WalletService interface WalletServiceOptions {     [client](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceOptions.html#client) ?: string;     [handlers](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceOptions.html#handlers) : [WalletServiceHandlers](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceHandlers.html) ;     [notifications](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceOptions.html#notifications) ?: [NotificationType](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.NotificationType.html) \[\];     [pool](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceOptions.html#pool) ?: [NostrPool](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.NostrPool.html) ;     [publishMethod](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceOptions.html#publishmethod) ?: [NostrPublishMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.NostrPublishMethod.html) ;     [relays](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceOptions.html#relays) : string\[\];     [secret](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceOptions.html#secret) ?: Uint8Array;     [signer](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceOptions.html#signer) : [EventSigner](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EventSigner.html) ;     [subscriptionMethod](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceOptions.html#subscriptionmethod) ?: [NostrSubscriptionMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.NostrSubscriptionMethod.html) ; } ##### Index ### Properties [client?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceOptions.html#client) [handlers](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceOptions.html#handlers) [notifications?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceOptions.html#notifications) [pool?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceOptions.html#pool) [publishMethod?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceOptions.html#publishmethod) [relays](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceOptions.html#relays) [secret?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceOptions.html#secret) [signer](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceOptions.html#signer) [subscriptionMethod?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceOptions.html#subscriptionmethod) Properties ---------- ### `Optional`client[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceOptions.html#client) client?: string The client's public key (used for restoring the service) ### handlers[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceOptions.html#handlers) handlers: [WalletServiceHandlers](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceHandlers.html) Map of method handlers ### `Optional`notifications[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceOptions.html#notifications) notifications?: [NotificationType](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.NotificationType.html) \[\] An array of notifications this wallet supports ### `Optional`pool[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceOptions.html#pool) pool?: [NostrPool](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.NostrPool.html) An optional pool for connection methods ### `Optional`publishMethod[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceOptions.html#publishmethod) publishMethod?: [NostrPublishMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.NostrPublishMethod.html) An optional method for publishing events ### relays[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceOptions.html#relays) relays: string\[\] The relays to use for the service ### `Optional`secret[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceOptions.html#secret) secret?: Uint8Array The client's secret key ### signer[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceOptions.html#signer) signer: [EventSigner](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.EventSigner.html) The signer to use for creating and unlocking events ### `Optional`subscriptionMethod[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceOptions.html#subscriptionmethod) subscriptionMethod?: [NostrSubscriptionMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.NostrSubscriptionMethod.html) An optional method for subscribing to relays ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [client](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceOptions.html#client) [handlers](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceOptions.html#handlers) [notifications](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceOptions.html#notifications) [pool](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceOptions.html#pool) [publishMethod](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceOptions.html#publishmethod) [relays](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceOptions.html#relays) [secret](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceOptions.html#secret) [signer](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceOptions.html#signer) [subscriptionMethod](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.WalletServiceOptions.html#subscriptionmethod) --- # ShareBlueprintOptions | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Blueprints](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html) * [ShareBlueprintOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Blueprints.ShareBlueprintOptions.html) Type Alias ShareBlueprintOptions ================================ ShareBlueprintOptions: [MetaTagOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Operations.MetaTagOptions.html) & [ZapOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Operations.Zap.ZapOptions.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # Helpers | AppleSauce * [applesauce-wallet-connect](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html) Namespace Helpers ================= Interfaces ---------- [BaseNotification](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.BaseNotification.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#basenotification) [BaseWalletRequest](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.BaseWalletRequest.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#basewalletrequest) [GetBalanceParams](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.GetBalanceParams.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#getbalanceparams) [GetBalanceResult](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.GetBalanceResult.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#getbalanceresult) [GetInfoParams](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.GetInfoParams.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#getinfoparams) [GetInfoResult](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.GetInfoResult.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#getinforesult) [ListTransactionsParams](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.ListTransactionsParams.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#listtransactionsparams) [ListTransactionsResult](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.ListTransactionsResult.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#listtransactionsresult) [LookupInvoiceParams](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.LookupInvoiceParams.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#lookupinvoiceparams) [MakeInvoiceParams](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.MakeInvoiceParams.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#makeinvoiceparams) [MultiPayInvoiceParams](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.MultiPayInvoiceParams.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#multipayinvoiceparams) [MultiPayInvoiceResult](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.MultiPayInvoiceResult.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#multipayinvoiceresult) [MultiPayKeysendParams](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.MultiPayKeysendParams.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#multipaykeysendparams) [MultiPayKeysendResult](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.MultiPayKeysendResult.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#multipaykeysendresult) [PayInvoiceParams](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.PayInvoiceParams.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#payinvoiceparams) [PayInvoiceResult](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.PayInvoiceResult.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#payinvoiceresult) [PayKeysendParams](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.PayKeysendParams.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#paykeysendparams) [PayKeysendResult](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.PayKeysendResult.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#paykeysendresult) [TLVRecord](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.TLVRecord.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#tlvrecord) [Transaction](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.Transaction.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#transaction) [WalletAuthURI](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletAuthURI.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#walletauthuri) [WalletConnectURI](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletConnectURI.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#walletconnecturi) [WalletResponseError](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletResponseError.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#walletresponseerror) [WalletSupport](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletSupport.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#walletsupport) Type Aliases ------------ [BaseWalletResponse](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.BaseWalletResponse.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#basewalletresponse) [GetBalanceRequest](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.GetBalanceRequest.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#getbalancerequest) [GetBalanceResponse](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.GetBalanceResponse.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#getbalanceresponse) [GetInfoRequest](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.GetInfoRequest.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#getinforequest) [GetInfoResponse](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.GetInfoResponse.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#getinforesponse) [ListTransactionsRequest](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.ListTransactionsRequest.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#listtransactionsrequest) [ListTransactionsResponse](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.ListTransactionsResponse.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#listtransactionsresponse) [LookupInvoiceRequest](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.LookupInvoiceRequest.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#lookupinvoicerequest) [LookupInvoiceResponse](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.LookupInvoiceResponse.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#lookupinvoiceresponse) [LookupInvoiceResult](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.LookupInvoiceResult.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#lookupinvoiceresult) [MakeInvoiceRequest](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.MakeInvoiceRequest.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#makeinvoicerequest) [MakeInvoiceResponse](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.MakeInvoiceResponse.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#makeinvoiceresponse) [MakeInvoiceResult](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.MakeInvoiceResult.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#makeinvoiceresult) [MultiPayInvoiceRequest](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.MultiPayInvoiceRequest.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#multipayinvoicerequest) [MultiPayInvoiceResponse](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.MultiPayInvoiceResponse.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#multipayinvoiceresponse) [MultiPayKeysendRequest](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.MultiPayKeysendRequest.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#multipaykeysendrequest) [MultiPayKeysendResponse](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.MultiPayKeysendResponse.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#multipaykeysendresponse) [NotificationType](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.NotificationType.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#notificationtype) [PayInvoiceRequest](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.PayInvoiceRequest.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#payinvoicerequest) [PayInvoiceResponse](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.PayInvoiceResponse.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#payinvoiceresponse) [PayKeysendRequest](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.PayKeysendRequest.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#paykeysendrequest) [PayKeysendResponse](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.PayKeysendResponse.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#paykeysendresponse) [PaymentReceivedNotification](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.PaymentReceivedNotification.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#paymentreceivednotification) [PaymentSentNotification](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.PaymentSentNotification.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#paymentsentnotification) [WalletConnectEncryptionMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.WalletConnectEncryptionMethod.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#walletconnectencryptionmethod) [WalletMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.WalletMethod.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#walletmethod) [WalletNotification](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.WalletNotification.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#walletnotification) [WalletRequest](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.WalletRequest.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#walletrequest) [WalletResponse](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.WalletResponse.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#walletresponse) Variables --------- [WALLET\_INFO\_KIND](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-wallet-connect.Helpers.WALLET_INFO_KIND.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#wallet_info_kind) [WALLET\_LEGACY\_NOTIFICATION\_KIND](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-wallet-connect.Helpers.WALLET_LEGACY_NOTIFICATION_KIND.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#wallet_legacy_notification_kind) [WALLET\_NOTIFICATION\_KIND](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-wallet-connect.Helpers.WALLET_NOTIFICATION_KIND.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#wallet_notification_kind) [WALLET\_REQUEST\_KIND](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-wallet-connect.Helpers.WALLET_REQUEST_KIND.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#wallet_request_kind) [WALLET\_RESPONSE\_KIND](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-wallet-connect.Helpers.WALLET_RESPONSE_KIND.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#wallet_response_kind) [WalletInfoSymbol](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-wallet-connect.Helpers.WalletInfoSymbol.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#walletinfosymbol) [WalletNotificationSymbol](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-wallet-connect.Helpers.WalletNotificationSymbol.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#walletnotificationsymbol) [WalletRequestSymbol](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-wallet-connect.Helpers.WalletRequestSymbol.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#walletrequestsymbol) [WalletResponseSymbol](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-wallet-connect.Helpers.WalletResponseSymbol.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#walletresponsesymbol) Functions --------- [createWalletAuthURI](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet-connect.Helpers.createWalletAuthURI.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#createwalletauthuri) [createWalletConnectURI](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet-connect.Helpers.createWalletConnectURI.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#createwalletconnecturi) [getEncryptionMethods](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet-connect.Helpers.getEncryptionMethods.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#getencryptionmethods) [getPreferredEncryption](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet-connect.Helpers.getPreferredEncryption.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#getpreferredencryption) [getSupportedMethods](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet-connect.Helpers.getSupportedMethods.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#getsupportedmethods) [getSupportedNotifications](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet-connect.Helpers.getSupportedNotifications.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#getsupportednotifications) [getWalletNotification](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet-connect.Helpers.getWalletNotification.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#getwalletnotification) [getWalletRequest](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet-connect.Helpers.getWalletRequest.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#getwalletrequest) [getWalletRequestEncryption](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet-connect.Helpers.getWalletRequestEncryption.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#getwalletrequestencryption) [getWalletRequestExpiration](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet-connect.Helpers.getWalletRequestExpiration.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#getwalletrequestexpiration) [getWalletRequestServicePubkey](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet-connect.Helpers.getWalletRequestServicePubkey.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#getwalletrequestservicepubkey) [getWalletResponse](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet-connect.Helpers.getWalletResponse.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#getwalletresponse) [getWalletResponseClientPubkey](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet-connect.Helpers.getWalletResponseClientPubkey.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#getwalletresponseclientpubkey) [getWalletResponseRequestId](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet-connect.Helpers.getWalletResponseRequestId.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#getwalletresponserequestid) [getWalletSupport](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet-connect.Helpers.getWalletSupport.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#getwalletsupport) [isWalletNotificationLocked](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet-connect.Helpers.isWalletNotificationLocked.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#iswalletnotificationlocked) [isWalletRequestExpired](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet-connect.Helpers.isWalletRequestExpired.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#iswalletrequestexpired) [isWalletRequestLocked](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet-connect.Helpers.isWalletRequestLocked.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#iswalletrequestlocked) [isWalletResponseLocked](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet-connect.Helpers.isWalletResponseLocked.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#iswalletresponselocked) [parseWalletAuthURI](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet-connect.Helpers.parseWalletAuthURI.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#parsewalletauthuri) [parseWalletConnectURI](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet-connect.Helpers.parseWalletConnectURI.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#parsewalletconnecturi) [supportsEncryption](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet-connect.Helpers.supportsEncryption.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#supportsencryption) [supportsMethod](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet-connect.Helpers.supportsMethod.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#supportsmethod) [supportsNotifications](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet-connect.Helpers.supportsNotifications.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#supportsnotifications) [supportsNotificationType](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet-connect.Helpers.supportsNotificationType.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#supportsnotificationtype) [unlockWalletNotification](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet-connect.Helpers.unlockWalletNotification.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#unlockwalletnotification) [unlockWalletRequest](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet-connect.Helpers.unlockWalletRequest.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#unlockwalletrequest) [unlockWalletResponse](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet-connect.Helpers.unlockWalletResponse.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#unlockwalletresponse) [validateWalletAuthURI](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet-connect.Helpers.validateWalletAuthURI.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#validatewalletauthuri) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Interfaces [BaseNotification](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#basenotification) [BaseWalletRequest](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#basewalletrequest) [GetBalanceParams](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#getbalanceparams) [GetBalanceResult](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#getbalanceresult) [GetInfoParams](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#getinfoparams) [GetInfoResult](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#getinforesult) [ListTransactionsParams](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#listtransactionsparams) [ListTransactionsResult](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#listtransactionsresult) [LookupInvoiceParams](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#lookupinvoiceparams) [MakeInvoiceParams](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#makeinvoiceparams) [MultiPayInvoiceParams](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#multipayinvoiceparams) [MultiPayInvoiceResult](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#multipayinvoiceresult) [MultiPayKeysendParams](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#multipaykeysendparams) [MultiPayKeysendResult](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#multipaykeysendresult) [PayInvoiceParams](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#payinvoiceparams) [PayInvoiceResult](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#payinvoiceresult) [PayKeysendParams](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#paykeysendparams) [PayKeysendResult](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#paykeysendresult) [TLVRecord](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#tlvrecord) [Transaction](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#transaction) [WalletAuthURI](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#walletauthuri) [WalletConnectURI](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#walletconnecturi) [WalletResponseError](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#walletresponseerror) [WalletSupport](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#walletsupport) Type Aliases [BaseWalletResponse](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#basewalletresponse) [GetBalanceRequest](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#getbalancerequest) [GetBalanceResponse](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#getbalanceresponse) [GetInfoRequest](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#getinforequest) [GetInfoResponse](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#getinforesponse) [ListTransactionsRequest](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#listtransactionsrequest) [ListTransactionsResponse](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#listtransactionsresponse) [LookupInvoiceRequest](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#lookupinvoicerequest) [LookupInvoiceResponse](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#lookupinvoiceresponse) [LookupInvoiceResult](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#lookupinvoiceresult) [MakeInvoiceRequest](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#makeinvoicerequest) [MakeInvoiceResponse](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#makeinvoiceresponse) [MakeInvoiceResult](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#makeinvoiceresult) [MultiPayInvoiceRequest](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#multipayinvoicerequest) [MultiPayInvoiceResponse](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#multipayinvoiceresponse) [MultiPayKeysendRequest](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#multipaykeysendrequest) [MultiPayKeysendResponse](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#multipaykeysendresponse) [NotificationType](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#notificationtype) [PayInvoiceRequest](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#payinvoicerequest) [PayInvoiceResponse](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#payinvoiceresponse) [PayKeysendRequest](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#paykeysendrequest) [PayKeysendResponse](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#paykeysendresponse) [PaymentReceivedNotification](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#paymentreceivednotification) [PaymentSentNotification](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#paymentsentnotification) [WalletConnectEncryptionMethod](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#walletconnectencryptionmethod) [WalletMethod](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#walletmethod) [WalletNotification](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#walletnotification) [WalletRequest](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#walletrequest) [WalletResponse](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#walletresponse) Variables [WALLET\_INFO\_KIND](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#wallet_info_kind) [WALLET\_LEGACY\_NOTIFICATION\_KIND](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#wallet_legacy_notification_kind) [WALLET\_NOTIFICATION\_KIND](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#wallet_notification_kind) [WALLET\_REQUEST\_KIND](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#wallet_request_kind) [WALLET\_RESPONSE\_KIND](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#wallet_response_kind) [WalletInfoSymbol](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#walletinfosymbol) [WalletNotificationSymbol](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#walletnotificationsymbol) [WalletRequestSymbol](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#walletrequestsymbol) [WalletResponseSymbol](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#walletresponsesymbol) Functions [createWalletAuthURI](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#createwalletauthuri) [createWalletConnectURI](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#createwalletconnecturi) [getEncryptionMethods](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#getencryptionmethods) [getPreferredEncryption](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#getpreferredencryption) [getSupportedMethods](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#getsupportedmethods) [getSupportedNotifications](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#getsupportednotifications) [getWalletNotification](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#getwalletnotification) [getWalletRequest](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#getwalletrequest) [getWalletRequestEncryption](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#getwalletrequestencryption) [getWalletRequestExpiration](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#getwalletrequestexpiration) [getWalletRequestServicePubkey](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#getwalletrequestservicepubkey) [getWalletResponse](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#getwalletresponse) [getWalletResponseClientPubkey](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#getwalletresponseclientpubkey) [getWalletResponseRequestId](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#getwalletresponserequestid) [getWalletSupport](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#getwalletsupport) [isWalletNotificationLocked](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#iswalletnotificationlocked) [isWalletRequestExpired](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#iswalletrequestexpired) [isWalletRequestLocked](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#iswalletrequestlocked) [isWalletResponseLocked](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#iswalletresponselocked) [parseWalletAuthURI](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#parsewalletauthuri) [parseWalletConnectURI](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#parsewalletconnecturi) [supportsEncryption](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#supportsencryption) [supportsMethod](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#supportsmethod) [supportsNotifications](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#supportsnotifications) [supportsNotificationType](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#supportsnotificationtype) [unlockWalletNotification](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#unlockwalletnotification) [unlockWalletRequest](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#unlockwalletrequest) [unlockWalletResponse](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#unlockwalletresponse) [validateWalletAuthURI](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html#validatewalletauthuri) --- # AddFavoriteRelay | AppleSauce * [applesauce-actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.html) * [Actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html) * [AddFavoriteRelay](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.AddFavoriteRelay.html) Function AddFavoriteRelay ========================= * AddFavoriteRelay(relay: string | string\[\], hidden?: boolean): [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.AddFavoriteRelay.html#addfavoriterelay) An action that adds a relay to the 10012 favorite relays event #### Parameters * relay: string | string\[\] * hidden: boolean = false #### Returns [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # NutzapProfile | AppleSauce * [applesauce-wallet](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.html) * [Actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.Actions.html) * [NutzapProfile](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet.Actions.NutzapProfile.html) Function NutzapProfile ====================== * NutzapProfile(     user: string | ProfilePointer,     token: Token,     comment?: string, ): [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet.Actions.NutzapProfile.html#nutzapprofile) Creates a NIP-61 nutzap event to a users profile #### Parameters * user: string | ProfilePointer * token: Token * `Optional`comment: string #### Returns [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # Comment | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Operations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html) * [Comment](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Comment.html) Namespace Comment ================= Functions --------- [setParent](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.Comment.setParent.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Comment.html#setparent) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Functions [setParent](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Comment.html#setparent) --- # addGroupTag | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Operations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html) * [TagOperations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html) * [addGroupTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.addGroupTag.html) Function addGroupTag ==================== * addGroupTag(group: [GroupPointer](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.GroupPointer.html) ): [TagOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.TagOperation.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.addGroupTag.html#addgrouptag) Adds a "group" tag to a list #### Parameters * group: [GroupPointer](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.GroupPointer.html) #### Returns [TagOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.TagOperation.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # CommentsModel | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Models](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html) * [CommentsModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.CommentsModel.html) Function CommentsModel ====================== * CommentsModel(parent: Event): [Model](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Model.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.CommentsModel.html#commentsmodel) A model that returns all NIP-22 comment replies for the event #### Parameters * parent: Event #### Returns [Model](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Model.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # createGroupTagFromGroupPointer | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html) * [createGroupTagFromGroupPointer](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.createGroupTagFromGroupPointer.html) Function createGroupTagFromGroupPointer ======================================= * createGroupTagFromGroupPointer(group: [GroupPointer](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.GroupPointer.html) ): [NameValueTag](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.NameValueTag.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.createGroupTagFromGroupPointer.html#creategrouptagfromgrouppointer) Creates a "group" tag from a [GroupPointer](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.GroupPointer.html) #### Parameters * group: [GroupPointer](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.GroupPointer.html) #### Returns [NameValueTag](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.NameValueTag.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # EncryptedContentSigner | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [EncryptedContentSigner](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.Helpers.EncryptedContentSigner.html) Interface EncryptedContentSigner ================================ interface EncryptedContentSigner {     [nip04](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.Helpers.EncryptedContentSigner.html#nip04) ?: {         decrypt: (             pubkey: string,             ciphertext: string,         ) \=> string | Promise;         encrypt: (pubkey: string, plaintext: string) \=> string | Promise;     };     [nip44](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.Helpers.EncryptedContentSigner.html#nip44) ?: {         decrypt: (             pubkey: string,             ciphertext: string,         ) \=> string | Promise;         encrypt: (pubkey: string, plaintext: string) \=> string | Promise;     }; } #### Hierarchy ([View Summary](https://hzrd149.github.io/applesauce/typedoc/hierarchy.html#applesauce-core.Helpers.EncryptedContentSigner) ) * EncryptedContentSigner * [HiddenContentSigner](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.Helpers.HiddenContentSigner.html) ##### Index ### Properties [nip04?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.Helpers.EncryptedContentSigner.html#nip04) [nip44?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.Helpers.EncryptedContentSigner.html#nip44) Properties ---------- ### `Optional`nip04[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.Helpers.EncryptedContentSigner.html#nip04) nip04?: {     decrypt: (         pubkey: string,         ciphertext: string,     ) \=> string | Promise;     encrypt: (pubkey: string, plaintext: string) \=> string | Promise; } ### `Optional`nip44[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.Helpers.EncryptedContentSigner.html#nip44) nip44?: {     decrypt: (         pubkey: string,         ciphertext: string,     ) \=> string | Promise;     encrypt: (pubkey: string, plaintext: string) \=> string | Promise; } ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [nip04](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.Helpers.EncryptedContentSigner.html#nip04) [nip44](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.Helpers.EncryptedContentSigner.html#nip44) --- # WalletSupport | AppleSauce * [applesauce-wallet-connect](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html) * [WalletSupport](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletSupport.html) Interface WalletSupport ======================= Wallet service capabilities and information interface WalletSupport {     [encryption](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletSupport.html#encryption) : [WalletConnectEncryptionMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.WalletConnectEncryptionMethod.html) \[\];     [methods](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletSupport.html#methods) : [WalletMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.WalletMethod.html) \[\];     [notifications](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletSupport.html#notifications) ?: [NotificationType](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.NotificationType.html) \[\]; } ##### Index ### Properties [encryption](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletSupport.html#encryption) [methods](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletSupport.html#methods) [notifications?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletSupport.html#notifications) Properties ---------- ### encryption[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletSupport.html#encryption) encryption: [WalletConnectEncryptionMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.WalletConnectEncryptionMethod.html) \[\] List of supported encryption methods ### methods[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletSupport.html#methods) methods: [WalletMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.WalletMethod.html) \[\] List of supported methods for this wallet service ### `Optional`notifications[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletSupport.html#notifications) notifications?: [NotificationType](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.NotificationType.html) \[\] List of supported notifications, optional ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [encryption](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletSupport.html#encryption) [methods](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletSupport.html#methods) [notifications](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletSupport.html#notifications) --- # GetBalanceHandler | AppleSauce * [applesauce-wallet-connect](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html) * [GetBalanceHandler](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.GetBalanceHandler.html) Type Alias GetBalanceHandler ============================ GetBalanceHandler: (params: [GetBalanceParams](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.GetBalanceParams.html) ) \=> Promise<[GetBalanceResult](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.GetBalanceResult.html) \> Handler function for get\_balance method #### Type declaration * * (params: [GetBalanceParams](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.GetBalanceParams.html) ): Promise<[GetBalanceResult](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.GetBalanceResult.html) \> * #### Parameters * params: [GetBalanceParams](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.GetBalanceParams.html) #### Returns Promise<[GetBalanceResult](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.GetBalanceResult.html) \> ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # onlyEvents | AppleSauce * [applesauce-relay](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-relay.html) * [onlyEvents](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-relay.onlyEvents.html) Function onlyEvents =================== * onlyEvents(): OperatorFunction<[SubscriptionResponse](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.SubscriptionResponse.html) , Event\>[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-relay.onlyEvents.html#onlyevents) Filter subscription responses and only return the events #### Returns OperatorFunction<[SubscriptionResponse](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.SubscriptionResponse.html) , Event\> ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # WrappedMessageBlueprintOptions | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Blueprints](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html) * [WrappedMessageBlueprintOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Blueprints.WrappedMessageBlueprintOptions.html) Type Alias WrappedMessageBlueprintOptions ========================================= type WrappedMessageBlueprintOptions \= {     [emojis](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Blueprints.WrappedMessageBlueprintOptions.html#emojis) ?: [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) .[Emoji](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.Emoji.html) \[\];     [subject](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Blueprints.WrappedMessageBlueprintOptions.html#subject) ?: string; } ##### Index ### Properties [emojis?](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Blueprints.WrappedMessageBlueprintOptions.html#emojis) [subject?](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Blueprints.WrappedMessageBlueprintOptions.html#subject) Properties ---------- ### `Optional`emojis[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Blueprints.WrappedMessageBlueprintOptions.html#emojis) emojis?: [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) .[Emoji](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.Emoji.html) \[\] ### `Optional`subject[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Blueprints.WrappedMessageBlueprintOptions.html#subject) subject?: string ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [emojis](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Blueprints.WrappedMessageBlueprintOptions.html#emojis) [subject](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Blueprints.WrappedMessageBlueprintOptions.html#subject) --- # AddFavoriteRelaySet | AppleSauce * [applesauce-actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.html) * [Actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html) * [AddFavoriteRelaySet](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.AddFavoriteRelaySet.html) Function AddFavoriteRelaySet ============================ * AddFavoriteRelaySet(     addr: AddressPointer | AddressPointer\[\],     hidden?: boolean, ): [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.AddFavoriteRelaySet.html#addfavoriterelayset) An action that adds a relay set to the 10012 favorite relays event #### Parameters * addr: AddressPointer | AddressPointer\[\] * hidden: boolean = false #### Returns [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # ReceiveToken | AppleSauce * [applesauce-wallet](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.html) * [Actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.Actions.html) * [ReceiveToken](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet.Actions.ReceiveToken.html) Function ReceiveToken ===================== * ReceiveToken(token: Token, redeemed?: string\[\], fee?: number): [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet.Actions.ReceiveToken.html#receivetoken) Adds a cashu token to the wallet and marks a list of nutzaps as redeemed #### Parameters * token: Token the cashu token to add * `Optional`redeemed: string\[\] an array of nutzap event ids to mark as redeemed * `Optional`fee: number #### Returns [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # Content | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Operations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html) * [Content](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Content.html) Namespace Content ================= Type Aliases ------------ [TextContentOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Operations.Content.TextContentOptions.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Content.html#textcontentoptions) Functions --------- [includeContentHashtags](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.Content.includeContentHashtags.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Content.html#includecontenthashtags) [includeEmojis](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.Content.includeEmojis.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Content.html#includeemojis) [includeQuoteTags](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.Content.includeQuoteTags.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Content.html#includequotetags) [repairNostrLinks](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.Content.repairNostrLinks.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Content.html#repairnostrlinks) [setContent](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.Content.setContent.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Content.html#setcontent) [setContentWarning](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.Content.setContentWarning.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Content.html#setcontentwarning) [setEncryptedContent](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.Content.setEncryptedContent.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Content.html#setencryptedcontent) [setHiddenContent](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.Content.setHiddenContent.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Content.html#sethiddencontent) [setShortTextContent](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.Content.setShortTextContent.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Content.html#setshorttextcontent) [tagPubkeyMentions](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.Content.tagPubkeyMentions.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Content.html#tagpubkeymentions) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Type Aliases [TextContentOptions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Content.html#textcontentoptions) Functions [includeContentHashtags](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Content.html#includecontenthashtags) [includeEmojis](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Content.html#includeemojis) [includeQuoteTags](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Content.html#includequotetags) [repairNostrLinks](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Content.html#repairnostrlinks) [setContent](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Content.html#setcontent) [setContentWarning](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Content.html#setcontentwarning) [setEncryptedContent](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Content.html#setencryptedcontent) [setHiddenContent](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Content.html#sethiddencontent) [setShortTextContent](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Content.html#setshorttextcontent) [tagPubkeyMentions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Content.html#tagpubkeymentions) --- # addHashtag | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Operations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html) * [TagOperations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html) * [addHashtag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.addHashtag.html) Function addHashtag =================== * addHashtag(hashtag: string): [TagOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.TagOperation.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.addHashtag.html#addhashtag) Adds a hashtag to the live event #### Parameters * hashtag: string #### Returns [TagOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.TagOperation.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # ContactsModel | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Models](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html) * [ContactsModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.ContactsModel.html) Function ContactsModel ====================== * ContactsModel(user: string | ProfilePointer): [Model](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Model.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.ContactsModel.html#contactsmodel) A model that returns all contacts for a user #### Parameters * user: string | ProfilePointer #### Returns [Model](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Model.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # EncryptionMethods | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [EncryptionMethods](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.Helpers.EncryptionMethods.html) Interface EncryptionMethods =========================== A pair of encryption methods for encrypting and decrypting event content interface EncryptionMethods {     [decrypt](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.Helpers.EncryptionMethods.html#decrypt) : (         pubkey: string,         ciphertext: string,     ) \=> string | Promise;     [encrypt](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.Helpers.EncryptionMethods.html#encrypt) : (pubkey: string, plaintext: string) \=> string | Promise; } ##### Index ### Properties [decrypt](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.Helpers.EncryptionMethods.html#decrypt) [encrypt](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.Helpers.EncryptionMethods.html#encrypt) Properties ---------- ### decrypt[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.Helpers.EncryptionMethods.html#decrypt) decrypt: (pubkey: string, ciphertext: string) \=> string | Promise ### encrypt[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.Helpers.EncryptionMethods.html#encrypt) encrypt: (pubkey: string, plaintext: string) \=> string | Promise ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [decrypt](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.Helpers.EncryptionMethods.html#decrypt) [encrypt](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.Helpers.EncryptionMethods.html#encrypt) --- # NostrPool | AppleSauce * [applesauce-wallet-connect](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html) * [NostrPool](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.NostrPool.html) Type Alias NostrPool ==================== A simple pool type that combines the subscription and publish methods type NostrPool \= {     [publish](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.NostrPool.html#publish) : [NostrPublishMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.NostrPublishMethod.html) ;     [subscription](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.NostrPool.html#subscription) : [NostrSubscriptionMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.NostrSubscriptionMethod.html) ; } ##### Index ### Properties [publish](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.NostrPool.html#publish) [subscription](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.NostrPool.html#subscription) Properties ---------- ### publish[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.NostrPool.html#publish) publish: [NostrPublishMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.NostrPublishMethod.html) ### subscription[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.NostrPool.html#subscription) subscription: [NostrSubscriptionMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.NostrSubscriptionMethod.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [publish](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.NostrPool.html#publish) [subscription](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.NostrPool.html#subscription) --- # GetInfoHandler | AppleSauce * [applesauce-wallet-connect](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html) * [GetInfoHandler](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.GetInfoHandler.html) Type Alias GetInfoHandler ========================= GetInfoHandler: (params: [GetInfoParams](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.GetInfoParams.html) ) \=> Promise<[GetInfoResult](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.GetInfoResult.html) \> Handler function for get\_info method #### Type declaration * * (params: [GetInfoParams](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.GetInfoParams.html) ): Promise<[GetInfoResult](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.GetInfoResult.html) \> * #### Parameters * params: [GetInfoParams](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.GetInfoParams.html) #### Returns Promise<[GetInfoResult](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.GetInfoResult.html) \> ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # ensureAddressPointerTag | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html) * [ensureAddressPointerTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.ensureAddressPointerTag.html) Function ensureAddressPointerTag ================================ * ensureAddressPointerTag(tags: string\[\]\[\], pointer: AddressPointer): string\[\]\[\][](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.ensureAddressPointerTag.html#ensureaddresspointertag) Adds or merges an AddressPointer into a tags list #### Parameters * tags: string\[\]\[\] * pointer: AddressPointer #### Returns string\[\]\[\] ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # CalendarBlueprint | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Blueprints](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html) * [CalendarBlueprint](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.CalendarBlueprint.html) Function CalendarBlueprint ========================== * CalendarBlueprint(     title: string,     events?: (Event | AddressPointer)\[\], ): [EventBlueprint](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventBlueprint.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.CalendarBlueprint.html#calendarblueprint) Creates a calendar event with a title and optional events #### Parameters * title: string * `Optional`events: (Event | AddressPointer)\[\] #### Returns [EventBlueprint](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventBlueprint.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # storeEvents | AppleSauce * [applesauce-relay](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-relay.html) * [storeEvents](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-relay.storeEvents.html) Function storeEvents ==================== * storeEvents(     eventStore: [IEventStore](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html) , ): MonoTypeOperatorFunction<[SubscriptionResponse](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.SubscriptionResponse.html) \>[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-relay.storeEvents.html#storeevents) Sends all events to the event store but does not remove duplicates #### Parameters * eventStore: [IEventStore](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html) #### Returns MonoTypeOperatorFunction<[SubscriptionResponse](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.SubscriptionResponse.html) \> ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # AddInboxRelay | AppleSauce * [applesauce-actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.html) * [Actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html) * [AddInboxRelay](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.AddInboxRelay.html) Function AddInboxRelay ====================== * AddInboxRelay(relay: string | string\[\]): [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.AddInboxRelay.html#addinboxrelay) An action to add an inbox relay to the kind 10002 relay list #### Parameters * relay: string | string\[\] #### Returns [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # Delete | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Operations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html) * [Delete](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Delete.html) Namespace Delete ================ Functions --------- [setDeleteEvents](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.Delete.setDeleteEvents.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Delete.html#setdeleteevents) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Functions [setDeleteEvents](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Delete.html#setdeleteevents) --- # RemoveNutzapInfoMint | AppleSauce * [applesauce-wallet](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.html) * [Actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.Actions.html) * [RemoveNutzapInfoMint](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet.Actions.RemoveNutzapInfoMint.html) Function RemoveNutzapInfoMint ============================= * RemoveNutzapInfoMint(mint: string | string\[\]): [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet.Actions.RemoveNutzapInfoMint.html#removenutzapinfomint) An action to remove a mint from the kind 10019 nutzap info event #### Parameters * mint: string | string\[\] #### Returns [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # addInboxRelay | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Operations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html) * [TagOperations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html) * [addInboxRelay](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.addInboxRelay.html) Function addInboxRelay ====================== * addInboxRelay(url: string | URL): [TagOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.TagOperation.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.addInboxRelay.html#addinboxrelay) Adds an inbox relay in NIP-65 mailboxes #### Parameters * url: string | URL #### Returns [TagOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.TagOperation.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # EncryptedContentModel | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Models](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html) * [EncryptedContentModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.EncryptedContentModel.html) Function EncryptedContentModel ============================== * EncryptedContentModel(event: string | Event): [Model](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Model.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.EncryptedContentModel.html#encryptedcontentmodel) A model that returns the encrypted content of an event or event id #### Parameters * event: string | Event #### Returns [Model](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Model.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # PollOption | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [PollOption](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.Helpers.PollOption.html) Interface PollOption ==================== interface PollOption {     [id](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.Helpers.PollOption.html#id) : string;     [label](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.Helpers.PollOption.html#label) : string; } ##### Index ### Properties [id](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.Helpers.PollOption.html#id) [label](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.Helpers.PollOption.html#label) Properties ---------- ### id[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.Helpers.PollOption.html#id) id: string ### label[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.Helpers.PollOption.html#label) label: string ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [id](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.Helpers.PollOption.html#id) [label](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.Helpers.PollOption.html#label) --- # ListTransactionsHandler | AppleSauce * [applesauce-wallet-connect](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html) * [ListTransactionsHandler](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.ListTransactionsHandler.html) Type Alias ListTransactionsHandler ================================== ListTransactionsHandler: (     params: [ListTransactionsParams](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.ListTransactionsParams.html) , ) \=> Promise<[ListTransactionsResult](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.ListTransactionsResult.html) \> Handler function for list\_transactions method #### Type declaration * * (params: [ListTransactionsParams](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.ListTransactionsParams.html) ): Promise<[ListTransactionsResult](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.ListTransactionsResult.html) \> * #### Parameters * params: [ListTransactionsParams](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.ListTransactionsParams.html) #### Returns Promise<[ListTransactionsResult](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.ListTransactionsResult.html) \> ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # ensureEventPointerTag | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html) * [ensureEventPointerTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.ensureEventPointerTag.html) Function ensureEventPointerTag ============================== * ensureEventPointerTag(tags: string\[\]\[\], pointer: EventPointer): string\[\]\[\][](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.ensureEventPointerTag.html#ensureeventpointertag) Adds or merges an EventPointer without marker or pubkey into a tags list NOTE: this should not be used for kind 1 notes #### Parameters * tags: string\[\]\[\] * pointer: EventPointer #### Returns string\[\]\[\] ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # WalletAuthURI | AppleSauce * [applesauce-wallet-connect](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html) * [WalletAuthURI](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletAuthURI.html) Interface WalletAuthURI ======================= interface WalletAuthURI {     [budgetRenewal](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletAuthURI.html#budgetrenewal) ?: "never" | "daily" | "weekly" | "monthly" | "yearly";     [client](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletAuthURI.html#client) : string;     [expiresAt](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletAuthURI.html#expiresat) ?: number;     [icon](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletAuthURI.html#icon) ?: string;     [isolated](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletAuthURI.html#isolated) ?: boolean;     [maxAmount](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletAuthURI.html#maxamount) ?: number;     [metadata](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletAuthURI.html#metadata) ?: Record;     [methods](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletAuthURI.html#methods) ?: [WalletMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.WalletMethod.html) \[\];     [name](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletAuthURI.html#name) ?: string;     [notifications](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletAuthURI.html#notifications) ?: [NotificationType](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.NotificationType.html) \[\];     [relays](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletAuthURI.html#relays) : string\[\];     [returnTo](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletAuthURI.html#returnto) ?: string;     [walletName](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletAuthURI.html#walletname) ?: string; } ##### Index ### Properties [budgetRenewal?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletAuthURI.html#budgetrenewal) [client](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletAuthURI.html#client) [expiresAt?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletAuthURI.html#expiresat) [icon?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletAuthURI.html#icon) [isolated?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletAuthURI.html#isolated) [maxAmount?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletAuthURI.html#maxamount) [metadata?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletAuthURI.html#metadata) [methods?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletAuthURI.html#methods) [name?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletAuthURI.html#name) [notifications?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletAuthURI.html#notifications) [relays](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletAuthURI.html#relays) [returnTo?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletAuthURI.html#returnto) [walletName?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletAuthURI.html#walletname) Properties ---------- ### `Optional`budgetRenewal[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletAuthURI.html#budgetrenewal) budgetRenewal?: "never" | "daily" | "weekly" | "monthly" | "yearly" The reset the budget at the end of the given budget renewal. Can be never (default), daily, weekly, monthly, yearly (optional) ### client[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletAuthURI.html#client) client: string The public key of the client requesting authorization ### `Optional`expiresAt[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletAuthURI.html#expiresat) expiresAt?: number The connection cannot be used after this date. Unix timestamp in seconds (optional) ### `Optional`icon[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletAuthURI.html#icon) icon?: string The URL of an icon of the client app to display on the confirmation page (optional) ### `Optional`isolated[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletAuthURI.html#isolated) isolated?: boolean The makes an isolated app connection / sub-wallet with its own balance and only access to its own transaction list (optional) ### `Optional`maxAmount[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletAuthURI.html#maxamount) maxAmount?: number The maximum amount in millisats that can be sent per renewal period (optional) ### `Optional`metadata[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletAuthURI.html#metadata) metadata?: Record Url encoded, JSON-serialized metadata that describes the app connection (optional) ### `Optional`methods[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletAuthURI.html#methods) methods?: [WalletMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.WalletMethod.html) \[\] List of request types that you need permission for (optional) ### `Optional`name[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletAuthURI.html#name) name?: string The name of the client app (optional) ### `Optional`notifications[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletAuthURI.html#notifications) notifications?: [NotificationType](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.NotificationType.html) \[\] List of notification types that you need permission for (optional) ### relays[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletAuthURI.html#relays) relays: string\[\] Required. URL of the relay where the client intends to communicate with the wallet service ### `Optional`returnTo[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletAuthURI.html#returnto) returnTo?: string URI to open after the connection is created (optional) ### `Optional`walletName[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletAuthURI.html#walletname) walletName?: string The wallet name for nostr+walletauth+walletname scheme (optional) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [budgetRenewal](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletAuthURI.html#budgetrenewal) [client](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletAuthURI.html#client) [expiresAt](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletAuthURI.html#expiresat) [icon](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletAuthURI.html#icon) [isolated](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletAuthURI.html#isolated) [maxAmount](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletAuthURI.html#maxamount) [metadata](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletAuthURI.html#metadata) [methods](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletAuthURI.html#methods) [name](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletAuthURI.html#name) [notifications](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletAuthURI.html#notifications) [relays](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletAuthURI.html#relays) [returnTo](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletAuthURI.html#returnto) [walletName](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletAuthURI.html#walletname) --- # ChannelMessageBlueprint | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Blueprints](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html) * [ChannelMessageBlueprint](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.ChannelMessageBlueprint.html) Function ChannelMessageBlueprint ================================ * ChannelMessageBlueprint(     channel: Event,     message: string,     options?: [TextContentOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Operations.Content.TextContentOptions.html) , ): [EventBlueprint](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventBlueprint.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.ChannelMessageBlueprint.html#channelmessageblueprint) Creates a NIP-28 channel message #### Parameters * channel: Event * message: string * `Optional`options: [TextContentOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Operations.Content.TextContentOptions.html) #### Returns [EventBlueprint](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventBlueprint.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # RemoveNutzapInfoRelay | AppleSauce * [applesauce-wallet](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.html) * [Actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.Actions.html) * [RemoveNutzapInfoRelay](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet.Actions.RemoveNutzapInfoRelay.html) Function RemoveNutzapInfoRelay ============================== * RemoveNutzapInfoRelay(relay: string | string\[\]): [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet.Actions.RemoveNutzapInfoRelay.html#removenutzapinforelay) An action to remove a relay from the kind 10019 nutzap info event #### Parameters * relay: string | string\[\] #### Returns [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # toEventStore | AppleSauce * [applesauce-relay](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-relay.html) * [toEventStore](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-relay.toEventStore.html) Function toEventStore ===================== * toEventStore(     eventStore: [IEventStore](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html) , ): OperatorFunction<[SubscriptionResponse](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.SubscriptionResponse.html) , Event\[\]\>[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-relay.toEventStore.html#toeventstore) Adds all events to event store and returns a deduplicated timeline when EOSE is received #### Parameters * eventStore: [IEventStore](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-core.IEventStore.html) #### Returns OperatorFunction<[SubscriptionResponse](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.SubscriptionResponse.html) , Event\[\]\> #### Deprecated[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-relay.toEventStore.html#deprecated) use `mapEventsToStore` and `mapEventsToTimeline` instead ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # AddOutboxRelay | AppleSauce * [applesauce-actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.html) * [Actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html) * [AddOutboxRelay](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.AddOutboxRelay.html) Function AddOutboxRelay ======================= * AddOutboxRelay(relay: string | string\[\]): [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.AddOutboxRelay.html#addoutboxrelay) An action to add an outbox relay to the kind 10002 relay list #### Parameters * relay: string | string\[\] #### Returns [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # Geohash | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Operations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html) * [Geohash](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Geohash.html) Namespace Geohash ================= Functions --------- [removeGeohash](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.Geohash.removeGeohash.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Geohash.html#removegeohash) [setGeohash](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.Geohash.setGeohash.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Geohash.html#setgeohash) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Functions [removeGeohash](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Geohash.html#removegeohash) [setGeohash](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Geohash.html#setgeohash) --- # addMailboxRelay | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Operations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html) * [TagOperations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html) * [addMailboxRelay](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.addMailboxRelay.html) Function addMailboxRelay ======================== * addMailboxRelay(url: string | URL): [TagOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.TagOperation.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.addMailboxRelay.html#addmailboxrelay) Adds an inbox and outbox relay to NIP-65 #### Parameters * url: string | URL #### Returns [TagOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.TagOperation.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # EventModel | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Models](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html) * [EventModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.EventModel.html) Function EventModel =================== * EventModel(pointer: string | EventPointer): [Model](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Model.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.EventModel.html#eventmodel) A model that returns a single event or undefined when its removed #### Parameters * pointer: string | EventPointer #### Returns [Model](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Model.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # AddressPointerWithoutD | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [AddressPointerWithoutD](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.AddressPointerWithoutD.html) Type Alias AddressPointerWithoutD ================================= AddressPointerWithoutD: Omit & {     identifier?: string; } ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # GetBalanceResult | AppleSauce * [applesauce-wallet-connect](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html) * [GetBalanceResult](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.GetBalanceResult.html) Interface GetBalanceResult ========================== Response for get\_balance method interface GetBalanceResult {     [balance](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.GetBalanceResult.html#balance) : number; } ##### Index ### Properties [balance](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.GetBalanceResult.html#balance) Properties ---------- ### balance[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.GetBalanceResult.html#balance) balance: number User's balance in msats ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [balance](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.GetBalanceResult.html#balance) --- # ensureKTag | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html) * [ensureKTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.ensureKTag.html) Function ensureKTag =================== * ensureKTag(tags: string\[\]\[\], kind: number): string\[\]\[\][](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.ensureKTag.html#ensurektag) Ensures an array of tags includes a simple "k" tag #### Parameters * tags: string\[\]\[\] * kind: number #### Returns string\[\]\[\] ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # ChannelMessageReplyBlueprint | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Blueprints](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html) * [ChannelMessageReplyBlueprint](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.ChannelMessageReplyBlueprint.html) Function ChannelMessageReplyBlueprint ===================================== * ChannelMessageReplyBlueprint(     parent: Event,     message: string,     options?: [TextContentOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Operations.Content.TextContentOptions.html) , ): [EventBlueprint](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventBlueprint.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.ChannelMessageReplyBlueprint.html#channelmessagereplyblueprint) Creates a NIP-28 channel message reply #### Parameters * parent: Event * message: string * `Optional`options: [TextContentOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Operations.Content.TextContentOptions.html) #### Returns [EventBlueprint](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventBlueprint.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # LookupInvoiceHandler | AppleSauce * [applesauce-wallet-connect](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html) * [LookupInvoiceHandler](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.LookupInvoiceHandler.html) Type Alias LookupInvoiceHandler =============================== LookupInvoiceHandler: (     params: [LookupInvoiceParams](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.LookupInvoiceParams.html) , ) \=> Promise<[LookupInvoiceResult](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.LookupInvoiceResult.html) \> Handler function for lookup\_invoice method #### Type declaration * * (params: [LookupInvoiceParams](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.LookupInvoiceParams.html) ): Promise<[LookupInvoiceResult](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.LookupInvoiceResult.html) \> * #### Parameters * params: [LookupInvoiceParams](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.LookupInvoiceParams.html) #### Returns Promise<[LookupInvoiceResult](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.LookupInvoiceResult.html) \> ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # AddRelayToRelaySet | AppleSauce * [applesauce-actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.html) * [Actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html) * [AddRelayToRelaySet](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.AddRelayToRelaySet.html) Function AddRelayToRelaySet =========================== * AddRelayToRelaySet(     relay: string | string\[\],     identifier: string | Event,     hidden?: boolean, ): [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.AddRelayToRelaySet.html#addrelaytorelayset) An action that adds a relay to a relay set #### Parameters * relay: string | string\[\] * identifier: string | Event * hidden: boolean = false #### Returns [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # RolloverTokens | AppleSauce * [applesauce-wallet](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.html) * [Actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.Actions.html) * [RolloverTokens](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet.Actions.RolloverTokens.html) Function RolloverTokens ======================= * RolloverTokens(tokens: Event\[\], token: Token): [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet.Actions.RolloverTokens.html#rollovertokens) An action that deletes old tokens and creates a new one but does not add a history event #### Parameters * tokens: Event\[\] * token: Token #### Returns [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # GiftWrap | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Operations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html) * [GiftWrap](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.GiftWrap.html) Namespace GiftWrap ================== Type Aliases ------------ [GiftWrapOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Operations.GiftWrap.GiftWrapOptions.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.GiftWrap.html#giftwrapoptions) Functions --------- [giftWrap](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.GiftWrap.giftWrap.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.GiftWrap.html#giftwrap) [sealRumor](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.GiftWrap.sealRumor.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.GiftWrap.html#sealrumor) [toRumor](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.GiftWrap.toRumor.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.GiftWrap.html#torumor) [wrapSeal](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.GiftWrap.wrapSeal.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.GiftWrap.html#wrapseal) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Type Aliases [GiftWrapOptions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.GiftWrap.html#giftwrapoptions) Functions [giftWrap](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.GiftWrap.html#giftwrap) [sealRumor](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.GiftWrap.html#sealrumor) [toRumor](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.GiftWrap.html#torumor) [wrapSeal](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.GiftWrap.html#wrapseal) --- # addNameValueTag | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Operations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html) * [TagOperations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html) * [addNameValueTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.addNameValueTag.html) Function addNameValueTag ======================== * addNameValueTag(     tag: \[string, string, ...string\[\]\],     replace?: boolean,     matcher?: (a: string, b: string) \=> boolean, ): [TagOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.TagOperation.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.addNameValueTag.html#addnamevaluetag) Adds a name / value tag #### Parameters * tag: \[string, string, ...string\[\]\] * replace: boolean = true * `Optional`matcher: (a: string, b: string) \=> boolean #### Returns [TagOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.TagOperation.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # MakeInvoiceHandler | AppleSauce * [applesauce-wallet-connect](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html) * [MakeInvoiceHandler](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.MakeInvoiceHandler.html) Type Alias MakeInvoiceHandler ============================= MakeInvoiceHandler: (params: [MakeInvoiceParams](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.MakeInvoiceParams.html) ) \=> Promise<[MakeInvoiceResult](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.MakeInvoiceResult.html) \> Handler function for make\_invoice method #### Type declaration * * (params: [MakeInvoiceParams](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.MakeInvoiceParams.html) ): Promise<[MakeInvoiceResult](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.MakeInvoiceResult.html) \> * #### Parameters * params: [MakeInvoiceParams](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.MakeInvoiceParams.html) #### Returns Promise<[MakeInvoiceResult](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.MakeInvoiceResult.html) \> ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # ensureMarkedAddressPointerTag | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html) * [ensureMarkedAddressPointerTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.ensureMarkedAddressPointerTag.html) Function ensureMarkedAddressPointerTag ====================================== * ensureMarkedAddressPointerTag(     tags: string\[\]\[\],     pointer: AddressPointer,     marker: [Nip10TagMarker](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Helpers.Nip10TagMarker.html) , ): string\[\]\[\][](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.ensureMarkedAddressPointerTag.html#ensuremarkedaddresspointertag) Adds or merges a marked AddressPointer into a tags list #### Parameters * tags: string\[\]\[\] * pointer: AddressPointer * marker: [Nip10TagMarker](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Helpers.Nip10TagMarker.html) #### Returns string\[\]\[\] ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # CommentBlueprint | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Blueprints](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html) * [CommentBlueprint](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.CommentBlueprint.html) Function CommentBlueprint ========================= * CommentBlueprint(     parent: Event,     content: string,     options?: [CommentBlueprintOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Blueprints.CommentBlueprintOptions.html) , ): [EventBlueprint](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventBlueprint.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.CommentBlueprint.html#commentblueprint) A blueprint to create a NIP-22 comment event #### Parameters * parent: Event * content: string * `Optional`options: [CommentBlueprintOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Blueprints.CommentBlueprintOptions.html) #### Returns [EventBlueprint](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventBlueprint.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # AddSearchRelay | AppleSauce * [applesauce-actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.html) * [Actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html) * [AddSearchRelay](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.AddSearchRelay.html) Function AddSearchRelay ======================= * AddSearchRelay(relay: string | string\[\], hidden?: boolean): [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.AddSearchRelay.html#addsearchrelay) An action that adds a relay to the 10007 search relays event #### Parameters * relay: string | string\[\] * hidden: boolean = false #### Returns [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # SetNutzapInfoPubkey | AppleSauce * [applesauce-wallet](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.html) * [Actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.Actions.html) * [SetNutzapInfoPubkey](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet.Actions.SetNutzapInfoPubkey.html) Function SetNutzapInfoPubkey ============================ * SetNutzapInfoPubkey(pubkey: string): [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet.Actions.SetNutzapInfoPubkey.html#setnutzapinfopubkey) An action to set the pubkey for the kind 10019 nutzap info event #### Parameters * pubkey: string #### Returns [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # Groups | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Operations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html) * [Groups](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Groups.html) Namespace Groups ================ Functions --------- [addPreviousRefs](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.Groups.addPreviousRefs.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Groups.html#addpreviousrefs) [setGroupPointer](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.Groups.setGroupPointer.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Groups.html#setgrouppointer) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Functions [addPreviousRefs](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Groups.html#addpreviousrefs) [setGroupPointer](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Groups.html#setgrouppointer) --- # addOutboxRelay | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Operations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html) * [TagOperations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html) * [addOutboxRelay](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.addOutboxRelay.html) Function addOutboxRelay ======================= * addOutboxRelay(url: string | URL): [TagOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.TagOperation.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.addOutboxRelay.html#addoutboxrelay) Add an outbox relay in NIP-65 mailboxes #### Parameters * url: string | URL #### Returns [TagOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.TagOperation.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # EventZapsModel | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Models](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html) * [EventZapsModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.EventZapsModel.html) Function EventZapsModel ======================= * EventZapsModel(id: string | EventPointer | AddressPointer): [Model](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Model.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.EventZapsModel.html#eventzapsmodel) A model that gets all zap events for an event #### Parameters * id: string | EventPointer | AddressPointer #### Returns [Model](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Model.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # CalendarEventParticipant | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [CalendarEventParticipant](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.CalendarEventParticipant.html) Type Alias CalendarEventParticipant =================================== CalendarEventParticipant: ProfilePointer & { role?: string } ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # MultiPayInvoiceHandler | AppleSauce * [applesauce-wallet-connect](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html) * [MultiPayInvoiceHandler](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.MultiPayInvoiceHandler.html) Type Alias MultiPayInvoiceHandler ================================= MultiPayInvoiceHandler: (     params: [MultiPayInvoiceParams](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.MultiPayInvoiceParams.html) , ) \=> Promise<[MultiPayInvoiceResult](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.MultiPayInvoiceResult.html) \[\]\> Handler function for multi\_pay\_invoice method #### Type declaration * * (params: [MultiPayInvoiceParams](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.MultiPayInvoiceParams.html) ): Promise<[MultiPayInvoiceResult](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.MultiPayInvoiceResult.html) \[\]\> * #### Parameters * params: [MultiPayInvoiceParams](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.MultiPayInvoiceParams.html) #### Returns Promise<[MultiPayInvoiceResult](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.MultiPayInvoiceResult.html) \[\]\> ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # ensureMarkedEventPointerTag | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html) * [ensureMarkedEventPointerTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.ensureMarkedEventPointerTag.html) Function ensureMarkedEventPointerTag ==================================== * ensureMarkedEventPointerTag(     tags: string\[\]\[\],     pointer: EventPointer,     marker?: [Nip10TagMarker](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Helpers.Nip10TagMarker.html) , ): string\[\]\[\][](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.ensureMarkedEventPointerTag.html#ensuremarkedeventpointertag) Adds or merges an EventPointer with marker into a tags list #### Parameters * tags: string\[\]\[\] * pointer: EventPointer * `Optional`marker: [Nip10TagMarker](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Helpers.Nip10TagMarker.html) #### Returns string\[\]\[\] ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # WalletResponse | AppleSauce * [applesauce-wallet-connect](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html) * [WalletResponse](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.WalletResponse.html) Type Alias WalletResponse ========================= WalletResponse:     | [PayInvoiceResponse](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.PayInvoiceResponse.html)     | [MultiPayInvoiceResponse](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.MultiPayInvoiceResponse.html)     | [PayKeysendResponse](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.PayKeysendResponse.html)     | [MultiPayKeysendResponse](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.MultiPayKeysendResponse.html)     | [MakeInvoiceResponse](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.MakeInvoiceResponse.html)     | [LookupInvoiceResponse](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.LookupInvoiceResponse.html)     | [ListTransactionsResponse](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.ListTransactionsResponse.html)     | [GetBalanceResponse](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.GetBalanceResponse.html)     | [GetInfoResponse](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.GetInfoResponse.html) Union type for all NIP-47 response types ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # DeleteBlueprint | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Blueprints](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html) * [DeleteBlueprint](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.DeleteBlueprint.html) Function DeleteBlueprint ======================== * DeleteBlueprint(events: Event\[\], reason?: string): [EventBlueprint](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventBlueprint.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.DeleteBlueprint.html#deleteblueprint) A blueprint for a NIP-09 delete event #### Parameters * events: Event\[\] * `Optional`reason: string #### Returns [EventBlueprint](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventBlueprint.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # AddUserToFollowSet | AppleSauce * [applesauce-actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.html) * [Actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html) * [AddUserToFollowSet](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.AddUserToFollowSet.html) Function AddUserToFollowSet =========================== * AddUserToFollowSet(     pubkey: string | ProfilePointer | (string | ProfilePointer)\[\],     identifier: string | Event,     hidden?: boolean, ): [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.AddUserToFollowSet.html#addusertofollowset) An action that adds a pubkey to a follow set #### Parameters * pubkey: string | ProfilePointer | (string | ProfilePointer)\[\] the pubkey to add to the set * identifier: string | Event the "d" tag of the follow set * hidden: boolean = false set to true to add to hidden follows #### Returns [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) #### Throws[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.AddUserToFollowSet.html#throws) if the follow set does not exist ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # LiveChatMessageBlueprintOptions | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Blueprints](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html) * [LiveChatMessageBlueprintOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Blueprints.LiveChatMessageBlueprintOptions.html) Type Alias LiveChatMessageBlueprintOptions ========================================== LiveChatMessageBlueprintOptions: [TextContentOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Operations.Content.TextContentOptions.html) & [MetaTagOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Operations.MetaTagOptions.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # RelayOptions | AppleSauce * [applesauce-relay](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-relay.html) * [RelayOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.RelayOptions.html) Type Alias RelayOptions ======================= type RelayOptions \= {     [eoseTimeout](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.RelayOptions.html#eosetimeout) ?: number;     [eventTimeout](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.RelayOptions.html#eventtimeout) ?: number;     [keepAlive](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.RelayOptions.html#keepalive) ?: number;     [WebSocket](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.RelayOptions.html#websocket) ?: WebSocketSubjectConfig\["WebSocketCtor"\]; } ##### Index ### Properties [eoseTimeout?](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.RelayOptions.html#eosetimeout) [eventTimeout?](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.RelayOptions.html#eventtimeout) [keepAlive?](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.RelayOptions.html#keepalive) [WebSocket?](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.RelayOptions.html#websocket) Properties ---------- ### `Optional`eoseTimeout[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.RelayOptions.html#eosetimeout) eoseTimeout?: number How long to wait for an EOSE message (default 10s) ### `Optional`eventTimeout[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.RelayOptions.html#eventtimeout) eventTimeout?: number How long to wait for an OK message from the relay (default 10s) ### `Optional`keepAlive[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.RelayOptions.html#keepalive) keepAlive?: number How long to keep the connection alive after nothing is subscribed (default 30s) ### `Optional`WebSocket[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.RelayOptions.html#websocket) WebSocket?: WebSocketSubjectConfig\["WebSocketCtor"\] Custom WebSocket implementation ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [eoseTimeout](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.RelayOptions.html#eosetimeout) [eventTimeout](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.RelayOptions.html#eventtimeout) [keepAlive](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.RelayOptions.html#keepalive) [WebSocket](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.RelayOptions.html#websocket) --- # ALLOWED_PIN_KINDS | AppleSauce * [applesauce-actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.html) * [Actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html) * [ALLOWED\_PIN\_KINDS](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-actions.Actions.ALLOWED_PIN_KINDS.html) Variable ALLOWED\_PIN\_KINDS`Const` =================================== ALLOWED\_PIN\_KINDS: number\[\] = ... ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # AddNutzapInfoRelay | AppleSauce * [applesauce-wallet](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.html) * [Actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.Actions.html) * [AddNutzapInfoRelay](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet.Actions.AddNutzapInfoRelay.html) Function AddNutzapInfoRelay =========================== * AddNutzapInfoRelay(relay: string | string\[\]): [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet.Actions.AddNutzapInfoRelay.html#addnutzapinforelay) An action to add a relay to the kind 10019 nutzap info event #### Parameters * relay: string | string\[\] #### Returns [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # Calendar | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Operations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html) * [Calendar](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Calendar.html) Namespace Calendar ================== Functions --------- [addEvent](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.Calendar.addEvent.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Calendar.html#addevent) [removeEvent](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.Calendar.removeEvent.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Calendar.html#removeevent) [setTitle](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.Calendar.setTitle.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Calendar.html#settitle) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Functions [addEvent](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Calendar.html#addevent) [removeEvent](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Calendar.html#removeevent) [setTitle](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Calendar.html#settitle) --- # removeCoordinateTag | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Operations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html) * [TagOperations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html) * [removeCoordinateTag](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-factory.Operations.TagOperations.removeCoordinateTag.html) Variable removeCoordinateTag`Const` =================================== removeCoordinateTag: (cord: string | AddressPointer) \=> [TagOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.TagOperation.html) = removeAddressTag #### Type declaration * * (cord: string | AddressPointer): [TagOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.TagOperation.html) * Removes all "a" tags for address pointer #### Parameters * cord: string | AddressPointer #### Returns [TagOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.TagOperation.html) #### Deprecated[](https://hzrd149.github.io/applesauce/typedoc/variables/applesauce-factory.Operations.TagOperations.removeCoordinateTag.html#deprecated) use removeAddressTag instead ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # CalendarEventsModel | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Models](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html) * [CalendarEventsModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.CalendarEventsModel.html) Function CalendarEventsModel ============================ * CalendarEventsModel(calendar: Event): [Model](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Model.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.CalendarEventsModel.html#calendareventsmodel) A model that gets all the events for a calendar #### Parameters * calendar: Event #### Returns [Model](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Model.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # Blueprints | AppleSauce * [applesauce-wallet-connect](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html) * [Blueprints](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Blueprints.html) Namespace Blueprints ==================== Functions --------- [WalletLegacyNotificationBlueprint](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet-connect.Blueprints.WalletLegacyNotificationBlueprint.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Blueprints.html#walletlegacynotificationblueprint) [WalletNotificationBlueprint](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet-connect.Blueprints.WalletNotificationBlueprint.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Blueprints.html#walletnotificationblueprint) [WalletRequestBlueprint](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet-connect.Blueprints.WalletRequestBlueprint.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Blueprints.html#walletrequestblueprint) [WalletResponseBlueprint](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet-connect.Blueprints.WalletResponseBlueprint.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Blueprints.html#walletresponseblueprint) [WalletSupportBlueprint](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet-connect.Blueprints.WalletSupportBlueprint.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Blueprints.html#walletsupportblueprint) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Functions [WalletLegacyNotificationBlueprint](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Blueprints.html#walletlegacynotificationblueprint) [WalletNotificationBlueprint](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Blueprints.html#walletnotificationblueprint) [WalletRequestBlueprint](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Blueprints.html#walletrequestblueprint) [WalletResponseBlueprint](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Blueprints.html#walletresponseblueprint) [WalletSupportBlueprint](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Blueprints.html#walletsupportblueprint) --- # createCommentTagsForEvent | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html) * [createCommentTagsForEvent](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.createCommentTagsForEvent.html) Function createCommentTagsForEvent ================================== * createCommentTagsForEvent(parent: Event, relayHint?: string): string\[\]\[\][](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.createCommentTagsForEvent.html#createcommenttagsforevent) Returns an array of NIP-22 tags for a kind 1111 comment event #### Parameters * parent: Event * `Optional`relayHint: string #### Returns string\[\]\[\] ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # WalletConnectOptions | AppleSauce * [applesauce-wallet-connect](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html) * [WalletConnectOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.WalletConnectOptions.html) Type Alias WalletConnectOptions =============================== type WalletConnectOptions \= {     [pool](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.WalletConnectOptions.html#pool) ?: [NostrPool](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.NostrPool.html) ;     [publishMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.WalletConnectOptions.html#publishmethod) ?: [NostrPublishMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.NostrPublishMethod.html) ;     [relays](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.WalletConnectOptions.html#relays) : string\[\];     [secret](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.WalletConnectOptions.html#secret) : Uint8Array;     [service](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.WalletConnectOptions.html#service) ?: string;     [subscriptionMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.WalletConnectOptions.html#subscriptionmethod) ?: [NostrSubscriptionMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.NostrSubscriptionMethod.html) ;     [timeout](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.WalletConnectOptions.html#timeout) ?: number; } ##### Index ### Properties [pool?](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.WalletConnectOptions.html#pool) [publishMethod?](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.WalletConnectOptions.html#publishmethod) [relays](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.WalletConnectOptions.html#relays) [secret](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.WalletConnectOptions.html#secret) [service?](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.WalletConnectOptions.html#service) [subscriptionMethod?](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.WalletConnectOptions.html#subscriptionmethod) [timeout?](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.WalletConnectOptions.html#timeout) Properties ---------- ### `Optional`pool[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.WalletConnectOptions.html#pool) pool?: [NostrPool](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.NostrPool.html) An optional pool for connection methods ### `Optional`publishMethod[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.WalletConnectOptions.html#publishmethod) publishMethod?: [NostrPublishMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.NostrPublishMethod.html) A method for publishing events ### relays[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.WalletConnectOptions.html#relays) relays: string\[\] The relays to use for the connection ### secret[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.WalletConnectOptions.html#secret) secret: Uint8Array The secret to use for the connection ### `Optional`service[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.WalletConnectOptions.html#service) service?: string The service pubkey to use for the connection (optional) ### `Optional`subscriptionMethod[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.WalletConnectOptions.html#subscriptionmethod) subscriptionMethod?: [NostrSubscriptionMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.NostrSubscriptionMethod.html) A method for subscribing to relays ### `Optional`timeout[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.WalletConnectOptions.html#timeout) timeout?: number Default timeout for RPC requests in milliseconds ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [pool](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.WalletConnectOptions.html#pool) [publishMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.WalletConnectOptions.html#publishmethod) [relays](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.WalletConnectOptions.html#relays) [secret](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.WalletConnectOptions.html#secret) [service](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.WalletConnectOptions.html#service) [subscriptionMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.WalletConnectOptions.html#subscriptionmethod) [timeout](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.WalletConnectOptions.html#timeout) --- # NoteBlueprintOptions | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Blueprints](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html) * [NoteBlueprintOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Blueprints.NoteBlueprintOptions.html) Type Alias NoteBlueprintOptions =============================== NoteBlueprintOptions: [TextContentOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Operations.Content.TextContentOptions.html) & [MetaTagOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Operations.MetaTagOptions.html) & [ZapOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Operations.Zap.ZapOptions.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # registerCommonAccountTypes | AppleSauce * [applesauce-accounts](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.html) * [Accounts](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-accounts.Accounts.html) * [registerCommonAccountTypes](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-accounts.Accounts.registerCommonAccountTypes.html) Function registerCommonAccountTypes =================================== * registerCommonAccountTypes(manager: [AccountManager](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html) ): void[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-accounts.Accounts.registerCommonAccountTypes.html#registercommonaccounttypes) Registers the most common account types to a account manager #### Parameters * manager: [AccountManager](https://hzrd149.github.io/applesauce/typedoc/classes/applesauce-accounts.AccountManager.html) #### Returns void ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # RequestOptions | AppleSauce * [applesauce-relay](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-relay.html) * [RequestOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.RequestOptions.html) Type Alias RequestOptions ========================= RequestOptions: [SubscriptionOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-relay.SubscriptionOptions.html) Options for the request method on the pool and relay ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # NostrConnectAppMetadata | AppleSauce * [applesauce-signers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.Helpers.html) * [NostrConnectAppMetadata](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.NostrConnectAppMetadata.html) Type Alias NostrConnectAppMetadata ================================== App metadata for a nostrconnect:// URI type NostrConnectAppMetadata \= {     [image](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.NostrConnectAppMetadata.html#image) ?: string;     [name](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.NostrConnectAppMetadata.html#name) ?: string;     [permissions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.NostrConnectAppMetadata.html#permissions) ?: string\[\];     [url](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.NostrConnectAppMetadata.html#url) ?: string | URL; } ##### Index ### Properties [image?](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.NostrConnectAppMetadata.html#image) [name?](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.NostrConnectAppMetadata.html#name) [permissions?](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.NostrConnectAppMetadata.html#permissions) [url?](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.NostrConnectAppMetadata.html#url) Properties ---------- ### `Optional`image[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.NostrConnectAppMetadata.html#image) image?: string An image for the client ### `Optional`name[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.NostrConnectAppMetadata.html#name) name?: string The name of the client ### `Optional`permissions[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.NostrConnectAppMetadata.html#permissions) permissions?: string\[\] The permissions the client has ### `Optional`url[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.NostrConnectAppMetadata.html#url) url?: string | URL The url of the client ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [image](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.NostrConnectAppMetadata.html#image) [name](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.NostrConnectAppMetadata.html#name) [permissions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.NostrConnectAppMetadata.html#permissions) [url](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.NostrConnectAppMetadata.html#url) --- # AddBlockedRelay | AppleSauce * [applesauce-actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.html) * [Actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html) * [AddBlockedRelay](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.AddBlockedRelay.html) Function AddBlockedRelay ======================== * AddBlockedRelay(relay: string | string\[\], hidden?: boolean): [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.AddBlockedRelay.html#addblockedrelay) An action that adds a relay to the 10006 blocked relays event #### Parameters * relay: string | string\[\] * hidden: boolean = false #### Returns [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # CompleteSpend | AppleSauce * [applesauce-wallet](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.html) * [Actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.Actions.html) * [CompleteSpend](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet.Actions.CompleteSpend.html) Function CompleteSpend ====================== * CompleteSpend(spent: Event\[\], change: Token): [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet.Actions.CompleteSpend.html#completespend) An action that deletes old token events and adds a spend history item #### Parameters * spent: Event\[\] * change: Token #### Returns [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # addAddressTag | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Operations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html) * [TagOperations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html) * [addAddressTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.addAddressTag.html) Function addAddressTag ====================== * addAddressTag(cord: string | AddressPointer, replace?: boolean): [TagOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.TagOperation.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.addAddressTag.html#addaddresstag) Adds a single "a" tag based on an AddressPointer #### Parameters * cord: string | AddressPointer * replace: boolean = true #### Returns [TagOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.TagOperation.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # NostrConnectURI | AppleSauce * [applesauce-signers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-signers.Helpers.html) * [NostrConnectURI](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.NostrConnectURI.html) Type Alias NostrConnectURI ========================== A nostrconnect:// URI type NostrConnectURI \= {     [client](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.NostrConnectURI.html#client) : string;     [metadata](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.NostrConnectURI.html#metadata) ?: [NostrConnectAppMetadata](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.NostrConnectAppMetadata.html) ;     [relays](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.NostrConnectURI.html#relays) : string\[\];     [secret](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.NostrConnectURI.html#secret) : string; } ##### Index ### Properties [client](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.NostrConnectURI.html#client) [metadata?](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.NostrConnectURI.html#metadata) [relays](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.NostrConnectURI.html#relays) [secret](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.NostrConnectURI.html#secret) Properties ---------- ### client[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.NostrConnectURI.html#client) client: string The pubkey of the client ### `Optional`metadata[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.NostrConnectURI.html#metadata) metadata?: [NostrConnectAppMetadata](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.NostrConnectAppMetadata.html) The metadata of the client ### relays[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.NostrConnectURI.html#relays) relays: string\[\] The relays used to communicate with the remote signer ### secret[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.NostrConnectURI.html#secret) secret: string The secret used by the signer to connect to the client ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [client](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.NostrConnectURI.html#client) [metadata](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.NostrConnectURI.html#metadata) [relays](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.NostrConnectURI.html#relays) [secret](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-signers.Helpers.NostrConnectURI.html#secret) --- # CalendarEvent | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Operations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html) * [CalendarEvent](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.CalendarEvent.html) Namespace CalendarEvent ======================= Functions --------- [addLocation](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.CalendarEvent.addLocation.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.CalendarEvent.html#addlocation) [addParticipant](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.CalendarEvent.addParticipant.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.CalendarEvent.html#addparticipant) [addReferenceLink](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.CalendarEvent.addReferenceLink.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.CalendarEvent.html#addreferencelink) [clearLocations](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.CalendarEvent.clearLocations.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.CalendarEvent.html#clearlocations) [removeGeohash](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.CalendarEvent.removeGeohash.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.CalendarEvent.html#removegeohash) [removeLocation](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.CalendarEvent.removeLocation.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.CalendarEvent.html#removelocation) [removeParticipant](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.CalendarEvent.removeParticipant.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.CalendarEvent.html#removeparticipant) [removeReferenceLink](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.CalendarEvent.removeReferenceLink.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.CalendarEvent.html#removereferencelink) [setEndDate](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.CalendarEvent.setEndDate.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.CalendarEvent.html#setenddate) [setEndTime](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.CalendarEvent.setEndTime.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.CalendarEvent.html#setendtime) [setGeohash](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.CalendarEvent.setGeohash.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.CalendarEvent.html#setgeohash) [setImage](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.CalendarEvent.setImage.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.CalendarEvent.html#setimage) [setStartDate](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.CalendarEvent.setStartDate.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.CalendarEvent.html#setstartdate) [setStartTime](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.CalendarEvent.setStartTime.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.CalendarEvent.html#setstarttime) [setSummary](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.CalendarEvent.setSummary.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.CalendarEvent.html#setsummary) [setTitle](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.CalendarEvent.setTitle.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.CalendarEvent.html#settitle) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Functions [addLocation](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.CalendarEvent.html#addlocation) [addParticipant](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.CalendarEvent.html#addparticipant) [addReferenceLink](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.CalendarEvent.html#addreferencelink) [clearLocations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.CalendarEvent.html#clearlocations) [removeGeohash](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.CalendarEvent.html#removegeohash) [removeLocation](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.CalendarEvent.html#removelocation) [removeParticipant](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.CalendarEvent.html#removeparticipant) [removeReferenceLink](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.CalendarEvent.html#removereferencelink) [setEndDate](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.CalendarEvent.html#setenddate) [setEndTime](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.CalendarEvent.html#setendtime) [setGeohash](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.CalendarEvent.html#setgeohash) [setImage](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.CalendarEvent.html#setimage) [setStartDate](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.CalendarEvent.html#setstartdate) [setStartTime](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.CalendarEvent.html#setstarttime) [setSummary](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.CalendarEvent.html#setsummary) [setTitle](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.CalendarEvent.html#settitle) --- # EventsModel | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Models](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html) * [EventsModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.EventsModel.html) Function EventsModel ==================== * EventsModel(ids: string\[\]): [Model](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Model.html) \>[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.EventsModel.html#eventsmodel) A model that returns a multiple events in a map #### Parameters * ids: string\[\] #### Returns [Model](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Model.html) \> #### Deprecated[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.EventsModel.html#deprecated) use multiple [EventModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.EventModel.html) instead ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # Bookmarks | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [Bookmarks](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.Bookmarks.html) Type Alias Bookmarks ==================== type Bookmarks \= {     [articles](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.Bookmarks.html#articles) : AddressPointer\[\];     [hashtags](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.Bookmarks.html#hashtags) : string\[\];     [notes](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.Bookmarks.html#notes) : EventPointer\[\];     [urls](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.Bookmarks.html#urls) : string\[\]; } ##### Index ### Properties [articles](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.Bookmarks.html#articles) [hashtags](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.Bookmarks.html#hashtags) [notes](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.Bookmarks.html#notes) [urls](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.Bookmarks.html#urls) Properties ---------- ### articles[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.Bookmarks.html#articles) articles: AddressPointer\[\] ### hashtags[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.Bookmarks.html#hashtags) hashtags: string\[\] ### notes[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.Bookmarks.html#notes) notes: EventPointer\[\] ### urls[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.Bookmarks.html#urls) urls: string\[\] ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [articles](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.Bookmarks.html#articles) [hashtags](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.Bookmarks.html#hashtags) [notes](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.Bookmarks.html#notes) [urls](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.Bookmarks.html#urls) --- # GetInfoResult | AppleSauce * [applesauce-wallet-connect](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html) * [GetInfoResult](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.GetInfoResult.html) Interface GetInfoResult ======================= Response for get\_info method interface GetInfoResult {     [alias](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.GetInfoResult.html#alias) : string;     [block\_hash](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.GetInfoResult.html#block_hash) : string;     [block\_height](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.GetInfoResult.html#block_height) : number;     [color](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.GetInfoResult.html#color) : string;     [methods](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.GetInfoResult.html#methods) : [WalletMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.WalletMethod.html) \[\];     [network](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.GetInfoResult.html#network) : "mainnet" | "testnet" | "signet" | "regtest";     [notifications](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.GetInfoResult.html#notifications) ?: [NotificationType](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.NotificationType.html) \[\];     [pubkey](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.GetInfoResult.html#pubkey) : string; } ##### Index ### Properties [alias](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.GetInfoResult.html#alias) [block\_hash](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.GetInfoResult.html#block_hash) [block\_height](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.GetInfoResult.html#block_height) [color](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.GetInfoResult.html#color) [methods](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.GetInfoResult.html#methods) [network](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.GetInfoResult.html#network) [notifications?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.GetInfoResult.html#notifications) [pubkey](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.GetInfoResult.html#pubkey) Properties ---------- ### alias[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.GetInfoResult.html#alias) alias: string Node alias ### block\_hash[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.GetInfoResult.html#block_hash) block\_hash: string Current block hash as hex string ### block\_height[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.GetInfoResult.html#block_height) block\_height: number Current block height ### color[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.GetInfoResult.html#color) color: string Node color as hex string ### methods[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.GetInfoResult.html#methods) methods: [WalletMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.WalletMethod.html) \[\] List of supported methods for this connection ### network[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.GetInfoResult.html#network) network: "mainnet" | "testnet" | "signet" | "regtest" Network type ### `Optional`notifications[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.GetInfoResult.html#notifications) notifications?: [NotificationType](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.NotificationType.html) \[\] List of supported notifications for this connection, optional ### pubkey[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.GetInfoResult.html#pubkey) pubkey: string Node public key as hex string ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [alias](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.GetInfoResult.html#alias) [block\_hash](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.GetInfoResult.html#block_hash) [block\_height](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.GetInfoResult.html#block_height) [color](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.GetInfoResult.html#color) [methods](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.GetInfoResult.html#methods) [network](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.GetInfoResult.html#network) [notifications](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.GetInfoResult.html#notifications) [pubkey](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.GetInfoResult.html#pubkey) --- # UnlockWallet | AppleSauce * [applesauce-wallet](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.html) * [Actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.Actions.html) * [UnlockWallet](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet.Actions.UnlockWallet.html) Function UnlockWallet ===================== * UnlockWallet(unlock?: { history?: boolean; tokens?: boolean }): [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet.Actions.UnlockWallet.html#unlockwallet) Unlocks the wallet event and optionally the tokens and history events #### Parameters * `Optional`unlock: { history?: boolean; tokens?: boolean } #### Returns [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # addPubkeyTag | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Operations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html) * [TagOperations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html) * [addPubkeyTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.addPubkeyTag.html) Function addPubkeyTag ===================== * addPubkeyTag(pubkey: string | ProfilePointer, replace?: boolean): [TagOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.TagOperation.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.addPubkeyTag.html#addpubkeytag) Adds a single "p" tag for a ProfilePointer #### Parameters * pubkey: string | ProfilePointer * replace: boolean = true #### Returns [TagOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.TagOperation.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # FavoriteRelaySetsModel | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Models](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html) * [FavoriteRelaySetsModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.FavoriteRelaySetsModel.html) Function FavoriteRelaySetsModel =============================== * FavoriteRelaySetsModel(     pubkey: string,     type?: [ReadListTags](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ReadListTags.html) , ): [Model](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Model.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.FavoriteRelaySetsModel.html#favoriterelaysetsmodel) A model that returns all favorite relay sets for a pubkey #### Parameters * pubkey: string The pubkey to get the favorite relay sets for * `Optional`type: [ReadListTags](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ReadListTags.html) Which types of tags to read #### Returns [Model](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Model.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # ChannelMetadataContent | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [ChannelMetadataContent](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ChannelMetadataContent.html) Type Alias ChannelMetadataContent ================================= ChannelMetadataContent: ChannelMetadata & { relays?: string\[\] } ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # Hashtags | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Operations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html) * [Hashtags](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Hashtags.html) Namespace Hashtags ================== Functions --------- [includeHashtags](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.Hashtags.includeHashtags.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Hashtags.html#includehashtags) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Functions [includeHashtags](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Hashtags.html#includehashtags) --- # MultiPayKeysendHandler | AppleSauce * [applesauce-wallet-connect](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html) * [MultiPayKeysendHandler](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.MultiPayKeysendHandler.html) Type Alias MultiPayKeysendHandler ================================= MultiPayKeysendHandler: (     params: [MultiPayKeysendParams](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.MultiPayKeysendParams.html) , ) \=> Promise<[MultiPayKeysendResult](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.MultiPayKeysendResult.html) \[\]\> Handler function for multi\_pay\_keysend method #### Type declaration * * (params: [MultiPayKeysendParams](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.MultiPayKeysendParams.html) ): Promise<[MultiPayKeysendResult](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.MultiPayKeysendResult.html) \[\]\> * #### Parameters * params: [MultiPayKeysendParams](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.MultiPayKeysendParams.html) #### Returns Promise<[MultiPayKeysendResult](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.MultiPayKeysendResult.html) \[\]\> ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # ensureMarkedProfilePointerTag | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html) * [ensureMarkedProfilePointerTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.ensureMarkedProfilePointerTag.html) Function ensureMarkedProfilePointerTag ====================================== * ensureMarkedProfilePointerTag(     tags: string\[\]\[\],     pointer: ProfilePointer,     marker: string, ): string\[\]\[\][](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.ensureMarkedProfilePointerTag.html#ensuremarkedprofilepointertag) Adds or merges an ProfilePointer into a tags list #### Parameters * tags: string\[\]\[\] * pointer: ProfilePointer * marker: string #### Returns string\[\]\[\] ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # ListTransactionsResult | AppleSauce * [applesauce-wallet-connect](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html) * [ListTransactionsResult](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.ListTransactionsResult.html) Interface ListTransactionsResult ================================ Response for list\_transactions method interface ListTransactionsResult {     [transactions](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.ListTransactionsResult.html#transactions) : [Transaction](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.Transaction.html) \[\]; } ##### Index ### Properties [transactions](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.ListTransactionsResult.html#transactions) Properties ---------- ### transactions[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.ListTransactionsResult.html#transactions) transactions: [Transaction](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.Transaction.html) \[\] Array of transactions ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [transactions](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.ListTransactionsResult.html#transactions) --- # FileMetadataBlueprint | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Blueprints](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html) * [FileMetadataBlueprint](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.FileMetadataBlueprint.html) Function FileMetadataBlueprint ============================== * FileMetadataBlueprint(     metadata: [FileMetadata](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.FileMetadata.html) ,     description?: string,     options?: [FileMetadataBlueprintOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Blueprints.FileMetadataBlueprintOptions.html) , ): [EventBlueprint](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventBlueprint.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.FileMetadataBlueprint.html#filemetadatablueprint) Blueprint to create a NIP-94 file metadata event #### Parameters * metadata: [FileMetadata](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.FileMetadata.html) * `Optional`description: string * `Optional`options: [FileMetadataBlueprintOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Blueprints.FileMetadataBlueprintOptions.html) #### Returns [EventBlueprint](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventBlueprint.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # BookmarkEvent | AppleSauce * [applesauce-actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.html) * [Actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html) * [BookmarkEvent](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.BookmarkEvent.html) Function BookmarkEvent ====================== * BookmarkEvent(     event: Event,     identifier?: string | Event,     hidden?: boolean, ): [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.BookmarkEvent.html#bookmarkevent) An action that adds a note or article to the bookmark list or a bookmark set #### Parameters * event: Event the event to bookmark * `Optional`identifier: string | Event the "d" tag of the bookmark set or `undefined` for the default bookmark list * hidden: boolean = false set to true to add to hidden bookmarks #### Returns [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # UpdateNutzapInfo | AppleSauce * [applesauce-wallet](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.html) * [Actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.Actions.html) * [UpdateNutzapInfo](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet.Actions.UpdateNutzapInfo.html) Function UpdateNutzapInfo ========================= * UpdateNutzapInfo(     relays: string\[\],     mints: { units?: string\[\]; url: string }\[\],     pubkey: string, ): [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet.Actions.UpdateNutzapInfo.html#updatenutzapinfo) An action to update the entire nutzap info event #### Parameters * relays: string\[\] * mints: { units?: string\[\]; url: string }\[\] * pubkey: string #### Returns [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # Highlight | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Operations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html) * [Highlight](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Highlight.html) Namespace Highlight =================== Type Aliases ------------ [AttributionRole](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Operations.Highlight.AttributionRole.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Highlight.html#attributionrole) Functions --------- [addAttribution](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.Highlight.addAttribution.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Highlight.html#addattribution) [setAttributions](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.Highlight.setAttributions.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Highlight.html#setattributions) [setComment](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.Highlight.setComment.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Highlight.html#setcomment) [setContext](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.Highlight.setContext.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Highlight.html#setcontext) [setHighlightContent](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.Highlight.setHighlightContent.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Highlight.html#sethighlightcontent) [setSource](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.Highlight.setSource.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Highlight.html#setsource) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Type Aliases [AttributionRole](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Highlight.html#attributionrole) Functions [addAttribution](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Highlight.html#addattribution) [setAttributions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Highlight.html#setattributions) [setComment](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Highlight.html#setcomment) [setContext](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Highlight.html#setcontext) [setHighlightContent](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Highlight.html#sethighlightcontent) [setSource](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Highlight.html#setsource) --- # addRelayTag | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Operations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html) * [TagOperations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html) * [addRelayTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.addRelayTag.html) Function addRelayTag ==================== * addRelayTag(     url: string | URL,     tagName?: string,     replace?: boolean, ): [TagOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.TagOperation.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.addRelayTag.html#addrelaytag) Adds a relay tag #### Parameters * url: string | URL * tagName: string = "relay" * replace: boolean = true #### Returns [TagOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.TagOperation.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # FavoriteRelaysModel | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Models](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html) * [FavoriteRelaysModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.FavoriteRelaysModel.html) Function FavoriteRelaysModel ============================ * FavoriteRelaysModel(     pubkey: string,     type?: [ReadListTags](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ReadListTags.html) , ): [Model](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Model.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.FavoriteRelaysModel.html#favoriterelaysmodel) A model that returns all favorite relays for a pubkey #### Parameters * pubkey: string The pubkey to get the favorite relays for * `Optional`type: [ReadListTags](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ReadListTags.html) Which types of tags to read #### Returns [Model](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Model.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # CommentAddressPointer | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [CommentAddressPointer](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.CommentAddressPointer.html) Type Alias CommentAddressPointer ================================ type CommentAddressPointer \= {     [id](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.CommentAddressPointer.html#id) ?: string;     [identifier](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.CommentAddressPointer.html#identifier) : string;     [kind](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.CommentAddressPointer.html#kind) : number;     [pubkey](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.CommentAddressPointer.html#pubkey) : string;     [relay](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.CommentAddressPointer.html#relay) ?: string;     [type](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.CommentAddressPointer.html#type) : "address"; } ##### Index ### Properties [id?](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.CommentAddressPointer.html#id) [identifier](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.CommentAddressPointer.html#identifier) [kind](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.CommentAddressPointer.html#kind) [pubkey](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.CommentAddressPointer.html#pubkey) [relay?](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.CommentAddressPointer.html#relay) [type](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.CommentAddressPointer.html#type) Properties ---------- ### `Optional`id[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.CommentAddressPointer.html#id) id?: string ### identifier[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.CommentAddressPointer.html#identifier) identifier: string ### kind[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.CommentAddressPointer.html#kind) kind: number ### pubkey[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.CommentAddressPointer.html#pubkey) pubkey: string ### `Optional`relay[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.CommentAddressPointer.html#relay) relay?: string ### type[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.CommentAddressPointer.html#type) type: "address" ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [id](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.CommentAddressPointer.html#id) [identifier](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.CommentAddressPointer.html#identifier) [kind](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.CommentAddressPointer.html#kind) [pubkey](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.CommentAddressPointer.html#pubkey) [relay](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.CommentAddressPointer.html#relay) [type](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.CommentAddressPointer.html#type) --- # ensureNamedValueTag | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html) * [ensureNamedValueTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.ensureNamedValueTag.html) Function ensureNamedValueTag ============================ * ensureNamedValueTag(     tags: string\[\]\[\],     tag: \[string, string, ...string\[\]\],     replace?: boolean,     matcher?: (a: string, b: string) \=> boolean, ): string\[\]\[\][](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.ensureNamedValueTag.html#ensurenamedvaluetag) Ensures a single named / value tag exists #### Parameters * tags: string\[\]\[\] * tag: \[string, string, ...string\[\]\] * replace: boolean = true * `Optional`matcher: (a: string, b: string) \=> boolean #### Returns string\[\]\[\] ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # Transaction | AppleSauce * [applesauce-wallet-connect](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html) * [Transaction](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.Transaction.html) Interface Transaction ===================== Transaction object used in multiple response types interface Transaction {     [amount](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.Transaction.html#amount) : number;     [created\_at](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.Transaction.html#created_at) : number;     [description](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.Transaction.html#description) ?: string;     [description\_hash](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.Transaction.html#description_hash) ?: string;     [expires\_at](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.Transaction.html#expires_at) ?: number;     [fees\_paid](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.Transaction.html#fees_paid) : number;     [invoice](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.Transaction.html#invoice) ?: string;     [metadata](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.Transaction.html#metadata) ?: Record;     [payment\_hash](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.Transaction.html#payment_hash) ?: string;     [preimage](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.Transaction.html#preimage) ?: string;     [settled\_at](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.Transaction.html#settled_at) ?: number;     [state](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.Transaction.html#state) : "failed" | "pending" | "expired" | "settled";     [type](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.Transaction.html#type) : "incoming" | "outgoing"; } ##### Index ### Properties [amount](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.Transaction.html#amount) [created\_at](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.Transaction.html#created_at) [description?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.Transaction.html#description) [description\_hash?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.Transaction.html#description_hash) [expires\_at?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.Transaction.html#expires_at) [fees\_paid](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.Transaction.html#fees_paid) [invoice?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.Transaction.html#invoice) [metadata?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.Transaction.html#metadata) [payment\_hash?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.Transaction.html#payment_hash) [preimage?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.Transaction.html#preimage) [settled\_at?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.Transaction.html#settled_at) [state](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.Transaction.html#state) [type](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.Transaction.html#type) Properties ---------- ### amount[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.Transaction.html#amount) amount: number Value in msats ### created\_at[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.Transaction.html#created_at) created\_at: number Invoice/payment creation unix timestamp ### `Optional`description[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.Transaction.html#description) description?: string Invoice's description, optional ### `Optional`description\_hash[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.Transaction.html#description_hash) description\_hash?: string Invoice's description hash, optional ### `Optional`expires\_at[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.Transaction.html#expires_at) expires\_at?: number Invoice expiration unix timestamp, optional if not applicable ### fees\_paid[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.Transaction.html#fees_paid) fees\_paid: number Value in msats ### `Optional`invoice[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.Transaction.html#invoice) invoice?: string Encoded invoice, optional ### `Optional`metadata[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.Transaction.html#metadata) metadata?: Record Generic metadata that can be used to add things like zap/boostagram details ### `Optional`payment\_hash[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.Transaction.html#payment_hash) payment\_hash?: string Payment hash for the payment, optional ### `Optional`preimage[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.Transaction.html#preimage) preimage?: string Payment's preimage, optional if unpaid ### `Optional`settled\_at[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.Transaction.html#settled_at) settled\_at?: number Invoice/payment settlement unix timestamp, optional if unpaid ### state[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.Transaction.html#state) state: "failed" | "pending" | "expired" | "settled" State of the transaction ### type[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.Transaction.html#type) type: "incoming" | "outgoing" Type of transaction ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [amount](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.Transaction.html#amount) [created\_at](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.Transaction.html#created_at) [description](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.Transaction.html#description) [description\_hash](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.Transaction.html#description_hash) [expires\_at](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.Transaction.html#expires_at) [fees\_paid](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.Transaction.html#fees_paid) [invoice](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.Transaction.html#invoice) [metadata](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.Transaction.html#metadata) [payment\_hash](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.Transaction.html#payment_hash) [preimage](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.Transaction.html#preimage) [settled\_at](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.Transaction.html#settled_at) [state](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.Transaction.html#state) [type](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.Transaction.html#type) --- # FollowSetBlueprint | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Blueprints](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html) * [FollowSetBlueprint](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.FollowSetBlueprint.html) Function FollowSetBlueprint =========================== * FollowSetBlueprint(     list?: { description?: string; image?: string; title?: string },     users?:         | ProfilePointer\[\]         | { hidden?: ProfilePointer\[\]; public?: ProfilePointer\[\] }, ): [EventBlueprint](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventBlueprint.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.FollowSetBlueprint.html#followsetblueprint) Creates a new kind 30000 follow set #### Parameters * `Optional`list: { description?: string; image?: string; title?: string } * `Optional`users: ProfilePointer\[\] | { hidden?: ProfilePointer\[\]; public?: ProfilePointer\[\] } #### Returns [EventBlueprint](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventBlueprint.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # PayInvoiceHandler | AppleSauce * [applesauce-wallet-connect](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html) * [PayInvoiceHandler](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.PayInvoiceHandler.html) Type Alias PayInvoiceHandler ============================ PayInvoiceHandler: (params: [PayInvoiceParams](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.PayInvoiceParams.html) ) \=> Promise<[PayInvoiceResult](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.PayInvoiceResult.html) \> Handler function for pay\_invoice method #### Type declaration * * (params: [PayInvoiceParams](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.PayInvoiceParams.html) ): Promise<[PayInvoiceResult](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.PayInvoiceResult.html) \> * #### Parameters * params: [PayInvoiceParams](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.PayInvoiceParams.html) #### Returns Promise<[PayInvoiceResult](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.PayInvoiceResult.html) \> ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # CreateBookmarkList | AppleSauce * [applesauce-actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.html) * [Actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html) * [CreateBookmarkList](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.CreateBookmarkList.html) Function CreateBookmarkList =========================== * CreateBookmarkList(bookmarks?: Event\[\]): [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.CreateBookmarkList.html#createbookmarklist) An action that creates a new bookmark list for a user #### Parameters * `Optional`bookmarks: Event\[\] #### Returns [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # WalletAddPrivateKey | AppleSauce * [applesauce-wallet](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.html) * [Actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet.Actions.html) * [WalletAddPrivateKey](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet.Actions.WalletAddPrivateKey.html) Function WalletAddPrivateKey ============================ * WalletAddPrivateKey(privateKey: Uint8Array): [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet.Actions.WalletAddPrivateKey.html#walletaddprivatekey) Adds a private key to a wallet event #### Parameters * privateKey: Uint8Array #### Returns [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) #### Throws[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-wallet.Actions.WalletAddPrivateKey.html#throws) if the wallet does not exist or is locked ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # LegacyMessage | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Operations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html) * [LegacyMessage](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.LegacyMessage.html) Namespace LegacyMessage ======================= Functions --------- [setMessageAddress](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.LegacyMessage.setMessageAddress.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.LegacyMessage.html#setmessageaddress) [setMessageParent](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.LegacyMessage.setMessageParent.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.LegacyMessage.html#setmessageparent) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Functions [setMessageAddress](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.LegacyMessage.html#setmessageaddress) [setMessageParent](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.LegacyMessage.html#setmessageparent) --- # removeAddressTag | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Operations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html) * [TagOperations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html) * [removeAddressTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.removeAddressTag.html) Function removeAddressTag ========================= * removeAddressTag(cord: string | AddressPointer): [TagOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.TagOperation.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.removeAddressTag.html#removeaddresstag) Removes all "a" tags for address pointer #### Parameters * cord: string | AddressPointer #### Returns [TagOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.TagOperation.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # GiftWrapRumorModel | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Models](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html) * [GiftWrapRumorModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.GiftWrapRumorModel.html) Function GiftWrapRumorModel =========================== * GiftWrapRumorModel(gift: string | Event): [Model](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Model.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.GiftWrapRumorModel.html#giftwraprumormodel) A model that returns the rumor event of a gift wrap event when its unlocked #### Parameters * gift: string | Event #### Returns [Model](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Model.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # CommentEventPointer | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [CommentEventPointer](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.CommentEventPointer.html) Type Alias CommentEventPointer ============================== type CommentEventPointer \= {     [id](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.CommentEventPointer.html#id) : string;     [kind](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.CommentEventPointer.html#kind) : number;     [pubkey](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.CommentEventPointer.html#pubkey) ?: string;     [relay](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.CommentEventPointer.html#relay) ?: string;     [type](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.CommentEventPointer.html#type) : "event"; } ##### Index ### Properties [id](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.CommentEventPointer.html#id) [kind](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.CommentEventPointer.html#kind) [pubkey?](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.CommentEventPointer.html#pubkey) [relay?](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.CommentEventPointer.html#relay) [type](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.CommentEventPointer.html#type) Properties ---------- ### id[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.CommentEventPointer.html#id) id: string ### kind[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.CommentEventPointer.html#kind) kind: number ### `Optional`pubkey[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.CommentEventPointer.html#pubkey) pubkey?: string ### `Optional`relay[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.CommentEventPointer.html#relay) relay?: string ### type[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.CommentEventPointer.html#type) type: "event" ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [id](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.CommentEventPointer.html#id) [kind](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.CommentEventPointer.html#kind) [pubkey](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.CommentEventPointer.html#pubkey) [relay](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.CommentEventPointer.html#relay) [type](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.CommentEventPointer.html#type) --- # ensureProfilePointerTag | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html) * [ensureProfilePointerTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.ensureProfilePointerTag.html) Function ensureProfilePointerTag ================================ * ensureProfilePointerTag(tags: string\[\]\[\], pointer: ProfilePointer): string\[\]\[\][](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.ensureProfilePointerTag.html#ensureprofilepointertag) Adds or merges an ProfilePointer into a tags list #### Parameters * tags: string\[\]\[\] * pointer: ProfilePointer #### Returns string\[\]\[\] ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # MakeInvoiceParams | AppleSauce * [applesauce-wallet-connect](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html) * [MakeInvoiceParams](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.MakeInvoiceParams.html) Interface MakeInvoiceParams =========================== Parameters for make\_invoice method interface MakeInvoiceParams {     [amount](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.MakeInvoiceParams.html#amount) : number;     [description](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.MakeInvoiceParams.html#description) ?: string;     [description\_hash](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.MakeInvoiceParams.html#description_hash) ?: string;     [expiry](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.MakeInvoiceParams.html#expiry) ?: number; } ##### Index ### Properties [amount](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.MakeInvoiceParams.html#amount) [description?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.MakeInvoiceParams.html#description) [description\_hash?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.MakeInvoiceParams.html#description_hash) [expiry?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.MakeInvoiceParams.html#expiry) Properties ---------- ### amount[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.MakeInvoiceParams.html#amount) amount: number Value in msats ### `Optional`description[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.MakeInvoiceParams.html#description) description?: string Invoice's description, optional ### `Optional`description\_hash[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.MakeInvoiceParams.html#description_hash) description\_hash?: string Invoice's description hash, optional ### `Optional`expiry[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.MakeInvoiceParams.html#expiry) expiry?: number Expiry in seconds from time invoice is created, optional ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [amount](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.MakeInvoiceParams.html#amount) [description](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.MakeInvoiceParams.html#description) [description\_hash](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.MakeInvoiceParams.html#description_hash) [expiry](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.MakeInvoiceParams.html#expiry) --- # GiftWrapBlueprint | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Blueprints](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html) * [GiftWrapBlueprint](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.GiftWrapBlueprint.html) Function GiftWrapBlueprint ========================== * GiftWrapBlueprint(     pubkey: string,     blueprint: Event | EventTemplate | UnsignedEvent | [EventBlueprint](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventBlueprint.html) ,     opts?: [MetaTagOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Operations.MetaTagOptions.html) , ): [EventBlueprint](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventBlueprint.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.GiftWrapBlueprint.html#giftwrapblueprint) Creates a gift wrapped event based on a blueprint #### Parameters * pubkey: string * blueprint: Event | EventTemplate | UnsignedEvent | [EventBlueprint](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventBlueprint.html) * `Optional`opts: [MetaTagOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Operations.MetaTagOptions.html) #### Returns [EventBlueprint](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventBlueprint.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # PayKeysendHandler | AppleSauce * [applesauce-wallet-connect](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html) * [PayKeysendHandler](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.PayKeysendHandler.html) Type Alias PayKeysendHandler ============================ PayKeysendHandler: (params: [PayKeysendParams](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.PayKeysendParams.html) ) \=> Promise<[PayKeysendResult](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.PayKeysendResult.html) \> Handler function for pay\_keysend method #### Type declaration * * (params: [PayKeysendParams](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.PayKeysendParams.html) ): Promise<[PayKeysendResult](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.PayKeysendResult.html) \> * #### Parameters * params: [PayKeysendParams](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.PayKeysendParams.html) #### Returns Promise<[PayKeysendResult](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.PayKeysendResult.html) \> ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # CreateBookmarkSet | AppleSauce * [applesauce-actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.html) * [Actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html) * [CreateBookmarkSet](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.CreateBookmarkSet.html) Function CreateBookmarkSet ========================== * CreateBookmarkSet(     title: string,     description: string,     additional: { hidden?: Event\[\]; image?: string; public?: Event\[\] }, ): [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.CreateBookmarkSet.html#createbookmarkset) An action that creates a new bookmark set for a user #### Parameters * title: string * description: string * additional: { hidden?: Event\[\]; image?: string; public?: Event\[\] } #### Returns [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # List | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Operations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html) * [List](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.List.html) Namespace List ============== Functions --------- [setDescription](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.List.setDescription.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.List.html#setdescription) [setImage](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.List.setImage.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.List.html#setimage) [setTitle](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.List.setTitle.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.List.html#settitle) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Functions [setDescription](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.List.html#setdescription) [setImage](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.List.html#setimage) [setTitle](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.List.html#settitle) --- # removeBlossomServerTag | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Operations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html) * [TagOperations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html) * [removeBlossomServerTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.removeBlossomServerTag.html) Function removeBlossomServerTag =============================== * removeBlossomServerTag(url: string | URL): [TagOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.TagOperation.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.removeBlossomServerTag.html#removeblossomservertag) Removes all server tags matching the url from a 10063 event #### Parameters * url: string | URL #### Returns [TagOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.TagOperation.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # GiftWrapsModel | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Models](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html) * [GiftWrapsModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.GiftWrapsModel.html) Function GiftWrapsModel ======================= * GiftWrapsModel(pubkey: string, locked?: boolean): [Model](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Model.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.GiftWrapsModel.html#giftwrapsmodel) A model that returns all gift wrap events for a pubkey, optionally filtered by locked status #### Parameters * pubkey: string * `Optional`locked: boolean #### Returns [Model](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Model.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # CommentExternalPointer | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [CommentExternalPointer](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.CommentExternalPointer.html) Type Alias CommentExternalPointer ==================================== CommentExternalPointer: [ExternalPointer](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ExternalPointer.html) <[T](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.CommentExternalPointer.html#t) \> & { type: "external" } #### Type Parameters * T extends keyof [ExternalIdentifiers](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ExternalIdentifiers.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # ensureQuoteEventPointerTag | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html) * [ensureQuoteEventPointerTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.ensureQuoteEventPointerTag.html) Function ensureQuoteEventPointerTag =================================== * ensureQuoteEventPointerTag(tags: string\[\]\[\], pointer: EventPointer): string\[\]\[\][](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.ensureQuoteEventPointerTag.html#ensurequoteeventpointertag) Adds or merges an EventPointer into a tags list #### Parameters * tags: string\[\]\[\] * pointer: EventPointer #### Returns string\[\]\[\] ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # PayInvoiceResult | AppleSauce * [applesauce-wallet-connect](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html) * [PayInvoiceResult](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.PayInvoiceResult.html) Interface PayInvoiceResult ========================== Response for pay\_invoice method interface PayInvoiceResult {     [fees\_paid](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.PayInvoiceResult.html#fees_paid) ?: number;     [preimage](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.PayInvoiceResult.html#preimage) : string; } ##### Index ### Properties [fees\_paid?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.PayInvoiceResult.html#fees_paid) [preimage](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.PayInvoiceResult.html#preimage) Properties ---------- ### `Optional`fees\_paid[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.PayInvoiceResult.html#fees_paid) fees\_paid?: number Value in msats, optional ### preimage[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.PayInvoiceResult.html#preimage) preimage: string Preimage of the payment ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [fees\_paid](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.PayInvoiceResult.html#fees_paid) [preimage](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.PayInvoiceResult.html#preimage) --- # SerializedWalletConnect | AppleSauce * [applesauce-wallet-connect](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html) * [SerializedWalletConnect](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.SerializedWalletConnect.html) Type Alias SerializedWalletConnect ================================== SerializedWalletConnect: [WalletConnectURI](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletConnectURI.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # GroupMessageBlueprint | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Blueprints](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html) * [GroupMessageBlueprint](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.GroupMessageBlueprint.html) Function GroupMessageBlueprint ============================== * GroupMessageBlueprint(     group: [GroupPointer](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.GroupPointer.html) ,     content: string,     options?: [GroupMessageBlueprintOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Blueprints.GroupMessageBlueprintOptions.html) , ): [EventBlueprint](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventBlueprint.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.GroupMessageBlueprint.html#groupmessageblueprint) A blueprint for a NIP-29 group message #### Parameters * group: [GroupPointer](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.GroupPointer.html) * content: string * `Optional`options: [GroupMessageBlueprintOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Blueprints.GroupMessageBlueprintOptions.html) #### Returns [EventBlueprint](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventBlueprint.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # CreateFollowSet | AppleSauce * [applesauce-actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.html) * [Actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html) * [CreateFollowSet](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.CreateFollowSet.html) Function CreateFollowSet ======================== * CreateFollowSet(     title: string,     options?: {         description?: string;         hidden?: (string | ProfilePointer)\[\];         image?: string;         public?: (string | ProfilePointer)\[\];     }, ): [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.CreateFollowSet.html#createfollowset) An action that creates a new follow set #### Parameters * title: string * `Optional`options: {     description?: string;     hidden?: (string | ProfilePointer)\[\];     image?: string;     public?: (string | ProfilePointer)\[\]; } #### Returns [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) #### Throws[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.CreateFollowSet.html#throws) if a follow set already exists ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # LiveStream | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Operations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html) * [LiveStream](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.LiveStream.html) Namespace LiveStream ==================== Functions --------- [includeLiveStreamTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.LiveStream.includeLiveStreamTag.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.LiveStream.html#includelivestreamtag) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Functions [includeLiveStreamTag](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.LiveStream.html#includelivestreamtag) --- # removeEventBookmarkTag | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Operations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html) * [TagOperations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html) * [removeEventBookmarkTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.removeEventBookmarkTag.html) Function removeEventBookmarkTag =============================== * removeEventBookmarkTag(event: Event): [TagOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.TagOperation.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.removeEventBookmarkTag.html#removeeventbookmarktag) Removes an "e" or "a" tag from a bookmark list or set #### Parameters * event: Event #### Returns [TagOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.TagOperation.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # HiddenContactsModel | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Models](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html) * [HiddenContactsModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.HiddenContactsModel.html) Function HiddenContactsModel ============================ * HiddenContactsModel(pubkey: string): [Model](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Model.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.HiddenContactsModel.html#hiddencontactsmodel) A model that returns all hidden contacts for a user #### Parameters * pubkey: string #### Returns [Model](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Model.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # DecodeResult | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [DecodeResult](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.DecodeResult.html) Type Alias DecodeResult ======================= DecodeResult: ReturnType ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # PayKeysendResult | AppleSauce * [applesauce-wallet-connect](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html) * [PayKeysendResult](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.PayKeysendResult.html) Interface PayKeysendResult ========================== Response for pay\_keysend method interface PayKeysendResult {     [fees\_paid](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.PayKeysendResult.html#fees_paid) ?: number;     [preimage](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.PayKeysendResult.html#preimage) : string; } ##### Index ### Properties [fees\_paid?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.PayKeysendResult.html#fees_paid) [preimage](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.PayKeysendResult.html#preimage) Properties ---------- ### `Optional`fees\_paid[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.PayKeysendResult.html#fees_paid) fees\_paid?: number Value in msats, optional ### preimage[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.PayKeysendResult.html#preimage) preimage: string Preimage of the payment ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [fees\_paid](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.PayKeysendResult.html#fees_paid) [preimage](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.PayKeysendResult.html#preimage) --- # eventPipe | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html) * [eventPipe](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.eventPipe.html) Function eventPipe ================== * eventPipe(...operations: (undefined | [EventOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventOperation.html) )\[\]): [EventOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventOperation.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.eventPipe.html#eventpipe) The core method that creates a pipeline to build an event #### Parameters * ...operations: (undefined | [EventOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventOperation.html) )\[\] #### Returns [EventOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventOperation.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # HighlightBlueprint | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Blueprints](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html) * [HighlightBlueprint](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.HighlightBlueprint.html) Function HighlightBlueprint =========================== * HighlightBlueprint(     content: string,     source: string | Event | AddressPointer,     options?: [HighlightBlueprintOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Blueprints.HighlightBlueprintOptions.html) , ): [EventBlueprint](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventBlueprint.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.HighlightBlueprint.html#highlightblueprint) NIP-84 Highlight event (kind 9802) blueprint Creates a highlight event that references content from nostr events or external URLs #### Parameters * content: string * source: string | Event | AddressPointer * `Optional`options: [HighlightBlueprintOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Blueprints.HighlightBlueprintOptions.html) #### Returns [EventBlueprint](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventBlueprint.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # SerializedWalletService | AppleSauce * [applesauce-wallet-connect](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html) * [SerializedWalletService](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.SerializedWalletService.html) Type Alias SerializedWalletService ================================== type SerializedWalletService \= {     [client](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.SerializedWalletService.html#client) : string;     [relays](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.SerializedWalletService.html#relays) : string\[\]; } ##### Index ### Properties [client](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.SerializedWalletService.html#client) [relays](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.SerializedWalletService.html#relays) Properties ---------- ### client[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.SerializedWalletService.html#client) client: string The client's public key ### relays[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.SerializedWalletService.html#relays) relays: string\[\] The relays to use for the service ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [client](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.SerializedWalletService.html#client) [relays](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.SerializedWalletService.html#relays) --- # CreateMailboxes | AppleSauce * [applesauce-actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.html) * [Actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html) * [CreateMailboxes](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.CreateMailboxes.html) Function CreateMailboxes ======================== * CreateMailboxes(inboxes: string\[\], outboxes: string\[\]): [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.CreateMailboxes.html#createmailboxes) An action to create a new kind 10002 relay list event #### Parameters * inboxes: string\[\] * outboxes: string\[\] #### Returns [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # Mailboxes | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Operations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html) * [Mailboxes](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Mailboxes.html) Namespace Mailboxes =================== Functions --------- [addInboxRelay](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.Mailboxes.addInboxRelay.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Mailboxes.html#addinboxrelay) [addMailboxRelay](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.Mailboxes.addMailboxRelay.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Mailboxes.html#addmailboxrelay) [addOutboxRelay](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.Mailboxes.addOutboxRelay.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Mailboxes.html#addoutboxrelay) [removeInboxRelay](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.Mailboxes.removeInboxRelay.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Mailboxes.html#removeinboxrelay) [removeMailboxRelay](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.Mailboxes.removeMailboxRelay.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Mailboxes.html#removemailboxrelay) [removeOutboxRelay](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.Mailboxes.removeOutboxRelay.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Mailboxes.html#removeoutboxrelay) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Functions [addInboxRelay](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Mailboxes.html#addinboxrelay) [addMailboxRelay](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Mailboxes.html#addmailboxrelay) [addOutboxRelay](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Mailboxes.html#addoutboxrelay) [removeInboxRelay](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Mailboxes.html#removeinboxrelay) [removeMailboxRelay](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Mailboxes.html#removemailboxrelay) [removeOutboxRelay](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Mailboxes.html#removeoutboxrelay) --- # removeEventTag | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Operations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html) * [TagOperations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html) * [removeEventTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.removeEventTag.html) Function removeEventTag ======================= * removeEventTag(id: string | EventPointer): [TagOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.TagOperation.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.removeEventTag.html#removeeventtag) Removes all "e" tags matching EventPointer or id #### Parameters * id: string | EventPointer #### Returns [TagOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.TagOperation.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # HiddenMuteModel | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Models](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html) * [HiddenMuteModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.HiddenMuteModel.html) Function HiddenMuteModel ======================== * HiddenMuteModel(pubkey: string): [Model](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Model.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.HiddenMuteModel.html#hiddenmutemodel) A model that returns all a users hidden muted things #### Parameters * pubkey: string #### Returns [Model](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Model.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # WalletRequest | AppleSauce * [applesauce-wallet-connect](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html) * [WalletRequest](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.WalletRequest.html) Type Alias WalletRequest ======================== WalletRequest:     | [PayInvoiceRequest](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.PayInvoiceRequest.html)     | [MultiPayInvoiceRequest](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.MultiPayInvoiceRequest.html)     | [PayKeysendRequest](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.PayKeysendRequest.html)     | [MultiPayKeysendRequest](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.MultiPayKeysendRequest.html)     | [MakeInvoiceRequest](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.MakeInvoiceRequest.html)     | [LookupInvoiceRequest](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.LookupInvoiceRequest.html)     | [ListTransactionsRequest](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.ListTransactionsRequest.html)     | [GetBalanceRequest](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.GetBalanceRequest.html)     | [GetInfoRequest](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.GetInfoRequest.html) Union type for all NIP-47 request types ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # getContentPointers | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html) * [getContentPointers](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.getContentPointers.html) Function getContentPointers =========================== * getContentPointers(     content: string, ): (     | { data: EventPointer; type: "nevent" }     | { data: ProfilePointer; type: "nprofile" }     | { data: AddressPointer; type: "naddr" }     | { data: string; type: "npub" }     | { data: Uint8Array; type: "nsec" }     | { data: string; type: "note" } )\[\][](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.getContentPointers.html#getcontentpointers) Returns all NIP-19 pointers in a content string #### Parameters * content: string #### Returns (     | { data: EventPointer; type: "nevent" }     | { data: ProfilePointer; type: "nprofile" }     | { data: AddressPointer; type: "naddr" }     | { data: string; type: "npub" }     | { data: Uint8Array; type: "nsec" }     | { data: string; type: "note" } )\[\] ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # ExternalIdentifiers | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [ExternalIdentifiers](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ExternalIdentifiers.html) Type Alias ExternalIdentifiers ============================== type ExternalIdentifiers \= {     ["#"](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ExternalIdentifiers.html#) : \`#${string}\`;     [doi](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ExternalIdentifiers.html#doi) : \`doi:${string}\`;     [geo](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ExternalIdentifiers.html#geo) : \`geo:${string}\`;     [isan](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ExternalIdentifiers.html#isan) : \`isan:${string}\`;     [isbn](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ExternalIdentifiers.html#isbn) : \`isbn:${string}\`;     ["podcast:guid"](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ExternalIdentifiers.html#podcastguid) : \`podcast:guid:${string}\`;     ["podcast:item:guid"](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ExternalIdentifiers.html#podcastitemguid) : \`podcast:item:guid:${string}\`;     ["podcast:publisher:guid"](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ExternalIdentifiers.html#podcastpublisherguid) : \`podcast:publisher:guid:${string}\`; } ##### Index ### Properties [#](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ExternalIdentifiers.html#) [doi](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ExternalIdentifiers.html#doi) [geo](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ExternalIdentifiers.html#geo) [isan](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ExternalIdentifiers.html#isan) [isbn](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ExternalIdentifiers.html#isbn) [podcast:guid](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ExternalIdentifiers.html#podcastguid) [podcast:item:guid](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ExternalIdentifiers.html#podcastitemguid) [podcast:publisher:guid](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ExternalIdentifiers.html#podcastpublisherguid) Properties ---------- ### # "#": \`#${string}\` ### doi[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ExternalIdentifiers.html#doi) doi: \`doi:${string}\` ### geo[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ExternalIdentifiers.html#geo) geo: \`geo:${string}\` ### isan[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ExternalIdentifiers.html#isan) isan: \`isan:${string}\` ### isbn[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ExternalIdentifiers.html#isbn) isbn: \`isbn:${string}\` ### podcast:guid[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ExternalIdentifiers.html#podcastguid) "podcast:guid": \`podcast:guid:${string}\` ### podcast:item:guid[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ExternalIdentifiers.html#podcastitemguid) "podcast:item:guid": \`podcast:item:guid:${string}\` ### podcast:publisher:guid[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ExternalIdentifiers.html#podcastpublisherguid) "podcast:publisher:guid": \`podcast:publisher:guid:${string}\` ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [#](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ExternalIdentifiers.html#) [doi](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ExternalIdentifiers.html#doi) [geo](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ExternalIdentifiers.html#geo) [isan](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ExternalIdentifiers.html#isan) [isbn](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ExternalIdentifiers.html#isbn) [podcast:guid](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ExternalIdentifiers.html#podcastguid) [podcast:item:guid](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ExternalIdentifiers.html#podcastitemguid) [podcast:publisher:guid](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ExternalIdentifiers.html#podcastpublisherguid) --- # LegacyMessageBlueprint | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Blueprints](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html) * [LegacyMessageBlueprint](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.LegacyMessageBlueprint.html) Function LegacyMessageBlueprint =============================== * LegacyMessageBlueprint(     recipient: string,     message: string,     opts?: [MetaTagOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Operations.MetaTagOptions.html) , ): [EventBlueprint](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventBlueprint.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.LegacyMessageBlueprint.html#legacymessageblueprint) A blueprint to create a nip-04 encrypted direct message #### Parameters * recipient: string * message: string * `Optional`opts: [MetaTagOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Operations.MetaTagOptions.html) #### Returns [EventBlueprint](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventBlueprint.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # CreatePinList | AppleSauce * [applesauce-actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.html) * [Actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html) * [CreatePinList](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.CreatePinList.html) Function CreatePinList ====================== * CreatePinList(pins?: Event\[\]): [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.CreatePinList.html#createpinlist) An action that creates a new pin list for a user #### Parameters * pins: Event\[\] = \[\] #### Returns [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # Note | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Operations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html) * [Note](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Note.html) Namespace Note ============== Functions --------- [includeNofityTags](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.Note.includeNofityTags.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Note.html#includenofitytags) [setThreadParent](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.Note.setThreadParent.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Note.html#setthreadparent) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Functions [includeNofityTags](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Note.html#includenofitytags) [setThreadParent](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Note.html#setthreadparent) --- # removeGroupTag | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Operations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html) * [TagOperations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html) * [removeGroupTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.removeGroupTag.html) Function removeGroupTag ======================= * removeGroupTag(group: [GroupPointer](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.GroupPointer.html) ): [TagOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.TagOperation.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.removeGroupTag.html#removegrouptag) Removes a "group" tag from a list #### Parameters * group: [GroupPointer](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.GroupPointer.html) #### Returns [TagOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.TagOperation.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # LegacyMessageReplies | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Models](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html) * [LegacyMessageReplies](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.LegacyMessageReplies.html) Function LegacyMessageReplies ============================= * LegacyMessageReplies(self: string, message: Event): [Model](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Model.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.LegacyMessageReplies.html#legacymessagereplies) Returns all the legacy direct messages that are replies to a given message #### Parameters * self: string * message: Event #### Returns [Model](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Model.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # WalletMethod | AppleSauce * [applesauce-wallet-connect](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html) * [WalletMethod](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.WalletMethod.html) Type Alias WalletMethod ======================= WalletMethod:     | "pay\_invoice"     | "multi\_pay\_invoice"     | "pay\_keysend"     | "multi\_pay\_keysend"     | "make\_invoice"     | "lookup\_invoice"     | "list\_transactions"     | "get\_balance"     | "get\_info" ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # identity | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html) * [identity](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.identity.html) Function identity ================= * identity<[T](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.identity.html#identityt) \>(x: [T](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.identity.html#identityt) ): [T](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.identity.html#identityt) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.identity.html#identity) #### Type Parameters * T #### Parameters * x: [T](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.identity.html#identityt) #### Returns [T](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.identity.html#identityt) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # ExternalPointer | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [ExternalPointer](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ExternalPointer.html) Type Alias ExternalPointer ================================== type ExternalPointer<[Prefix](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ExternalPointer.html#prefix) extends keyof [ExternalIdentifiers](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ExternalIdentifiers.html) \> \= {     [identifier](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ExternalPointer.html#identifier) : [ExternalIdentifiers](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ExternalIdentifiers.html) \[[Prefix](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ExternalPointer.html#prefix)\ \];     [kind](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ExternalPointer.html#kind) : [Prefix](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ExternalPointer.html#prefix) ; } #### Type Parameters * Prefix extends keyof [ExternalIdentifiers](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ExternalIdentifiers.html) ##### Index ### Properties [identifier](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ExternalPointer.html#identifier) [kind](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ExternalPointer.html#kind) Properties ---------- ### identifier[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ExternalPointer.html#identifier) identifier: [ExternalIdentifiers](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ExternalIdentifiers.html) \[[Prefix](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ExternalPointer.html#prefix)\ \] ### kind[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ExternalPointer.html#kind) kind: [Prefix](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ExternalPointer.html#prefix) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [identifier](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ExternalPointer.html#identifier) [kind](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ExternalPointer.html#kind) --- # LegacyMessageReplyBlueprint | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Blueprints](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html) * [LegacyMessageReplyBlueprint](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.LegacyMessageReplyBlueprint.html) Function LegacyMessageReplyBlueprint ==================================== * LegacyMessageReplyBlueprint(     parent: Event,     message: string,     opts?: [MetaTagOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Operations.MetaTagOptions.html) , ): [EventBlueprint](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventBlueprint.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.LegacyMessageReplyBlueprint.html#legacymessagereplyblueprint) Creates a reply to a legacy message #### Parameters * parent: Event * message: string * `Optional`opts: [MetaTagOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Operations.MetaTagOptions.html) #### Returns [EventBlueprint](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventBlueprint.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # CreateProfile | AppleSauce * [applesauce-actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.html) * [Actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html) * [CreateProfile](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.CreateProfile.html) Function CreateProfile ====================== * CreateProfile(content: [ProfileContent](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ProfileContent.html) ): [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.CreateProfile.html#createprofile) An action that creates a new kind 0 profile event for a user #### Parameters * content: [ProfileContent](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ProfileContent.html) #### Returns [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # PicturePost | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Operations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html) * [PicturePost](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.PicturePost.html) Namespace PicturePost ===================== Functions --------- [setImageMetadata](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.PicturePost.setImageMetadata.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.PicturePost.html#setimagemetadata) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Functions [setImageMetadata](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.PicturePost.html#setimagemetadata) --- # removeHashtag | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Operations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html) * [TagOperations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html) * [removeHashtag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.removeHashtag.html) Function removeHashtag ====================== * removeHashtag(hashtag: string): [TagOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.TagOperation.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.removeHashtag.html#removehashtag) Removes a hashtag from the live event #### Parameters * hashtag: string #### Returns [TagOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.TagOperation.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # LegacyMessagesGroup | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Models](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html) * [LegacyMessagesGroup](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.LegacyMessagesGroup.html) Function LegacyMessagesGroup ============================ * LegacyMessagesGroup(self: string, corraspondant: string): [Model](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Model.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.LegacyMessagesGroup.html#legacymessagesgroup) Returns all legacy direct messages in a group #### Parameters * self: string * corraspondant: string #### Returns [Model](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Model.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # NotificationType | AppleSauce * [applesauce-wallet-connect](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html) * [NotificationType](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-wallet-connect.Helpers.NotificationType.html) Type Alias NotificationType =========================== NotificationType: "payment\_received" | "payment\_sent" Supported notification types ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # FileMetadata | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [FileMetadata](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.FileMetadata.html) Type Alias FileMetadata ======================= type FileMetadata \= {     [alt](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.FileMetadata.html#alt) ?: string;     [blurhash](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.FileMetadata.html#blurhash) ?: string;     [dimensions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.FileMetadata.html#dimensions) ?: string;     [fallback](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.FileMetadata.html#fallback) ?: string\[\];     [image](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.FileMetadata.html#image) ?: string;     [infohash](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.FileMetadata.html#infohash) ?: string;     [magnet](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.FileMetadata.html#magnet) ?: string;     [originalSha256](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.FileMetadata.html#originalsha256) ?: string;     [sha256](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.FileMetadata.html#sha256) ?: string;     [size](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.FileMetadata.html#size) ?: number;     [summary](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.FileMetadata.html#summary) ?: string;     [thumbnail](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.FileMetadata.html#thumbnail) ?: string;     [type](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.FileMetadata.html#type) ?: string;     [url](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.FileMetadata.html#url) : string; } ##### Index ### Properties [alt?](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.FileMetadata.html#alt) [blurhash?](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.FileMetadata.html#blurhash) [dimensions?](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.FileMetadata.html#dimensions) [fallback?](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.FileMetadata.html#fallback) [image?](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.FileMetadata.html#image) [infohash?](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.FileMetadata.html#infohash) [magnet?](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.FileMetadata.html#magnet) [originalSha256?](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.FileMetadata.html#originalsha256) [sha256?](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.FileMetadata.html#sha256) [size?](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.FileMetadata.html#size) [summary?](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.FileMetadata.html#summary) [thumbnail?](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.FileMetadata.html#thumbnail) [type?](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.FileMetadata.html#type) [url](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.FileMetadata.html#url) Properties ---------- ### `Optional`alt[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.FileMetadata.html#alt) alt?: string description for accessability ### `Optional`blurhash[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.FileMetadata.html#blurhash) blurhash?: string blurhash ### `Optional`dimensions[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.FileMetadata.html#dimensions) dimensions?: string size of file in pixels in the form x ### `Optional`fallback[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.FileMetadata.html#fallback) fallback?: string\[\] fallback URLs ### `Optional`image[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.FileMetadata.html#image) image?: string URL to a preview image with the same dimensions ### `Optional`infohash[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.FileMetadata.html#infohash) infohash?: string torrent infohash ### `Optional`magnet[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.FileMetadata.html#magnet) magnet?: string magnet ### `Optional`originalSha256[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.FileMetadata.html#originalsha256) originalSha256?: string The original sha256 hash before the file was transformed #### Deprecated[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.FileMetadata.html#deprecated) ### `Optional`sha256[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.FileMetadata.html#sha256) sha256?: string sha256 hash of the file ### `Optional`size[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.FileMetadata.html#size) size?: number size of the file in bytes ### `Optional`summary[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.FileMetadata.html#summary) summary?: string summary ### `Optional`thumbnail[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.FileMetadata.html#thumbnail) thumbnail?: string URL to a thumbnail ### `Optional`type[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.FileMetadata.html#type) type?: string MIME type ### url[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.FileMetadata.html#url) url: string URL of the file ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [alt](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.FileMetadata.html#alt) [blurhash](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.FileMetadata.html#blurhash) [dimensions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.FileMetadata.html#dimensions) [fallback](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.FileMetadata.html#fallback) [image](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.FileMetadata.html#image) [infohash](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.FileMetadata.html#infohash) [magnet](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.FileMetadata.html#magnet) [originalSha256](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.FileMetadata.html#originalsha256) [sha256](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.FileMetadata.html#sha256) [size](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.FileMetadata.html#size) [summary](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.FileMetadata.html#summary) [thumbnail](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.FileMetadata.html#thumbnail) [type](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.FileMetadata.html#type) [url](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.FileMetadata.html#url) --- # pipeFromAsyncArray | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html) * [pipeFromAsyncArray](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.pipeFromAsyncArray.html) Function pipeFromAsyncArray =========================== * pipeFromAsyncArray<[T](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.pipeFromAsyncArray.html#pipefromasyncarrayt) , [R](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.pipeFromAsyncArray.html#pipefromasyncarrayr) \>(     fns: [Operation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Operation.html) <[T](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.pipeFromAsyncArray.html#pipefromasyncarrayt) , [R](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.pipeFromAsyncArray.html#pipefromasyncarrayr) \>\[\],     preserve?: symbol\[\], ): [Operation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Operation.html) <[T](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.pipeFromAsyncArray.html#pipefromasyncarrayt) , [R](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.pipeFromAsyncArray.html#pipefromasyncarrayr) \>[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.pipeFromAsyncArray.html#pipefromasyncarray) `Internal` #### Type Parameters * T * R #### Parameters * fns: [Operation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Operation.html) <[T](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.pipeFromAsyncArray.html#pipefromasyncarrayt) , [R](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.pipeFromAsyncArray.html#pipefromasyncarrayr) \>\[\] An array of operations to pipe together * `Optional`preserve: symbol\[\] If set an array of symbols to keep, all other symbols will be removed #### Returns [Operation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Operation.html) <[T](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.pipeFromAsyncArray.html#pipefromasyncarrayt) , [R](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.pipeFromAsyncArray.html#pipefromasyncarrayr) \> ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # CreateRelaySet | AppleSauce * [applesauce-actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.html) * [Actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html) * [CreateRelaySet](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.CreateRelaySet.html) Function CreateRelaySet ======================= * CreateRelaySet(     title: string,     options?: {         description?: string;         hidden?: string\[\];         image?: string;         public?: string\[\];     }, ): [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.CreateRelaySet.html#createrelayset) An action that creates a new relay set #### Parameters * title: string * `Optional`options: { description?: string; hidden?: string\[\]; image?: string; public?: string\[\] } #### Returns [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # LiveChatMessageBlueprint | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Blueprints](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html) * [LiveChatMessageBlueprint](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.LiveChatMessageBlueprint.html) Function LiveChatMessageBlueprint ================================= * LiveChatMessageBlueprint(     stream: Event,     message: string,     options?: [LiveChatMessageBlueprintOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Blueprints.LiveChatMessageBlueprintOptions.html) , ): [EventBlueprint](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventBlueprint.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.LiveChatMessageBlueprint.html#livechatmessageblueprint) A blueprint for creating a live stream message #### Parameters * stream: Event * message: string * `Optional`options: [LiveChatMessageBlueprintOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Blueprints.LiveChatMessageBlueprintOptions.html) #### Returns [EventBlueprint](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventBlueprint.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # skip | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html) * [skip](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.skip.html) Function skip ============= * skip<[T](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.skip.html#skipt) \>(): (value: [T](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.skip.html#skipt) ) \=> [T](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.skip.html#skipt) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.skip.html#skip) A pipeline operation that does nothing #### Type Parameters * T #### Returns (value: [T](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.skip.html#skipt) ) \=> [T](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.skip.html#skipt) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # removeInboxRelay | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Operations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html) * [TagOperations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html) * [removeInboxRelay](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.removeInboxRelay.html) Function removeInboxRelay ========================= * removeInboxRelay(url: string | URL): [TagOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.TagOperation.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.removeInboxRelay.html#removeinboxrelay) Remove an inbox relay in NIP-65 mailboxes #### Parameters * url: string | URL #### Returns [TagOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.TagOperation.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # LegacyMessagesGroups | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Models](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html) * [LegacyMessagesGroups](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.LegacyMessagesGroups.html) Function LegacyMessagesGroups ============================= * LegacyMessagesGroups(     self: string, ): [Model](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Model.html) <{ id: string; lastMessage: Event; participants: string\[\] }\[\]\>[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.LegacyMessagesGroups.html#legacymessagesgroups) A model that returns all legacy message groups (1-1) that a pubkey is participating in #### Parameters * self: string #### Returns [Model](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Model.html) <{ id: string; lastMessage: Event; participants: string\[\] }\[\]\> ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # WalletConnectURI | AppleSauce * [applesauce-wallet-connect](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-wallet-connect.Helpers.html) * [WalletConnectURI](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletConnectURI.html) Interface WalletConnectURI ========================== interface WalletConnectURI {     [lud16](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletConnectURI.html#lud16) ?: string;     [relays](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletConnectURI.html#relays) : string\[\];     [secret](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletConnectURI.html#secret) : string;     [service](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletConnectURI.html#service) : string; } ##### Index ### Properties [lud16?](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletConnectURI.html#lud16) [relays](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletConnectURI.html#relays) [secret](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletConnectURI.html#secret) [service](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletConnectURI.html#service) Properties ---------- ### `Optional`lud16[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletConnectURI.html#lud16) lud16?: string An optional lub16 lightning address that is associated with the wallet ### relays[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletConnectURI.html#relays) relays: string\[\] The relays to use for the connection ### secret[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletConnectURI.html#secret) secret: string The secret key that the client will use to encrypt messages ### service[](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletConnectURI.html#service) service: string The pubkey of the wallet service ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [lud16](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletConnectURI.html#lud16) [relays](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletConnectURI.html#relays) [secret](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletConnectURI.html#secret) [service](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-wallet-connect.Helpers.WalletConnectURI.html#service) --- # GroupPointer | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [GroupPointer](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.GroupPointer.html) Type Alias GroupPointer ======================= NIP-29 group pointer type GroupPointer \= {     [id](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.GroupPointer.html#id) : string;     [name](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.GroupPointer.html#name) ?: string;     [relay](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.GroupPointer.html#relay) : string; } ##### Index ### Properties [id](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.GroupPointer.html#id) [name?](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.GroupPointer.html#name) [relay](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.GroupPointer.html#relay) Properties ---------- ### id[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.GroupPointer.html#id) id: string the id of the group ### `Optional`name[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.GroupPointer.html#name) name?: string The name of the group ### relay[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.GroupPointer.html#relay) relay: string The url to the relay with wss:// or ws:// protocol ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [id](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.GroupPointer.html#id) [name](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.GroupPointer.html#name) [relay](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.GroupPointer.html#relay) --- # NoteBlueprint | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Blueprints](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html) * [NoteBlueprint](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.NoteBlueprint.html) Function NoteBlueprint ====================== * NoteBlueprint(content: string, options?: [NoteBlueprintOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Blueprints.NoteBlueprintOptions.html) ): [EventBlueprint](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventBlueprint.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.NoteBlueprint.html#noteblueprint) Short text note (kind 1) blueprint #### Parameters * content: string * `Optional`options: [NoteBlueprintOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Blueprints.NoteBlueprintOptions.html) #### Returns [EventBlueprint](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventBlueprint.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # FollowUser | AppleSauce * [applesauce-actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.html) * [Actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html) * [FollowUser](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.FollowUser.html) Function FollowUser =================== * FollowUser(pubkey: string, relay?: string, hidden?: boolean): [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.FollowUser.html#followuser) An action that adds a pubkey to a users contacts event #### Parameters * pubkey: string * `Optional`relay: string * hidden: boolean = false #### Returns [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # Poll | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Operations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html) * [Poll](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Poll.html) Namespace Poll ============== Functions --------- [addOption](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.Poll.addOption.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Poll.html#addoption) [addRelay](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.Poll.addRelay.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Poll.html#addrelay) [setEndsAt](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.Poll.setEndsAt.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Poll.html#setendsat) [setOptions](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.Poll.setOptions.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Poll.html#setoptions) [setQuestion](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.Poll.setQuestion.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Poll.html#setquestion) [setRelays](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.Poll.setRelays.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Poll.html#setrelays) [setType](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.Poll.setType.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Poll.html#settype) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Functions [addOption](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Poll.html#addoption) [addRelay](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Poll.html#addrelay) [setEndsAt](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Poll.html#setendsat) [setOptions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Poll.html#setoptions) [setQuestion](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Poll.html#setquestion) [setRelays](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Poll.html#setrelays) [setType](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Poll.html#settype) --- # PollResponse | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Operations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html) * [PollResponse](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.PollResponse.html) Namespace PollResponse ====================== Functions --------- [setChoice](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.PollResponse.setChoice.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.PollResponse.html#setchoice) [setChoices](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.PollResponse.setChoices.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.PollResponse.html#setchoices) [setPollEvent](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.PollResponse.setPollEvent.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.PollResponse.html#setpollevent) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Functions [setChoice](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.PollResponse.html#setchoice) [setChoices](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.PollResponse.html#setchoices) [setPollEvent](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.PollResponse.html#setpollevent) --- # removeMailboxRelay | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Operations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html) * [TagOperations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html) * [removeMailboxRelay](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.removeMailboxRelay.html) Function removeMailboxRelay =========================== * removeMailboxRelay(url: string | URL): [TagOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.TagOperation.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.removeMailboxRelay.html#removemailboxrelay) Completely removes a mailbox relay from NIP-65 #### Parameters * url: string | URL #### Returns [TagOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.TagOperation.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # LegacyMessageThreads | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Models](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html) * [LegacyMessageThreads](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.LegacyMessageThreads.html) Function LegacyMessageThreads ============================= * LegacyMessageThreads(self: string, corraspondant: string): [Model](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Model.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.LegacyMessageThreads.html#legacymessagethreads) Returns an array of legacy messages that have replies #### Parameters * self: string * corraspondant: string #### Returns [Model](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Model.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # HandlerLinkPlatform | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [HandlerLinkPlatform](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.HandlerLinkPlatform.html) Type Alias HandlerLinkPlatform ============================== HandlerLinkPlatform: "web" | "ios" | "android" ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # tagPipe | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Helpers.html) * [tagPipe](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.tagPipe.html) Function tagPipe ================ * tagPipe(...operations: (undefined | [TagOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.TagOperation.html) )\[\]): [TagOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.TagOperation.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Helpers.tagPipe.html#tagpipe) The core method that creates a pipeline to create or modify an array of tags #### Parameters * ...operations: (undefined | [TagOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.TagOperation.html) )\[\] #### Returns [TagOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.TagOperation.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # NoteReplyBlueprint | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Blueprints](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html) * [NoteReplyBlueprint](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.NoteReplyBlueprint.html) Function NoteReplyBlueprint =========================== * NoteReplyBlueprint(     parent: Event,     content: string,     options?: [TextContentOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Operations.Content.TextContentOptions.html) , ): [EventBlueprint](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventBlueprint.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.NoteReplyBlueprint.html#notereplyblueprint) Short text note reply (kind 1) blueprint #### Parameters * parent: Event * content: string * `Optional`options: [TextContentOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Operations.Content.TextContentOptions.html) #### Returns [EventBlueprint](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventBlueprint.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # MuteHashtag | AppleSauce * [applesauce-actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.html) * [Actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html) * [MuteHashtag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.MuteHashtag.html) Function MuteHashtag ==================== * MuteHashtag(hashtag: string, hidden?: boolean): [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.MuteHashtag.html#mutehashtag) Add a hashtag to the mute list #### Parameters * hashtag: string * hidden: boolean = false #### Returns [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # Profile | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Operations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html) * [Profile](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Profile.html) Namespace Profile ================= Functions --------- [setProfile](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.Profile.setProfile.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Profile.html#setprofile) [updateProfile](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.Profile.updateProfile.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Profile.html#updateprofile) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Functions [setProfile](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Profile.html#setprofile) [updateProfile](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Profile.html#updateprofile) --- # removeNameValueTag | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Operations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html) * [TagOperations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html) * [removeNameValueTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.removeNameValueTag.html) Function removeNameValueTag =========================== * removeNameValueTag(tag: string\[\]): [TagOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.TagOperation.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.removeNameValueTag.html#removenamevaluetag) Removes all matching name / value tag #### Parameters * tag: string\[\] #### Returns [TagOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.TagOperation.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # HandlerLinkType | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [HandlerLinkType](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.HandlerLinkType.html) Type Alias HandlerLinkType ========================== HandlerLinkType: [DecodeResult](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.DecodeResult.html) \["type"\] ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # MailboxesModel | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Models](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html) * [MailboxesModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.MailboxesModel.html) Function MailboxesModel ======================= * MailboxesModel(     user: string | ProfilePointer, ): [Model](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Model.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.MailboxesModel.html#mailboxesmodel) A model that gets and parses the inbox and outbox relays for a pubkey #### Parameters * user: string | ProfilePointer #### Returns [Model](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Model.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # PicturePostBlueprint | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Blueprints](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html) * [PicturePostBlueprint](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.PicturePostBlueprint.html) Function PicturePostBlueprint ============================= * PicturePostBlueprint(     pictures: [FileMetadata](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.FileMetadata.html) \[\],     content: string,     options?: [PicturePostBlueprintOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Blueprints.PicturePostBlueprintOptions.html) , ): [EventBlueprint](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventBlueprint.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.PicturePostBlueprint.html#picturepostblueprint) A blueprint to create a kind 20 picture post #### Parameters * pictures: [FileMetadata](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.FileMetadata.html) \[\] * content: string * `Optional`options: [PicturePostBlueprintOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Blueprints.PicturePostBlueprintOptions.html) #### Returns [EventBlueprint](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventBlueprint.html) #### See[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.PicturePostBlueprint.html#see) [https://github.com/nostr-protocol/nips/blob/master/68.md](https://github.com/nostr-protocol/nips/blob/master/68.md) #### Throws[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.PicturePostBlueprint.html#throws) if the pictures are not image/\* types ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # MuteThread | AppleSauce * [applesauce-actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.html) * [Actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html) * [MuteThread](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.MuteThread.html) Function MuteThread =================== * MuteThread(thread: string | Event | EventPointer, hidden?: boolean): [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.MuteThread.html#mutethread) Add a thread to the mute list #### Parameters * thread: string | Event | EventPointer * hidden: boolean = false #### Returns [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # Reaction | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Operations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html) * [Reaction](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Reaction.html) Namespace Reaction ================== Functions --------- [setReaction](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.Reaction.setReaction.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Reaction.html#setreaction) [setReactionParent](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.Reaction.setReactionParent.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Reaction.html#setreactionparent) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Functions [setReaction](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Reaction.html#setreaction) [setReactionParent](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Reaction.html#setreactionparent) --- # removeOutboxRelay | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Operations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html) * [TagOperations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html) * [removeOutboxRelay](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.removeOutboxRelay.html) Function removeOutboxRelay ========================== * removeOutboxRelay(url: string | URL): [TagOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.TagOperation.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.removeOutboxRelay.html#removeoutboxrelay) Remove an outbox relay in NIP-65 mailboxes #### Parameters * url: string | URL #### Returns [TagOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.TagOperation.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # MuteModel | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Models](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html) * [MuteModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.MuteModel.html) Function MuteModel ================== * MuteModel(user: string | ProfilePointer): [Model](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Model.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.MuteModel.html#mutemodel) A model that returns all a users muted things #### Parameters * user: string | ProfilePointer #### Returns [Model](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Model.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # HighlightAttribution | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [HighlightAttribution](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.HighlightAttribution.html) Type Alias HighlightAttribution =============================== HighlightAttribution: ProfilePointer & { role?: [HighlightAttributionRole](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.HighlightAttributionRole.html) } Attribution information for a highlight #### Type declaration * ##### `Optional`role?: [HighlightAttributionRole](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.HighlightAttributionRole.html) Role of the attributed profile ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # PollBlueprint | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Blueprints](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html) * [PollBlueprint](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.PollBlueprint.html) Function PollBlueprint ====================== * PollBlueprint(     question: string,     options: [Blueprints](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html) .[PollOption](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.Blueprints.PollOption.html) \[\],     opts?: [PollBlueprintOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Blueprints.PollBlueprintOptions.html) , ): [EventBlueprint](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventBlueprint.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.PollBlueprint.html#pollblueprint) NIP-88 Poll event (kind 1068) blueprint Creates a poll event with question and options #### Parameters * question: string * options: [Blueprints](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html) .[PollOption](https://hzrd149.github.io/applesauce/typedoc/interfaces/applesauce-factory.Blueprints.PollOption.html) \[\] * `Optional`opts: [PollBlueprintOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Blueprints.PollBlueprintOptions.html) #### Returns [EventBlueprint](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventBlueprint.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # MuteUser | AppleSauce * [applesauce-actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.html) * [Actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html) * [MuteUser](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.MuteUser.html) Function MuteUser ================= * MuteUser(pubkey: string, hidden?: boolean): [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.MuteUser.html#muteuser) An action that adds a pubkey to the mute list #### Parameters * pubkey: string * hidden: boolean = false #### Returns [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # removePubkeyTag | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Operations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html) * [TagOperations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html) * [removePubkeyTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.removePubkeyTag.html) Function removePubkeyTag ======================== * removePubkeyTag(pubkey: string | ProfilePointer): [TagOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.TagOperation.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.removePubkeyTag.html#removepubkeytag) Removes all "p" tags matching a pubkey #### Parameters * pubkey: string | ProfilePointer #### Returns [TagOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.TagOperation.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # ProfileModel | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Models](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html) * [ProfileModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.ProfileModel.html) Function ProfileModel ===================== * ProfileModel(user: string | ProfilePointer): [Model](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Model.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.ProfileModel.html#profilemodel) A model that gets and parses the kind 0 metadata for a pubkey #### Parameters * user: string | ProfilePointer #### Returns [Model](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Model.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # HighlightAttributionRole | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [HighlightAttributionRole](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.HighlightAttributionRole.html) Type Alias HighlightAttributionRole =================================== HighlightAttributionRole: "author" | "editor" | "mention" | string Role of an attributed profiles in a highlight ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # PollResponseBlueprint | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Blueprints](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html) * [PollResponseBlueprint](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.PollResponseBlueprint.html) Function PollResponseBlueprint ============================== * PollResponseBlueprint(     poll: string | Event | EventPointer,     optionIds: string\[\],     opts?: [PollResponseBlueprintOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Blueprints.PollResponseBlueprintOptions.html) , ): [EventBlueprint](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventBlueprint.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.PollResponseBlueprint.html#pollresponseblueprint) NIP-88 Poll Response event (kind 1018) blueprint Creates a response to a poll event #### Parameters * poll: string | Event | EventPointer * optionIds: string\[\] * `Optional`opts: [PollResponseBlueprintOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Blueprints.PollResponseBlueprintOptions.html) #### Returns [EventBlueprint](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventBlueprint.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # Stream | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Operations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html) * [Stream](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Stream.html) Namespace Stream ================ Functions --------- [addHashtag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.Stream.addHashtag.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Stream.html#addhashtag) [addParticipant](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.Stream.addParticipant.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Stream.html#addparticipant) [addRelay](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.Stream.addRelay.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Stream.html#addrelay) [removeHashtag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.Stream.removeHashtag.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Stream.html#removehashtag) [removeParticipant](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.Stream.removeParticipant.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Stream.html#removeparticipant) [removePinnedMessage](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.Stream.removePinnedMessage.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Stream.html#removepinnedmessage) [removeRelay](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.Stream.removeRelay.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Stream.html#removerelay) [setCurrentViewers](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.Stream.setCurrentViewers.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Stream.html#setcurrentviewers) [setEndTime](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.Stream.setEndTime.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Stream.html#setendtime) [setHost](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.Stream.setHost.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Stream.html#sethost) [setImage](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.Stream.setImage.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Stream.html#setimage) [setMaxViewers](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.Stream.setMaxViewers.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Stream.html#setmaxviewers) [setPinnedMessage](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.Stream.setPinnedMessage.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Stream.html#setpinnedmessage) [setRecordingUrl](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.Stream.setRecordingUrl.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Stream.html#setrecordingurl) [setStartTime](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.Stream.setStartTime.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Stream.html#setstarttime) [setStatus](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.Stream.setStatus.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Stream.html#setstatus) [setStreamingUrl](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.Stream.setStreamingUrl.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Stream.html#setstreamingurl) [setSummary](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.Stream.setSummary.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Stream.html#setsummary) [setTitle](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.Stream.setTitle.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Stream.html#settitle) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Functions [addHashtag](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Stream.html#addhashtag) [addParticipant](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Stream.html#addparticipant) [addRelay](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Stream.html#addrelay) [removeHashtag](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Stream.html#removehashtag) [removeParticipant](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Stream.html#removeparticipant) [removePinnedMessage](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Stream.html#removepinnedmessage) [removeRelay](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Stream.html#removerelay) [setCurrentViewers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Stream.html#setcurrentviewers) [setEndTime](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Stream.html#setendtime) [setHost](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Stream.html#sethost) [setImage](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Stream.html#setimage) [setMaxViewers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Stream.html#setmaxviewers) [setPinnedMessage](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Stream.html#setpinnedmessage) [setRecordingUrl](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Stream.html#setrecordingurl) [setStartTime](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Stream.html#setstarttime) [setStatus](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Stream.html#setstatus) [setStreamingUrl](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Stream.html#setstreamingurl) [setSummary](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Stream.html#setsummary) [setTitle](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Stream.html#settitle) --- # MuteWord | AppleSauce * [applesauce-actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.html) * [Actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html) * [MuteWord](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.MuteWord.html) Function MuteWord ================= * MuteWord(word: string, hidden?: boolean): [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.MuteWord.html#muteword) Add a word to the mute list #### Parameters * word: string * hidden: boolean = false #### Returns [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # StreamChat | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Operations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html) * [StreamChat](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.StreamChat.html) Namespace StreamChat ==================== Functions --------- [setMessage](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.StreamChat.setMessage.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.StreamChat.html#setmessage) [setStream](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.StreamChat.setStream.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.StreamChat.html#setstream) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Functions [setMessage](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.StreamChat.html#setmessage) [setStream](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.StreamChat.html#setstream) --- # removeRelayTag | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Operations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html) * [TagOperations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html) * [removeRelayTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.removeRelayTag.html) Function removeRelayTag ======================= * removeRelayTag(url: string | URL, tagName?: string): [TagOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.TagOperation.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.removeRelayTag.html#removerelaytag) Removes all relay tags matching the relay #### Parameters * url: string | URL * tagName: string = "relay" #### Returns [TagOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.TagOperation.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # PublicContactsModel | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Models](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html) * [PublicContactsModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.PublicContactsModel.html) Function PublicContactsModel ============================ * PublicContactsModel(pubkey: string): [Model](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Model.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.PublicContactsModel.html#publiccontactsmodel) A model that returns all public contacts for a user #### Parameters * pubkey: string #### Returns [Model](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Model.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # MediaAttachment | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [MediaAttachment](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.MediaAttachment.html) Type Alias MediaAttachment ========================== MediaAttachment: [FileMetadata](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.FileMetadata.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # ReactionBlueprint | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Blueprints](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html) * [ReactionBlueprint](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.ReactionBlueprint.html) Function ReactionBlueprint ========================== * ReactionBlueprint(event: Event, emoji?: string | [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) .[Emoji](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.Emoji.html) ): [EventBlueprint](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventBlueprint.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.ReactionBlueprint.html#reactionblueprint) blueprint for kind 7 reaction event #### Parameters * event: Event * emoji: string | [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) .[Emoji](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.Emoji.html) = "+" #### Returns [EventBlueprint](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventBlueprint.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # NewBlockedRelays | AppleSauce * [applesauce-actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.html) * [Actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html) * [NewBlockedRelays](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.NewBlockedRelays.html) Function NewBlockedRelays ========================= * NewBlockedRelays(     relays?: string\[\] | { hidden?: string\[\]; public?: string\[\] }, ): [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.NewBlockedRelays.html#newblockedrelays) Creates a new blocked relays event #### Parameters * `Optional`relays: string\[\] | { hidden?: string\[\]; public?: string\[\] } #### Returns [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # removeSingletonTag | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Operations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html) * [TagOperations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html) * [removeSingletonTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.removeSingletonTag.html) Function removeSingletonTag =========================== * removeSingletonTag(tag: string): [TagOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.TagOperation.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.removeSingletonTag.html#removesingletontag) Removes all instances of a singleton tag #### Parameters * tag: string #### Returns [TagOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.TagOperation.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # PublicMuteModel | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Models](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html) * [PublicMuteModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.PublicMuteModel.html) Function PublicMuteModel ======================== * PublicMuteModel(pubkey: string): [Model](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Model.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.PublicMuteModel.html#publicmutemodel) A model that returns all a users public muted things #### Parameters * pubkey: string #### Returns [Model](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Model.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # Mutes | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [Mutes](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.Mutes.html) Type Alias Mutes ================ type Mutes \= {     [hashtags](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.Mutes.html#hashtags) : Set;     [pubkeys](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.Mutes.html#pubkeys) : Set;     [threads](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.Mutes.html#threads) : Set;     [words](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.Mutes.html#words) : Set; } ##### Index ### Properties [hashtags](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.Mutes.html#hashtags) [pubkeys](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.Mutes.html#pubkeys) [threads](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.Mutes.html#threads) [words](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.Mutes.html#words) Properties ---------- ### hashtags[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.Mutes.html#hashtags) hashtags: Set ### pubkeys[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.Mutes.html#pubkeys) pubkeys: Set ### threads[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.Mutes.html#threads) threads: Set ### words[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.Mutes.html#words) words: Set ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [hashtags](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.Mutes.html#hashtags) [pubkeys](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.Mutes.html#pubkeys) [threads](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.Mutes.html#threads) [words](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.Mutes.html#words) --- # WrappedMessage | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Operations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html) * [WrappedMessage](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.WrappedMessage.html) Namespace WrappedMessage ======================== Functions --------- [setConversation](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.WrappedMessage.setConversation.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.WrappedMessage.html#setconversation) [setParent](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.WrappedMessage.setParent.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.WrappedMessage.html#setparent) [setSubject](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.WrappedMessage.setSubject.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.WrappedMessage.html#setsubject) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Functions [setConversation](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.WrappedMessage.html#setconversation) [setParent](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.WrappedMessage.html#setparent) [setSubject](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.WrappedMessage.html#setsubject) --- # ShareBlueprint | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Blueprints](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html) * [ShareBlueprint](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.ShareBlueprint.html) Function ShareBlueprint ======================= * ShareBlueprint(event: Event, options?: [ShareBlueprintOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Blueprints.ShareBlueprintOptions.html) ): [EventBlueprint](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventBlueprint.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.ShareBlueprint.html#shareblueprint) Blueprint for a NIP-18 repost event #### Parameters * event: Event * `Optional`options: [ShareBlueprintOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Blueprints.ShareBlueprintOptions.html) #### Returns [EventBlueprint](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventBlueprint.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # NewBlossomServers | AppleSauce * [applesauce-actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.html) * [Actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html) * [NewBlossomServers](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.NewBlossomServers.html) Function NewBlossomServers ========================== * NewBlossomServers(servers?: (string | URL)\[\]): [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.NewBlossomServers.html#newblossomservers) Creates a new Blossom servers event #### Parameters * `Optional`servers: (string | URL)\[\] #### Returns [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # setSingletonTag | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Operations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html) * [TagOperations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.TagOperations.html) * [setSingletonTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.setSingletonTag.html) Function setSingletonTag ======================== * setSingletonTag(tag: \[string, ...string\[\]\], replace?: boolean): [TagOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.TagOperation.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.TagOperations.setSingletonTag.html#setsingletontag) Sets a singleton tag #### Parameters * tag: \[string, ...string\[\]\] * replace: boolean = true #### Returns [TagOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.TagOperation.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # ReactionsModel | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Models](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html) * [ReactionsModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.ReactionsModel.html) Function ReactionsModel ======================= * ReactionsModel(event: Event): [Model](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Model.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.ReactionsModel.html#reactionsmodel) A model that returns all reactions to an event (supports replaceable events) #### Parameters * event: Event #### Returns [Model](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Model.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # Zap | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Operations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html) * [Zap](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Zap.html) Namespace Zap ============= Type Aliases ------------ [ZapOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Operations.Zap.ZapOptions.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Zap.html#zapoptions) Functions --------- [setZapSplit](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.Zap.setZapSplit.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Zap.html#setzapsplit) [setZapSplitTags](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.Zap.setZapSplitTags.html) [](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Zap.html#setzapsplittags) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Type Aliases [ZapOptions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Zap.html#zapoptions) Functions [setZapSplit](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Zap.html#setzapsplit) [setZapSplitTags](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.Zap.html#setzapsplittags) --- # SingleChoicePollResponseBlueprint | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Blueprints](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html) * [SingleChoicePollResponseBlueprint](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.SingleChoicePollResponseBlueprint.html) Function SingleChoicePollResponseBlueprint ========================================== * SingleChoicePollResponseBlueprint(     poll: string | Event | EventPointer,     optionId: string,     opts?: [PollResponseBlueprintOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Blueprints.PollResponseBlueprintOptions.html) , ): [EventBlueprint](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventBlueprint.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.SingleChoicePollResponseBlueprint.html#singlechoicepollresponseblueprint) Convenience blueprint for single-choice poll responses Creates a response to a poll event with a single option #### Parameters * poll: string | Event | EventPointer * optionId: string * `Optional`opts: [PollResponseBlueprintOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Blueprints.PollResponseBlueprintOptions.html) #### Returns [EventBlueprint](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventBlueprint.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # NewContacts | AppleSauce * [applesauce-actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.html) * [Actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html) * [NewContacts](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.NewContacts.html) Function NewContacts ==================== * NewContacts(pubkeys?: (string | ProfilePointer)\[\]): [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.NewContacts.html#newcontacts) An action that creates a new kind 3 contacts lists, throws if a contact list already exists #### Parameters * `Optional`pubkeys: (string | ProfilePointer)\[\] #### Returns [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # ReceivedZapsModel | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Models](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html) * [ReceivedZapsModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.ReceivedZapsModel.html) Function ReceivedZapsModel ========================== * ReceivedZapsModel(pubkey: string): [Model](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Model.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.ReceivedZapsModel.html#receivedzapsmodel) A model that returns all zaps received by a user #### Parameters * pubkey: string #### Returns [Model](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Model.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # MetaTagOptions | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Operations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html) * [MetaTagOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Operations.MetaTagOptions.html) Type Alias MetaTagOptions ========================= Options for [setMetaTags](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.setMetaTags.html) type MetaTagOptions \= {     [alt](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Operations.MetaTagOptions.html#alt) ?: string;     [expiration](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Operations.MetaTagOptions.html#expiration) ?: number;     [protected](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Operations.MetaTagOptions.html#protected) ?: boolean; } ##### Index ### Properties [alt?](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Operations.MetaTagOptions.html#alt) [expiration?](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Operations.MetaTagOptions.html#expiration) [protected?](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Operations.MetaTagOptions.html#protected) Properties ---------- ### `Optional`alt[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Operations.MetaTagOptions.html#alt) alt?: string Alt description for clients that can't render the event ### `Optional`expiration[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Operations.MetaTagOptions.html#expiration) expiration?: number Unix timestamp when the event expires ### `Optional`protected[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Operations.MetaTagOptions.html#protected) protected?: boolean Whether the event is protected (can only be published by author) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [alt](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Operations.MetaTagOptions.html#alt) [expiration](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Operations.MetaTagOptions.html#expiration) [protected](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Operations.MetaTagOptions.html#protected) --- # ParseResult | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [ParseResult](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ParseResult.html) Type Alias ParseResult ====================== ParseResult: { \[P in keyof [ExternalIdentifiers](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ExternalIdentifiers.html)\ \]: [ExternalPointer](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ExternalPointer.html) }\[keyof [ExternalIdentifiers](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ExternalIdentifiers.html)\ \] ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # StreamChatMessage | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Blueprints](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html) * [StreamChatMessage](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.StreamChatMessage.html) Function StreamChatMessage ========================== * StreamChatMessage(     stream: Event | AddressPointer,     content: string,     options?: [TextContentOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Operations.Content.TextContentOptions.html) , ): [EventBlueprint](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventBlueprint.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.StreamChatMessage.html#streamchatmessage) Creates a stream chat message #### Parameters * stream: Event | AddressPointer * content: string * `Optional`options: [TextContentOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Operations.Content.TextContentOptions.html) #### Returns [EventBlueprint](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventBlueprint.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # NewDMRelays | AppleSauce * [applesauce-actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.html) * [Actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html) * [NewDMRelays](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.NewDMRelays.html) Function NewDMRelays ==================== * NewDMRelays(relays?: string\[\]): [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.NewDMRelays.html#newdmrelays) Creates a new DM relays event #### Parameters * `Optional`relays: string\[\] #### Returns [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # ReplaceableModel | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Models](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html) * [ReplaceableModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.ReplaceableModel.html) Function ReplaceableModel ========================= * ReplaceableModel(     pointer: AddressPointer | [AddressPointerWithoutD](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.AddressPointerWithoutD.html) , ): [Model](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Model.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.ReplaceableModel.html#replaceablemodel) A model that returns the latest version of a replaceable event or undefined if its removed #### Parameters * pointer: AddressPointer | [AddressPointerWithoutD](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.AddressPointerWithoutD.html) #### Returns [Model](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Model.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # PollType | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [PollType](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.PollType.html) Type Alias PollType =================== PollType: "singlechoice" | "multiplechoice" ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # ModifyTagsOptions | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Operations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html) * [ModifyTagsOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Operations.ModifyTagsOptions.html) Type Alias ModifyTagsOptions ============================ ModifyTagsOptions:     | [TagOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.TagOperation.html)     | [TagOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.TagOperation.html) \[\]     | {         hidden?: [TagOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.TagOperation.html)         | [TagOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.TagOperation.html) \[\];         public?: [TagOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.TagOperation.html) | [TagOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.TagOperation.html) \[\];     } ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # WrappedMessageBlueprint | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Blueprints](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html) * [WrappedMessageBlueprint](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.WrappedMessageBlueprint.html) Function WrappedMessageBlueprint ================================ * WrappedMessageBlueprint(     participants: string | string\[\],     message: string,     opts?: [WrappedMessageBlueprintOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Blueprints.WrappedMessageBlueprintOptions.html) , ): [EventBlueprint](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventBlueprint.html) <[Rumor](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.Rumor.html) \>[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.WrappedMessageBlueprint.html#wrappedmessageblueprint) A blueprint that creates a wrapped message event to a conversation #### Parameters * participants: string | string\[\] The conversation identifier (pubkey1:pubkey2:pubkey3), a users pubkey, or a list of participant pubkeys * message: string The message to wrap * `Optional`opts: [WrappedMessageBlueprintOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Blueprints.WrappedMessageBlueprintOptions.html) #### Returns [EventBlueprint](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventBlueprint.html) <[Rumor](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.Rumor.html) \> A blueprint that creates a wrapped message event to a conversation ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # NewFavoriteRelays | AppleSauce * [applesauce-actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.html) * [Actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html) * [NewFavoriteRelays](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.NewFavoriteRelays.html) Function NewFavoriteRelays ========================== * NewFavoriteRelays(     relays?: string\[\] | { hidden?: string\[\]; public?: string\[\] },     sets?:         | AddressPointer\[\]         | { hidden?: AddressPointer\[\]; public?: AddressPointer\[\] }, ): [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.NewFavoriteRelays.html#newfavoriterelays) Creates a new favorite relays event #### Parameters * `Optional`relays: string\[\] | { hidden?: string\[\]; public?: string\[\] } * `Optional`sets: AddressPointer\[\] | { hidden?: AddressPointer\[\]; public?: AddressPointer\[\] } #### Returns [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # ReplaceableSetModel | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Models](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html) * [ReplaceableSetModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.ReplaceableSetModel.html) Function ReplaceableSetModel ============================ * ReplaceableSetModel(     pointers: (AddressPointer | [AddressPointerWithoutD](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.AddressPointerWithoutD.html) )\[\], ): [Model](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Model.html) \>[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.ReplaceableSetModel.html#replaceablesetmodel) A model that returns a directory of events by their UID #### Parameters * pointers: (AddressPointer | [AddressPointerWithoutD](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.AddressPointerWithoutD.html) )\[\] #### Returns [Model](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Model.html) \> #### Deprecated[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.ReplaceableSetModel.html#deprecated) use multiple [ReplaceableModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.ReplaceableModel.html) instead ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # includeAltTag | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Operations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html) * [includeAltTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.includeAltTag.html) Function includeAltTag ====================== * includeAltTag(description: string): [EventOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventOperation.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.includeAltTag.html#includealttag) Includes a NIP-31 alt tag in an events public tags #### Parameters * description: string #### Returns [EventOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventOperation.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # ReadListTags | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [ReadListTags](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ReadListTags.html) Type Alias ReadListTags ======================= ReadListTags: "public" | "hidden" | "all" ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # WrappedMessageReplyBlueprint | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Blueprints](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Blueprints.html) * [WrappedMessageReplyBlueprint](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.WrappedMessageReplyBlueprint.html) Function WrappedMessageReplyBlueprint ===================================== * WrappedMessageReplyBlueprint(     parent: [Rumor](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.Rumor.html) ,     message: string,     opts?: [WrappedMessageBlueprintOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Blueprints.WrappedMessageBlueprintOptions.html) , ): [EventBlueprint](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventBlueprint.html) <[Rumor](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.Rumor.html) \>[](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Blueprints.WrappedMessageReplyBlueprint.html#wrappedmessagereplyblueprint) A blueprint that creates a reply to a wrapped message event #### Parameters * parent: [Rumor](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.Rumor.html) * message: string The message to wrap * `Optional`opts: [WrappedMessageBlueprintOptions](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.Blueprints.WrappedMessageBlueprintOptions.html) #### Returns [EventBlueprint](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventBlueprint.html) <[Rumor](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.Rumor.html) \> A blueprint that creates a wrapped message event to a conversation ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # NewSearchRelays | AppleSauce * [applesauce-actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.html) * [Actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html) * [NewSearchRelays](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.NewSearchRelays.html) Function NewSearchRelays ======================== * NewSearchRelays(     relays?: string\[\] | { hidden?: string\[\]; public?: string\[\] }, ): [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.NewSearchRelays.html#newsearchrelays) Creates a new search relays event #### Parameters * `Optional`relays: string\[\] | { hidden?: string\[\]; public?: string\[\] } #### Returns [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # RepliesModel | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Models](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html) * [RepliesModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.RepliesModel.html) Function RepliesModel ===================== * RepliesModel(event: Event, overrideKinds?: number\[\]): [Model](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Model.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.RepliesModel.html#repliesmodel) A model that gets all legacy and NIP-10, and NIP-22 replies for an event #### Parameters * event: Event * `Optional`overrideKinds: number\[\] #### Returns [Model](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Model.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # includeNameValueTag | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Operations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html) * [includeNameValueTag](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.includeNameValueTag.html) Function includeNameValueTag ============================ * includeNameValueTag(     tag: \[string, string, ...string\[\]\],     replace?: boolean, ): [EventOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventOperation.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.includeNameValueTag.html#includenamevaluetag) Includes only a single name / value tag in an events public tags #### Parameters * tag: \[string, string, ...string\[\]\] * replace: boolean = true #### Returns [EventOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventOperation.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # ReportedEvent | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Helpers](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Helpers.html) * [ReportedEvent](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ReportedEvent.html) Type Alias ReportedEvent ======================== type ReportedEvent \= {     [blobs](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ReportedEvent.html#blobs) ?: string\[\];     [comment](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ReportedEvent.html#comment) ?: string;     [event](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ReportedEvent.html#event) : NostrEvent;     [id](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ReportedEvent.html#id) : string;     [pubkey](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ReportedEvent.html#pubkey) : string;     [reason](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ReportedEvent.html#reason) ?: [ReportReason](https://hzrd149.github.io/applesauce/typedoc/enums/applesauce-core.Helpers.ReportReason.html) ;     [type](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ReportedEvent.html#type) : "event"; } ##### Index ### Properties [blobs?](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ReportedEvent.html#blobs) [comment?](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ReportedEvent.html#comment) [event](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ReportedEvent.html#event) [id](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ReportedEvent.html#id) [pubkey](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ReportedEvent.html#pubkey) [reason?](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ReportedEvent.html#reason) [type](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ReportedEvent.html#type) Properties ---------- ### `Optional`blobs[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ReportedEvent.html#blobs) blobs?: string\[\] ### `Optional`comment[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ReportedEvent.html#comment) comment?: string ### event[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ReportedEvent.html#event) event: NostrEvent ### id[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ReportedEvent.html#id) id: string ### pubkey[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ReportedEvent.html#pubkey) pubkey: string ### `Optional`reason[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ReportedEvent.html#reason) reason?: [ReportReason](https://hzrd149.github.io/applesauce/typedoc/enums/applesauce-core.Helpers.ReportReason.html) ### type[](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ReportedEvent.html#type) type: "event" ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [blobs](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ReportedEvent.html#blobs) [comment](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ReportedEvent.html#comment) [event](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ReportedEvent.html#event) [id](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ReportedEvent.html#id) [pubkey](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ReportedEvent.html#pubkey) [reason](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ReportedEvent.html#reason) [type](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ReportedEvent.html#type) --- # PinNote | AppleSauce * [applesauce-actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.html) * [Actions](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.Actions.html) * [PinNote](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.PinNote.html) Function PinNote ================ * PinNote(note: Event): [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-actions.Actions.PinNote.html#pinnote) An action that pins a note to the users pin list #### Parameters * note: Event #### Returns [Action](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-actions.Action.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # SearchRelaysModel | AppleSauce * [applesauce-core](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.html) * [Models](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-core.Models.html) * [SearchRelaysModel](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.SearchRelaysModel.html) Function SearchRelaysModel ========================== * SearchRelaysModel(     pubkey: string,     type?: [ReadListTags](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ReadListTags.html) , ): [Model](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Model.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-core.Models.SearchRelaysModel.html#searchrelaysmodel) A model that returns all search relays for a pubkey #### Parameters * pubkey: string The pubkey to get the search relays for * `Optional`type: [ReadListTags](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Helpers.ReadListTags.html) Which types of tags to read #### Returns [Model](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-core.Model.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # includeReplaceableIdentifier | AppleSauce * [applesauce-factory](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.html) * [Operations](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-factory.Operations.html) * [includeReplaceableIdentifier](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.includeReplaceableIdentifier.html) Function includeReplaceableIdentifier ===================================== * includeReplaceableIdentifier(     identifier?: string | (() \=> string), ): [EventOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventOperation.html) [](https://hzrd149.github.io/applesauce/typedoc/functions/applesauce-factory.Operations.includeReplaceableIdentifier.html#includereplaceableidentifier) Ensures parameterized replaceable kinds have "d" tags #### Parameters * identifier: string | (() \=> string) = nanoid #### Returns [EventOperation](https://hzrd149.github.io/applesauce/typedoc/types/applesauce-factory.EventOperation.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ---