com.casper.sdk

Class CasperSdk

java.lang.Object

com.casper.sdk.CasperSdk

public class CasperSdk
extends java.lang.Object

Entry point into the SDK Exposes all permissible methods

Constructor Summary

Constructors

Constructor and Description
CasperSdk(java.lang.String url, int port)

Method Summary

Modifier and Type	Method and Description
java.security.PublicKey	createPublicKey(java.lang.String publicKeyHex) Creates a public key from a hex string where the first byte is the algorithm type and the following bytes the raw public key bytes.
Deploy	deployFromJson(java.io.InputStream jsonStream) Converts a JSON object to a Deploy.
Deploy	deployFromJson(java.lang.String json) Converts a JSON object to a Deploy.
java.lang.String	deployToJson(Deploy deploy) Converts a Casper type object ot a JSON string
java.math.BigInteger	getAccountBalance(java.security.PublicKey accountKey) Obtains the account balance at a certain global state root hash.
java.lang.String	getAccountHash(java.security.PublicKey accountKey) Obtains the account public key hashed using BLAKE2_B_256 as a hex encode string
java.lang.String	getAccountInfo(java.security.PublicKey accountKey) Obtains the account info JSON
URef	getAccountMainPurseURef(java.security.PublicKey accountKey) Obtains an on-chain account's main purse unforgeable reference.
java.lang.String	getAuctionInfo()
java.lang.String	getBlockInfo(Digest hash) Obtains a block info by the block's hash
java.lang.String	getBlockInfoByHeight(java.lang.Number height) Obtains a block info by the block's height
java.lang.String	getBlockTransfers() Returns on-chain block transfers information as JSON
java.lang.String	getBlockTransfers(java.lang.String blockHash) Returns on-chain block transfers information as JSON for a specific block hash
ContractHash	getContractHash(java.security.PublicKey accountKey) Obtains the contract has from the account info
Deploy	getDeploy(Digest deployHash) Obtains deploy from the network
java.lang.String	getEraInfoBySwitchBlock() Obtains the chain ero info by switch block as JSON
java.lang.String	getLatestBlockInfo() Obtains the latest block info from a mode
java.lang.String	getNodeMetrics() Obtains the node metrics as JSON
java.lang.String	getNodePeers()
java.lang.String	getNodeStatus()
byte[]	getPublicKeyBytes(java.security.PublicKey publicKey) Obtains the bytes of a public key in casper format with the first byte being the algorithm type identifier value.
java.lang.String	getRpcSchema() Obtain the RPC Schema as a JSON string
java.lang.String	getStateRootHash() Returns a root hash of global state
<T extends java.security.Key> T	loadKey(java.io.InputStream in) Loads a single public or private key from a .pem in the provided stream
java.security.KeyPair	loadKeyPair(java.io.InputStream publicKeyIn, java.io.InputStream privateKeyIn) Loads the key pair from the provided streams
Deploy	makeDeploy(DeployParams deployParams, DeployExecutable session, DeployExecutable payment) Construct new unsigned deploy.
Deploy	makeInstallContract(DeployParams deployParams, java.lang.Number payment, java.io.InputStream wasmIn, int tokenDecimals, java.lang.String tokenName, java.lang.String tokenSymbol, java.lang.Number tokenTotalSupply) Creates an install contract deploy
Deploy	makeInvokeContract(DeployParams deployParams, java.lang.Number payment, java.lang.Number amount, java.security.PublicKey operatorKey, java.security.PublicKey recipient) Creates a new invoke contract delpoy
Deploy	makeNativeTransfer(DeployParams deployParams, java.lang.Number amount, java.security.PublicKey target, java.lang.Number correlationId) Creates a native transfer deploy.
Deploy	makeTransferDeploy(DeployParams deployParams, DeployExecutable session, DeployExecutable payment) Construct new unsigned deploy for transfer purpose.
Deploy	makeValidatorAuctionBid(DeployParams deployParams, java.lang.Number amount, int delegationRate, java.security.PublicKey validatorPublicKey, java.io.InputStream wasmIn) Creates a validator auction bid deploy.
Deploy	makeValidatorAuctionBidWithdrawal(DeployParams deployParams, java.lang.Number amount, java.security.PublicKey validatorPublicKey, java.io.InputStream wasmIn, URef unbondPurse) Creates an auction bid withdraw delegation deploy.
Deploy	makeValidatorDelegation(DeployParams deployParams, java.lang.Number amount, java.security.PublicKey delegatorPublicKey, java.security.PublicKey validatorPublicKey, java.io.InputStream wasmIn) Creates a standard delegation deploy
Deploy	makeValidatorDelegationWithdrawal(DeployParams deployParams, java.lang.Number amount, java.security.PublicKey delegatorPublicKey, java.security.PublicKey validatorPublicKey, java.io.InputStream wasmIn) Creates a standard withdraw delegation deploy.
Transfer	newTransfer(java.lang.Number amount, java.security.PublicKey target, java.lang.Number id) Creates a new Transfer to the target account of the specified amount
Digest	putDeploy(Deploy signedDeploy) Send deploy to network
Deploy	signDeploy(Deploy deploy, java.security.KeyPair signKeyPair) Sign the deploy with the specified signKeyPair.
ModuleBytes	standardPayment(java.lang.Number paymentAmount) Creates a new standard payment.
CLPublicKey	toCLPublicKey(java.security.PublicKey publicKey) Converts a java security public key to a Casper Labs public key

