主な機能 🚀
簡単セットアップ
公開されているDockerイメージを利用するか、最小限の設定で開発モードを開始できます。
柔軟なウォレットオプション
ローカルで管理する秘密鍵を使ったSequenceスマートウォレット、またはAWS/GCP KMSと安全に連携してセキュリティを強化できます。
Webhook管理
高性能なSequence Indexerを活用し、独自のカスタムWebhookを構築・設定できます。
Tenderly連携
Tenderlyを利用してトランザクションのデバッグが簡単に行えます。Sidekick経由で実行された各トランザクションにはシミュレーション用URLが付与されます。
自動コントラクト検証
コントラクトの検証は手間がかかります。Sidekickはデプロイされたすべてのコントラクトを検証します。
Sequence Builderとの統合
すでにSequence Builderのプロジェクトをお持ちですか？すべてのコントラクトデータをAPIコール1回でSidekickにインポートできます。
Bull MQダッシュボード内蔵
バックグラウンドジョブの作成・監視・管理が可能です。
Swagger UI
APIドキュメントを確認し、Swagger UIでエンドポイントのテストが行えます。
最適化されたトランザクション実行
トランザクションは最適なガス価格で送信され、3ブロック以内にmempoolに含まれない場合は自動で再送信されます。
分析とモニタリング
SidekickはGrafana、Prometheus、Blackbox Exporterと統合されており、バックエンドの状態を監視できます。
バックエンドウォレットについて
Sidekickは、指定されたBACKEND_WALLET_PV_KEYまたはAWS / GCP KMS署名者に基づいてSequenceスマートコントラクトウォレットを作成します。これにより、ガス代の肩代わり（ガススポンサーシップ）、トランザクションのバッチ処理、その他の最適化が可能となります。
バックエンドウォレットの設定方法：
- ローカル環境でセットアップする場合は、BACKEND_WALLET_PV_KEYを.envファイルに記載してください（本番環境では推奨されません）。また、指定しない場合はランダムなキーが自動生成され、
dev.keyファイルに保存されます。 - 推奨方法： AWS または GCP KMSを設定し、必要な認証情報を.envファイルに追加
ローカル、AWS、GCPウォレット構成に必要な認証情報は、env.exampleファイルをご参照ください。
AWS KMSおよびGCP KMSで正しいキータイプを選択してください。
- AWS KMS:
ECC_NIST_P256_KEY_ALIAS - GCP KMS:
GCP_KEY_RING_NAME
Sequence Sidekickを利用する際の注意点：
msg.senderはあなたのEOAのSequenceウォレットアドレスとなり、EOAアドレスそのものではありません。tx.originはSequenceリレイヤーアドレスのいずれかになります。- コントラクト関数呼び出しの際は、Sequenceウォレットアドレスに適切な権限が付与されていることを確認してください。
- メインネットステータスページでアクティブなリレイヤーアドレスを確認できます。
CLIからDockerで開始する
GitHub Container Registryで公開されているDockerイメージをご利用いただけます。SEQUENCE_PROJECT_ACCESS_KEY の設定も推奨していますが、テスト目的の場合はデフォルトのキーも利用できます。ご自身のキーはSequence Builderから取得できます。
開発モードでSidekickを起動する
1
Sidekickリポジトリをクローンする
2
3
Dockerがインストールされていることを確認してください
こちらから入手できます
4
DockerコンテナでSidekickを起動する
5
バックエンドウォレットアドレスの確認