#API Documentation

#Crypto\Blocks\BlockFactory

#fromHex()

1public static fromHex(hex: string)

Generate Block object from HEX.

#Parameters

#Return Value

IBlock

#fromBytes()

1public static fromBytes(buffer: Buffer)

Generate Block object from a Buffer.

#Parameters

#Return Value

IBlock

#fromJson()

1public static fromJson(json: IBlockJson)

Generate Block object from JSON.

#Parameters

#Return Value

IBlock

#fromData()

1public static fromData(data: IBlockData, options: { deserializeTransactionsUnchecked?: boolean } = {})

Generate Block object from Block data.

#Parameters

#Return Value

IBlock

#Crypto\Blocks\Serializer

#size()

1public static size(block: IBlock)

Get size of Block.

#Parameters

#Return Value

number

#serializeWithTransactions()

1public static serializeWithTransactions(block: IBlockData)

Serialize Block with Transactions.

#Parameters

#Return Value

Buffer

#serialize()

1public static serialize(block: IBlockData, includeSignature: boolean = true)

Serialize Block without Transactions.

#Parameters

#Return Value

Buffer

#Crypto\Crypto\HashAlgorithms

#ripemd160()

1public static ripemd160(buffer: Buffer | string)

Hash with RIPEMD-160.

#Parameters

#Return Value

Buffer

#sha1()

1public static sha1(buffer: Buffer | string)

Hash with SHA-1.

#Parameters

#Return Value

Buffer

#sha256()

1public static sha256(buffer: Buffer | string | Buffer[])

Hash with SHA-256.

#Parameters

#Return Value

Buffer

#hash160()

1public static hash160(buffer: Buffer | string)

Hash with Hash160.

#Parameters

#Return Value

Buffer

#hash256()

1public static hash256(buffer: Buffer | string)

Hash with Hash256.

#Parameters

#Return Value

Buffer

#Crypto\Crypto\Hash

#signECDSA()

1public static signECDSA(hash: Buffer, keys: IKeyPair)

Sign hash with ECDSA.

#Parameters

#Return Value

string

#verifyECDSA()

1public static verifyECDSA(hash: Buffer, signature: Buffer | string, publicKey: Buffer | string)

Verify ECDSA signature.

#Parameters

#Return Value

boolean

#signSchnorr()

1public static signSchnorr(hash: Buffer, keys: IKeyPair)

Sign hash with Schnorr.

#Parameters

#Return Value

string

#verifySchnorr()

1public static verifySchnorr(hash: Buffer, signature: Buffer | string, publicKey: Buffer | string)

Verify Schnorr signature.

#Parameters

#Return Value

boolean

#Crypto\Crypto\HDWallet

#fromMnemonic()

1public static fromMnemonic(mnemonic: string, passphrase?: string)

Generate BIP32 Wallet from mnemonic.

#Parameters

#Return Value

BIP32Interface

#fromKeys()

1public static fromKeys(keys: IKeyPair, chainCode: Buffer)

Generate BIP32 Wallet from KeyPair.

#Parameters

#Return Value

BIP32Interface

#getKeys()

1public static getKeys(node: BIP32Interface)

Get keys for BIP32 Wallet.

#Parameters

#Return Value

IKeyPair

#deriveSlip44()

1public static deriveSlip44(root: BIP32Interface, hardened: boolean = true)

Determine Slip44 for BIP32 Wallet.

#Parameters

#Return Value

BIP32Interface

#deriveNetwork()

1public static deriveNetwork(root: BIP32Interface)

Determine Network for BIP32 Wallet.

#Parameters

#Return Value

BIP32Interface

#Crypto\Crypto\Message

#sign()

1public static sign(message: string, passphrase: string)

Sign a message using the given passphrase.

#Parameters

#Return Value

IMessage

#signWithWif()

1public static signWithWif(message: string, wif: string, network?: INetwork)