Methods inherited from class java.lang.Object

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

Constructor Detail

CasperSdk

public CasperSdk(java.lang.String url,
                 int port)

Method Detail

getAccountInfo

public java.lang.String getAccountInfo(java.security.PublicKey accountKey)

Obtains the account info JSON

Parameters:

accountKey - An account holder's public key

Returns:

account information in JSON format.

getContractHash

public ContractHash getContractHash(java.security.PublicKey accountKey)

Obtains the contract has from the account info

Parameters:

accountKey - an account holder's public key

Returns:

ERC20 named key encapsulated in a ContractHash

getAccountBalance

public java.math.BigInteger getAccountBalance(java.security.PublicKey accountKey)

Obtains the account balance at a certain global state root hash.

Parameters:

accountKey - they of the account

Returns:

account balance if on-chain account is found.

getAccountMainPurseURef

public URef getAccountMainPurseURef(java.security.PublicKey accountKey)

Obtains an on-chain account's main purse unforgeable reference.

Parameters:

accountKey - key of an on-chain account.

Returns:

an on-chain account's main purse unforgeable reference.

getStateRootHash

public java.lang.String getStateRootHash()

Returns a root hash of global state

Returns:

a root hash of global state

getAccountHash

public java.lang.String getAccountHash(java.security.PublicKey accountKey)

Obtains the account public key hashed using BLAKE2_B_256 as a hex encode string

Parameters:

accountKey - the public key to hash

Returns:

the hashed key

getAuctionInfo

public java.lang.String getAuctionInfo()

Returns:

the action info string

getNodeStatus

public java.lang.String getNodeStatus()

Returns:

the node status information

getNodePeers

public java.lang.String getNodePeers()

Returns:

the node peers information

deployFromJson

public Deploy deployFromJson(java.io.InputStream jsonStream)
                      throws java.io.IOException

Converts a JSON object to a Deploy.

Parameters:

jsonStream - the input stream to read the JSON object from

Returns:

a new Deploygi

Throws:

java.io.IOException - - if there was an error reading the stream

deployFromJson

public Deploy deployFromJson(java.lang.String json)
                      throws java.io.IOException

Converts a JSON object to a Deploy.

Parameters:

json - the input JSON to read t

Returns:

a new Deploy

Throws:

java.io.IOException - - if there was an error reading the json

makeValidatorDelegation

