Class MintlayerAPIClient

Client for interacting with the Mintlayer API Provides methods to interact with various endpoints of the Mintlayer blockchain including chain, block, transaction, address, pool, delegation, token, and order operations

Constructors

constructor

new MintlayerAPIClient(baseURL: string): MintlayerAPIClient
Creates a new instance of the Mintlayer API client
Parameters
- baseURL: string
  The base URL of the Mintlayer API server
Returns MintlayerAPIClient
- Defined in src/api.ts:33

Methods

getAddress

getAddress(address: string): Promise<AddressInfo>
Fetches information about a specific address
Parameters
- address: string
  The address to query
Returns Promise<AddressInfo>
Promise resolving to the address information
- Defined in src/api.ts:208

getAddressDelegations

getAddressDelegations(address: string): Promise<DelegationInfo[]>
Fetches delegation information for a specific address
Parameters
- address: string
  The address to query
Returns Promise<DelegationInfo[]>
Promise resolving to an array of delegation information
- Defined in src/api.ts:259

getAddressTokenAuthority

getAddressTokenAuthority(address: string): Promise<string[]>
Fetches token authority information for a specific address
Parameters
- address: string
  The address to query
Returns Promise<string[]>
Promise resolving to an array of token authority IDs
- Defined in src/api.ts:268

getAddressUtxos

getAddressUtxos(
address: string,
): Promise<{ outpoint: UtxoOutPoint; utxo: TransactionOutput }[]>
Fetches spendable UTXOs for a specific address
Parameters
- address: string
  The address to query
Returns Promise<{ outpoint: UtxoOutPoint; utxo: TransactionOutput }[]>
Promise resolving to an array of spendable UTXO information
- Defined in src/api.ts:245

getAllAddressUtxos

getAllAddressUtxos(
address: string,
): Promise<{ outpoint: UtxoOutPoint; utxo: TransactionOutput }[]>
Fetches all UTXOs for a specific address
Parameters
- address: string
  The address to query
Returns Promise<{ outpoint: UtxoOutPoint; utxo: TransactionOutput }[]>
Promise resolving to an array of UTXO information
- Defined in src/api.ts:231

getBlock

getBlock(id: string): Promise<BlockInfo>
Fetches detailed information about a specific block
Parameters
- id: string
  The block ID to query
Returns Promise<BlockInfo>
Promise resolving to the block information
- Defined in src/api.ts:119

getBlockHeader

getBlockHeader(id: string): Promise<BlockHeader>
Fetches the header information for a specific block
Parameters
- id: string
  The block ID to query
Returns Promise<BlockHeader>
Promise resolving to the block header information
- Defined in src/api.ts:128

getBlockReward

getBlockReward(id: string): Promise<TransactionOutput[]>
Fetches the reward information for a specific block
Parameters
- id: string
  The block ID to query
Returns Promise<TransactionOutput[]>
Promise resolving to the block reward transaction outputs
- Defined in src/api.ts:137

getBlockTransactionIds

getBlockTransactionIds(id: string): Promise<string[]>
Fetches the list of transaction IDs in a specific block
Parameters
- id: string
  The block ID to query
Returns Promise<string[]>
Promise resolving to an array of transaction IDs
- Defined in src/api.ts:146

getChainAtHeight

getChainAtHeight(height: string): Promise<string>
Fetches the block ID at a specific height
Parameters
- height: string
  The block height to query
Returns Promise<string>
Promise resolving to the block ID at the specified height
- Defined in src/api.ts:110

getChainGenesis

getChainGenesis(): Promise<
    {
        block_id: string;
        genesis_message: string;
        timestamp: number;
        utxos: TransactionOutput[];
    },
>
Fetches the genesis block information

Returns Promise<
    {
        block_id: string;
        genesis_message: string;
        timestamp: number;
        utxos: TransactionOutput[];
    },
>
Promise resolving to the genesis block data including block ID, message, timestamp, and UTXOs
- Defined in src/api.ts:85

getChainTip

getChainTip(): Promise<{ block_height: number; block_id: string }>
Fetches the current chain tip information

Returns Promise<{ block_height: number; block_id: string }>
Promise resolving to the current block height and block ID
- Defined in src/api.ts:98

getCoinStatistics

getCoinStatistics(): Promise<
    {
        burned: string;
        circulating_supply: string;
        preminted: string;
        staked: string;
    },
>
Fetches coin statistics including supply information

