#API Documentation

#ArkEcosystem.Crypto.Configuration.Fee

#get()

def self.get(type)

Get a fee for a given transaction type

#Parameters

#Return Value

?

#set()

def self.set(type, fee)

Set a fee

#Parameters

#Return Value

?

#ArkEcosystem.Crypto.Configuration.Network

#get()

def self.get

Get settings for a selected network, default network is mainnet.

#Return Value

?

#set()

def self.set(network)

Set settings for a selected network, default network is mainnet.

#Parameters

#Return Value

?

#ArkEcosystem.Crypto.Identities.Address

#from_public_key()

def self.from_public_key(public_key, network = nil)

Derive the address from the given public key.

#Parameters

#Return Value

string

#from_private_key()

def self.from_private_key(private_key, network = nil)

Derive the address from the given private key.

#Parameters

#Return Value

?

#from_passphrase()

def self.from_passphrase(passphrase, network = nil)

Derive the address from the given passphrase.

#Parameters

#Return Value

string

#validate()

def self.validate(address)

Validate the given address.

#Parameters

#Return Value

bool

#ArkEcosystem.Crypto.Identities.PrivateKey

#from_passphrase()

def self.from_passphrase(passphrase)

Derive the private key for the given passphrase.

#Parameters

#Return Value

?

#from_hex()

def self.from_hex(private_key)

Create a private key instance from a hex string.

#Parameters

#Return Value

?

#ArkEcosystem.Crypto.Identities.PublicKey

#from_passphrase()

def self.from_passphrase(passphrase)

Derive the public from the given passphrase.

#Parameters

#Return Value

?

#from_hex()

def self.from_hex(public_key)

Create a public key instance from a hex string.

#Parameters

#Return Value

?

#ArkEcosystem.Crypto.Identities.WIF

#from_passphrase()

def self.from_passphrase(passphrase, network = nil)

Derive the WIF from the given passphrase.

#Parameters

#Return Value

?

#ArkEcosystem.Crypto.Networks.Devnet

#epoch()

def self.epoch

Get the epoch time of the Network.

#Return Value

String

#version()

def self.version

Get the version of the Network.

#Return Value

Integer

#wif()

def self.wif

Get the WIF of the Network.

#Return Value

Integer

#ArkEcosystem.Crypto.Networks.Mainnet

#epoch()

def self.epoch

Get the epoch time of the Network.

#Return Value

String

#version()

def self.version

Get the version of the Network.

#Return Value

Integer

#wif()

def self.wif

Get the WIF of the Network.

#Return Value

Integer

#ArkEcosystem.Crypto.Networks.Testnet

#epoch()

def self.epoch

Get the epoch time of the Network.

#Return Value

String

#version()

def self.version

Get the version of the Network.

#Return Value

Integer

#wif()

def self.wif

Get the WIF of the Network.

#Return Value

Integer

#ArkEcosystem.Crypto.Transactions.Builder.Base

#sign()

def sign(passphrase)

Sign the transaction using the given passphrase.

#Parameters

#Return Value

?

#sign_and_create_id()

def sign_and_create_id(passphrase)

Sign the transaction using the given passphrase and generate a valid id for it.

#Parameters

#Return Value

?

#second_sign()

def second_sign(second_passphrase)

Sign the transaction using the given second passphrase.

#Parameters

#Return Value

?

#verify()

def verify

Verify the transaction with a public key.

#Return Value

?

#second_verify()

def second_verify(second_public_key)

Verify the transaction with a second public key.

#Parameters

#Return Value

?

#to_params()

def to_params

Convert the transaction to its params representation.

#Return Value

?

#to_json()

def to_json

Convert the transaction to its JSON representation.

#Return Value

?

#ArkEcosystem.Crypto.Transactions.Builder.DelegateRegistration

#def set_username()

def set_username(username)

Set the username to assign.

#Parameters

#Return Value

?

#def sign()

def sign(passphrase)

Sign the transaction using the given passphrase.

#Parameters

#Return Value

?

#def type()

def type

Get the type of the transaction.

#Return Value

ArkEcosystem::Crypto::Enums::Types::DELEGATE_REGISTRATION

#ArkEcosystem.Crypto.Transactions.Builder.MultiSignatureRegistration

#def set_keysgroup()

def set_keysgroup(keysgroup)

