NWC.h

Go to the documentation of this file.

#ifndef _NOSTR_NWC_H
#define _NOSTR_NWC_H
#include <functional>
#include <memory>
#include <vector>
 
#include "ArduinoJson.h"
#include "Nip47.h"
#include "NostrEvent.h"
#include "NostrPool.h"
#include "NostrString.h"
#include "NostrTransport.h"
#include "NostrUtils.h"
 
#define NWC_INFO_KIND "13194"
#define NWC_RESPONSE_KIND "23195"
#define NWC_NIP04_NOTIFICATION_KIND "23196"
#define NWC_NIP44_NOTIFICATION_KIND "23197"
 
#define NWC_DEFAULT_TIMEOUT (60 * 10) // 10 minutes in seconds
#define NWC_INFINITE_TIMEOUT (0xFFFFFFFF) // Max unsigned int, ~136 years
 
namespace nostr {
 
enum class NWCEncryptionPolicy {
    RequireNip44,
    AllowLegacyNip04
};
 
class NWCResponseCallbackBase {
  public:
    virtual ~NWCResponseCallbackBase() = default;
    virtual void call(Nip47 *nip47, SignedNostrEvent *ev) {}
    std::function<void(NostrString, NostrString)> onErr = nullptr;
    unsigned long long timestampSeconds;
    unsigned int timeoutSeconds = NWC_DEFAULT_TIMEOUT;
    NostrString eventId;
    NostrString subId;
    unsigned int n = 1;
    bool requiresItemId = false;
    bool strictItemIds = false;
    std::vector<NostrString> expectedItemIds;
    std::vector<NostrString> seenItemIds;
    std::vector<NostrString> seenEventIds;
    bool accept(SignedNostrEvent *event);
};
 
template <typename T> class NWCResponseCallback : public NWCResponseCallbackBase {
  public:
    void call(Nip47 *nip47, SignedNostrEvent *ev) override {
        Nip47Response<T> resp;
        nip47->parseResponse(ev, resp);
        if (NostrString_length(resp.errorCode) > 0) {
            if (this->onErr != nullptr) {
                this->onErr(resp.errorCode, resp.errorMessage);
            }
        } else {
            if (this->onRes != nullptr) {
                this->onRes(resp.result);
            }
        }
    }
    std::function<void(T)> onRes = nullptr;
};
 
class NWC {
  public:
    ~NWC();
    NWC(Transport *transport, NostrString nwcUrl, const NostrLimits &limits = NostrLimits(),
        NWCEncryptionPolicy encryptionPolicy = NWCEncryptionPolicy::RequireNip44);
 
    void loop();
 
    void close();
 
    bool isReady() const { return encryptionReady; }
 
    bool isValid() const { return validConnection; }
 
    Nip47Encryption getEncryption() const { return nip47.getEncryption(); }
 
    void payInvoice(NostrString invoice, MilliSats amount = MILLISATS_UNSPECIFIED, std::function<void(PayInvoiceResponse)> onRes = nullptr,
                    std::function<void(NostrString, NostrString)> onErr = nullptr);
 
    void multiPayInvoice(std::initializer_list<Invoice> invoices, std::function<void(MultiPayInvoiceResponse)> onRes = nullptr, std::function<void(NostrString, NostrString)> onErr = nullptr);
    void multiPayInvoice(const std::vector<Invoice> &invoices, std::function<void(MultiPayInvoiceResponse)> onRes = nullptr,
                         std::function<void(NostrString, NostrString)> onErr = nullptr);
 
    void payKeySend(NostrString pubkey, MilliSats amount, NostrString preimage = "", std::initializer_list<TLVRecords> tlv = {}, std::function<void(PayKeySendResponse)> onRes = nullptr,
                    std::function<void(NostrString, NostrString)> onErr = nullptr);
    void payKeySend(NostrString pubkey, MilliSats amount, NostrString preimage, const std::vector<TLVRecords> &tlv,
                    std::function<void(PayKeySendResponse)> onRes = nullptr,
                    std::function<void(NostrString, NostrString)> onErr = nullptr);
 