public Deploy makeValidatorDelegation(DeployParams deployParams,
                                      java.lang.Number amount,
                                      java.security.PublicKey delegatorPublicKey,
                                      java.security.PublicKey validatorPublicKey,
                                      java.io.InputStream wasmIn)

Creates a standard delegation deploy

Parameters:

deployParams - standard parameters used when creating a deploy

amount - the amount in motes to be delegated.

delegatorPublicKey - public key of delegator.

validatorPublicKey - public key of validator

wasmIn - input stream of a compiled delegate.wasm.

Returns:

a standard delegation deploy

makeValidatorDelegationWithdrawal

public Deploy makeValidatorDelegationWithdrawal(DeployParams deployParams,
                                                java.lang.Number amount,
                                                java.security.PublicKey delegatorPublicKey,
                                                java.security.PublicKey validatorPublicKey,
                                                java.io.InputStream wasmIn)

Creates a standard withdraw delegation deploy.

Parameters:

deployParams - standard parameters used when creating a deploy

amount - amount in motes to be delegated

delegatorPublicKey - public key of delegator

validatorPublicKey - public key of validator

wasmIn - to compiled delegate.wasm

Returns:

A standard delegation deploy.

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

Returns:

a new unsigned deploy for transfer purpose

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

Returns:

a new unsigned deploy

signDeploy

