#API Documentation

#ArkEcosystem\Crypto\Configuration\Fee

#get()

1public static function get(int $type)

Get a fee for a given transaction type

#Parameters

#Return Value

int

#set()

1public static function set(int $type, int $fee)

Set a fee

#Parameters

#Return Value

void

#ArkEcosystem\Crypto\Configuration\Network

#set()

1public static function set(AbstractNetwork $network)

Set what network you want to use in the crypto library

#Parameters

#Return Value

void

#get()

1public static function get()

Get settings for a selected network, default network is devnet

#Return Value

AbstractNetwork

#ArkEcosystem\Crypto\Identities\Address

#fromPublicKey()

1public static function fromPublicKey(string $publicKey, $network = null)

Derive the address from the given public key.

#Parameters

#Return Value

string

#fromPrivateKey()

1public static function fromPrivateKey(EccPrivateKey $privateKey, AbstractNetwork $network = null)

Derive the address from the given private key.

#Parameters

#Return Value

string

#fromPassphrase()

1public static function fromPassphrase(string $passphrase, AbstractNetwork $network = null)

Derive the address from the given passphrase.

#Parameters

#Return Value

string

#validate()

1public static function validate(string $address, $network = null)

Validate the given address.

#Parameters

#Return Value

bool

#ArkEcosystem\Crypto\Identities\PrivateKey

#fromPassphrase()

1public static function fromPassphrase(string $passphrase)

Derive the private key for the given passphrase.

#Parameters

#Return Value

EcPrivateKey

#fromHex()

1public static function fromHex($privateKey)

Create a private key instance from a hex string.

#Parameters

#Return Value

EcPrivateKey

#fromWif()

1public static function fromWif(string $wif, AbstractNetwork $network = null)

Create a private key instance from a hex string.

#Parameters

#Return Value

EcPrivateKey

#ArkEcosystem\Crypto\Identities\PublicKey

#fromPassphrase()

1public static function fromPassphrase(string $passphrase)

Derive the public from the given passphrase.

#Parameters

#Return Value

EcPublicKey

#fromHex()

1public static function fromHex($publicKey)

Create a public key instance from a hex string.

#Parameters

#Return Value

EcPublicKey

#ArkEcosystem\Crypto\Identities\WIF

#fromPassphrase()

1public static function fromPassphrase(string $passphrase, AbstractNetwork $network = null)

Derive the WIF from the given passphrase.

#Parameters

#Return Value

string

#ArkEcosystem\Crypto\Networks\Devnet

#epoch()

1public function epoch()

Get the epoch time of the start of the Network.

#Return Value

string

#ArkEcosystem\Crypto\Networks\Mainnet

#epoch()

1public function epoch()

Get the epoch time of the start of the Network.

#Return Value

string

#ArkEcosystem\Crypto\Networks\Testnet

#epoch()

1public function epoch()

Get the epoch time of the start of the Network.

#Return Value

string

#ArkEcosystem\Crypto\Transactions\Builder\AbstractTransaction

#__toString()

1public function __toString()

Convert the message to its string representation.

#Return Value

string

#new()

1public function new()

Create a new transaction instance.

#Return Value

self

#withFee()

1public function withFee(int $fee)

Set the transaction fee.

#Parameters

#Return Value

self

#toJson()

1public function toJson()

Convert the transaction to its JSON representation.

#Return Value

string

#toArray()

1public function toArray()

Convert the transaction to its array representation.

#Return Value

array

#sign()

1public function sign(string $passphrase)

Sign the transaction using the given passphrase.

#Parameters

#Return Value

self

#secondSign()

1public function secondSign(string $secondPassphrase)

Sign the transaction using the given second passphrase

#Parameters

#Return Value

self

#verify()

1public function verify()

Verify the transaction validity.

#Return Value

bool

#secondVerify()

1public function secondVerify(string $secondPublicKey)

Verify the transaction validity with a second signature

#Parameters

#Return Value

bool

#ArkEcosystem\Crypto\Transactions\Builder\DelegateRegistration

#sign()

1public function sign(string $passphrase)

Sign the transaction using the given passphrase

#Parameters

#Return Value

AbstractTransaction

#username()

1public function username(string $username)

Set the username to assign.

#Parameters

#Return Value

self

#ArkEcosystem\Crypto\Transactions\Builder\MultiPayment

#add()

1public function add(string $recipientId, int $amount)

Add a new payment to the collection.

#Parameters

#Return Value

self

#ArkEcosystem\Crypto\Transactions\Builder\MultiSignatureRegistration

#min()

1public function min(int $min)

Set the minimum required signatures.

#Parameters

#Return Value

self

#lifetime()

1public function lifetime(int $lifetime)

Set the transaction lifetime.

#Parameters

#Return Value