Returns Promise<
    {
        burned: string;
        circulating_supply: string;
        preminted: string;
        staked: string;
    },
>
Promise resolving to coin statistics including circulating supply, preminted, burned, and staked amounts
- Defined in src/api.ts:364

getDelegation

getDelegation(id: string): Promise<DelegationInfo>
Fetches information about a specific delegation
Parameters
- id: string
  The delegation ID to query
Returns Promise<DelegationInfo>
Promise resolving to the delegation information
- Defined in src/api.ts:319

getFeerate

getFeerate(params?: { in_top_x_mb?: number }): Promise<string>
Fetches the current fee rate
Parameters
- Optionalparams: { in_top_x_mb?: number }
  Optional parameters including in_top_x_mb for fee rate calculation
Returns Promise<string>
Promise resolving to the current fee rate
- Defined in src/api.ts:167

getNFT

getNFT(id: string): Promise<NFTInfo>
Fetches information about a specific NFT
Parameters
- id: string
  The NFT ID to query
Returns Promise<NFTInfo>
Promise resolving to the NFT information
- Defined in src/api.ts:337

getOrder

getOrder(id: string): Promise<OrderDetails>
Fetches information about a specific order
Parameters
- id: string
  The order ID to query
Returns Promise<OrderDetails>
Promise resolving to the order information
- Defined in src/api.ts:401

getOrderPair

getOrderPair(pair: string, params?: PaginationParams): Promise<OrderDetails[]>
Fetches orders for a specific trading pair
Parameters
- pair: string
  The trading pair to query
- Optionalparams: PaginationParams
  Optional pagination parameters
Returns Promise<OrderDetails[]>
Promise resolving to an array of order information for the specified pair
- Defined in src/api.ts:411

getOrders

getOrders(params?: PaginationParams): Promise<OrderDetails[]>
Fetches a list of orders with optional pagination
Parameters
- Optionalparams: PaginationParams
  Optional pagination parameters
Returns Promise<OrderDetails[]>
Promise resolving to an array of order information
- Defined in src/api.ts:392

getPool

getPool(id: string): Promise<PoolInfo>
Fetches information about a specific pool
Parameters
- id: string
  The pool ID to query
Returns Promise<PoolInfo>
Promise resolving to the pool information
- Defined in src/api.ts:286

getPoolBlockStats

getPoolBlockStats(
id: string,
timeFilter: TimeFilter,
): Promise<{ block_count: number }>
Fetches block statistics for a specific pool
Parameters
- id: string
  The pool ID to query
- timeFilter: TimeFilter
  Time filter parameters for the statistics
Returns Promise<{ block_count: number }>
Promise resolving to the pool's block statistics
- Defined in src/api.ts:296

getPoolDelegations

getPoolDelegations(id: string): Promise<DelegationInfo[]>
Fetches delegation information for a specific pool
Parameters
- id: string
  The pool ID to query
Returns Promise<DelegationInfo[]>
Promise resolving to an array of delegation information
- Defined in src/api.ts:310

getPools

getPools(
params?: PaginationParams & { sort?: "by_height" | "by_pledge" },
): Promise<PoolInfo[]>
Fetches a list of pools with optional pagination and sorting
Parameters
- Optionalparams: PaginationParams & { sort?: "by_height" | "by_pledge" }
  Optional parameters including pagination and sort options
Returns Promise<PoolInfo[]>
Promise resolving to an array of pool information
- Defined in src/api.ts:277

getToken

getToken(id: string): Promise<TokenDetails>
Fetches information about a specific token
Parameters
- id: string
  The token ID to query
Returns Promise<TokenDetails>
Promise resolving to the token information
- Defined in src/api.ts:328

getTokenIds

getTokenIds(params?: PaginationParams): Promise<string[]>
Fetches a list of token IDs with optional pagination
Parameters
- Optionalparams: PaginationParams
  Optional pagination parameters
Returns Promise<string[]>
Promise resolving to an array of token IDs
- Defined in src/api.ts:346

getTokenIdsByTicker

getTokenIdsByTicker(
ticker: string,
params?: PaginationParams,
): Promise<string[]>
Fetches token IDs by their ticker symbol
Parameters
- ticker: string
  The ticker symbol to search for
- Optionalparams: PaginationParams
  Optional pagination parameters
Returns Promise<string[]>
Promise resolving to an array of token IDs matching the ticker
- Defined in src/api.ts:356

