#API Documentation

#ArkEcosystem.Crypto.Configuration.Fee

#Get()

1public static UInt64 Get(int type)

Get a fee for a given transaction type

#Parameters

#Return Value

UInt64

#Set()

1public static void Set(int type, UInt64 value)

Set a fee

#Parameters

#Return Value

void

#ArkEcosystem.Crypto.Configuration.Network

#Set()

1public static void Set(INetwork network)

Set what network you want to use in the crypto library

#Parameters

#Return Value

void

#Get()

1public static INetwork Get()

Get settings for a selected network, default network is devnet

#Return Value

INetwork

#ArkEcosystem.Crypto.Identities.Address

#FromPassphrase()

1public static string FromPassphrase(string passphrase, byte publicKeyHash = 0)

Get an address from a passphrase.

#Parameters

#Return Value

string

#FromPublicKey()

1public static string FromPublicKey(PubKey publicKey, byte publicKeyHash = 0)

Get an address from a public key.

#Parameters

#Return Value

string

#FromPrivateKey()

1public static string FromPrivateKey(Key privateKey, byte publicKeyHash = 0)

Get an address from a private key.

#Parameters

#Return Value

string

#Validate()

1public static bool Validate(string address, byte publicKeyHash = 0)

Validate a given address

#Parameters

#Return Value

bool

#ArkEcosystem.Crypto.Identities.PrivateKey

#FromPassphrase()

1public static Key FromPassphrase(string passphrase)

Create PrivateKey object from a given passphrase.

#Parameters

#Return Value

Key

#FromHex()

1public static Key FromHex(string privateKey)

Create PrivateKey object from a hex string.

#Parameters

#Return Value

Key

#ArkEcosystem.Crypto.Identities.PublicKey

#FromPassphrase()

1public static PubKey FromPassphrase(string passphrase)

Create PublicKey object from a given passphrase.

#Parameters

#Return Value

PubKey

#FromHex()

1public static PubKey FromHex(string publicKey)

Create PublicKey object from a given public key.

#Parameters

#Return Value

PubKey

#ArkEcosystem.Crypto.Identities.WIF

#FromPassphrase()

1public static string FromPassphrase(string passphrase)

Get wif from passphrase

#Parameters

#Return Value

string

#ArkEcosystem.Crypto.Networks.Devnet

#GetEpoch()

1public DateTime GetEpoch()

Return the epoch date for devnet.

#Return Value

DateTime

#GetVersion()

1public byte GetVersion()

Return the version for devnet.

#Return Value

byte

#GetWIF()

1public byte GetWIF()

Return the WIF for devnet.

#Return Value

byte

#ArkEcosystem.Crypto.Networks.Mainnet

#GetEpoch()

1public DateTime GetEpoch()

Return the epoch date for main net.

#Return Value

DateTime

#GetVersion()

1public byte GetVersion()

Return the version for main net.

#Return Value

byte

#GetWIF()

1public byte GetWIF()

Return the WIF for main net.

#Return Value

byte

#Crypto.Crypto.Networks.Testnet.Testnet

#GetEpoch()

1public DateTime GetEpoch()

Return the epoch date for testnet.

#Return Value

DateTime

#GetVersion()

1public byte GetVersion()

Return the version for testnet.

#Return Value

byte

#GetWIF()

1public byte GetWIF()

Return the WIF for testnet.

#Return Value

byte

#ArkEcosystem.Crypto.Transactions.Builder.Builder

#Sign()

1public static Transaction Sign(Transaction transaction, string passphrase, string secondPassphrase = null)

Builds a transaction for a transfer.

#Parameters

#Return Value

Transaction

#ArkEcosystem.Crypto.Transactions.Builder.DelegateRegistration

#Create()

1public static Transaction Create(string username, string passphrase, string secondPassphrase = null)

Builds a transaction for a delegate registration.

#Parameters

#Return Value

Transaction

#ArkEcosystem.Crypto.Transactions.Builder.MultiSignatureRegistration

#Create()

1public static Transaction Create(int min, int lifetime, List<string> keysgroup, string passphrase, string secondPassphrase)

Builds a transaction for a multi signature registration.

#Parameters

#Return Value

Transaction

#ArkEcosystem.Crypto.Transactions.Builder.SecondSignatureRegistration

#Create()

1public static Transaction Create(string passphrase, string secondPassphrase)

Builds a transaction for a second signature registration.

#Parameters

#Return Value

Transaction

#ArkEcosystem.Crypto.Transactions.Builder.Transfer

#Create()

1public static Transaction Create(string recipientId, ulong amount, string vendorField, string passphrase, string secondPassphrase = null)

Builds a transaction for a transfer.

#Parameters

#Return Value

Transaction