Sign a message using the given WIF string.

#Parameters

#Return Value

IMessage

#verify()

1public static verify({ message, publicKey, signature }: IMessage)

Verify the message contents

#Parameters

#Return Value

boolean

#Crypto\Crypto\Slots

#getTime()

1public static getTime(time?: number)

Get the time diff between now and network start.

#Parameters

#Return Value

number

#getTimeInMsUntilNextSlot()

1public static getTimeInMsUntilNextSlot()

Get the time (in milliseconds) until the start of the next slot.

#Return Value

number

#getSlotNumber()

1public static getSlotNumber(epoch?: number)

Get the slot number.

#Parameters

#Return Value

number

#getSlotTime()

1public static getSlotTime(slot: number)

Get the slot time.

#Parameters

#Return Value

number

#getNextSlot()

1public static getNextSlot()

Get the next slot.

#Return Value

number

#isForgingAllowed()

1public static isForgingAllowed(epoch?: number)

Verify is forging is allowed.

#Parameters

#Return Value

boolean

#Crypto\Identities\Address

#fromPassphrase()

1public static fromPassphrase(passphrase: string, networkVersion?: number)

Derive the address from the given passphrase.

#Parameters

#Return Value

string

#fromPublicKey()

1public static fromPublicKey(publicKey: string, networkVersion?: number)

Derive a (multisig) address from a multi signature asset.

#Parameters

#Return Value

string

#fromWIF()

1public static fromWIF(wif: string, network?: NetworkType)

Derive the address from a WIF string.

#Parameters

#Return Value

string

#fromMultiSignatureAsset()

1public static fromMultiSignatureAsset(asset: IMultiSignatureAsset, networkVersion?: number)

Derive the address from the given multi signature asset.

#Parameters

#Return Value

string

#fromPrivateKey()

1public static fromPrivateKey(privateKey, networkVersion?: number)

Derive the address from the given private key.

#Parameters

#Return Value

string

#fromBuffer()

1public static fromBuffer(buffer: Buffer)

Derive the address from a Buffer.

#Parameters

#Return Value

string

#toBuffer()

1public static toBuffer(address: string)

Convert address to a Buffer.

#Parameters

#Return Value

{ addressBuffer: Buffer; addressError?: string }

#validate()

1public static validate(address: string, networkVersion?: number)

Validate the given address.

#Parameters

#Return Value

boolean

#Crypto\Identities\Keys

#fromPassphrase()

1public static fromPassphrase(passphrase: string, compressed: boolean = true)

Derive the keys from the given passphrase.

#Parameters

#Return Value

IKeyPair

#fromPrivateKey()

1public static fromPrivateKey(privateKey: Buffer | string, compressed: boolean = true)

Derive the keys from the given private key.

#Parameters

#Return Value

IKeyPair

#fromWIF()

1public static fromWIF(wifKey: string, network?: INetwork)

Derive the keys from the given WIF.

#Parameters

#Return Value

IKeyPair

#Crypto\Identities\PrivateKey

#fromPassphrase()

1public static fromPassphrase(passphrase: string)

Derive the private key for the given passphrase.

#Parameters

#Return Value

string

#fromWIF()

1public static fromWIF(wif: string, network?: NetworkType)

Create a private key instance from a hex string.

#Parameters

#Return Value

string

#Crypto\Identities\PublicKey

#fromPassphrase()

1public static fromPassphrase(passphrase: string)

Derive the public key from the given passphrase.

#Parameters

#Return Value

string

#fromWIF()

1public static fromWIF(wif: string, network?: NetworkType)

Derive the public key from the given WIF.

#Parameters

#Return Value

string

#fromMultiSignatureAsset()

1public static fromMultiSignatureAsset(asset: IMultiSignatureAsset)

Derive the public key from the given multi signature asset.

#Parameters

#Return Value

string

#validate()

1public static validate(publicKey: string, networkVersion?: number)

