#API Documentation

#org.arkecosystem.crypto.configuration.Fee;

#get()

public static long get(Types type)

Get a fee for a given transaction type

#Parameters

#Return Value

long

#set()

public static void set(Types type, long fee)

Set a fee

#Parameters

#Return Value

void

#org.arkecosystem.crypto.configuration.Network;

#set()

public static void set(INetwork network)

Set what network you want to use in the crypto library

#Parameters

#Return Value

void

#get()

public static INetwork get()

Get settings for a selected network, default network is devnet

#Return Value

INetwork

#org.arkecosystem.crypto.enums.Fees;

#getValue()

public Long getValue()

Get the fees value.

#Return Value

Long

#org.arkecosystem.crypto.enums.Types;

#getValue()

public int getValue()

Get the types value.

#Return Value

int

#org.arkecosystem.crypto.identities.Address;

#fromPublicKey() (string, integer)

public static String fromPublicKey(String publicKey, Integer networkVersion)

Derive the address from the given public key.

#Parameters

#Return Value

String

#fromPublicKey() string

public static String fromPublicKey(String publicKey)

Derive the address from the given public key.

#Parameters

#Return Value

String

#fromPrivateKey() (eckey, integer)

public static String fromPrivateKey(ECKey privateKey, Integer networkVersion)

Derive the address from the given private key.

#Parameters

#Return Value

String

#fromPrivateKey() eckey

public static String fromPrivateKey(ECKey privateKey)

Derive the address from the given private key.

#Parameters

#Return Value

String

#fromPassphrase() (string, integer)

public static String fromPassphrase(String passphrase, Integer networkVersion)

Derive the address from the given passphrase.

#Parameters

#Return Value

String

#fromPassphrase() string

public static String fromPassphrase(String passphrase)

Derive the address from the given passphrase.

#Parameters

#Return Value

String

#validate() (string, integer)

public static Boolean validate(String address, Integer networkVersion)

Validate the given address.

#Parameters

#Return Value

Boolean

#validate() (string)

public static Boolean validate(String address)

Validate the given address.

#Parameters

#Return Value

Boolean

#org.arkecosystem.crypto.identities.PrivateKey;

#fromPassphrase()

public static ECKey fromPassphrase(String passphrase)

Derive the private key for the given passphrase.

#Parameters

#Return Value

ECKey

#fromHex()

public static ECKey fromHex(String privateKey)

Create a private key instance from a hex String.

#Parameters

#Return Value

ECKey

#org.arkecosystem.crypto.identities.PublicKey;

#fromPassphrase()

public static String fromPassphrase(String passphrase)

Derive the public from the given passphrase.

#Parameters

#Return Value

String

#org.arkecosystem.crypto.identities.WIF;

#fromPassphrase()

public static String fromPassphrase(String passphrase)

Derive the WIF from the given passphrase.

#Parameters

#Return Value

String

#org.arkecosystem.crypto.networks.Devnet;

#version()

public int version()

Get the epoch time of the start of the Network.

#Return Value

int

#wif()

public int wif()

Get the epoch time of the start of the Network.

#Return Value

int

#epoch()

public String epoch()

Get the epoch time of the start of the Network.

#Return Value

String

#org.arkecosystem.crypto.networks.Mainnet;

#version()

public int version()

Get the epoch time of the start of the Network.

#Return Value

int

#wif()

public int wif()

Get the epoch time of the start of the Network.

#Return Value

int

#epoch()

public String epoch()

Get the epoch time of the start of the Network.

#Return Value

String

#org.arkecosystem.crypto.networks.Testnet;

#version()

public int version()

Get the epoch time of the start of the Network.

#Return Value

int

#wif()

public int wif()

Get the epoch time of the start of the Network.

#Return Value

int

#epoch()

public String epoch()

Get the epoch time of the start of the Network.

#Return Value

String

#org.arkecosystem.crypto.transactions.builder.AbstractTransaction;

#AbstractTransaction()

public AbstractTransaction()

AbstractTransaction class constructor.

#version()

public TBuilder version(int version)

Sets the version of transaction.

#Parameters

#typeGroup()

public TBuilder typeGroup(int typeGroup)

Sets the typeGroup of transaction.

#Parameters

#nonce()

public TBuilder nonce(long nonce)

Sets the nonce of transaction. To see how sequential nonces work, check this guide Understanding Transaction Nonce.

