@terra-classic-community/terra.js/dist/client/lcd/api/TreasuryAPI.d.ts

The JavaScript SDK for Terra

import { BaseAPI } from './BaseAPI';
import { Coin, Denom, Dec, Coins, PolicyConstraints } from '../../../core';
import { APIParams } from '../APIRequester';
import { LCDClient } from '../LCDClient';
export interface TreasuryParams {
    /**
     * Current Tax Policy which governs how Tax Rate can be changed.
     */
    tax_policy: PolicyConstraints;
    /**
     * Current Reward Policy which governs how Reward Weight can be changed.
     */
    reward_policy: PolicyConstraints;
    /**
     * Factor that determines reward weight.
     */
    seigniorage_burden_target: Dec;
    /**
     * Factor that determines reward weight.
     */
    mining_increment: Dec;
    /**
     * Number of epochs defining a short window.
     */
    window_short: number;
    /**
     * Number of epochs defining a long window.
     */
    window_long: number;
    /**
     * Number of epochs defining the probationary period after genesis, during which monetary policy levers Tax Rate and Reward Weight do not change.
     */
    window_probation: number;
    /**
     * Factor that determines how much tax will be allocated to the community pool
     */
    burn_tax_split: Dec;
}
export declare namespace TreasuryParams {
    interface Data {
        tax_policy: PolicyConstraints.Data;
        reward_policy: PolicyConstraints.Data;
        seigniorage_burden_target: string;
        mining_increment: string;
        window_short: string;
        window_long: string;
        window_probation: string;
        burn_tax_split: string;
    }
}
export declare class TreasuryAPI extends BaseAPI {
    lcd: LCDClient;
    constructor(lcd: LCDClient);
    /**
     * Gets the current registered Tax caps for all denomination
     * @returns Coin[]
     */
    taxCaps(params?: APIParams): Promise<Coins>;
    /**
     * Gets the current registered Tax Cap for a specified denomination.
     * @param denom denomination desired for Tax Cap query.
     */
    taxCap(denom: Denom, params?: APIParams): Promise<Coin>;
    /**
     * Gets the current registered Tax Rate.
     */
    taxRate(height?: number, _params?: APIParams): Promise<Dec>;
    /**
     * Gets the current registered Reward Weight monetary policy lever.
     */
    rewardWeight(params?: APIParams): Promise<Dec>;
    /**
     * Gets the tax proceeds for the epoch.
     */
    taxProceeds(params?: APIParams): Promise<Coins>;
    /**
     * Gets the seigniorage proceeds for the epoch.
     */
    seigniorageProceeds(params?: APIParams): Promise<Coin>;
    /**
     * Gets the current Treasury module's parameters.
     */
    parameters(params?: APIParams): Promise<TreasuryParams>;
}