JSON-RPC

Stellar-RPC will accept HTTP POST requests using the JSON-RPC 2.0 specification. Los errores se devuelven a través del objeto de error jsonrpc siempre que sea posible (y tenga sentido).

Para instancias de producción y otras accesibles al público, el endpoint JSON-RPC debe ser servido sobre SSL en el puerto 443, siempre que sea posible, por razones de seguridad y facilidad de uso. Sin embargo, stellar-rpc no termina ssl por sí mismo, por lo que necesitará un equilibrador de carga u otro servicio para terminar SSL por él.

Para interactuar con stellar-rpc desde una aplicación JavaScript, utiliza el paquete JavaScript SDK, que proporciona una interfaz conveniente para los métodos RPC dentro de su módulo rpc.

Cuando se pasa XDR como un parámetro o se devuelve, siempre es una cadena codificada utilizando base64 estándar.

información

Por favor, ten en cuenta que la estructura de parámetros debe contener parámetros nombrados como un objeto por nombre, y no como argumentos posicionales como un arreglo por posición. Los argumentos posicionales como un arreglo por posición serán eliminados en futuras versiones de RPC.

Ejemplo de solicitud

{
  "jsonrpc": "2.0",
  "id": "1",
  "method": "getTransaction",
  "params": {
    "hash": "5ee7e055afb3b0b13fd6ac6d8adb11f799df8593448e23ad93454fefc387bbfa"
  }
}

Ejemplo de respuesta

{
  "jsonrpc": "2.0",
  "id": "1",
  "result": {
    "status": "SUCCESS",
    // ...
  }
}

Especificación Open-RPC

Stellar-RPC proporciona un documento de especificación OpenRPC que se puede usar para simular, desarrollar y/o validar tanto implementaciones de software para servidor como para cliente. Este documento se utiliza para generar todas nuestras páginas de documentación sobre métodos. Puedes ver el documento completo de [especificación aquí]. Además, puedes experimentar con este documento de especificación en el OpenRPC Playground.