erebos

erebos

  • Docs
  • Examples
  • API
  • Help
  • GitHub

›RPC tools

Docs

  • Introduction
  • Getting started

Swarm examples

  • File storage examples
  • Feeds examples
  • Communications examples

Swarm APIs and CLI

  • Swarm client
  • Individual APIs
  • Bzz API
  • Bzz Feed API
  • Bzz FS API
  • Pss API
  • CLI

Data structures

  • Data structures
  • Feed lists
  • Document synchronization
  • Timeline

Timeline protocol

  • Timeline specification
  • Timeline example
  • Timeline API

Utility libraries

  • Hexadecimal encoding
  • Keccak256 hashing
  • SECP256k1 signing
  • Hierarchical Deterministic wallet

RPC tools

  • RPC clients, handler and transport
  • Base RPC class and types
  • RPC Errors
  • RequestRPC client (stateless)
  • StreamRPC client (stateful)
  • RPC handler
  • RPC client over HTTP
  • RPC client over WebSocket
  • RPC client over IPC
  • RPC client for browsers
  • RPC client for Node
  • RPC client for Electron
  • HTTP transport
  • WebSocket transport
  • IPC transport
  • Electron transport
Edit

RPC Errors

Purpose

Error class and utilities for JSON-RPC errors.

Installation

npm install @erebos/rpc-error

Usage

import {
  RPCError,
  createParseError,
  createMethodNotFound,
} from '@erebos/rpc-error'

const error1 = createParseError()
const error2 = createMethodNotFound('get_user')
const error3 = new RPCError(-32600) // Invalid request
const error4 = new RPCError(1000, 'Custom app error', { user: 'alice' })

API

new RPCError()

Arguments

  1. code: number
  2. message?: string: will be set based on the code when not provided
  3. data?: T = any: optional additional error data

.toObject()

Returns RPCErrorObject

RPCError.fromObject()

Creates a RPCError instance from a RPCErrorObject.

Arguments

  1. error: RPCErrorObject

Returns RPCError instance

isServerError()

Arguments

  1. code: number

Returns boolean

getErrorMessage()

Arguments

  1. code: number

Returns string

createParseError()

Arguments

  1. data?: ?any

Returns RPCError instance with code -32700

createInvalidRequest()

Arguments

  1. data?: ?any

Returns RPCError instance with code -32600

createMethodNotFound()

Arguments

  1. data?: ?any

Returns RPCError instance with code -32601

createInvalidParams()

Arguments

  1. data?: ?any

Returns RPCError instance with code -32602

createInternalError()

Arguments

  1. data?: ?any

Returns RPCError instance with code -32603

← Base RPC class and typesRequestRPC client (stateless) →
  • Purpose
  • Installation
  • Usage
  • API
    • new RPCError()
    • .toObject()
    • RPCError.fromObject()
    • isServerError()
    • getErrorMessage()
    • createParseError()
    • createInvalidRequest()
    • createMethodNotFound()
    • createInvalidParams()
    • createInternalError()
Docs
Getting StartedAPI ReferenceCLI
Community
Gitter chatGitHub repositoryStar
Swarm
Official documentationHTTP gatewayDevelopment chat