#Parameters

#network()

public TBuilder network(int network)

Sets the network of a transaction.

#Parameters

#fee()

public TBuilder fee(long fee)

Sets the fee of transaction.

#Parameters

#amount()

public TBuilder amount(long amount)

Sets the amount of transaction.

#Parameters

#sign()

public AbstractTransaction sign(String passphrase)

Sign the transaction using the given passphrase.

#Parameters

#Return Value

AbstractTransaction

#secondSign()

public AbstractTransaction secondSign(String passphrase)

Sign the transaction using the given second passphrase

#Parameters

#Return Value

AbstractTransaction

#getType()

abstract int getType()

Get the type of the transaction.

#instance()

abstract TBuilder instance();

Get the instance of the builder.

#org.arkecosystem.crypto.transactions.builder.DelegateRegistration;

#getType()

public int getType()

Get the type of the transaction.

#Return Value

int

#username()

public DelegateRegistration username(String username)

Set the username to assign.

#Parameters

#Return Value

DelegateRegistration

#instance()

public DelegateRegistration instance()

#Return Value

DelegateRegistration

#org.arkecosystem.crypto.transactions.builder.DelegateResignation;

#getType()

public int getType()

Get the type of the transaction.

#Return Value

int

#instance()

public DelegateResignation instance()

#Return Value

DelegateResignation

#org.arkecosystem.crypto.transactions.builder.HtlcClaim;

#getType()

public int getType()

Get the type of the transaction.

#Return Value

int

#htlcClaimAsset()

public HtlcClaim htlcClaimAsset(String lockTransactionId, String unlockSecret)

Sets the locks transaction id and unlock secret.

#Parameters

#Return Value

HtlcClaim

#instance()

public HtlcClaim instance()

#Return Value

HtlcClaim

#org.arkecosystem.crypto.transactions.builder.HtlcLock

#recipientId()

public HtlcLock recipientId(String recipientId)

Sets the recipient id.

#Parameters

#Return Value

HtlcLock

#secretHash()

public HtlcLock secretHash(String secretHash)

Sets secret hash.

#Parameters

#Return Value

HtlcLock

#ExpirationType()

public HtlcLock expirationType(HtlcLockExpirationType expirationType, int expirationValue)

Sets the expiration type of htlc lock.

#Parameters

#Return Value

HtlcLock

#vendorField()

public HtlcLock vendorField(String vendorField)

Sets the vendor field.

#Parameters

#Return Value

HtlcLock

#getType()

public int getType()

Get the type of the transaction.

#Return Value

int

#instance()

public HtlcLock instance()

#Return Value

HtlcLock

#org.arkecosystem.crypto.transactions.builder.HtlcRefund;

#htlcRefundAsset()

public HtlcRefund htlcRefundAsset(String lockTransactionId)

Sets the refund lock transaction id.

#Parameters

#Return Value

HtlcRefund

#getType()

public int getType()

Get the type of the transaction.

#Return Value

int

#instance()

public HtlcRefund instance()

#Return Value

HtlcRefund

#org.arkecosystem.crypto.transactions.builder.Ipfs;

#ipfsAsset()

public AbstractTransactionBuilder ipfsAsset(String ipfsId)

Set the ipfs id.

#Parameters

#Return Value

Ipfs

#getType()

public int getType()

Get the type of the transaction.

#Return Value

int

#instance()

public Ipfs instance()

#Return Value

Ipfs

#org.arkecosystem.crypto.transactions.builder.MultiPayment;

#addPayment()

public MultiPayment addPayment(String recipientId, long amount)

#Parameters

#Return value

MultiPayment

#vendorField()

public HtlcLock vendorField(String vendorField)

Sets the vendor field.

#Parameters

#Return Value

MultiPayment

#getType()

public int getType()

Get the type of the transaction.

#Return Value

int

#instance()

public MultiPayment instance()

#Return Value

MultiPayment

#org.arkecosystem.crypto.transactions.builder.MultiSignatureRegistration;

#min() int

public MultiSignatureRegistration min(int min)

Set the minimum required signatures.

#Parameters

#Return Value

MultiSignatureRegistration

#min() byte

public MultiSignatureRegistration min(byte min)

Set the minimum required signatures.

#Parameters

#Return Value

MultiSignatureRegistration

#lifetime() int

public MultiSignatureRegistration lifetime(int lifetime)

