Working with ADM Key Pairs

The library can create a new ADAMANT account — a passphrase, key pair (public key and private key), and ADAMANT address. Read more about ADAMANT accounts and key pairs.

• createNewPassphrase()
• makeKeypairFromHash()
• createHashFromPassphrase()
• createKeypairFromPassphrase()
• createAddressFromPublicKey()

SECURITY

A passphrase and private key are secrets. Never log them, store them in plain text, or transmit them.

createNewPassphrase()

Generates a new mnemonic passphrase consisting of English words.

function createNewPassphrase(): string;

Returns a new, randomly generated passphrase.

import {createNewPassphrase} from 'adamant-api';

const passphrase = createNewPassphrase();
// `passphrase` is a 12-word secret like 'apple banana ...'.
// Store it securely — never log it in real code.

makeKeypairFromHash()

Creates a pair of public and private keys from the provided hash, using Sodium (NaCl).

function makeKeypairFromHash(hash: Buffer): {
  publicKey: Buffer;
  privateKey: Buffer;
};

• hash — SHA-256 hash of a passphrase. Use createHashFromPassphrase to obtain it.

import {createHashFromPassphrase, makeKeypairFromHash} from 'adamant-api';

const hash = createHashFromPassphrase('apple banana...');
const keypair = makeKeypairFromHash(hash);

// `keypair.publicKey` is safe to share; `keypair.privateKey` is a secret —
// never log it in real code.

createHashFromPassphrase()

Generates an SHA-256 hash from a given passphrase.

function createHashFromPassphrase(passphrase: string): Buffer;

• passphrase — a 12-word mnemonic passphrase.

import {createNewPassphrase, createHashFromPassphrase} from 'adamant-api';

const passphrase = createNewPassphrase();
const hash = createHashFromPassphrase(passphrase);

// `hash` derives the key pair (see makeKeypairFromHash above), so treat it as
// a secret — never log it in real code.

createKeypairFromPassphrase()

Creates public and private keys from a passphrase using Sodium (NaCl).

function createKeypairFromPassphrase(passphrase: string): {
  publicKey: Buffer;
  privateKey: Buffer;
};

• passphrase — a 12-word mnemonic passphrase.

import {createKeypairFromPassphrase} from 'adamant-api';

let keyPair;

try {
  keyPair = createKeypairFromPassphrase(process.env.PASSPHRASE);
} catch (error) {
  console.log(`❌ Invalid passphrase. Error: ${error}`);
  process.exit(-1);
}

console.log('✅ The given passphrase is valid');

createAddressFromPublicKey()

Derives an ADAMANT address from the given public key.

function createAddressFromPublicKey(publicKey: Buffer | string): `U${string}`;

• publicKey — the public key of an account.

Returns the derived ADAMANT address, in the format U123....

import {
  createKeypairFromPassphrase,
  createAddressFromPublicKey,
} from 'adamant-api';

const {publicKey} = createKeypairFromPassphrase(process.env.PASSPHRASE);
const address = createAddressFromPublicKey(publicKey);

console.log(`Your ADAMANT address: ${address}`);

For the authoritative signatures of every export, see the API Reference.