#ArkEcosystem.Crypto.Transactions.Builder.Vote

#Create()

1public static Transaction Create(List<string> votes, string passphrase, string secondPassphrase = null)

Builds a transaction for a vote.

#Parameters

#Return Value

Transaction

#ArkEcosystem.Crypto.Transactions.Deserializers.DelegateRegistration

#Deserialize()

1public static Transaction Deserialize(
2            BinaryReader reader,
3            MemoryStream stream,
4            Transaction transaction,
5            string serialized,
6            int assetOffset
7        )

Handle the deserialization of “delegate registration” data.

#Parameters

#Return Value

Transaction

#ArkEcosystem.Crypto.Transactions.Deserializers.DelegateResignation

#Deserialize()

1public static Transaction Deserialize(
2            BinaryReader reader,
3            MemoryStream stream,
4            Transaction transaction,
5            string serialized,
6            int assetOffset
7        )

Handle the deserialization of “delegate resignation” data.

#Parameters

#Return Value

Transaction

#ArkEcosystem.Crypto.Transactions.Deserializers.IPFS

#Deserialize()

1public static Transaction Deserialize(
2            BinaryReader reader,
3            MemoryStream stream,
4            Transaction transaction,
5            string serialized,
6            int assetOffset
7        )

Handle the deserialization of “IPFS” data.

#Parameters

#Return Value

Transaction

#ArkEcosystem.Crypto.Transactions.Deserializers.MultiPayment

#Deserialize()

1public static Transaction Deserialize(
2            BinaryReader reader,
3            MemoryStream stream,
4            Transaction transaction,
5            string serialized,
6            int assetOffset
7        )

Handle the deserialization of “multi payments” data.

#Parameters

#Return Value

Transaction

#ArkEcosystem.Crypto.Transactions.Deserializers.MultiSignatureRegistration

#Deserialize()

1public static Transaction Deserialize(
2            BinaryReader reader,
3            MemoryStream stream,
4            Transaction transaction,
5            string serialized,
6            int assetOffset
7        )

Handle the deserialization of “multi signature registration” data.

#Parameters

#Return Value

Transaction

#ArkEcosystem.Crypto.Transactions.Deserializers.SecondSignatureRegistration

#Deserialize()

1public static Transaction Deserialize(
2            BinaryReader reader,
3            MemoryStream stream,
4            Transaction transaction,
5            string serialized,
6            int assetOffset
7        )

Handle the deserialization of “second signature registration” data.

#Parameters

#Return Value

Transaction

#ArkEcosystem.Crypto.Transactions.Deserializers.TimelockTransfer

#Deserialize()

1public static Transaction Deserialize(
2            BinaryReader reader,
3            MemoryStream stream,
4            Transaction transaction,
5            string serialized,
6            int assetOffset
7        )

Handle the deserialization of “timelock transfer” data.

#Parameters

#Return Value

Transaction

#ArkEcosystem.Crypto.Transactions.Deserializers.Transfer

#Deserialize()

1public static Transaction Deserialize(
2            BinaryReader reader,
3            MemoryStream stream,
4            Transaction transaction,
5            string serialized,
6            int assetOffset
7        )

Handle the deserialization of “transfer” data.

#Parameters

#Return Value

Transaction

#ArkEcosystem.Crypto.Transactions.Deserializers.Vote

#Deserialize()

1public static Transaction Deserialize(
2            BinaryReader reader,
3            MemoryStream stream,
4            Transaction transaction,
5            string serialized,
6            int assetOffset
7        )

Handle the deserialization of “vote” data.

#Parameters

#Return Value

Transaction

#ArkEcosystem.Crypto.Transactions.Serializers.DelegateRegistration

#Serialize()

1public static void Serialize(BinaryWriter writer, Transaction transaction)

Handle the serialization of “delegate registration” data.

#Parameters

#Return Value

void

#ArkEcosystem.Crypto.Transactions.Serializers.DelegateResignation

#Serialize()

1public static void Serialize(BinaryWriter writer, Transaction transaction)

Handle the serialization of “delegate resignation” data.

#Parameters

#Return Value

void

#ArkEcosystem.Crypto.Transactions.Serializers.IPFS

#Serialize()

1public static void Serialize(BinaryWriter writer, Transaction transaction)

Handle the serialization of “IPFS” data.

#Parameters

#Return Value

void

#ArkEcosystem.Crypto.Transactions.Serializers.MultiPayment

#Serialize()

1public static void Serialize(BinaryWriter writer, Transaction transaction)

Handle the serialization of “multi payments” data.

#Parameters

#Return Value

void

#ArkEcosystem.Crypto.Transactions.Serializers.MultiSignatureRegistration

#Serialize()

