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 incluído

​

Instalações antigas/personalizadas

• O onboarding (openclaw onboard) e openclaw channels add ainda exibem o Nostr a partir do catálogo compartilhado de canais.
• Se o seu build excluir o Nostr incluído, instale o pacote npm diretamente.

openclaw plugins install @openclaw/nostr

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

​

Configuração não interativa

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"

​

Configuração rápida

1. Gere um par de chaves Nostr (se necessário):

# Using nak
nak key generate

2. Adicione à configuração:

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

3. Exporte a chave:

export NOSTR_PRIVATE_KEY="nsec1..."

4. Reinicie o Gateway.

​

Referência de configuração

​

Metadados de perfil

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

• URLs de perfil devem usar https://.
• A importação a partir de relays mescla campos e preserva substituições locais.

​

Controle de acesso

​

Políticas de DM

• pairing (padrão): remetentes desconhecidos recebem um código de pairing.
• allowlist: somente pubkeys em allowFrom podem enviar DM.
• open: DMs públicas de entrada (exige allowFrom: ["*"]).
• disabled: ignora DMs de entrada.

• Assinaturas de eventos de entrada são verificadas antes da política de remetente e da descriptografia NIP-04, portanto eventos forjados são rejeitados cedo.
• Respostas de pairing são enviadas sem processar o corpo da DM original.
• DMs de entrada têm limite de taxa, e cargas úteis grandes demais são descartadas antes da descriptografia.

​

Exemplo de allowlist

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

​

Formatos de chave

• Chave privada: nsec... ou hex de 64 caracteres
• Pubkeys (allowFrom): npub... ou hex

​

Relays

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

• Use 2 a 3 relays para redundância.
• Evite relays demais (latência, duplicação).
• Relays pagos podem melhorar a confiabilidade.
• Relays locais são adequados para testes (ws://localhost:7777).

​

Suporte de protocolo

​

Testes

​

Relay local

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

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

​

Teste manual

1. Anote a pubkey (npub) do bot nos logs.
2. Abra um cliente Nostr (Damus, Amethyst etc.).
3. Envie uma DM para a pubkey do bot.
4. Verifique a resposta.

​

Solução de problemas

​

Não recebe mensagens

• Verifique se a chave privada é válida.
• Garanta que as URLs de relay estejam acessíveis e usem wss:// (ou ws:// para local).
• Confirme que enabled não é false.
• Verifique os logs do Gateway para erros de conexão com relay.

​

Não envia respostas

• Verifique se o relay aceita escritas.
• Verifique a conectividade de saída.
• Fique atento aos limites de taxa do relay.

​

Respostas duplicadas

• Esperado ao usar vários relays.
• As mensagens são desduplicadas por ID de evento; somente a primeira entrega aciona uma resposta.

​

Segurança

• Nunca faça commit de chaves privadas.
• Use variáveis de ambiente para chaves.
• Considere allowlist para bots em produção.
• Assinaturas são verificadas antes da política de remetente, e a política de remetente é aplicada antes da descriptografia, portanto eventos forjados são rejeitados cedo e remetentes desconhecidos não podem forçar trabalho criptográfico completo.

​

Limitações (MVP)

• Somente mensagens diretas (sem chats em grupo).
• Sem anexos de mídia.
• Somente NIP-04 (NIP-17 gift-wrap planejado).

​

Relacionados

• Visão geral de canais — todos os canais compatíveis
• Pairing — autenticação de DM e fluxo de pairing
• Grupos — comportamento de chat em grupo e controle por menções
• Roteamento de canais — roteamento de sessões para mensagens
• Segurança — modelo de acesso e hardening