self

#keysGroup()

1public function keysgroup(array $keysgroup)

Set the keysgroup of signatures.

#Parameters

#Return Value

self

#ArkEcosystem\Crypto\Transactions\Builder\SecondSignatureRegistration

#signature()

1public function signature(string $secondPassphrase)

Set the signature asset to register the second passphrase.

#Parameters

#Return Value

self

#ArkEcosystem\Crypto\Transactions\Builder\TimelockTransfer

#timelock

1public function timelock(int $timelock)

Set the timelock of the transfer.

#Parameters

#Return Value

self

#timestamp

1public function timestamp()

Set the timelock type of the transfer to timestamp.

#Return Value

self

#height

1public function height()

Set the timelock type of the transfer to block height.

#Return Value

self

#ArkEcosystem\Crypto\Transactions\Builder\Transfer

#recipient()

1public function recipient(string $recipientId)

Set the recipient of the transfer.

#Parameters

#Return Value

self

#amount()

1public function amount(int $amount)

Set the amount to transfer.

#Parameters

#Return Value

self

#vendorField()

1public function vendorField(string $vendorField)

Set the vendor field / smartbridge.

#Parameters

#Return Value

self

#ArkEcosystem\Crypto\Transactions\Builder\Vote

#votes()

1public function votes(array $votes)

Set the votes to cast.

#Parameters

#Return Value

self

#sign()

1public function sign(string $passphrase)

Sign the transaction using the given passphrase.

#Parameters

#Return Value

AbstractTransaction

#ArkEcosystem\Crypto\Transactions\Deserializers\AbstractDeserializer

#__construct()

1public function __construct(Reader $buffer, int $assetOffset, Transaction $transaction)

Create a new deserializer instance

#Parameters

#Return Value

AbstractDeserializer

#deserialize()

1abstract public function deserialize()

Handle the deserialization of transaction data

#Return Value

object

#ArkEcosystem\Crypto\Transactions\Deserializers\DelegateRegistration

#deserialize()

1public function deserialize()

Handle the deserialization of “delegate registration” data.

#Return Value

object

#ArkEcosystem\Crypto\Transactions\Deserializers\DelegateResignation

#deserialize()

1public function deserialize()

Handle the deserialization of “delegate resignation” data.

#Return Value

object

#ArkEcosystem\Crypto\Transactions\Deserializers\IPFS

#deserialize()

1public function deserialize()

Handle the deserialization of “ipfs” data

#Return Value

object

#ArkEcosystem\Crypto\Transactions\Deserializers\MultiPayment

#deserialize()

1public function deserialize()

Handle the deserialization of “multi payment” data

#Return Value

object

#ArkEcosystem\Crypto\Transactions\Deserializers\MultiSignatureRegistration

#deserialize()

1public function deserialize()

Handle the deserialization of “multi signature registration” data

#Return Value

object

#ArkEcosystem\Crypto\Transactions\Deserializers\SecondSignatureRegistration

#deserialize()

1public function deserialize()

Handle the deserialization of “second signature” data.

#Return Value

object

#ArkEcosystem\Crypto\Transactions\Deserializers\TimelockTransfer

#deserialize()

1public function deserialize()

Handle the deserialization of “timelock transfer” data.

#Return Value

object

#ArkEcosystem\Crypto\Transactions\Deserializers\Transfer

#deserialize()

1public function deserialize()

Handle the deserialization of “transfer” data.

#Return Value

object

#ArkEcosystem\Crypto\Transactions\Deserializers\Vote

#deserialize()

1public function deserialize()

Handle the deserialization of “vote” data.

#Return Value

object

#ArkEcosystem\Crypto\Transactions\Serializers\AbstractSerializer

#__construct()

1public function __construct(array $transaction, Writer $buffer)

Create a new serializer instance.

#Parameters

#Return Value

AbstractSerializer

#serialize

1abstract public function serialize()

Handle the serialization of transaction data.

#Return Value

void

#ArkEcosystem\Crypto\Transactions\Serializers\DelegateRegistration

#serialize

1public function serialize()

Handle the serialization of “delegate registration” data.

#Return Value

void

#ArkEcosystem\Crypto\Transactions\Serializers\DelegateResignation

#serialize

1public function serialize()

Handle the serialization of “delegate resignation” data.

#Return Value

void

#ArkEcosystem\Crypto\Transactions\Serializers\IPFS

#serialize

1public function serialize()

Handle the serialization of “IPFS” data.

#Return Value

void

#ArkEcosystem\Crypto\Transactions\Serializers\MultiPayment

#serialize

1public function serialize()

Handle the serialization of “multi payment” data.

#Return Value

void

#ArkEcosystem\Crypto\Transactions\Serializers\MultiSignatureRegistration

#serialize