Validate the given public key.

#Parameters

#Return Value

boolean

#Crypto\Identities\WIF

#fromPassphrase()

1public static fromPassphrase(passphrase: string, network?: INetwork)

Derive the WIF from the given passphrase.

#Parameters

#Return Value

string

#fromKeys()

1public static fromKeys(keys: IKeyPair, network?: INetwork)

Derive the WIF from the given keys.

#Parameters

#Return Value

string

#Crypto\Managers\ConfigManager

#setConfig()

1public setConfig(config: INetworkConfig)

Set the configuration.

#Parameters

#Return Value

void

#setFromPreset()

1public setFromPreset(network: NetworkName)

Set the configuration from given presets.

#Parameters

#Return Value

void

#getPreset()

1public getPreset(network: NetworkName)

Get configuration preset.

#Parameters

#Return Value

INetworkConfig

#all()

1public all()

Get all configs.

#Return Value

INetworkConfig

#set()

1public set<T = any>(key: string, value: T)

Set a value for the specified network config key.

#Parameters

#Return Value

void

#get()

1public get<T = any>(key: string)

Get key.

#Parameters

#Return Value

T

#setHeight()

1public setHeight(value: number)

Set network height.

#Parameters

#Return Value

void

#getHeight()

1public getHeight()

Get network height.

#Return Value

number

#isNewMilestone()

1public isNewMilestone(height?: number)

Verify if current height contains a milestone.

#Parameters

#Return Value

boolean

#getMilestone()

1public getMilestone(height?: number)

Get milestone.

#Parameters

#Return Value

{ [key: string]: any }

#getMilestones()

1public getMilestones()

Get all milestones.

#Return Value

any

#Crypto\Managers\NetworkManager

#all()

1public static all()

Get settings for all networks.

#Return Value

Record<NetworkName, INetworkConfig>

#findByName()

1public static findByName(name: NetworkName)

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

#Parameters

#Return Value

INetworkConfig

#Crypto\Transactions\Deserializer

#deserialize()

1public static deserialize(serialized: string | Buffer, options: IDeserializeOptions = {})

Deserialize Transaction into object.

#Parameters

#Return Value

ITransaction

#applyV1Compatibility()

1public static applyV1Compatibility(transaction: ITransactionData)

Modify transaction to be v1 compatible.

#Parameters

#Return Value

void

#Crypto\Transactions\TransactionFactory

#fromHex()

1public static fromHex(hex: string)

Create Transaction object from HEX.

#Parameters

#Return Value

ITransaction

#fromBytes()

1public static fromBytes(buffer: Buffer, strict: boolean = true)

Create Transaction object from Buffer.

#Parameters

#Return Value

ITransaction

#fromBytesUnsafe()

1public static fromBytesUnsafe(buffer: Buffer, id?: string)

Create Transaction object from Buffer (unsafe).

NOTE: Only use this internally when it is safe to assume the buffer has already been verified.

#Parameters

#Return Value

ITransaction

#fromJson()

1public static fromJson(json: ITransactionJson)

Create Transaction object from JSON.

#Parameters

#Return Value

ITransaction

#fromData()

1public static fromData(data: ITransactionData, strict: boolean = true)

Create Transaction object from Transaction data.

#Parameters

#Return Value

ITransaction

#Crypto\Transactions\Serializer

#getBytes()

1public static getBytes(transaction: ITransactionData, options: ISerializeOptions = {})

Convert the transaction to its byte representation.

#Parameters

#Return Value

Buffer

#serialize()

1public static serialize(transaction: ITransaction, options: ISerializeOptions = {})

Perform AIP11 compliant serialization.

#Parameters

#Return Value

Buffer

#Crypto\Transactions\Signer

#sign()

1public static sign(transaction: ITransactionData, keys: IKeyPair, options?: ISerializeOptions)

Sign the given transaction with the provided keys.

#Parameters

#Return Value

string