Set the transaction lifetime.

#Parameters

#Return Value

MultiSignatureRegistration

#lifetime() byte

public MultiSignatureRegistration lifetime(byte lifetime)

Set the transaction lifetime.

#Parameters

#Return Value

MultiSignatureRegistration

#keysGroup()

public MultiSignatureRegistration keysgroup(List<String> keysgroup)

Set the keysgroup of signatures.

#Parameters

#Return Value

MultiSignatureRegistration

#getType()

public int getType()

Get the type of the transaction.

#Return Value

int

#instance()

public MultiPayment instance()

#Return Value

MultiPayment

#org.arkecosystem.crypto.transactions.builder.SecondSignatureRegistration;

#signature()

public SecondSignatureRegistration signature(String signature)

Set the signature asset to register the second passphrase.

#Parameters

#Return Value

SecondSignatureRegistration

#getType()

public int getType()

Get the type of the transaction.

#Return Value

int

#instance()

public SecondSignatureRegistration instance()

#Return Value

SecondSignatureRegistration

#org.arkecosystem.crypto.transactions.builder.Transfer;

#recipient()

public Transfer recipient(String recipientId)

Set the recipient of the transfer.

#Parameters

#Return Value

Transfer

#amount() int

public Transfer amount(int amount)

Set the amount to transfer.

#Parameters

#Return Value

Transfer

#amount() long

public Transfer amount(long amount)

Set the amount to transfer.

#Parameters

#Return Value

Transfer

#vendorField()

public Transfer vendorField(String vendorField)

Set the vendor field / smartbridge.

#Parameters

#Return Value

Transfer

#getType()

public int getType()

Get the type of the transaction.

#Return Value

int

#instance()

public Transfer instance()

#Return Value

Transfer

#org.arkecosystem.crypto.transactions.builder.Vote;

#votes()

public Vote votes(List votes)

Set the votes to cast.

#Parameters

#Return Value

Vote

#sign()

public Vote sign(String passphrase)

Sign the transaction using the given passphrase.

#Parameters

#Return Value

Vote

#getType()

public int getType()

Get the type of the transaction.

#Return Value

int

#instance()

public Vote instance()

#Return Value

Vote

#org.arkecosystem.crypto.transactions.deserializers.AbstractDeserializer;

#AbstractDeserializer()

public AbstractDeserializer(String serialized, ByteBuffer buffer, Transaction transaction)

Create a new deserializer instance

#Parameters

#Return Value

AbstractDeserializer

#org.arkecosystem.crypto.transactions.deserializers.DelegateRegistration;

#DelegateRegistration()

public DelegateRegistration(String serialized, ByteBuffer buffer, Transaction transaction)

Create a new DelegateRegistration instance.

#Parameters

#deserialize()

public void deserialize(int assetOffset)

Handle the deserialization of “delegate registration” data.

#Parameters

#Return Value

void

#org.arkecosystem.crypto.transactions.deserializers.DelegateResignation;

#DelegateResignation()

public DelegateResignation(String serialized, ByteBuffer buffer, Transaction transaction)

Create a new DelegateResignation instance.

#Parameters

#deserialize()

public void deserialize(int assetOffset)

Handle the deserialization of “delegate resignation” data

#Parameters

#Return Value

void

#org.arkecosystem.crypto.transactions.deserializers.HtlcClaim;

#HtlcClaim()

public HtlcClaim(String serialized, ByteBuffer buffer, Transaction transaction)

Create a new HtlcClaim instance.

#Parameters

#deserialize()

public void deserialize(int assetOffset)

Handle the deserialization of “htlc claim” data

#Parameters

#Return Value

void

#org.arkecosystem.crypto.transactions.deserializers.HtlcLock;

#HtlcLock()

public HtlcLock(String serialized, ByteBuffer buffer, Transaction transaction)

Create a new HtlcLock instance.

#Parameters

#deserialize()

public void deserialize(int assetOffset)

Handle the deserialization of “htlc lock” data

#Parameters

#Return Value

void

#org.arkecosystem.crypto.transactions.deserializers.HtlcRefund;

#HtlcRefund()

public HtlcRefund(String serialized, ByteBuffer buffer, Transaction transaction)

Create a new HtlcRefund instance.

#Parameters

#deserialize()

public void deserialize(int assetOffset)

Handle the deserialization of “htlc refund” data

#Parameters

#Return Value