1public function serialize()

Handle the serialization of “multi signature registration” data.

#Return Value

void

#ArkEcosystem\Crypto\Transactions\Serializers\SecondSignatureRegistration

#serialize

1public function serialize()

Handle the serialization of “second signature registration” data.

#Return Value

void

#ArkEcosystem\Crypto\Transactions\Serializers\TimelockTransfer

#serialize

1public function serialize()

Handle the serialization of “timelock transfer” data.

#Return Value

void

#ArkEcosystem\Crypto\Transactions\Serializers\Transfer

#serialize

1public function serialize()

Handle the serialization of “transfer” data.

#Return Value

void

#ArkEcosystem\Crypto\Transactions\Serializers\Vote

#serialize

1public function serialize()

Handle the serialization of “vote” data.

#Return Value

void

#ArkEcosystem\Crypto\Transactions\Deserializer

#__construct()

1public function __construct(string $serialized)

Create a new deserializer instance.

#Parameters

#Return Value

Deserializer

#new()

1public static function new(string $serialized)

Create a new deserializer instance.

#Parameters

#Return Value

Deserializer

#deserialize

1public function deserialize(self):

Perform AIP11 compliant deserialization.

#Return Value

Transaction

#handleType

1public function handleType(int $assetOffset, Transaction $transaction)

Handle the deserialization of “type” data

#Parameters

#Return Value

Transaction

#handleVersionOne

1public function handleVersionOne(Transaction $transaction)

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

#Parameters

#Return Value

Transaction

#handleVersionTwo

1public function handleVersionTwo(Transaction $transaction)

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

#Parameters

#Return Value

Transaction

#ArkEcosystem\Crypto\Transactions\Serializer

#__construct()

1private function __construct($transaction)

Create a new serializer instance.

#Parameters

#Return Value

Serializer

#new()

1public static function new($transaction)

Create a new serializer instance.

#Parameters

#Return Value

self

#serialize()

1public function serialize()

Perform AIP11 compliant serialization.

#Return Value

Buffer

#handleType()

1public function handleType(Writer $buffer)

Handle the serialization of “type” data

#Parameters

#Return Value

void

#handleSignatures()

1public function handleSignatures(Writer $buffer)

Handle the serialization of “signatures” data

#Parameters

#Return Value

void

#ArkEcosystem\Crypto\Transactions\Transaction

#getId()

1public function getId()

Convert the byte representation to a unique identifier.

#Return Value

string

#sign()

1public function sign(PrivateKey $keys)

Sign the transaction using the given passphrase.

#Parameters

#Return Value

self

#secondSign()

1public function secondSign(PrivateKey $keys)

Sign the transaction using the given second passphrase.

#Parameters

#Return Value

self

#verify()

1public function verify()

Verify the transaction.

#Return Value

bool

#secondVerify()

1public function secondVerify(string $secondPublicKey)

Verify the transaction with a second public key.

#Parameters

#Return Value

bool

#parseSignatures()

1public function parseSignatures(string $serialized, int $startOffset)

Parse the signature, second signature and multi signatures.

#Parameters

#Return Value

self

#toArray()

1public function toArray()

Convert the transaction to its array representation.

#Return Value

array

#toJson()

1public function toJson():

Convert the transaction to its JSON representation.

#Return Value

string

#toBytes()

1public function toBytes(bool $skipSignature = true, bool $skipSecondSignature = true)

Convert the transaction to its byte representation.

#Parameters

#Return Value

Buffer

#serialize()

1public function serialize()

Perform AIP11 compliant serialization

#Return Value

Buffer

#deserialize()

1public static function deserialize(string $serialized)

Perform AIP11 compliant deserialization.

#Parameters

#Return Value

self

#ArkEcosystem\Crypto\Utils\Message

#__construct()

1public function __construct(object $message)

Create a new message instance

#Parameters

#Return Value

Message

#__toString()

1public function __toString()

Convert the message to its JSON representation

#Return Value

string

#new()

1public static function new($message)

Create a new message instance.

#Parameters

#Return Value

self

#sign()

1public static function sign(string $message, string $passphrase)

Sign a message using the given passphrase.

#Parameters

#Return Value

self

#verify()

1public function verify()

Verify the message contents

#Return Value

bool

#toArray()

1public function toArray()

Convert the message to its array representation

#Return Value

array

#toJson()

1public function toJson()

Convert the message to its JSON representation

#Return Value

string

#ArkEcosystem\Crypto\Util\Slot

#time()

1public static function time()

Get the time diff between now and network start.

#Return Value

int

#epoch()

1public static function epoch()

Get the network start epoch.

#Return Value

int

#ArkEcosystem\Crypto\Helpers

#version()

1public static function version($network)

Get the network version.

#Parameters

#Return Value

int