#secondSign()

1public static secondSign(transaction: ITransactionData, keys: IKeyPair)

Second sign the given transaction with the provided keys.

#Parameters

#Return Value

string

#multiSign()

1public static multiSign(transaction: ITransactionData, keys: IKeyPair, index: number = -1)

Multi sign the given transaction with the provided keys.

#Parameters

#Return Value

string

#Crypto\Transactions\Utils

#toBytes()

1public static toBytes(data: ITransactionData)

Convert Transaction object to Buffer.

#Parameters

#Return Value

Buffer

#toHash()

1public static toHash(transaction: ITransactionData, options?: ISerializeOptions)

Convert Transaction object to Hash.

#Parameters

#Return Value

Buffer

#getId()

1public static getId(transaction: ITransactionData, options: ISerializeOptions = {})

Get Transaction ID of Transaction object.

#Parameters

#Return Value

string

#Crypto\Transactions\Verifier

#verify()

1public static verify(data: ITransactionData)

Verify transaction.

#Parameters

#Return Value

boolean

#verifySecondSignature()

1public static verifySecondSignature(transaction: ITransactionData, publicKey: string)

Verify second signature.

#Parameters

#Return Value

boolean

#verifySignatures()

1public static verifySignatures(transaction: ITransactionData, multiSignature: IMultiSignatureAsset)

Verify the signatures of a Transaction object.

#Parameters

#Return Value

boolean

#verifyHash()

1public static verifyHash(data: ITransactionData)

Verify transaction hash.

#Parameters

#Return Value

boolean

#verifySchema()

1public static verifySchema(data: ITransactionData, strict: boolean = true)

Verify transaction schema.

#Parameters

#Return Value

ISchemaValidationResult

#Crypto\Transactions\Builders\BuilderFactory

#transfer()

1public static transfer()

Initiate a Transfer transaction type.

#Return Value

TransferBuilder

#secondSignature()

1public static secondSignature()

Initiate a Second Signature transaction type.

#Return Value

SecondSignatureBuilder

#delegateRegistration()

1public static delegateRegistration()

Initiate a Delegate Resignation transaction type.

#Return Value

DelegateRegistrationBuilder

#vote()

1public static vote()

Initiate a Vote transaction type.

#Return Value

VoteBuilder

#multiSignature()

1public static multiSignature()

Initiate a Multi-Signature transaction type.

#Return Value

MultiSignatureBuilder

#ipfs()

1public static ipfs()

Initiate an IPFS transaction type.

#Return Value

IPFSBuilder

#multiPayment()

1public static multiPayment()

Initiate a Multi-Payment transaction type.

#Return Value

MultiPaymentBuilder

#delegateResignation()

1public static delegateResignation()

Initiate a Delegate Resignation transaction type.

#Return Value

DelegateResignationBuilder

#htlcLock()

1public static htlcLock()

Initiate a HTLC Lock transaction type.

#Return Value

HtlcLockBuilder

#htlcClaim()

1public static htlcClaim()

Initiate a HTLC Claim transaction type.

#Return Value

HtlcClaimBuilder

#htlcRefund()

1public static htlcRefund()

Initiate a HTLC Refund transaction type.

#Return Value

HtlcRefundBuilder

#Crypto\Transactions\Builders\Transactions\DelegateRegistrationBuilder

#usernameAsset()

1public usernameAsset(username: string)

Set the username to assign.

#Parameters

#Return Value

DelegateRegistrationBuilder

#getStruct()

1public getStruct()

Get transaction structure.

#Return Value

ITransactionData

#Crypto\Transactions\Builders\Transactions\DelegateResignationBuilder

#getStruct()

1public getStruct()

Get transaction structure.

#Return Value

ITransactionData

#Crypto\Transactions\Builders\Transactions\HtlcClaimBuilder

#htlcClaimAsset()

1public htlcClaimAsset(claimAsset: IHtlcClaimAsset)

