JSON-RPC

Stellar-RPC aceptará solicitudes HTTP POST utilizando la especificación JSON-RPC 2.0. Los errores se devuelven a través del jsonrpc error object siempre que sea posible (y tenga sentido).

Para instancias de producción y otras accesibles públicamente, el endpoint JSON-RPC debería servirse a través de SSL en el puerto 443, siempre que sea posible, por seguridad y facilidad de uso. Sin embargo, stellar-rpc no termina SSL por sí mismo, por lo que necesitará un balanceador de carga u otro servicio para terminar SSL para él.

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

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

información

Por favor, ten en cuenta que la estructura del parámetro debe contener parámetros nombrados como un objeto con nombre, y no como argumentos posicionales en un arreglo por posición. Los argumentos posicionales en un arreglo por posición serán desaprobados 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 utilizar para simular, construir y/o validar las implementaciones de software tanto del servidor como del cliente. Este documento se utiliza para generar todas nuestras páginas de documentación [methods]. Puedes ver el documento completo de [especificación aquí]. Además, puedes experimentar con este documento de especificación en el OpenRPC Playground.