Skip to content

adamant-api / index

index

Default adamant-api entry point: the full ADM SDK surface plus the bundled ADM and external-coin wallet metadata. Importing this entry point does not load coin-specific implementations.

Enumerations

EnumerationDescription
LogLevel-
MessageTypeMessage type
TransactionType-

Classes

ClassDescription
AdamantWsConnectionError-
Logger-
WebSocketClient-

Interfaces

InterfaceDescription
BasicTransaction-
ChatTransaction-
DelegateTransaction-
KeyPair-
SendTransaction-
StateTransaction-
VoteTransaction-
WsOptions-

Type Aliases

Type AliasDescription
AnyTransactionHandler-
CustomLogger-
LogLevelInputLogger threshold accepted by the SDK.
LogLevelName-
MessageTypes-
PossiblySignedTransaction-
SignedTransaction-
SingleTransactionHandler-
SomeTransaction-
TransactionDirectionDirection of transactions delivered to WebSocket handlers.
TransactionHandler-
VoteDirection-
WsType-

Variables

VariableDescription
DEFAULT_GET_REQUEST_RETRIES-
fees-
HEALTH_CHECK_TIMEOUT4 seconds
logLevels-
MAX_VOTES_PER_TRANSACTION-
SAT-
transactionDirections-

Functions

FunctionDescription
admToSats-
bytesToHex-
chatGetBytes-
createAddressFromPublicKeyConverts an ADM public key into its U-prefixed account address.
createHashFromPassphraseApplies the protocol-compatible ADM passphrase hashing procedure.
createKeypairFromPassphraseDerives the established ADM keypair from a BIP39 passphrase.
createNewPassphraseCreates a new BIP39 mnemonic suitable for an ADM account passphrase.
decodeMessageDecrypts an ADM chat payload and returns an empty string on auth failure.
delegatesGetBytes-
encodeMessageEncrypts a message for an ADM recipient using the established NaCl format.
getAssetBytes-
getBytes-
getEpochTime-
getEpochTimeMsReturns the time since the ADAMANT epoch in milliseconds.
getHash-
getTransactionId-
hexToBytes-
isAdmAddress-
isAdmPublicKey-
isAdmVoteForAddress-
isAdmVoteForDelegateName-
isAdmVoteForPublicKey-
isDelegateName-
isPassphrase-
isVoteDirection-
makeKeypairFromHashDerives the established ADM Ed25519 keypair from a 32-byte seed hash.
parseVote-
sign-
signTransaction-
statesGetBytes-
transformTransactionQuerySerializes a transaction query into the flat shape the node expects.
utf8ArrayToStr-
validateMessage-
voteGetBytes-

References

AdamantAddress

Re-exports AdamantAddress


AdamantApi

Re-exports AdamantApi


AdamantApiOptions

Re-exports AdamantApiOptions


AddressObject

Re-exports AddressObject


AddressOrPublicKeyObject

Re-exports AddressOrPublicKeyObject


AnyTransactionData

Re-exports AnyTransactionData


BasicTransactionData

Re-exports BasicTransactionData


ChatroomsOptions

Re-exports ChatroomsOptions


ChatTransactionData

Re-exports ChatTransactionData


coinMetadata

Re-exports coinMetadata


CoinMetadata

Re-exports CoinMetadata


CoinSymbol

Re-exports CoinSymbol


createBasicTransaction

Re-exports createBasicTransaction


createChatTransaction

Re-exports createChatTransaction


createDelegateTransaction

Re-exports createDelegateTransaction


createSendTransaction

Re-exports createSendTransaction


createStateTransaction

Re-exports createStateTransaction


createVoteTransaction

Re-exports createVoteTransaction


DelegateLookupOptions

Re-exports DelegateLookupOptions


DelegateTransactionData

Re-exports DelegateTransactionData


GetBlocksOptions

Re-exports GetBlocksOptions


GetDelegatesOptions

Re-exports GetDelegatesOptions


GetPeersOptions

Re-exports GetPeersOptions


KVSOptions

Re-exports KVSOptions


PublicKeyObject

Re-exports PublicKeyObject


SendTransactionData

Re-exports SendTransactionData


StateTransactionData

Re-exports StateTransactionData


TransactionQuery

Re-exports TransactionQuery


TransactionQueryParameters

Re-exports TransactionQueryParameters


TransactionsOptions

Re-exports TransactionsOptions


UsernameObject

Re-exports UsernameObject


UsernameOrPublicKeyObject

Re-exports UsernameOrPublicKeyObject


VoteTransactionData

Re-exports VoteTransactionData


walletMetadataSource

Re-exports walletMetadataSource

Released under the GPL-3.0 License.