void

#org.arkecosystem.crypto.transactions.deserializers.Ipfs;

#Ipfs()

public Ipfs(String serialized, ByteBuffer buffer, Transaction transaction)

Create a new Ipfs instance.

#Parameters

#deserialize()

public void deserialize(int assetOffset)

Handle the deserialization of “Ipfs” data

#Parameters

#Return Value

void

#org.arkecosystem.crypto.transactions.deserializers.MultiPayment;

#MultiPayment()

public MultiPayment(String serialized, ByteBuffer buffer, Transaction transaction)

Create a new MultiPayment instance.

#Parameters

#deserialize()

public void deserialize(int assetOffset)

Handle the deserialization of “multi payment” data

#Parameters

#Return Value

void

#org.arkecosystem.crypto.transactions.deserializers.MultiSignatureRegistration;

#MultiSignatureRegistration()

public MultiSignatureRegistration(String serialized, ByteBuffer buffer, Transaction transaction)

Create a new MultiSignatureRegistration instance.

#Parameters

#deserialize()

public void deserialize(int assetOffset)

Handle the deserialization of “multi signature registration” data

#Parameters

#Return Value

void

#org.arkecosystem.crypto.transactions.deserializers.SecondSignatureRegistration;

#SecondSignatureRegistration()

public SecondSignatureRegistration(String serialized, ByteBuffer buffer, Transaction transaction)

Create a new SecondSignatureRegistration instance.

#Parameters

#deserialize()

public void deserialize(int assetOffset)

Handle the deserialization of “second signature” data.

#Parameters

#Return Value

void

#org.arkecosystem.crypto.transactions.deserializers.Transfer;

#Transfer()

public Transfer(String serialized, ByteBuffer buffer, Transaction transaction)

Create a new Transfer instance.

#Parameters

#deserialize()

public void deserialize(int assetOffset)

Handle the deserialization of “transfer” data.

#Parameters

#Return Value

void

#org.arkecosystem.crypto.transactions.deserializers.Vote;

#Vote()

public Vote(String serialized, ByteBuffer buffer, Transaction transaction)

Create a new Vote instance.

#Parameters

#deserialize()

public void deserialize(int assetOffset)

Handle the deserialization of “vote” data.

#Parameters

#Return Value

void

#org.arkecosystem.crypto.transactions.serializers.AbstractSerializer;

#AbstractSerializer()

public AbstractSerializer(ByteBuffer buffer, Transaction transaction)

Create a new AbstractSerializer instance.

#Parameters

#org.arkecosystem.crypto.transactions.serializers.DelegateRegistration;

#DelegateRegistration()

public DelegateRegistration(ByteBuffer buffer, Transaction transaction)

Create a new DelegateRegistration instance.

#Parameters

#serialize

public void serialize()

Handle the serialization of “delegate registration” data.

#Return Value

void

#org.arkecosystem.crypto.transactions.serializers.DelegateResignation;

#DelegateResignation()

public DelegateResignation(ByteBuffer buffer, Transaction transaction)

Create a new DelegateResignation instance.

#Parameters

#serialize

public void serialize()

Handle the serialization of “delegate resignation” data.

#Return Value

void

#org.arkecosystem.crypto.transactions.serializers.HtlcClaim;

#HtlcClaim()

public HtlcClaim(ByteBuffer buffer, Transaction transaction)

Create a new HtlcClaim instance.

#Parameters

#serialize

public void serialize()

Handle the serialization of “htlc claim” data.

#Return Value

void

#org.arkecosystem.crypto.transactions.serializers.HtlcLock;

#HtlcLock()

public HtlcLock(ByteBuffer buffer, Transaction transaction)

Create a new HtlcLock instance.

#Parameters

#serialize

public void serialize()

Handle the serialization of “htlc lock” data.

#Return Value

void

#org.arkecosystem.crypto.transactions.serializers.HtlcRefund;

#HtlcRefund()

public HtlcRefund(ByteBuffer buffer, Transaction transaction)

Create a new HtlcRefund instance.

#Parameters

#serialize

public void serialize()

Handle the serialization of “htlc refund” data.

#Return Value

void

#org.arkecosystem.crypto.transactions.serializers.Ipfs;

#Ipfs()

public Ipfs(ByteBuffer buffer, Transaction transaction)

Create a new Ipfs instance.

#Parameters

#serialize

public void serialize()

