\RippleRest

Ripple Rest Client for PHP.

Summary

Methods
Properties
Constants
setup()
getTransaction()
isServerConnected()
getServerInfo()
createUUID()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

getTransaction()

getTransaction(string $hash) : array

Retrieve the details of a transaction in the standard Ripple JSON format.

Parameters

string $hash

transaction hash

Throws

\RippleRestError

if RippleRest server returns an error

\RippleRestProtocolError

if protocol is wrong or network is down

Returns

array —

See the Ripple Wiki page on Transaction Formats for more information.

isServerConnected()

isServerConnected() : boolean

A simple endpoint that can be used to check if ripple-rest is connected to a rippled and is ready to serve. If used before querying the other endpoints this can be used to centralize the logic to handle if rippled is disconnected from the Ripple Network and unable to process transactions.

Throws

\RippleRestError

if RippleRest server returns an error

\RippleRestProtocolError

if protocol is wrong or network is down

Returns

boolean —

true if ripple-rest is ready to serve

createUUID()

createUUID() : string

A UUID v4 generator.

Throws

\RippleRestError

if RippleRest server returns an error

\RippleRestProtocolError

if protocol is wrong or network is down

Returns

string —

"xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx"