Nostr

Documentation Index

Fetch the complete documentation index at: https://docs.openclaw.ai/llms.txt

Use this file to discover all available pages before exploring further.

​

Dołączony Plugin

​

Starsze/niestandardowe instalacje

• Onboarding (openclaw onboard) oraz openclaw channels add nadal pokazują Nostr ze współdzielonego katalogu kanałów.
• Jeśli Twoja kompilacja wyklucza dołączony Nostr, zainstaluj pakiet npm bezpośrednio.

openclaw plugins install @openclaw/nostr

openclaw plugins install --link <path-to-local-nostr-plugin>

​

Konfiguracja nieinteraktywna

openclaw channels add --channel nostr --private-key "$NOSTR_PRIVATE_KEY"
openclaw channels add --channel nostr --private-key "$NOSTR_PRIVATE_KEY" --relay-urls "wss://relay.damus.io,wss://relay.primal.net"

​

Szybka konfiguracja

1. Wygeneruj parę kluczy Nostr (jeśli potrzebna):

# Using nak
nak key generate

2. Dodaj do konfiguracji:

{
  channels: {
    nostr: {
      privateKey: "${NOSTR_PRIVATE_KEY}",
    },
  },
}

3. Wyeksportuj klucz:

export NOSTR_PRIVATE_KEY="nsec1..."

4. Uruchom ponownie Gateway.

​

Dokumentacja konfiguracji

​

Metadane profilu

{
  channels: {
    nostr: {
      privateKey: "${NOSTR_PRIVATE_KEY}",
      profile: {
        name: "openclaw",
        displayName: "OpenClaw",
        about: "Personal assistant DM bot",
        picture: "https://example.com/avatar.png",
        banner: "https://example.com/banner.png",
        website: "https://example.com",
        nip05: "openclaw@example.com",
        lud16: "openclaw@example.com",
      },
    },
  },
}

• Adresy URL profilu muszą używać https://.
• Importowanie z przekaźników scala pola i zachowuje lokalne nadpisania.

​

Kontrola dostępu

​

Zasady DM

• pairing (domyślnie): nieznani nadawcy otrzymują kod parowania.
• allowlist: DM mogą wysyłać tylko klucze publiczne z allowFrom.
• open: publiczne przychodzące DM (wymaga allowFrom: ["*"]).
• disabled: ignoruj przychodzące DM.

• Podpisy zdarzeń przychodzących są weryfikowane przed zasadami nadawcy i odszyfrowaniem NIP-04, więc sfałszowane zdarzenia są odrzucane wcześnie.
• Odpowiedzi parowania są wysyłane bez przetwarzania pierwotnej treści DM.
• Przychodzące DM są ograniczane limitem szybkości, a zbyt duże ładunki są odrzucane przed odszyfrowaniem.

​

Przykład allowlist

{
  channels: {
    nostr: {
      privateKey: "${NOSTR_PRIVATE_KEY}",
      dmPolicy: "allowlist",
      allowFrom: ["npub1abc...", "npub1xyz..."],
    },
  },
}

​

Formaty kluczy

• Klucz prywatny: nsec... lub 64-znakowy hex
• Klucze publiczne (allowFrom): npub... lub hex

​

Przekaźniki

{
  channels: {
    nostr: {
      privateKey: "${NOSTR_PRIVATE_KEY}",
      relays: ["wss://relay.damus.io", "wss://relay.primal.net", "wss://nostr.wine"],
    },
  },
}

• Używaj 2-3 przekaźników dla redundancji.
• Unikaj zbyt wielu przekaźników (opóźnienia, duplikacja).
• Płatne przekaźniki mogą poprawić niezawodność.
• Lokalne przekaźniki dobrze sprawdzają się w testach (ws://localhost:7777).

​

Obsługa protokołu

​

Testowanie

​

Lokalny przekaźnik

# Start strfry
docker run -p 7777:7777 ghcr.io/hoytech/strfry

{
  channels: {
    nostr: {
      privateKey: "${NOSTR_PRIVATE_KEY}",
      relays: ["ws://localhost:7777"],
    },
  },
}

​

Test ręczny

1. Zanotuj klucz publiczny bota (npub) z logów.
2. Otwórz klienta Nostr (Damus, Amethyst itd.).
3. Wyślij DM na klucz publiczny bota.
4. Zweryfikuj odpowiedź.

​

Rozwiązywanie problemów

​

Wiadomości nie są odbierane

• Zweryfikuj, czy klucz prywatny jest prawidłowy.
• Upewnij się, że adresy URL przekaźników są osiągalne i używają wss:// (lub ws:// lokalnie).
• Potwierdź, że enabled nie ma wartości false.
• Sprawdź logi Gateway pod kątem błędów połączeń z przekaźnikami.

​

Odpowiedzi nie są wysyłane

• Sprawdź, czy przekaźnik akceptuje zapisy.
• Zweryfikuj łączność wychodzącą.
• Uważaj na limity szybkości przekaźników.

​

Zduplikowane odpowiedzi

• Oczekiwane przy używaniu wielu przekaźników.
• Wiadomości są deduplikowane według identyfikatora zdarzenia; tylko pierwsze dostarczenie wywołuje odpowiedź.

​

Bezpieczeństwo

• Nigdy nie commituj kluczy prywatnych.
• Używaj zmiennych środowiskowych dla kluczy.
• Rozważ allowlist dla botów produkcyjnych.
• Podpisy są weryfikowane przed zasadami nadawcy, a zasady nadawcy są wymuszane przed odszyfrowaniem, więc sfałszowane zdarzenia są odrzucane wcześnie, a nieznani nadawcy nie mogą wymusić pełnej pracy kryptograficznej.

​

Ograniczenia (MVP)

• Tylko wiadomości bezpośrednie (bez czatów grupowych).
• Brak załączników multimedialnych.
• Tylko NIP-04 (planowany gift-wrap NIP-17).

​

Powiązane

• Przegląd kanałów — wszystkie obsługiwane kanały
• Parowanie — uwierzytelnianie DM i przepływ parowania
• Grupy — zachowanie czatu grupowego i kontrola wzmianek
• Routing kanałów — routing sesji dla wiadomości
• Bezpieczeństwo — model dostępu i utwardzanie