Specify the HTLC Claim asset data for the Transaction.

#Parameters

#Return Value

HtlcClaimBuilder

#getStruct()

1public getStruct()

Get transaction structure.

#Return Value

ITransactionData

#Crypto\Transactions\Builders\Transactions\HtlcLockBuilder

#htlcLockAsset()

1public htlcLockAsset(lockAsset: IHtlcLockAsset)

Specify the HTLC Lock asset data for the Transaction.

#Parameters

#Return Value

HtlcLockBuilder

#getStruct()

1public getStruct()

Get transaction structure.

#Return Value

ITransactionData

#Crypto\Transactions\Builders\Transactions\HtlcRefundBuilder

#htlcRefundAsset()

1public htlcRefundAsset(refundAsset: IHtlcRefundAsset)

Specify the HTLC Refund asset data for the Transaction.

#Parameters

#Return Value

HtlcRefundBuilder

#getStruct()

1public getStruct()

Get transaction structure.

#Return Value

ITransactionData

#Crypto\Transactions\Builders\Transactions\IPFSBuilder

#ipfsAsset()

1public ipfsAsset(ipfsId: string)

Set IPFS asset.

#Parameters

#Return Value

IPFSBuilder

#getStruct()

1public getStruct()

Get transaction structure.

#Return Value

ITransactionData

#Crypto\Transactions\Builders\Transactions\MultiPaymentBuilder

#addPayment()

1public addPayment(recipientId: string, amount: string)

Add a new payment to the collection.

#Parameters

#Return Value

MultiPaymentBuilder

#getStruct()

1public getStruct()

Get transaction structure.

#Return Value

ITransactionData

#Crypto\Transactions\Builders\Transactions\MultiSignatureBuilder

#participant()

1public participant(publicKey: string)

Add participant to multi signature transaction.

#Parameters

#Return Value

MultiSignatureBuilder

#min()

1public min(min: number)

Set the minimum required signatures.

#Parameters

#Return Value

MultiSignatureBuilder

#multiSignatureAsset()

1public multiSignatureAsset(multiSignature: IMultiSignatureAsset)

Derive the address from the given multi signature asset.

#Parameters

#Return Value

MultiSignatureBuilder

#getStruct()

1public getStruct()

Get transaction structure.

#Return Value

ITransactionData

#Crypto\Transactions\Builders\Transactions\SecondSignatureBuilder

#signatureAsset()

1public signatureAsset(secondPassphrase: string)

Specify the Second Signature asset data for the Transaction.

#Parameters

#Return Value

SecondSignatureBuilder

#getStruct()

1public getStruct()

Get transaction structure.

#Return Value

ITransactionData

#Crypto\Transactions\Builders\Transactions\TransferBuilder

#expiration()

1public expiration(expiration: number)

Set Transfer expiration.

#Parameters

#Return Value

TransferBuilder

#getStruct()

1public getStruct()

Get transaction structure.

#Return Value

ITransactionData

#Crypto\Transactions\Builders\Transactions\VoteBuilder

#votesAsset()

1public votesAsset(votes: string[])

Specify the Vote asset data for the Transaction.

#Parameters

#Return Value

VoteBuilder

#getStruct()

1public getStruct()

Get transaction structure.

#Return Value

ITransactionData

#Crypto\Transactions\Types\DelegateRegistrationTransaction

#getSchema()

1public static getSchema()

Get transaction schema.

#Return Value

schemas.TransactionSchema

#serialize()

1public serialize(options?: ISerializeOptions)

Handle the serialization of “delegate registration” data.

#Parameters

#Return Value

ByteBuffer

#deserialize()

1public deserialize(buf: ByteBuffer)

Handle the deserialization of “delegate registration” data.

#Parameters

#Return Value

void

#Crypto\Transactions\Types\DelegateResignationTransaction

#getSchema()

1public static getSchema()

Get transaction schema.

