com.casper.sdk

Class CasperSdk

java.lang.Object

com.casper.sdk.CasperSdk

public class CasperSdk
extends Object

Entry point into the SDK Exposes all permissible methods

Constructor Summary

Constructors

Constructor and Description
CasperSdk(String url, int port)

Method Summary

Modifier and Type	Method and Description
Deploy	deployFromJson(InputStream jsonStream) Converts a JSON object to a Deploy.
Deploy	deployFromJson(String json) Converts a JSON object to a Deploy.
String	deployToJson(Deploy deploy) Converts a Casper type object ot a JSON string
String	getAccountBalance(String accountKey)
String	getAccountHash(String accountKey)
String	getAccountInfo(String accountKey)
String	getAccountMainPurseURef(String accountKey)
String	getAuctionInfo()
String	getNodePeers()
String	getNodeStatus()
String	getStateRootHash()
org.bouncycastle.crypto.AsymmetricCipherKeyPair	loadKeyPair(InputStream publicKeyIn, InputStream privateKeyIn) Loads the key pair from the provide streams
Deploy	makeDeploy(DeployParams deployParams, DeployExecutable session, DeployExecutable payment) Construct new unsigned deploy.
Deploy	makeTransferDeploy(DeployParams deployParams, DeployExecutable session, DeployExecutable payment) Construct new unsigned deploy for transfer purpose.
Transfer	newTransfer(Number amount, PublicKey target, Number id) Creates a new Transfer to the target account of the specified ammount
Digest	putDeploy(Deploy signedDeploy) Send deploy to network
Deploy	signDeploy(Deploy deploy, org.bouncycastle.crypto.AsymmetricCipherKeyPair signKeyPair) Sign the deploy with the specified signKeyPair.
ModuleBytes	standardPayment(Number paymentAmount) Creates a new standard payment

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CasperSdk

public CasperSdk(String url,
                 int port)

Method Detail

getAccountInfo

public String getAccountInfo(String accountKey)
                      throws Throwable

Throws:

Throwable

getAccountBalance

public String getAccountBalance(String accountKey)
                         throws Throwable

Throws:

Throwable

getAccountMainPurseURef

public String getAccountMainPurseURef(String accountKey)
                               throws Throwable

Throws:

Throwable

getStateRootHash

public String getStateRootHash()
                        throws Throwable

Throws:

Throwable

getAccountHash

public String getAccountHash(String accountKey)
                      throws NoSuchAlgorithmException

Throws:

NoSuchAlgorithmException

getAuctionInfo

public String getAuctionInfo()
                      throws Throwable

Throws:

Throwable

getNodeStatus

public String getNodeStatus()
                     throws Throwable

Throws:

Throwable

getNodePeers

public String getNodePeers()
                    throws Throwable

Throws:

Throwable

deployFromJson

public Deploy deployFromJson(InputStream jsonStream)
                      throws IOException

Converts a JSON object to a Deploy.

Parameters:

jsonStream - the input stream to read the JSON object from

Returns:

a new Deploy

Throws:

IOException - - if there was an error reading the stream

deployFromJson

public Deploy deployFromJson(String json)
                      throws IOException

Converts a JSON object to a Deploy.

Parameters:

json - the input JSON to read t

Returns:

a new Deploy

Throws:

IOException - - if there was an error reading the json

makeTransferDeploy

public Deploy makeTransferDeploy(DeployParams deployParams,
                                 DeployExecutable session,
                                 DeployExecutable payment)

Construct new unsigned deploy for transfer purpose.

Parameters:

deployParams - the deployment parameters

session - the session/transfer

payment - the payment

makeDeploy

public Deploy makeDeploy(DeployParams deployParams,
                         DeployExecutable session,
                         DeployExecutable payment)

Construct new unsigned deploy.

Parameters:

deployParams - the deployment parameters

session - the session/transfer

payment - the payment

signDeploy

public Deploy signDeploy(Deploy deploy,
                         org.bouncycastle.crypto.AsymmetricCipherKeyPair signKeyPair)

Sign the deploy with the specified signKeyPair.

Parameters:

deploy - unsigned Deploy object

signKeyPair - the keypair to sign the Deploy object

Returns:

the signed deploy

putDeploy

public Digest putDeploy(Deploy signedDeploy)
                 throws Throwable

Send deploy to network

Parameters:

signedDeploy - Signed deploy object

Returns:

the deploy hash, ech deploy gets a unique hash. This is part of the cryptographic security of blockchain technology. No two deploys will ever return the same hash.

Throws:

Throwable

loadKeyPair

public org.bouncycastle.crypto.AsymmetricCipherKeyPair loadKeyPair(InputStream publicKeyIn,
                                                                   InputStream privateKeyIn)
                                                            throws IOException

Loads the key pair from the provide streams

Parameters:

publicKeyIn - the public key .pem file input stream

privateKeyIn - the private key .pem file input stream

Returns:

the files loaded into a AsymmetricCipherKeyPair

Throws:

IOException - if the is a problem loading the files

standardPayment

public ModuleBytes standardPayment(Number paymentAmount)

Creates a new standard payment

Parameters:

paymentAmount - the number of notes paying to execution engine

newTransfer

public Transfer newTransfer(Number amount,
                            PublicKey target,
                            Number id)

Creates a new Transfer to the target account of the specified ammount

Parameters:

amount - the amount to transfer

target - the public key of the target account

id - the optional ID name argument value

Returns:

the newly created transfer

deployToJson

public String deployToJson(Deploy deploy)
                    throws IOException

Converts a Casper type object ot a JSON string

Parameters:

deploy - the type object to write

Returns:

the JSON representation of the clObject

Throws:

IOException - - on write error