API Documentation

This method returns an address derived from the given passphrase in string format.

String address = Address.fromPassphrase("super secret passphrase");
>> "0x2289577F3784788784226Eb41E9B0ca9705C7C37"

This method returns an address derived from the given public key in string format.

String address = Address.fromPublicKey("validPublicKey");
>> "0x2289577F3784788784226Eb41E9B0ca9705C7C37"

This method returns an address derived from the given private key in string format.

String address = Address.fromPrivateKey(privateKey);
>> "0x2289577F3784788784226Eb41E9B0ca9705C7C37"

This method returns a boolean indicating whether the address is valid.

boolean isValid = Address.validate("0x2289577F3784788784226Eb41E9B0ca9705C7C37");
>> true

This method returns a private key object derived from the given passphrase.

ECKey privateKey = PrivateKey.fromPassphrase("super secret passphrase");
>> ECKey

This method returns a private key object derived from the given hex string.

ECKey privateKey = PrivateKey.fromHex("validHexString");
>> ECKey

This method returns a public key in hexadecimal string format derived from the given passphrase.

String publicKey = PublicKey.fromPassphrase("super secret passphrase");
>> "02d1c19f660a2725f55fad7864202b98671538381c0c77f57b8961ada0d1d61c1b"

This method returns the public key in the same hexadecimal format.

String publicKey = PublicKey.fromHex("validHexString");
>> "validHexString"

This method returns a WIF string derived from the given passphrase.

String wif = WIF.fromPassphrase("super secret passphrase");
>> "L2KVU2v4a1kgwem1S7LhWhTkzwMBvd1aR9Kh8itwu1c7cnRXAUxE"

This method returns the current network configuration object.

INetwork currentNetwork = Network.get();
>> Mainnet // or `Devnet` or `Testnet`

This method sets the network configuration to the provided object.

Network.set(new Mainnet());

This method sets the gas limit of the transaction and returns the builder instance.

builder.gasLimit(1000000);

This method sets the recipient address of the transaction and returns the builder instance.

builder.recipientAddress("0x1234567890abcdef");

This method sets the gas price of the transaction and returns the builder instance.

builder.gasPrice(50000000000);

This method sets the nonce of the transaction and returns the builder instance.

builder.nonce(1);

This method sets the network version of the transaction and returns the builder instance.

builder.network(23);

This method signs the transaction with the given passphrase and returns the builder instance.

builder.sign("super secret passphrase");

This method verifies the transaction and returns a boolean indicating validity.

boolean isValid = builder.verify();

This method converts the transaction to a JSON string and returns it.

String json = builder.toJson();

This method sets the payload for the EVM call transaction, removing any leading '0x' if present, and returns the builder instance.

EvmCallBuilder builder = (new EvmCallBuilder()).payload("payloadData");

This method sets the value for the transfer transaction, refreshes the payload data, and returns the builder instance.

TransferBuilder builder = (new TransferBuilder()).value("1000000");

This method sets the validator public key for the registration and returns the builder instance.

ValidatorRegistrationBuilder builder = (new ValidatorRegistrationBuilder()).validatorPublicKey("yourValidatorPublicKey");

This method sets the vote for the transaction and returns the builder instance.

VoteBuilder builder = (new VoteBuilder()).vote("yourVote");

This method computes the transaction ID and sets it to the `id` field.

transaction.computeId();

This method returns the transaction ID as a string.

String transactionId = transaction.getId();

This method signs the transaction with the provided passphrase and returns the transaction instance.

transaction.sign("super secret passphrase");

This method recovers the sender's public key and address from the transaction signature.

transaction.recoverSender();

This method verifies the transaction signature and returns `true` if valid, otherwise `false`.

boolean isValid = transaction.verify();

This method converts the transaction to a JSON string.

String json = transaction.toJson();

This method converts the transaction to a HashMap representation.

HashMap<String, Object> map = transaction.toHashMap();

This method serializes the transaction into a byte array with an option to skip the signature.

byte[] serializedTransaction = transaction.serialize(false);

This method decodes the transaction payload and returns a list of arguments.

List<Object> payload = transaction.decodePayload(data);

This method creates a new Serializer instance for the given transaction.

Serializer serializer = Serializer.newSerializer(transaction);

This method serializes the transaction and returns the resulting byte array.

byte[] transactionBytes = Serializer.getBytes(transaction, false);

This method serializes the transaction to a byte array with an option to skip the signature.

byte[] serializedTransaction = serializer.serialize(false);

This method creates a new Deserializer instance for the provided serialized transaction string.

Deserializer deserializer = Deserializer.newDeserializer("serialized transaction string");

This method deserializes the transaction from the buffer and returns an AbstractTransaction object.

AbstractTransaction transaction = deserializer.deserialize();

This method signs a message using the provided passphrase and returns a Message object containing the message, signature, and public key.

Message signedMessage = Message.sign("Hello, world!", "super secret passphrase");

This method verifies the signature of the message and returns true if valid, otherwise false.

boolean isValid = signedMessage.verify();

This method converts the message into a Map containing the message, public key, and signature.

Map<String, Object> messageMap = signedMessage.toMap();

This method converts the message to a JSON string representation.

String jsonMessage = signedMessage.toJson();

This method returns the original message.

String originalMessage = signedMessage.getMessage();

This method returns the public key used to sign the message.

String publicKey = signedMessage.getPublickey();

This method returns the signature of the message.

String signature = signedMessage.getSignature();

This method returns the current network time in seconds since the network epoch.

int currentNetworkTime = Slot.time();

This method returns the network epoch time in milliseconds since January 1, 1970.

long networkEpochTime = Slot.epoch();

This method decodes the function name and parameters from the given ABI-encoded data, returning a map containing the function name and arguments.

AbiDecoder decoder = new AbiDecoder();
Map<String, Object> decodedData = decoder.decodeFunctionData("0x0123456789abcdef...");
>> {functionName="transfer", args=["0x1234...", "1000"]}

This method encodes a function call with no parameters into ABI format.

AbiEncoder encoder = new AbiEncoder();
String encodedCall = encoder.encodeFunctionCall("transfer");
>> "0xa9059cbb"

This method encodes a function call with the given parameters into ABI format.

AbiEncoder encoder = new AbiEncoder();
List<Object> args = Arrays.asList("0x1234...", 1000);
String encodedCall = encoder.encodeFunctionCall("transfer", args);
>> "0xa9059cbb0000000000000000000000001234...000000000000000000000000000003e8"