#Return Value

schemas.TransactionSchema

#verify()

1public verify()

Verify transaction.

#Return Value

boolean

#serialize()

1public serialize(options?: ISerializeOptions)

Handle the serialization of “delegate resignation” data.

#Parameters

#Return Value

ByteBuffer

#deserialize()

1public deserialize(buf: ByteBuffer)

Handle the deserialization of “delegate resignation” data.

#Parameters

#Return Value

void

#Crypto\Transactions\Types\TransactionTypeFactory

#initialize()

1public static initialize(transactionTypes: Map<InternalTransactionType, TransactionConstructor>)

Initialize new transaction types factory.

#Parameters

#create()

1public static create(data: ITransactionData)

Create new transaction type.

#Parameters

#Return Value

ITransaction

#get()

1public static get(type: number, typeGroup?: number)

Get a transaction type.

#Parameters

#Return Value

TransactionConstructor

#Crypto\Transactions\Types\HtlcClaimTransaction

#getSchema()

1public static getSchema()

Get transaction schema.

#Return Value

schemas.TransactionSchema

#verify()

1public verify()

Verify transaction.

#Return Value

boolean

#serialize()

1public serialize(options?: ISerializeOptions)

Serialize Transaction object.

#Parameters

#Return Value

ByteBuffer

#deserialize()

1public deserialize(buf: ByteBuffer)

Deserialize into Transaction object.

#Parameters

#Return Value

void

#Crypto\Transactions\Types\HtlcLockTransaction

#getSchema()

1public static getSchema()

Get transaction schema.

#Return Value

schemas.TransactionSchema

#verify()

1public verify()

Verify transaction.

#Return Value

boolean

#hasVendorField()

1public hasVendorField()

Verify if the transaction contains a vendorfield.

#Return Value

boolean

#serialize()

1public serialize(options?: ISerializeOptions)

Serialize a Transaction object.

#Parameters

#Return Value

ByteBuffer

#deserialize()

1public deserialize(buf: ByteBuffer)

Deserialize into a Transaction object.

#Parameters

#Return Value

void

#Crypto\Transactions\Types\HtlcRefundTransaction

#getSchema()

1public static getSchema()

Get transaction schema.

#Return Value

schemas.TransactionSchema

#verify()

1public verify()

Verify transaction.

#Return Value

boolean

#serialize()

1public serialize(options?: ISerializeOptions)

Serialize a Transaction object.

#Parameters

#Return Value

ByteBuffer

#deserialize()

1public deserialize(buf: ByteBuffer)

Deserialize into a Transaction object.

#Parameters

#Return Value

void

#Crypto\Transactions\Types\InternalTransactionType

#from()

1public static from(type: number, typeGroup?: number)

Create new internal transaction type from existing type.

#Parameters

#Return Value

InternalTransactionType

#toString()

1public toString()

Convert transaction type to a group/type string representation (E.g. 1/0)

#Return Value

string

#Crypto\Transactions\Types\IpfsTransaction

#getSchema()

1public static getSchema()

Get transaction schema.

#Return Value

schemas.TransactionSchema

#verify()

1public verify()

Verify transaction.

#Return Value

boolean

#serialize()

1public serialize(options?: ISerializeOptions)

Handle the serialization of “IPFS” data.

#Parameters

#Return Value

ByteBuffer

#deserialize()

1public deserialize(buf: ByteBuffer)

Handle the deserialization of “IPFS” data.

#Parameters

#Return Value

void

#Crypto\Transactions\Types\MultiPaymentTransaction

#getSchema()

1public static getSchema()

Get transaction schema.

#Return Value

schemas.TransactionSchema

#verify()

1public verify()

Verify transaction.

#Return Value

boolean

#hasVendorField()

1public hasVendorField()

Verify if the transaction contains a vendorfield.

#Return Value

boolean

#serialize()

1public serialize(options?: ISerializeOptions)

