Signal出力
Signal出力:
Section titled “Signal出力:”signal出力は、別途管理するsignal-cli HTTP JSON-RPCデーモンを通じて、選択したAdderイベントを送信します。Signalには公式のボットAPIがありません。リンク済みまたは登録済みのアカウントを使用する、管理対象のsignal-cliデーモンを実行してください。たとえば、次のコマンドを使用します。
signal-cli -a ACCOUNT daemon --http=127.0.0.1:8081plugins.output.signalに次のYAML設定を指定します。
plugins: output: signal: endpoint: "http://127.0.0.1:8081/api/v1/rpc" recipients: "+15551234567,00000000-0000-0000-0000-000000000000" account: "+15557654321" event-types: "blocks,rollbacks,governance"| 項目 | 必須 | 説明 |
|---|---|---|
endpoint | いいえ | signal-cliデーモンのHTTP JSON-RPC URL。既定値はhttp://127.0.0.1:8081/api/v1/rpcです。 |
recipients | はい | 受信者の電話番号またはサービスIDをカンマ区切りで指定します。既定値はありません。少なくとも1件の受信者を指定してください。 |
account | いいえ | 複数アカウントを扱うデーモンで使用するsignal-cliアカウントです。 |
event-types | いいえ | 送信するイベントタイプをカンマ区切りで指定します。既定値はblocks,rollbacks,governanceです。値の大文字と小文字は区別しません。 |
endpointの制限
Section titled “endpointの制限”endpointには、/api/v1/rpcパスを持つURLを指定します。Adderは次の規則でURLを検証します。
- リモートエンドポイントにはHTTPSを使用します。
localhost、127.0.0.1、または::1のループバックエンドポイントではHTTPを使用できます。- URLに認証情報、クエリ、またはフラグメントを指定できません。
- パスは
/api/v1/rpcと完全に一致する必要があります。
イベントタイプ
Section titled “イベントタイプ”event-typesには次の値を指定できます。
blocks— ブロックイベントtransactions— トランザクションイベントrollbacks— ロールバックイベントgovernance— ガバナンスイベントdrep-registration— DRep登録イベントdrep-update— DRep更新イベントdrep-retirement— DRep退任イベント
event-typesに未対応の値を指定すると、設定を拒否します。空の値は少なくとも1つのイベントタイプを指定していないため、設定を拒否します。
選択した各イベントのJSONをメッセージ本文として、signal-cliのsend JSON-RPCメソッドに送信します。HTTPリクエストはPOSTで、Content-Typeはapplication/jsonです。accountを指定した場合、リクエストにそのアカウントを含めます。
AdderはHTTPステータス200のレスポンスだけを受け付けます。さらに、レスポンスが次の条件をすべて満たす必要があります。
- JSON-RPCバージョンが
2.0である。 - レスポンスIDがリクエストIDと一致する。
- 成功した
sendの結果に0ではないタイムスタンプが含まれる。 - 各受信者の結果のステータスが
SUCCESSである。
受信者の送信に失敗した場合、Adderはその結果タイプをエラーとして報告します。エラーにはメッセージ本文や受信者アドレスを記録しません。その他のRPCエラー、無効なレスポンス、HTTPエラーも出力エラーチャネルに報告します。
Adderはリクエストを自動的に再試行しません。タイムアウトはSignalがメッセージを送信した後にも発生する可能性があり、再試行すると重複送信につながるためです。RPCが成功した場合も、signal-cliが送信を受け付けたことだけを示し、受信者がメッセージを読んだことは示しません。
再起動時の動作
Section titled “再起動時の動作”保留中のイベントはAdderの再起動をまたいで保持されません。再起動時に保留中だったイベントは、再起動後にSignalへ送信されません。
安全に確認するには、専用のSignalアカウントと受信者を使用して、次の手順を実行します。
- Signalアカウントをリンクまたは登録し、
signal-cliHTTP JSON-RPCデーモンを実行します。 endpointとrecipientsに確認用のデーモンと受信者を指定します。event-typesで選択したイベントをAdderから送信します。- 受信者にメッセージが届くことを確認します。
ローカルテストではHTTPテストデーモンを使用して、JSON-RPCリクエストとレスポンスの契約を確認できます。
Docs authored by Doc Holiday