#API Documentation

#Crypto.Crypto.Configuration.FeeConfiguration.Fee

#get()

1public func get(forType: TransactionType)

Get a fee for a given transaction type

#Parameters

#Return Value

UInt64

#set()

1public func set(forType: TransactionType, fee: UInt64)

Set a fee

#Parameters

#Return Value

UInt64

#Crypto.Crypto.Configuration.NetworkConfiguration.ArkNetwork

#set()

1public func set(network: ProtocolNetwork)

Set what network you want to use in the crypto library

#Parameters

#Return Value

Void

#get()

1public func get()

Get settings for a selected network, default network is devnet

#Return Value

ProtocolNetwork

#Crypto.Crypto.Identities.Address.ArkAddress

#from

1public static func from(passphrase: String, network: UInt8? = nil)
2public static func from(privateKey: PrivateKey, network: UInt8? = nil)
3public static func from(publicKey: String, network: UInt8? = nil)

Get an address from a passphrase, a private key or a public key

#Parameters

#Return Value

String

#validate()

1public static func validate(address: String)

Validate a given address

#Parameters

#Return Value

Bool

#Crypto.Crypto.Identities.PrivateKey.ArkPrivateKey

#from()

1public static func from(passphrase: String)
2public static func from(hex: String)

Create PrivateKey object from a given passphrase or hex string

#Parameters

#Return Value

PrivateKey

#Crypto.Crypto.Identities.PublicKey.ArkPublicKey

#from()

1public static func from(passphrase: String)
2public static func from(hex: String)

Create PublicKey object from a given passphrase

#Parameters

#Return Value

PublicKey

#Crypto.Crypto.Identities.WIF.WIF

#from()

1public static func from(passphrase: String)

Get wif from passphrase

#Parameters

#Return Value

String

#Crypto.Crypto.Networks.Devnet.Devnet

#epoch()

1public func epoch()

Return the epoch date for devnet.

#Return Value

String

#version()

1public func version()

Return the version for devnet.

#Return Value

UInt8

#nethash()

1public func nethash()

Return the nethash for devnet.

#Return Value

String

#wif()

1public func wif()

Return the WIF for devnet.

#Return Value

UInt8

#Crypto.Crypto.Networks.Mainnet.Mainnet

#epoch()

1public func epoch()

Return the epoch date for mainnet.

#Return Value

String

#version()

1public func version()

Return the version for mainnet.

#Return Value

UInt8

#nethash()

1public func nethash()

Return the nethash for mainnet.

#Return Value

String

#wif()

1public func wif()

Return the WIF for mainnet.

#Return Value

UInt8

#Crypto.Crypto.Networks.Testnet.Testnet

#epoch()

1public func epoch()

Return the epoch date for testnet.

#Return Value

String

#version()

1public func version()

Return the version for testnet.

#Return Value

UInt8

#nethash()

1public func nethash()

Return the nethash for testnet.

#Return Value

String

#wif()

1public func wif()

Return the WIF for testnet.

#Return Value

UInt8

#Crypto.Crypto.Transactions.ArkBuilder.ArkBuilder

#buildTransfer()

1public static func buildTransfer(_ passphrase: String, secondPassphrase: String?, to recipient: String, amount: UInt64, vendorField: String?)

Builds a transaction for a transfer.

#Parameters

#Return Value

ArkTransaction

#buildSecondSignature()

1public static func buildSecondSignature(_ passphrase: String, secondPassphrase: String)

Builds a transaction for a second signature registration.

#Parameters

#Return Value

ArkTransaction

#buildDelegateRegistration()

1public static func buildDelegateRegistration(_ passphrase: String, secondPassphrase: String?, username: String)

Builds a transaction for a delegate registration.

#Parameters

#Return Value

ArkTransaction

#buildVote()

1public static func buildVote(_ passphrase: String, secondPassphrase: String?, vote: String)

Builds a transaction for a vote.

#Parameters

#Return Value

ArkTransaction

#buildUnvote()

1public static func buildUnvote(_ passphrase: String, secondPassphrase: String?, vote: String)

Builds a transaction for an unvote.

#Parameters

#Return Value

ArkTransaction

#buildMultiSignatureRegistration()

1public static func buildMultiSignatureRegistration(_ passphrase: String, secondPassphrase: String?, min: UInt8, lifetime: UInt8, keysgroup: [String])

Builds a transaction for a multi signature registration.

#Parameters

#Return Value

ArkTransaction

#Crypto.Crypto.Transactions.ArkDeserializer.ArkDeserializer

#deserialize()

1public static func deserialize(serialized: String)

Perform AIP11 compliant deserialization.

#Parameters

#Return Value

ArkTransaction

#Crypto.Crypto.Transactions.ArkSerializer.ArkSerializer

#serialize()

1public static func serialize(transaction: ArkTransaction)

Handle the serialization of transaction data.

#Parameters

#Return Value

String

#Crypto.Crypto.Transactions.ArkTransaction.ArkTransaction

#getId()

1public static func getId()

Convert the byte representation to a unique identifier.

#Return Value

String

#sign()

1public func sign(_ keys: PrivateKey)

Sign the transaction using the given passphrase.

#Parameters

#Return Value

ArkTransaction

#secondSign()

1public func secondSign(_ keys: PrivateKey)

Sign the transaction using the given second passphrase.

#Parameters

#Return Value

ArkTransaction

#verify()

1public static func verify()

Verify the transaction.

#Return Value

Bool

#secondVerify()

1public func secondVerify(publicKey: String)

Verify the transaction with a second public key.

#Parameters

#Return Value

Bool

#toBytes()

1public func toBytes(skipSignature: Bool = true, skipSecondSignature: Bool = true)

Convert the transaction to its byte representation.

#Parameters

#Return Value

[UInt8]

#toDict()

1public func toDict()

Convert the transaction to its dict representation.

#Return Value

[String: Any]

#toJson()

1public func toJson()

Convert the transaction to its JSON representation.

#Return Value

String?

#Crypto.Crypto.Utils.Message.ArkMessage

#init()

1public init(publicKey: String, signature: String, message: String)

Create a new message instance.

#Parameters

#sign()

1public static func sign(message: String, passphrase: String)

Sign a message using the given passphrase.

#Parameters

#Return Value

ArkMessage?

#verify()

1public func sign()

Verify the message contents.

#Return Value

Bool

#toDict()

1public func toDict()

Convert the message to its dict representation.

#Return Value

[String: String]

#toJson()

1public func toJson()

Convert the message to its JSON representation.

#Return Value

String

#Crypto.Crypto.Utils.Slot.Slot

#time()

1public static func time()

Get the time diff between now and network start.

#Return Value

UInt32

#epoch()

1public static func epoch()

Get the network start epoch.

#Return Value

Int