Handle the serialization of “ipfs” data.

#Return Value

void

#org.arkecosystem.crypto.transactions.serializers.MultiPayment;

#MultiPayment()

public MultiPayment(ByteBuffer buffer, Transaction transaction)

Create a new MultiPayment instance.

#Parameters

#serialize

public void serialize()

Handle the serialization of “multi payment” data.

#Return Value

void

#org.arkecosystem.crypto.transactions.serializers.MultiSignatureRegistration;

#MultiSignatureRegistration

public MultiSignatureRegistration(ByteBuffer buffer, Transaction transaction)

Create a new MultiSignatureRegistration instance.

#Parameters

#serialize

public function serialize()

Handle the serialization of “multi signature registration” data.

#Return Value

void

#org.arkecosystem.crypto.transactions.serializers.SecondSignatureRegistration;

#SecondSignatureRegistration

public SecondSignatureRegistration(ByteBuffer buffer, Transaction transaction)

Create a new SecondSignatureRegistration instance.

#Parameters

#serialize

public void serialize()

Handle the serialization of “second signature registration” data.

#Return Value

void

#org.arkecosystem.crypto.transactions.serializers.Transfer;

#Transfer

public Transfer(ByteBuffer buffer, Transaction transaction)

Create a new Transfer instance.

#Parameters

#serialize

public void serialize()

Handle the serialization of “transfer” data.

#Return Value

void

#org.arkecosystem.crypto.transactions.serializers.Vote;

#Vote

public Vote(ByteBuffer buffer, Transaction transaction)

Create a new Vote instance.

#Parameters

#serialize

public void serialize()

Handle the serialization of “vote” data.

#Return Value

void

#org.arkecosystem.crypto.transactions.Deserializer;

#deserialize

public Transaction deserialize(String serialized)

Perform AIP11 compliant deserialization.

#Parameters

#Return Value

Transaction

#org.arkecosystem.crypto.transactions.Serializer;

#serialize()

public byte[] serialize(Transaction transaction)

Perform AIP11 compliant serialization.

#Parameters

#Return Value

byte[]

#org.arkecosystem.crypto.transactions.Transaction;

#computeId()

public String computeId()

Convert the byte representation to a unique identifier.

#Return Value

String

#sign()

public Transaction sign(String passphrase)

Sign the transaction using the given passphrase.

#Parameters

#Return Value

Transaction

#secondSign()

public Transaction secondSign(String passphrase)

Sign the transaction using the given second passphrase.

#Parameters

#Return Value

Transaction

#verify()

public boolean verify()

Verify the transaction.

#Return Value

boolean

#secondVerify()

public boolean secondVerify(String secondPublicKey)

Verify the transaction with a second public key.

#Parameters

#Return Value

boolean

#parseSignatures()

public Transaction parseSignatures(String serialized, int startOffset)

Parse the signature, second signature and multi signatures.

#Parameters

#Return Value

Transaction

#toHashMap()

public HashMap toHashMap()

Convert the transaction to its hashmap representation.

#Return Value

HashMap

#toJson()

public String toJson()

Convert the transaction to its JSON representation.

#Return Value

String

#serialize()

public String serialize()

Perform AIP11 compliant serialization

#Return Value

String

#deserialize()

public static Transaction deserialize(String serialized)

Perform AIP11 compliant deserialization.

#Parameters

#Return Value

Transaction

#org.arkecosystem.crypto.utils.Message;

#Message()

public Message(String publickey, String signature, String message)

Create a new message instance

#Parameters

#Return Value

Message

#sign()

public static Message sign(String message, String passphrase)

Sign a message using the given passphrase.

#Parameters

#Return Value

Message

#verify()

public boolean verify()

Verify the message contents

#Return Value

boolean

#toMap()

public Map toMap()

Convert the message to its map representation

#Return Value

array

#toJson()

public String toJson()

Convert the message to its JSON representation

#Return Value

String

#getMessage()

public String getMessage()

Get the message content from the message object.

#Return Value

String

#getPublickey()

public String getPublickey()

Get the public key from the message.

#Return Value

String

#getSignature()

public String getSignature()

Get the signature from the message.

#Return Value

String

#org.arkecosystem.crypto.utils.Slot;

#time()

public static int time()

Get the time diff between now and network start.

#Return Value

int

#epoch()

public static long epoch()

Get the network start epoch.

#Return Value

long