Características principales 🚀
Configuración sin complicaciones
Puede usar nuestra imagen pública de Docker o iniciarlo en modo de desarrollo con una configuración mínima.
Opciones flexibles de wallet
Utilice una Sequence Smart Wallet con claves privadas gestionadas localmente o integre de forma segura AWS/GCP KMS para mayor seguridad.
Gestión de webhooks
Aproveche nuestro indexador de alto rendimiento para crear y configurar sus propios webhooks personalizados mediante el eficiente Sequence Indexer.
Integración con Tenderly
Utilice Tenderly para depurar fácilmente sus transacciones; obtiene una URL de simulación para cada transacción ejecutada a través de Sidekick.
Verificación automática de contratos
La verificación de contratos suele ser tediosa. Sidekick lo hace automáticamente en cada contrato que despliegas.
Integrado con Sequence Builder
¿Ya tiene un proyecto en Sequence Builder? Importe todos los datos de sus contratos a Sidekick con una sola llamada a la API.
Panel integrado de Bull MQ
Cree, monitoree y gestione sus tareas en segundo plano.
Swagger UI
Explore la documentación de la API y pruebe los endpoints con Swagger UI
Ejecución de transacciones optimizada
Las transacciones se envían con precios de gas óptimos y se reenvían automáticamente si no se incluyen en el mempool en tres bloques.
Analítica y monitoreo
Sidekick viene integrado con Grafana, Prometheus y Blackbox Exporter para monitorear la salud de su backend.
Acerca del backend wallet
Sidekick crea una Sequence Smart Contract Wallet basada en elBACKEND_WALLET_PV_KEY
o el firmante de AWS / GCP KMS
que usted proporcione. Esto permite patrocinio de gas, batching y otras optimizaciones.
Para configurar el backend wallet, puedes:
- Declare su BACKEND_WALLET_PV_KEY en el archivo .env para una configuración local (no recomendado para producción), o no lo proporcione y se generará uno aleatorio para usted, el cual podrá encontrar en el archivo
dev.key
generado automáticamente. - Usa el método recomendado: configura AWS o GCP KMS y agrega las credenciales necesarias en el archivo .env.
Para saber cuáles son las credenciales requeridas para configuraciones de wallet local, AWS o GCP, consulte el archivo env.example.
Asegúrese de elegir los tipos de clave correctos en AWS KMS y GCP KMS.
- AWS KMS:
ECC_NIST_P256_KEY_ALIAS
- GCP KMS:
GCP_KEY_RING_NAME
Inicie con Docker desde la CLI
Hay una imagen pública de Docker disponible en GitHub Container Registry.Recomendamos también configurar SEQUENCE_PROJECT_ACCESS_KEY, pero para pruebas proporcionamos uno predeterminado. Puedes obtener tu clave en Sequence Builder.
Inicie Sidekick en modo de desarrollo
1
Clone el repositorio de Sidekick
2
Configure las variables de entorno requeridas
Variables de entorno requeridas
Variable | Description |
---|---|
PROJECT_ACCESS_KEY | Clave de acceso de Sequence Builder API Keys |
Variables de entorno opcionales
Variable | Description |
---|---|
BACKEND_WALLET_PV_KEY | Clave privada para la EOA utilizada para firmar transacciones |
PORT | Puerto para el servidor de Sidekick (por defecto: 7500) |
HOST | Dirección del host para el servidor (por defecto: 0.0.0.0) |
REDIS_HOST | Host del servidor Redis (por defecto: localhost) |
REDIS_PORT | Puerto del servidor Redis (por defecto: 6379) |
REDIS_PASSWORD | Contraseña para el servidor Redis (opcional) |
DATABASE_URL | Cadena de conexión PostgreSQL para la base de datos de Sidekick |
SIDEKICK_API_SECRET_KEY | Clave secreta requerida para acceso de escritura a la API de Sidekick |
ETHERSCAN_API_KEY | Clave de API para Etherscan para habilitar la verificación de contratos |
VERIFY_CONTRACT_ON_DEPLOY | Habilite la verificación automática de contratos al desplegar (establezca en true para activar) |
DEBUG | Habilite el registro de depuración (establezca en true para salida detallada) |
SIGNER_TYPE | Tipo de firmante a utilizar (local, aws_kms, google_kms) |
AWS_REGION | Región de la cuenta AWS |
AWS_ACCESS_KEY_ID | ID de clave de acceso de AWS |
AWS_SECRET_ACCESS_KEY | Clave secreta de acceso de AWS |
AWS_KMS_KEY_ID | ID de la clave KMS a usar |
PROJECT | Nombre del proyecto GCP |
LOCATION | Ubicación del proyecto GCP |
KEY_RING | Nombre del key ring |
CRYPTO_KEY | Nombre de la clave criptográfica |
CRYPTO_KEY_VERSION | Versión de la clave criptográfica |
Variables de configuración del wallet
Elija una de las siguientes configuraciones:Para wallet local:
Variable | Description | |
---|---|---|
SIGNER_TYPE | local | |
BACKEND_WALLET_PV_KEY | 0x… | (opcional) |
Para AWS KMS:
Variable | Description |
---|---|
SIGNER_TYPE | aws_kms |
AWS_REGION | Región de la cuenta AWS |
AWS_ACCESS_KEY_ID | ID de clave de acceso de AWS |
AWS_SECRET_ACCESS_KEY | Clave secreta de acceso de AWS |
AWS_KMS_KEY_ID | ID de la clave KMS a usar |
Para GCP KMS:
Variable | Description |
---|---|
SIGNER_TYPE | google_kms |
PROJECT | Nombre del proyecto GCP |
LOCATION | Ubicación del proyecto GCP |
KEY_RING | Nombre del key ring |
CRYPTO_KEY | Nombre de la clave criptográfica |
CRYPTO_KEY_VERSION | Versión de la clave criptográfica |
3
Asegúrese de tener Docker instalado
Descárguelo desde aquí
4
Inicie Sidekick en un contenedor Docker
5
Verifique la dirección de la backend wallet