    void multiPayKeySend(std::initializer_list<KeySend> keySends, std::function<void(MultiPayKeySendResponse)> onRes = nullptr, std::function<void(NostrString, NostrString)> onErr = nullptr);
    void multiPayKeySend(const std::vector<KeySend> &keySends, std::function<void(MultiPayKeySendResponse)> onRes = nullptr,
                         std::function<void(NostrString, NostrString)> onErr = nullptr);
 
    void makeInvoice(MilliSats amount, NostrString description = "", NostrString descriptionHash = "", unsigned long expiry = 0, std::function<void(MakeInvoiceResponse)> onRes = nullptr,
                     std::function<void(NostrString, NostrString)> onErr = nullptr);
 
    void lookUpPaymentHash(NostrString paymentHash, std::function<void(LookUpInvoiceResponse)> onRes = nullptr, std::function<void(NostrString, NostrString)> onErr = nullptr);
 
    void lookUpInvoice(NostrString invoice, std::function<void(LookUpInvoiceResponse)> onRes = nullptr, std::function<void(NostrString, NostrString)> onErr = nullptr);
 
    void listTransactions(unsigned long from = 0, unsigned long until = 0, int limit = 0, int offset = 0, bool unpaid = false, NostrString type = "",
                          std::function<void(ListTransactionsResponse)> onRes = nullptr, std::function<void(NostrString, NostrString)> onErr = nullptr);
 
    void getBalance(std::function<void(GetBalanceResponse)> onRes = nullptr, std::function<void(NostrString, NostrString)> onErr = nullptr);
 
    void getInfo(std::function<void(GetInfoResponse)> onRes = nullptr, std::function<void(NostrString, NostrString)> onErr = nullptr);
 
    void subscribeNotifications(std::function<void(NotificationResponse)> onRes, std::function<void(NostrString, NostrString)> onErr);
 
    void setSeenTracker(NostrSeenCallback callback) {
        if (this->pool != nullptr) this->pool->setSeenTracker(callback);
    }
 
  private:
    struct PendingRequest {
        std::function<void()> send;
        std::function<void(NostrString, NostrString)> onErr;
    };
 
    Transport *transport;
    NostrLimits limits;
    NWCEncryptionPolicy encryptionPolicy;
    NostrString sendEvent(SignedNostrEvent *ev,
                          std::function<void(NostrString, NostrString)> onErr);
    void discoverEncryption();
    void finishEncryptionDiscovery();
    void selectEncryption(Nip47Encryption encryption, bool includeEncryptionTag);
    void rejectUnsupportedEncryption();
    void failEncryption(NostrString errorCode, NostrString errorMessage);
    bool deferUntilEncryptionReady(std::function<void()> send,
                                   std::function<void(NostrString, NostrString)> onErr);
    bool flushPendingRequests();
    bool rejectIfCallbackQueueFull(std::function<void(NostrString, NostrString)> onErr);
    void finishInfoSubscription();
    void performClose();
    void removeCallback(const std::shared_ptr<NWCResponseCallbackBase> &callback);
    std::unique_ptr<NostrPool> pool;
    NWCData nwc;
    Nip47 nip47;
    NostrString accountPubKey;
    NostrString infoSubId;
    bool encryptionReady = false;
    bool encryptionFailed = false;
    unsigned int notificationKind = 0;
    NostrString encryptionErrorCode;
    NostrString encryptionErrorMessage;
    std::vector<PendingRequest> pendingRequests;
    std::vector<std::shared_ptr<NWCResponseCallbackBase>> callbacks;
    unsigned int poolDispatchDepth = 0;
    bool deferredClose = false;
    bool closed = false;
    bool validConnection = false;
    unsigned long long discoveryStartedAt = 0;
    bool sawInfoEvent = false;
    bool sawNip44 = false;
    bool sawNip04 = false;
    bool sawLegacyWithoutTag = false;
};
} 
 
#endif