Saltearse al contenido

Sidecar

Conectando Datos de Blockchain con APIs REST.

El Substrate API Sidecar es un servicio RESTful diseñado para facilitar la interacción fluida con nodos de blockchain construidos con el framework Substrate (FRAME). Con una amplia variedad de endpoints, la API de Sidecar otorga a los desarrolladores la capacidad de consultar y administrar datos de blockchains basadas en Substrate con gran precisión y eficiencia. Ya sea para interactuar con cuentas, bloques, transacciones, parachains u otros componentes de la blockchain, la API de Sidecar es una herramienta esencial para los desarrolladores que trabajan dentro de los ecosistemas de Polkadot y Substrate —y más allá.

¿Qué es Substrate API Sidecar?

Substrate API Sidecar funciona como una interfaz REST para interactuar con nodos Substrate. Simplifica las interacciones complejas con la blockchain, permitiendo a los desarrolladores:

  • Consultar datos de la blockchain en tiempo real, como saldos de cuentas, detalles de bloques y transacciones.
  • Acceder a componentes específicos como parachains, almacenamiento de pallets y assets.
  • Construir aplicaciones integradas con la blockchain sin necesidad de un conocimiento profundo de la arquitectura subyacente.

Gracias a su facilidad de uso, se ha convertido en un recurso indispensable para quienes crean herramientas y aplicaciones en los ecosistemas de Polkadot y Substrate.

Características Clave de Substrate API Sidecar

  1. Amplios Endpoints de la API. Sidecar expone numerosos endpoints que posibilitan diversas funcionalidades:

    • Gestión de Cuentas: Consulta de saldos de cuenta, historiales de transacciones y más.
    • Datos de Bloques: Acceso a información detallada sobre bloques, incluidas extrinsics y eventos.
    • Parachains: Interacción con datos específicos de parachains, como identificadores únicos o ítems de almacenamiento.
    • Extrinsics y Transacciones: Consulta de detalles sobre extrinsics enviados y el estado de las transacciones.
  2. Integración Fácil para Desarrolladores. Diseñada con los desarrolladores en mente, la API brinda:

    • Colecciones predefinidas para herramientas como Postman, simplificando pruebas y exploración.
    • Documentación integrada y variables reutilizables para facilitar la depuración y el desarrollo.
  3. Despliegue Personalizable. De manera predeterminada, el servicio Sidecar se conecta a un nodo Substrate local, pero puede configurarse para interactuar con nodos remotos o distintos entornos mediante parámetros ajustables, como SUBSTRATE_URL.

Uso de Substrate API Sidecar

1. Configuración del Servicio

Para utilizar Sidecar, sigue estos pasos:

  • Instala el paquete de forma global usando npm o yarn:
    Ventana de terminal
    npm install -g @substrate/api-sidecar

Inicia el Servicio y Conéctalo a un Nodo Substrate

Inicia el servicio y conéctalo a un nodo Substrate en ejecución. Por defecto, el servicio se ejecuta en http://127.0.0.1:8080.

Explora los Endpoints de la API

Con herramientas como Postman, los desarrolladores pueden:

  • Importar colecciones predefinidas.
  • Definir variables de entorno para interacciones dinámicas.
  • Enviar solicitudes a la API e inspeccionar respuestas en formatos JSON, XML, u otros.

Por ejemplo, para consultar la lista de endpoints disponibles, solo se requiere la variable url. Una respuesta típica puede incluir rutas como:

  • /accounts/:address/asset-balances
  • /blocks/:blockNumber

Casos de Uso Prácticos

  1. Consulta de Saldos de Cuentas. Recupera el saldo de una cuenta específica configurando la variable account y enviando una solicitud GET a /accounts/:address/balance-info. La respuesta incluye información clave, como:

    • Saldos free y reserved.
    • Valor de nonce.
    • Estados de bloqueo.
  2. Acceso a Detalles de Bloques. Los desarrolladores pueden consultar información integral de bloques especificando el número o hash del bloque, útil para tareas de depuración o análisis de la cadena.

¿Por Qué Usar Substrate API Sidecar?

Substrate API Sidecar cierra la brecha entre los nodos de blockchain y el desarrollo de aplicaciones al ofrecer:

  • Eficiencia: Acceso directo a datos críticos de la blockchain sin necesidad de llamadas RPC complejas.
  • Flexibilidad: Configuraciones personalizables para entornos diversos, desde desarrollo local hasta aplicaciones a gran escala en producción.
  • Escalabilidad: Integración fluida en el creciente ecosistema de Polkadot, con soporte de casos de uso avanzados en dApps y plataformas de análisis.

Conclusión

Substrate API Sidecar es una herramienta esencial para los desarrolladores que trabajan con blockchains basadas en Substrate. Su robusta interfaz RESTful simplifica las interacciones con la blockchain, impulsando nuevas posibilidades de innovación dentro del ecosistema de Polkadot. Al aprovechar sus amplias funciones, los desarrolladores pueden crear aplicaciones eficientes, confiables y preparadas para escalar en un panorama blockchain en constante evolución.
Para más información, consulta la documentación de Substrate API Sidecar.

Videos de la Comunidad Substrate API Sidecar


API Sidecar and TX Wrapper | Polkadot Deep Dive

Polkadot Deep Dives: API Sidecar & TxWrapper

Integrations Tools Being Built and Maintained | Substrate Seminar