1public static void Serialize(BinaryWriter writer, Transaction transaction)

Handle the serialization of “multi signature registration” data.

#Parameters

#Return Value

void

#ArkEcosystem.Crypto.Transactions.Serializers.SecondSignatureRegistration

#Serialize()

1public static void Serialize(BinaryWriter writer, Transaction transaction)

Handle the serialization of “second signature registration” data.

#Parameters

#Return Value

void

#ArkEcosystem.Crypto.Transactions.Serializers.TimelockTransfer

#Serialize()

1public static void Serialize(BinaryWriter writer, Transaction transaction)

Handle the serialization of “timelock transfer” data.

#Parameters

#Return Value

void

#ArkEcosystem.Crypto.Transactions.Serializers.Transfer

#Serialize()

1public static void Serialize(BinaryWriter writer, Transaction transaction)

Handle the serialization of “transfer” data.

#Parameters

#Return Value

void

#ArkEcosystem.Crypto.Transactions.Serializers.Vote

#Serialize()

1public static void Serialize(BinaryWriter writer, Transaction transaction)

Handle the serialization of “vote” data.

#Parameters

#Return Value

void

#ArkEcosystem.Crypto.Transactions.Deserializer

#Deserializer()

1public Deserializer(string serialized)

Class constructor.

#Parameters

#Return Value

Deserializer

#Deserialize()

1public Transaction Deserialize()

Perform AIP11 compliant deserialization.

#Return Value

Transaction

#HandleHeader()

1public Transaction HandleHeader(Transaction transaction)

Handle the deserialization of “headers” data.

#Parameters

#Return Value

Transaction

#HandleType()

1Transaction HandleType(Transaction transaction)

Handle the deserialization of “type” data

#Parameters

#Return Value

Transaction

#HandleVersionOne()

1Transaction HandleVersionOne(Transaction transaction)

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

#Parameters

#Return Value

Transaction

#ArkEcosystem.Crypto.Transactions.Serializer

#Serializer()

1public Serializer(Transaction transaction)

Class constructor.

#Parameters

#Return Value

Serializer

#Serialize()

1public byte[] Serialize()

Perform AIP11 compliant serialization.

#Return Value

byte[]

#HandleHeader()

1public void HandleHeader()

Handle the serialization of “headers” data.

#Return Value

void

#ArkEcosystem.Crypto.Transactions.Transaction

#GetId()

1public string GetId()

Convert the byte representation to a unique identifier.

#Return Value

string

#Sign()

1public string Sign(string passphrase)

Sign the transaction using the given passphrase.

#Parameters

#Return Value

string

#SecondSign()

1public string SecondSign(string passphrase)

Sign the transaction using the given second passphrase.

#Parameters

#Return Value

string

#Verify()

1public bool Verify()

Verify the transaction.

#Return Value

bool

#SecondVerify()

1public bool SecondVerify(string secondPublicKey)

Verify the transaction with a second public key.

#Parameters

#Return Value

bool

#ParseSignatures()

1public Transaction ParseSignatures(string serialized, int startOffset)

Parse the signature, second signature and multi signatures.

#Parameters

#Return Value

Transaction

#ToBytes()

1public byte[] ToBytes(bool skipSignature = true, bool skipSecondSignature = true)

Convert the transaction to its byte representation.

#Parameters

#Return Value

byte[]

#Serialize()

1public byte[] Serialize()

Perform AIP11 compliant serialization.

#Return Value

byte[]

#Deserialize()

1public static Transaction Deserialize(string serialized)

Perform AIP11 compliant deserialization.

#Parameters

#Return Value

Transaction

#ToDictionary()

1public Dictionary<string, dynamic> ToDictionary()

Convert the transaction to its dict representation.

#Return Value

Dictionary<string, dynamic>

#ToJson()

1public string ToJson()

Convert the transaction to its JSON representation.

#Return Value

string

#ArkEcosystem.Crypto.Message

#Message()

1public Message(string publicKey, string signature, string message)

Create a new message instance.

#Parameters

#Return Value

Message

#Sign()

1public static Message Sign(string message, string passphrase)

Sign a message using the given passphrase.

#Parameters

#Return Value

Message

#Verify()

1public bool Verify()

Verify the message contents.

#Return Value

bool

#ToDictionary()

1public Dictionary<string, string> ToDictionary()

Convert the message to its dict representation.

#Return Value

Dictionary<string, string>

#ToJson()

1public string ToJson()

Convert the message to its JSON representation.

#Return Value

string

#ArkEcosystem.Crypto.Slot

#GetTime()

1public static uint GetTime()

Get the time diff between now and network start.

#Return Value

uint

#GetEpoch()

1public static DateTime GetEpoch()

Get the network start epoch.

#Return Value

DateTime