Set the keysgroup of signatures.

#Parameters

#Return Value

?

#def set_lifetime()

def set_lifetime(lifetime)

Set the transaction lifetime.

#Parameters

#Return Value

?

#def set_min()

def set_min(min)

Set the transaction minimum required signatures.

#Parameters

#Return Value

?

#def type()

def type

Get the type of the transaction.

#Return Value

ArkEcosystem::Crypto::Enums::Types::MULTI_SIGNATURE_REGISTRATION

#ArkEcosystem.Crypto.Transactions.Builder.SecondSignatureRegistration

#def set_second_passphrase()

def set_second_passphrase(second_passphrase)

Set the second passphrase for the transaction.

#Parameters

#Return Value

?

#def type()

def type

Get the type of the transaction.

#Return Value

ArkEcosystem::Crypto::Enums::Types::SECOND_SIGNATURE_REGISTRATION

#ArkEcosystem.Crypto.Transactions.Builder.Transfer

#def set_recipient_id()

def set_recipient_id(recipient_id)

Set the recipient id of the transaction.

#Parameters

#Return Value

?

#def set_amount()

def set_amount(amount)

Set the amount of the transaction.

#Parameters

#Return Value

?

#def set_vendor_field()

def set_vendor_field(vendor_field)

Set the vendorfield of the transaction.

#Parameters

#Return Value

?

#def type()

def type

Get the type of the transaction.

#Return Value

ArkEcosystem::Crypto::Enums::Types::TRANSFER

#ArkEcosystem.Crypto.Transactions.Builder.Vote

#def set_votes()

def set_votes(votes)

Set the votes to cast.

#Parameters

#Return Value

?

#def sign()

def sign(passphrase)

Sign the transaction using the given passphrase.

#Parameters

#Return Value

?

#def type()

def type

Get the type of the transaction.

#Return Value

ArkEcosystem::Crypto::Enums::Types::VOTE

#ArkEcosystem.Crypto.Transactions.Deserializers.Base

#initialize()

def initialize(serialized, binary, asset_offset, transaction)

The base deserializer for transactions.

#Parameters

#Return Value

?

#ArkEcosystem.Crypto.Transactions.Deserializers.DelegateRegistration

#deserialize()

def deserialize

Handle the deserialization of “delegate registration” data.

#Return Value

?

#ArkEcosystem.Crypto.Transactions.Deserializers.DelegateResignation

#deserialize()

def deserialize

Handle the deserialization of “delegate resignation” data.

#Return Value

?

#ArkEcosystem.Crypto.Transactions.Deserializers.IPFS

#deserialize()

def deserialize

Handle the deserialization of “ipfs” data

#Return Value

?

#ArkEcosystem.Crypto.Transactions.Deserializers.MultiPayment

#deserialize()

def deserialize

Handle the deserialization of “multi payment” data

#Return Value

?

#ArkEcosystem.Crypto.Transactions.Deserializers.MultiSignatureRegistration

#deserialize()

def deserialize

Handle the deserialization of “multi signature registration” data

#Return Value

?

#ArkEcosystem.Crypto.Transactions.Deserializers.SecondSignatureRegistration

#deserialize()

def deserialize

Handle the deserialization of “second signature” data.

#Return Value

?

#ArkEcosystem.Crypto.Transactions.Deserializers.TimelockTransfer

#deserialize()

def deserialize

Handle the deserialization of “timelock transfer” data.

#Return Value

?

#ArkEcosystem.Crypto.Transactions.Deserializers.Transfer

#deserialize()

def deserialize

Handle the deserialization of “transfer” data.

#Return Value

?

#ArkEcosystem.Crypto.Transactions.Deserializers.Vote

#deserialize()

def deserialize

Handle the deserialization of “vote” data.

#Return Value

?

#ArkEcosystem.Crypto.Transactions.Serializers.Base

#initialize()

def initialize(transaction, bytes)

The base serializer for transactions

#Parameters

#Return Value

?

#ArkEcosystem.Crypto.Transactions.Serializers.DelegateRegistration

#serialize()

def serialize

Handle the serialization of “delegate registration” data.

#Return Value

?

#ArkEcosystem.Crypto.Transactions.Serializers.DelegateResignation

#serialize()

def serialize

Handle the serialization of “delegate resignation” data.

