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.

​

Plugin groupé

​

Installations anciennes/personnalisées

• L’onboarding (openclaw onboard) et openclaw channels add présentent toujours Nostr depuis le catalogue de canaux partagé.
• Si votre build exclut Nostr groupé, installez directement le package npm.

openclaw plugins install @openclaw/nostr

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

​

Configuration non interactive

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"

​

Configuration rapide

1. Générez une paire de clés Nostr (si nécessaire) :

# Using nak
nak key generate

2. Ajoutez-la à la configuration :

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

3. Exportez la clé :

export NOSTR_PRIVATE_KEY="nsec1..."

4. Redémarrez le Gateway.

​

Référence de configuration

​

Métadonnées de profil

{
  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",
      },
    },
  },
}

• Les URL de profil doivent utiliser https://.
• L’importation depuis des relais fusionne les champs et préserve les substitutions locales.

​

Contrôle d’accès

​

Politiques de DM

• pairing (par défaut) : les expéditeurs inconnus reçoivent un code d’appairage.
• allowlist : seules les pubkeys dans allowFrom peuvent envoyer des DM.
• open : DM entrants publics (requiert allowFrom: ["*"]).
• disabled : ignorer les DM entrants.

• Les signatures des événements entrants sont vérifiées avant la politique d’expéditeur et le déchiffrement NIP-04, ce qui permet de rejeter tôt les événements falsifiés.
• Les réponses d’appairage sont envoyées sans traiter le corps du DM d’origine.
• Les DM entrants sont limités en débit, et les charges utiles surdimensionnées sont supprimées avant le déchiffrement.

​

Exemple d’allowlist

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

​

Formats de clés

• Clé privée : nsec... ou hex de 64 caractères
• Pubkeys (allowFrom) : npub... ou hex

​

Relais

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

• Utilisez 2 à 3 relais pour la redondance.
• Évitez un trop grand nombre de relais (latence, duplication).
• Les relais payants peuvent améliorer la fiabilité.
• Les relais locaux conviennent aux tests (ws://localhost:7777).

​

Prise en charge du protocole

​

Tests

​

Relais local

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

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

​

Test manuel

1. Notez la pubkey du bot (npub) depuis les journaux.
2. Ouvrez un client Nostr (Damus, Amethyst, etc.).
3. Envoyez un DM à la pubkey du bot.
4. Vérifiez la réponse.

​

Dépannage

​

Messages non reçus

• Vérifiez que la clé privée est valide.
• Assurez-vous que les URL de relais sont joignables et utilisent wss:// (ou ws:// en local).
• Confirmez que enabled n’est pas false.
• Consultez les journaux du Gateway pour les erreurs de connexion aux relais.

​

Réponses non envoyées

• Vérifiez que le relais accepte les écritures.
• Vérifiez la connectivité sortante.
• Surveillez les limites de débit des relais.

​

Réponses en double

• Attendu lors de l’utilisation de plusieurs relais.
• Les messages sont dédupliqués par ID d’événement ; seule la première livraison déclenche une réponse.

​

Sécurité

• Ne commitez jamais de clés privées.
• Utilisez des variables d’environnement pour les clés.
• Envisagez allowlist pour les bots en production.
• Les signatures sont vérifiées avant la politique d’expéditeur, et la politique d’expéditeur est appliquée avant le déchiffrement ; les événements falsifiés sont donc rejetés tôt et les expéditeurs inconnus ne peuvent pas forcer l’exécution complète du travail cryptographique.

​

Limitations (MVP)

• Messages directs uniquement (pas de conversations de groupe).
• Pas de pièces jointes multimédias.
• NIP-04 uniquement (emballage cadeau NIP-17 prévu).

​

Connexe

• Vue d’ensemble des canaux — tous les canaux pris en charge
• Appairage — authentification DM et flux d’appairage
• Groupes — comportement des conversations de groupe et filtrage des mentions
• Routage des canaux — routage de session pour les messages
• Sécurité — modèle d’accès et durcissement