signal

Documentation

Overview

Package signal is the gateway's Signal channel adapter. It talks to a signal-cli daemon running in native HTTP mode (`signal-cli daemon --http`): inbound messages arrive over the daemon's SSE event stream, replies go out as JSON-RPC `send` calls. Nobody embeds libsignal — both Hermes and OpenClaw require the same companion daemon; we spawn nothing and just connect to it (SIGNAL_CLI_URL, default http://127.0.0.1:8080). The account is a LINKED DEVICE (`signal-cli link`) — use a dedicated number, not your main one.

Attachments: the daemon writes them to its own data directory; the adapter reads them from there (attachmentsDir) and copies them into the media spool.

Index

• type Channel
  • func New(baseURL, account, attachmentsDir, mediaDir string) *Channel
  • func (c *Channel) Name() string
  • func (c *Channel) Send(ctx context.Context, conversation string, msg channels.Outbound) error
  • func (c *Channel) Start(ctx context.Context, sink channels.Sink) error

Types

type Channel

type Channel struct {
	// contains filtered or unexported fields
}

Channel is a connection to a signal-cli HTTP daemon.

func New

func New(baseURL, account, attachmentsDir, mediaDir string) *Channel

New builds a Signal channel. baseURL "" uses the local daemon default.

func (*Channel) Name

func (c *Channel) Name() string

Name returns the adapter identifier.

func (*Channel) Send

func (c *Channel) Send(ctx context.Context, conversation string, msg channels.Outbound) error

Send posts a reply — to a peer (DM) or a group — as JSON-RPC send calls, split with the shared chunker. A synthesized voice note (VoicePath) rides the first part as an attachment path; the daemon runs on the same machine, so the spool path is directly readable.

func (*Channel) Start

func (c *Channel) Start(ctx context.Context, sink channels.Sink) error

Start consumes the daemon's SSE event stream until ctx is cancelled, reconnecting with jittered backoff on any error. Delivery is best-effort like Discord's websocket: the daemon has no per-message replay, so a failed durable record can't be re-driven from the provider side.