getTokenStatistics

getTokenStatistics(
    tokenId: string,
): Promise<
    {
        burned: string;
        circulating_supply: string;
        preminted: string;
        staked: string;
    },
>
Fetches statistics for a specific token
Parameters
- tokenId: string
  The token ID to query
Returns Promise<
    {
        burned: string;
        circulating_supply: string;
        preminted: string;
        staked: string;
    },
>
Promise resolving to token statistics including circulating supply, preminted, burned, and staked amounts
- Defined in src/api.ts:378

getTransaction

getTransaction(id: string): Promise<TransactionDetail>
Fetches detailed information about a specific transaction
Parameters
- id: string
  The transaction ID to query
Returns Promise<TransactionDetail>
Promise resolving to the transaction information
- Defined in src/api.ts:185

getTransactionMerklePath

getTransactionMerklePath(
    id: string,
): Promise<
    {
        block_id: string;
        merkle_path: string[];
        merkle_root: string;
        transaction_index: number;
    },
>
Fetches the Merkle path for a specific transaction
Parameters
- id: string
  The transaction ID to query
Returns Promise<
    {
        block_id: string;
        merkle_path: string[];
        merkle_root: string;
        transaction_index: number;
    },
>
Promise resolving to the transaction's Merkle path information
- Defined in src/api.ts:194

getTransactions

getTransactions(params?: PaginationParams): Promise<Transaction[]>
Fetches a list of transactions with optional pagination
Parameters
- Optionalparams: PaginationParams
  Optional pagination parameters
Returns Promise<Transaction[]>
Promise resolving to an array of transactions
- Defined in src/api.ts:176

submitTransaction

submitTransaction(transaction: string): Promise<{ tx_id: string }>
Submits a new transaction to the network
Parameters
- transaction: string
  The transaction data to submit
Returns Promise<{ tx_id: string }>
Promise resolving to the transaction ID
- Defined in src/api.ts:155

Class MintlayerAPIClient

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns MintlayerAPIClient

Methods

getAddress

Parameters

Returns Promise<AddressInfo>

getAddressDelegations

Parameters

Returns Promise<DelegationInfo[]>

getAddressTokenAuthority

Parameters

Returns Promise<string[]>

getAddressUtxos

Parameters

Returns Promise<{ outpoint: UtxoOutPoint; utxo: TransactionOutput }[]>

getAllAddressUtxos

Parameters

Returns Promise<{ outpoint: UtxoOutPoint; utxo: TransactionOutput }[]>

getBlock

Parameters

Returns Promise<BlockInfo>

getBlockHeader

Parameters

Returns Promise<BlockHeader>

getBlockReward

Parameters

Returns Promise<TransactionOutput[]>

getBlockTransactionIds

Parameters

Returns Promise<string[]>

getChainAtHeight

Parameters

Returns Promise<string>

getChainGenesis

Returns Promise< { block_id: string; genesis_message: string; timestamp: number; utxos: TransactionOutput[]; },>

getChainTip

Returns Promise<{ block_height: number; block_id: string }>

getCoinStatistics

Returns Promise< { burned: string; circulating_supply: string; preminted: string; staked: string; },>

getDelegation

Parameters

Returns Promise<DelegationInfo>

getFeerate

Parameters

Returns Promise<string>

getNFT

Parameters

Returns Promise<NFTInfo>

getOrder

Parameters

Returns Promise<OrderDetails>

getOrderPair

Parameters

Returns Promise<OrderDetails[]>

getOrders

Parameters

Returns Promise<OrderDetails[]>

getPool

Parameters

Returns Promise<PoolInfo>

getPoolBlockStats

Parameters

Returns Promise<{ block_count: number }>

getPoolDelegations

Parameters

Returns Promise<DelegationInfo[]>

getPools

Parameters

Returns Promise<PoolInfo[]>

getToken

Parameters

Returns Promise<TokenDetails>

getTokenIds

Parameters

Returns Promise<
{
block_id: string;
genesis_message: string;
timestamp: number;
utxos: TransactionOutput[];
},
>

Returns Promise<
{
burned: string;
circulating_supply: string;
preminted: string;
staked: string;
},
>

Returns Promise<
{
burned: string;
circulating_supply: string;
preminted: string;
staked: string;
},
>

Returns Promise<
{
block_id: string;
merkle_path: string[];
merkle_root: string;
transaction_index: number;
},
>