Serialize a Transaction object.

#Parameters

#Return Value

ByteBuffer

#deserialize()

1public deserialize(buf: ByteBuffer)

Deserialize into a Transaction object.

#Parameters

#Return Value

void

#Crypto\Transactions\Types\MultiSignatureRegistrationTransaction

#getSchema()

1public static getSchema()

Get transaction schema.

#Return Value

schemas.TransactionSchema

#staticFee()

1public static staticFee(feeContext: { height?: number; data?: ITransactionData } = {})

Get the static fee for the Multi-Signature transaction type.

#Parameters

#Return Value

BigNumber

#verify()

1public verify()

Verify transaction.

#Return Value

boolean

#serialize()

1public serialize(options?: ISerializeOptions)

Serialize a Transaction object.

#Parameters

#Return Value

ByteBuffer

#deserialize()

1public deserialize(buf: ByteBuffer)

Deserialize into a Transaction object.

#Parameters

#Return Value

void

#Crypto\Transactions\Types\SecondSignatureRegistrationTransaction

#getSchema()

1public static getSchema()

Get transaction schema.

#Return Value

schemas.TransactionSchema

#serialize()

1public serialize(options?: ISerializeOptions)

Serialize a Transaction object.

#Parameters

#Return Value

ByteBuffer

#deserialize()

1public deserialize(buf: ByteBuffer)

Deserialize into a Transaction object.

#Parameters

#Return Value

void

#Crypto\Transactions\Types\TransferTransaction

#getSchema()

1public static getSchema()

Get transaction schema.

#Return Value

schemas.TransactionSchema

#hasVendorField()

1public hasVendorField()

Verify if the transaction contains a vendorfield.

#Return Value

boolean

#serialize()

1public serialize(options?: ISerializeOptions)

Perform AIP11 compliant serialization.

#Parameters

#Return Value

ByteBuffer

#deserialize()

1public deserialize(buf: ByteBuffer)

Perform AIP11 compliant deserialization.

#Parameters

#Return Value

void

#Crypto\Transactions\Types\VoteTransaction

#getSchema()

1public static getSchema()

Get transaction schema.

#Return Value

schemas.TransactionSchema

#serialize()

1public serialize(options?: ISerializeOptions)

Perform AIP11 compliant serialization.

#Parameters

#Return Value

ByteBuffer

#deserialize()

1public deserialize(buf: ByteBuffer)

Perform AIP11 compliant deserialization.

#Parameters

#Return Value

void

#Crypto\Validation\Validator

#getInstance()

1public getInstance()

Get an instance of the Validator object.

#Return Value

Ajv.Ajv

#validate()

1public validate<T = any>(schemaKeyRef: string | boolean | object, data: T)

Validate a schema object.

#Parameters

#Return Value

ISchemaValidationResult<T>

#validateException()

1public validateException<T = any>(schemaKeyRef: string | boolean | object, data: T)

Validate a schema object for an exception.

#Parameters

#Return Value

ISchemaValidationResult<T>

#addFormat()

1public addFormat(name: string, format: Ajv.FormatDefinition)

Add formatting definition used for validation.

#Parameters

#Return Value

void

#addKeyword()

1public addKeyword(keyword: string, definition: Ajv.KeywordDefinition)

Add keyword definition used for validation.

#Parameters

#Return Value

void

#addSchema()

1public addSchema(schema: object | object[], key?: string)

Add schema used for validation.

#Parameters

#Return Value

void

#removeKeyword()

1public removeKeyword(keyword: string)

Remove keyword definition from validation.

#Parameters

#Return Value

void

#removeSchema()

1public removeSchema(schemaKeyRef: string | boolean | object | RegExp)

Remove schema from validation.

#Parameters

#Return Value

void

#extendTransaction()

1public extendTransaction(schema: TransactionSchema, remove?: boolean)

Extend a Transaction’s schema for validation.

#Parameters