public Deploy signDeploy(Deploy deploy,
                         java.security.KeyPair 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

getDeploy

public Deploy getDeploy(Digest deployHash)

Obtains deploy from the network

Parameters:

deployHash - the hash of the deploy object to obtain

Returns:

the deploy

putDeploy

public Digest putDeploy(Deploy signedDeploy)

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.

loadKeyPair

public java.security.KeyPair loadKeyPair(java.io.InputStream publicKeyIn,
                                         java.io.InputStream privateKeyIn)

Loads the key pair from the provided 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

loadKey

public <T extends java.security.Key> T loadKey(java.io.InputStream in)

Loads a single public or private key from a .pem in the provided stream

Type Parameters:

T - the type of the key

Parameters:

in - the stream for a .pem file

Returns:

the loaded key

getPublicKeyBytes

public byte[] getPublicKeyBytes(java.security.PublicKey publicKey)

Obtains the bytes of a public key in casper format with the first byte being the algorithm type identifier value.

Parameters:

publicKey - the public key to extract the bytes from

Returns:

the bytes

standardPayment

public ModuleBytes standardPayment(java.lang.Number paymentAmount)

Creates a new standard payment.

Parameters:

paymentAmount - the number of notes paying to execution engine

Returns:

a new standard payment module bytes

newTransfer

public Transfer newTransfer(java.lang.Number amount,
                            java.security.PublicKey target,
                            java.lang.Number id)

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

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 java.lang.String deployToJson(Deploy deploy)
                              throws java.io.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:

java.io.IOException - - on write error

getNodeMetrics

public java.lang.String getNodeMetrics()

Obtains the node metrics as JSON

Returns:

the metrics JSON result

createPublicKey

public java.security.PublicKey createPublicKey(java.lang.String publicKeyHex)

Creates a public key from a hex string where the first byte is the algorithm type and the following bytes the raw public key bytes.

Parameters:

publicKeyHex - the public key hex

Returns:

the java security public key

toCLPublicKey

public CLPublicKey toCLPublicKey(java.security.PublicKey publicKey)

Converts a java security public key to a Casper Labs public key

Parameters:

publicKey - the public key to convert

Returns:

the Casper Labs public key

getLatestBlockInfo

public java.lang.String getLatestBlockInfo()

Obtains the latest block info from a mode

Returns:

the block info JSON

getBlockInfo

public java.lang.String getBlockInfo(Digest hash)

Obtains a block info by the block's hash

Parameters:

hash - the has of the block info to obtain

Returns:

the block info JSON

getBlockInfoByHeight

public java.lang.String getBlockInfoByHeight(java.lang.Number height)

Obtains a block info by the block's height

Parameters:

height - the has of the block info to obtain

Returns:

the block info JSON

getBlockTransfers

public java.lang.String getBlockTransfers()

Returns on-chain block transfers information as JSON

Returns:

the block transfers information as JSON

getBlockTransfers

public java.lang.String getBlockTransfers(java.lang.String blockHash)

Returns on-chain block transfers information as JSON for a specific block hash

Parameters:

blockHash - the block hash to otain the transfers for

Returns:

the block transfers information as JSON

getEraInfoBySwitchBlock

public java.lang.String getEraInfoBySwitchBlock()

Obtains the chain ero info by switch block as JSON

Returns:

the JSON result

getRpcSchema

public java.lang.String getRpcSchema()

Obtain the RPC Schema as a JSON string

Returns:

the RPC schema

makeValidatorAuctionBid

public Deploy makeValidatorAuctionBid(DeployParams deployParams,
                                      java.lang.Number amount,
                                      int delegationRate,
                                      java.security.PublicKey validatorPublicKey,
                                      java.io.InputStream wasmIn)

Creates a validator auction bid deploy.

Parameters:

deployParams - standard parameters used when creating a deploy.

amount - amount in motes to be submitted as an auction bid.

delegationRate - percentage charged to a delegator for provided service

validatorPublicKey - public key of validator

wasmIn - stream of compiled delegate.wasm

Returns:

a validator auction bid deploy.

makeNativeTransfer

public Deploy makeNativeTransfer(DeployParams deployParams,
                                 java.lang.Number amount,
                                 java.security.PublicKey target,
                                 java.lang.Number correlationId)

Creates a native transfer deploy.

Parameters:

deployParams - standard parameters used when creating a deploy.

amount - amount in motes to be transferred.

target - target account public key.

correlationId - identifier used to correlate transfer to internal systems.

Returns:

native transfer deploy.

makeValidatorAuctionBidWithdrawal

public Deploy makeValidatorAuctionBidWithdrawal(DeployParams deployParams,
                                                java.lang.Number amount,
                                                java.security.PublicKey validatorPublicKey,
                                                java.io.InputStream wasmIn,
                                                URef unbondPurse)

Creates an auction bid withdraw delegation deploy.

Parameters:

deployParams - standard parameters used when creating a deploy.

amount - amount in motes to be withdrawn from auction.

validatorPublicKey - public key of validator.

wasmIn - input stream of compiled delegate.wasm.

unbondPurse - validator's * purse to which to withdraw fund

Returns:

an auction bid withdraw delegation deploy.

makeInstallContract

public Deploy makeInstallContract(DeployParams deployParams,
                                  java.lang.Number payment,
                                  java.io.InputStream wasmIn,
                                  int tokenDecimals,
                                  java.lang.String tokenName,
                                  java.lang.String tokenSymbol,
                                  java.lang.Number tokenTotalSupply)

Creates an install contract deploy

Parameters:

deployParams - standard parameters used when creating a deploy.

payment - mount in motes to be offered as payment.

wasmIn - path to erc20.wasm file

tokenDecimals - number of decimal places within ERC-20 token to be minted.

tokenName - name of ERC-20 token to be minted.

tokenSymbol - symbol of ERC-20 token to be minted.

tokenTotalSupply - total number of ERC-20 tokens to be issued

Returns:

an install contract deploy

makeInvokeContract

public Deploy makeInvokeContract(DeployParams deployParams,
                                 java.lang.Number payment,
                                 java.lang.Number amount,
                                 java.security.PublicKey operatorKey,
                                 java.security.PublicKey recipient)

Creates a new invoke contract delpoy

Parameters:

deployParams - standard parameters used when creating a deploy.

payment - amount in motes to be offered as payment

amount - amount of ERC-20 tokens to be transferred to user

operatorKey - operator account key

recipient - public ket of recipient user

Returns:

a new invoke contract delpoy