Resumen y configuración de Sidekick
Sequence Sidekick simplifica el envío de transacciones en redes compatibles con Ethereum para juegos y aplicaciones, escalando a millones de usuarios.
Sequence Sidekick 👷♂️
Sequence Sidekick ofrece un backend totalmente equipado, aprovechando la infraestructura de Sequence para facilitar las interacciones blockchain a los desarrolladores. Con Sidekick, puede realizar programáticamente las siguientes operaciones usando su propio backend wallet:
- Servicios backend preconfigurados: Redis, PostgreSQL, API de transacciones y un Indexer, todo listo para usar.
- Despliegue sin esfuerzo: Levante su backend en minutos con un solo comando para crear un contenedor Docker.
- Opciones flexibles de wallet: Use un Sequence Smart Wallet con claves privadas gestionadas localmente o integre de forma segura AWS/GCP KMS para mayor seguridad.
- Despliegue de contratos sin complicaciones: Despliegue contratos inteligentes ERC20, ERC721, ERC1155 o personalizados mediante llamadas API.
- Gestión confiable de transacciones: Lea y escriba en cualquier contrato para su juego o app, con manejo automático de nonce, ajuste de gas y otras optimizaciones para una ejecución eficiente.
- Integración con webhooks: Aproveche nuestro indexador de alto rendimiento para gestionar completamente los webhooks.
- Optimización de precios de gas: Las transacciones se envían con precios de gas óptimos, con reenvío automático si no se incluyen en el mempool en tres bloques.
- Sistema de recompensas integrado: Configura recompensas de usuario autogestionadas o recurrentes (ERC20, ERC721, ERC1155) con una sola llamada API.
- Panel Bull MQ integrado: Monitorea y gestiona tus tareas en segundo plano.
- Swagger UI: Explore la documentación de la API y pruebe los endpoints con Swagger UI
- Utilidades de contrato: Verifica fácilmente los despliegues de contratos en diferentes cadenas.
- Integración fluida con Sequence Builder: Importa todos tus contratos de Sequence Builder al backend de Sidekick con una sola llamada API, o agrega contratos personalizados manualmente.
Acerca del backend wallet
Todas las transacciones ejecutadas a través de Sidekick usan un Sequence smart wallet, que se crea automáticamente para la cuenta externa (EOA) que usted especifique, aprovechando nuestra infraestructura para una ejecución optimizada y eficiente.
Para configurar el backend wallet, puedes:
- Declara tu EVM_PRIVATE_KEY en el archivo .env para una configuración local (no recomendado para producción)
- 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
Sidekick está diseñado para integrarse perfectamente con AWS y GCP KMS, permitiéndole usar su propio firmante KMS. Hemos desarrollado adaptadores que hacen que AWS/GCP KMS sean compatibles con el tipo de firmante de ethers, asegurando compatibilidad con la última versión.
Sequence Sidekick brinda a los desarrolladores una solución backend escalable y lista para usar para aplicaciones basadas en blockchain, permitiéndole enfocarse en el desarrollo de su aplicación sin complicaciones de backend.
Pasos para iniciar su backend de Sidekick
Clone el repositorio de Sidekick
Configure las variables de entorno requeridas
Variables de entorno requeridas
| Variable | Description | |
|---|---|---|
| PROJECT_ACCESS_KEY | Clave de acceso de Sequence Builder API Keys | |
| SECRET_KEY | Su clave secreta personalizada de Sidekick | |
| SEQUENCE_RPC_URL | URL RPC de Sequence | |
| BUILDER_API_SECRET_KEY | Clave secreta de Sequence Builder API Keys | eyJh... |
| INDEXER_URL | URL del Indexer según la red | |
| SIGNER_TYPE | Tipo de firmante a usar |
Variables de configuración del wallet
Elija una de las siguientes configuraciones:
Wallet local:
| Variable | Description |
|---|---|
| EVM_PRIVATE_KEY | Clave privada para la EOA utilizada para firmar transacciones |
Configuración de AWS KMS:
| Variable | Description |
|---|---|
| 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 |
Configuración de GCP KMS:
| Variable | Description |
|---|---|
| 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 |
Asegúrese de tener Docker instalado
Descárguelo desde aquí
Inicie Sidekick en un contenedor Docker
Realice su primera llamada API para obtener la dirección del smart wallet
Modo desarrollador sin Docker
Si desea hacer cambios en el código y probarlos sin Docker, puede ejecutar el backend localmente siguiendo las instrucciones en el README.
Gas Sponsorship
En testnet, patrocinamos todas las transacciones. Sin embargo, en mainnet, usted querrá asegurarse de patrocinar las transacciones para que se procesen correctamente patrocinando el propio contrato. Puede ver más detalles en nuestra solución de Gas Sponsorship para aprender cómo hacerlo.