#Return Value

?

#ArkEcosystem.Crypto.Transactions.Serializers.IPFS

#serialize()

def serialize

Handle the serialization of “IPFS” data.

#Return Value

void

#ArkEcosystem.Crypto.Transactions.Serializers.MultiPayment

#serialize()

def serialize

Handle the serialization of “multi payment” data.

#Return Value

?

#ArkEcosystem.Crypto.Transactions.Serializers.MultiSignatureRegistration

#serialize()

def serialize

Handle the serialization of “multi signature registration” data.

#Return Value

?

#ArkEcosystem.Crypto.Transactions.Serializers.SecondSignatureRegistration

#serialize()

def serialize

Handle the serialization of “second signature registration” data.

#Return Value

?

#ArkEcosystem.Crypto.Transactions.Serializers.TimelockTransfer

#serialize()

def serialize

Handle the serialization of “timelock transfer” data.

#Return Value

?

#ArkEcosystem.Crypto.Transactions.Serializers.Transfer

#serialize()

def serialize

Handle the serialization of “transfer” data.

#Return Value

?

#ArkEcosystem.Crypto.Transactions.Serializers.Vote

#serialize()

def serialize

Handle the serialization of “vote” data.

#Return Value

void

#ArkEcosystem.Crypto.Transactions.Deserializer

#initialize()

def initialize(serialized)

The base deserializer for transactions

#Parameters

#Return Value

?

#deserialize()

def deserialize

Perform AIP11 compliant deserialization.

#Return Value

?

#handle_type()

def handle_type(asset_offset, transaction)

Handle the deserialization of “type” data

#Parameters

#Return Value

?

#handle_version_one()

def handle_version_one(transaction)

Handle the deserialization of transaction data with a version of 1.0.

#Parameters

#Return Value

?

#ArkEcosystem.Crypto.Transactions.Serializer

#initialize()

def initialize(transaction)

The base serializer for transactions.

#Parameters

#Return Value

?

#serialize()

def serialize

Perform AIP11 compliant serialization.

#Return Value

?

#handle_type()

def handle_type(bytes)

Handle the serialization of “type” data

#Parameters

#Return Value

?

#handle_signatures()

def handle_signatures(bytes)

Handle the serialization of “signatures” data

#Parameters

#Return Value

?

#ArkEcosystem.Crypto.Transactions.Transaction

#get_id()

def get_id

Convert the byte representation to a unique identifier.

#Return Value

String

#sign()

def sign(passphrase)

Sign the transaction using the given passphrase.

#Parameters

#Return Value

?

#second_sign()

def second_sign(second_passphrase)

Sign the transaction using the given second passphrase.

#Parameters

#Return Value

?

#verify()

def verify

Verify the transaction.

#Return Value

?

#second_verify()

def second_verify(second_public_key)

Verify the transaction with a second public key.

#Parameters

#Return Value

?

#to_bytes()

def to_bytes(skip_signature = true, skip_second_signature = true)

Convert the transaction to its byte representation.

#Parameters

#Return Value

?

#parse_signatures()

def parse_signatures(serialized, start_offset)

Parse the signature, second signature, and multi signatures.

#Parameters

#Return Value

?

#to_params()

def to_params

Convert the transaction to its params representation.

#Return Value

?

#to_json()

def to_json

Convert the transaction to its JSON representation.

#Return Value

?

#serialize()

def serialize(transaction)

Perform AIP11 compliant serialization

#Parameters

#Return Value

?

#deserialize()

def serialize(transaction)

Perform AIP11 compliant deserialization.

#Parameters

#Return Value

?

#ArkEcosystem.Crypto.Utils.Message

#initialize()

def initialize(message)

The builder to work with signed messages.

#Parameters

#Return Value

?

#sign()

def self.sign(message, passphrase)

Sign a message using the given passphrase.

#Parameters

#Return Value

?

#verify()

def verify

Verify the message contents

#Return Value

?

#to_params()

def to_params

Convert the message to its params representation

#Return Value

?

#to_json()

def to_json

Convert the message to its JSON representation

#Return Value

?

#ArkEcosystem.Crypto.Utils.Slot

#get_time()

def get_time

Get the time diff between now and network start.

#Return Value

?

#get_epoch()

def get_epoch

Get the network start epoch.

#Return Value

?