@ardenthq/arkvault-url NPM

ARKVault URL

A package to generate URLs compatible with ARKVault

Installation

pnpm install @ardenthq/arkvault-url

Usage

Import and instantiate the builder.

import { URLBuilder } from "@ardenthq/arkvault-url";

const builder = new URLBuilder("https://your-url.com");

The baseUrl parameter is optional and defaults to "https://app.arkvault.io"

The builder can be further configured by setting a custom coin and nethash, which default to "ARK" and ARK's mainnet nethash otherwise.

builder.setCoin("CUSTOM");
builder.setNethash("0123...cdef)";

Methods

The following methods are available.

Transfer

builder.generateTransfer("recipient");

> https://app.arkvault.io/#/?method=transfer&recipient=recipient&coin=ARK&nethash=6e84d08bd299ed97c212c886c98a57e36545c8f5d645ca7eeae63a8bd62d8988

Sign Message

builder.generateMessageSign("hello world");

> https://app.arkvault.io/#/?method=sign&message=hello+world&coin=ARK&nethash=6e84d08bd299ed97c212c886c98a57e36545c8f5d645ca7eeae63a8bd62d8988"

Verify Message

builder.generateMessageVerify({
    message: "hello world",
    signatory: "025f81956d5826bad7d30daed2b5c8c98e72046c1ec8323da336445476183fb7ca",
    signature: "22f8ef55e8120fbf51e2407c808a1cc98d7ef961646226a3d3fad606437f8ba49ab68dc33c6d4a478f954c72e9bac2b4a4fe48baa70121a311a875dba1527d9d",
});

> https://app.arkvault.io/#/?method=verify&message=hello+world&signatory=025f81956d5826bad7d30daed2b5c8c98e72046c1ec8323da336445476183fb7ca&signature=22f8ef55e8120fbf51e2407c808a1cc98d7ef961646226a3d3fad606437f8ba49ab68dc33c6d4a478f954c72e9bac2b4a4fe48baa70121a311a875dba1527d9d&coin=ARK&nethash=6e84d08bd299ed97c212c886c98a57e36545c8f5d645ca7eeae63a8bd62d8988"

More detailed docs will follow soon

Development

pnpm is required to be installed before starting. It is used to manage this repo.

Install dependencies

pnpm install

Apply `eslint` rules and `prettier` formatting

pnpm format

Run tests

pnpm test

Build the production code

pnpm build

Security

If you discover a security vulnerability within this package, please send an e-mail to security@ardenthq.com. All security vulnerabilities will be promptly addressed.