caver-js/types/packages/caver-rpc/src/klay.d.ts

caver-js is a JavaScript API library that allows developers to interact with a Kaia node

/*
    Copyright 2021 The caver-js Authors
    This file is part of the caver-js library.

    The caver-js library is free software: you can redistribute it and/or modify
    it under the terms of the GNU Lesser General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    The caver-js library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    GNU Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public License
    along with the caver-js. If not, see <http://www.gnu.org/licenses/>.
*/

import BN = require('bn.js')
import BigNumber from 'bignumber.js'
import { AccountKey } from '../../caver-account/src'
import {
    Block,
    Header,
    BlockNumber,
    Rewards,
    ChainConfig,
    GovernanceItems,
    StakingInformation,
    TransactionReceipt,
    BlockWithConsensusInfo,
    TransactionForRPC,
    PromiEvent,
    TransactionForSendRPC,
    RLPEncodedTransaction,
    DecodedAnchoringTransaction,
    Log,
    LogsOptions,
    LogObject,
    CallObject,
    FeeHistoryResult,
} from '../../caver-core/src'
import { Transaction, FeeDelegatedTransaction, AccessListResult } from '../../caver-transaction/src'

export interface AccountForRPC {
    accType: number
    account: {
        nonce: number
        balance: string
        humanReadable: boolean
        key: AccountKeyForRPC
    }
}

export interface PublicKeyForRPC {
    x: string
    y: string
}

export interface WeightedPublicKeyForRPC {
    weight: number
    key: PublicKeyForRPC
}

export interface WeightedMultiSigKeyForRPC {
    threshold: number
    keys: WeightedPublicKeyForRPC[]
}

export interface AccountKeyForRPC {
    keyType?: number
    nonce?: number
    key?: PublicKeyForRPC | WeightedMultiSigKeyForRPC | AccountKeyForRPC | AccountKeyForRPC[]
}

export interface Syncing {
    startingBlock: number
    currentBlock: number
    highestBlock: number
    knownStates: number
    pulledStates: number
}

export interface KlaytnCall {
    getAccountKey: Klay['getAccountKey']
    getChainId: Klay['getChainId']
    getGasPrice: Klay['getGasPrice']
    getHeaderByNumber: Klay['getHeaderByNumber']
    getTransactionByHash: Klay['getTransactionByHash']
    getTransactionCount: Klay['getTransactionCount']
    getMaxPriorityFeePerGas: Klay['getMaxPriorityFeePerGas']
}

export class Klay {
    constructor(...args: any[])

    klaytnCall: KlaytnCall

    accountCreated(address: string, callback?: (error: Error, result: boolean) => void): Promise<boolean>
    accountCreated(address: string, blockNumber: BlockNumber, callback?: (error: Error, result: boolean) => void): Promise<boolean>
    getAccounts(callback?: (error: Error, result: string[]) => void): Promise<string[]>
    encodeAccountKey(accountKey: AccountKeyForRPC | AccountKey, callback?: (error: Error, result: string) => void): Promise<string>
    decodeAccountKey(encodedAccountKey: string, callback?: (error: Error, result: AccountKeyForRPC) => void): Promise<AccountKeyForRPC>
    getAccount(address: string, callback?: (error: Error, result: AccountForRPC) => void): Promise<AccountForRPC>
    getAccount(address: string, blockNumber: BlockNumber, callback?: (error: Error, result: AccountForRPC) => void): Promise<AccountForRPC>
    getAccountKey(address: string, callback?: (error: Error, result: AccountKeyForRPC) => void): Promise<AccountKeyForRPC>
    getAccountKey(
        address: string,
        blockNumber: BlockNumber,
        callback?: (error: Error, result: AccountKeyForRPC) => void
    ): Promise<AccountKeyForRPC>
    getBalance(address: string, callback?: (error: Error, result: string) => void): Promise<string>
    getBalance(address: string, blockNumber: BlockNumber, callback?: (error: Error, result: string) => void): Promise<string>
    getCode(address: string, callback?: (error: Error, result: string) => void): Promise<string>
    getCode(address: string, blockNumber: BlockNumber, callback?: (error: Error, result: string) => void): Promise<string>
    getTransactionCount(address: string, callback?: (error: Error, result: string) => void): Promise<string>
    getTransactionCount(address: string, blockNumber: BlockNumber, callback?: (error: Error, result: string) => void): Promise<string>
    isContractAccount(address: string, callback?: (error: Error, result: boolean) => void): Promise<boolean>
    isContractAccount(address: string, blockNumber: BlockNumber, callback?: (error: Error, result: boolean) => void): Promise<boolean>
    sign(address: string, message: string, callback?: (error: Error, result: string) => void): Promise<string>
    sign(address: string, message: string, blockNumber: BlockNumber, callback?: (error: Error, result: string) => void): Promise<string>

    getBlockNumber(callback?: (error: Error, result: string) => void): Promise<string>
    getBlock(blockNumber: BlockNumber, callback?: (error: Error, result: Block) => void): Promise<Block>
    getBlock(blockNumber: BlockNumber, returnTransactionObjects: boolean, callback?: (error: Error, result: Block) => void): Promise<Block>
    getBlockByNumber(
        blockNumber: 'genesis' | 'latest' | number | BN | BigNumber,
        callback?: (error: Error, result: Block) => void
    ): Promise<Block>
    getBlockByNumber(
        blockNumber: 'genesis' | 'latest' | number | BN | BigNumber,
        returnTransactionObjects: boolean,
        callback?: (error: Error, result: Block) => void
    ): Promise<Block>
    getBlockByHash(blockHash: string, callback?: (error: Error, result: Block) => void): Promise<Block>
    getBlockByHash(blockHash: string, returnTransactionObjects: boolean, callback?: (error: Error, result: Block) => void): Promise<Block>
    getHeader(blockNumber: BlockNumber, callback?: (error: Error, result: Header) => void): Promise<Header>
    getHeaderByNumber(blockNumber: BlockNumber, callback?: (error: Error, result: Header) => void): Promise<Header>
    getHeaderByHash(blockHash: string, callback?: (error: Error, result: Header) => void): Promise<Header>

    getRewards(blockNumber: BlockNumber, callback?: (error: Error, result: Header) => void): Promise<Rewards>
    getParams(callback?: (error: Error, result: GovernanceItems) => void): Promise<GovernanceItems>
    getParams(blockNumber: BlockNumber, callback?: (error: Error, result: GovernanceItems) => void): Promise<GovernanceItems>
    getChainConfig(callback?: (error: Error, result: ChainConfig) => void): Promise<ChainConfig>
    getChainConfig(blockNumber: BlockNumber, callback?: (error: Error, result: ChainConfig) => void): Promise<ChainConfig>
    getChainConfigAt(callback?: (error: Error, result: ChainConfig) => void): Promise<ChainConfig>
    // TODO-caver getChainConfigAt will be deleted in v1.11.0
    getChainConfigAt(blockNumber: BlockNumber, callback?: (error: Error, result: ChainConfig) => void): Promise<ChainConfig>
    getNodeAddress(callback?: (error: Error, result: string) => void): Promise<string>
    // TODO-caver getGovParamsAt will be deleted in v1.11.0
    getGovParamsAt(callback?: (error: Error, result: GovernanceItems) => void): Promise<GovernanceItems>
    getGovParamsAt(blockNumber: BlockNumber, callback?: (error: Error, result: GovernanceItems) => void): Promise<GovernanceItems>
    getStakingInfo(callback?: (error: Error, result: StakingInformation) => void): Promise<StakingInformation>
    getStakingInfo(blockNumber: BlockNumber, callback?: (error: Error, result: StakingInformation) => void): Promise<StakingInformation>

    getBlockReceipts(blockHash: string, callback?: (error: Error, result: TransactionReceipt[]) => void): Promise<TransactionReceipt[]>
    getBlockTransactionCount(blockNumber: BlockNumber, callback?: (error: Error, result: string) => void): Promise<string>
    getBlockTransactionCountByNumber(
        blockNumber: 'genesis' | 'latest' | number | BN | BigNumber,
        callback?: (error: Error, result: string) => void
    ): Promise<string>
    getBlockTransactionCountByHash(blockHash: string, callback?: (error: Error, result: string) => void): Promise<string>
    getBlockWithConsensusInfo(
        blockNumber: BlockNumber,
        callback?: (error: Error, result: BlockWithConsensusInfo) => void
    ): Promise<BlockWithConsensusInfo>
    getBlockWithConsensusInfoByNumber(
        blockNumber: 'genesis' | 'latest' | number | BN | BigNumber,
        callback?: (error: Error, result: BlockWithConsensusInfo) => void
    ): Promise<BlockWithConsensusInfo>
    getBlockWithConsensusInfoByHash(
        blockHash: string,
        callback?: (error: Error, result: BlockWithConsensusInfo) => void
    ): Promise<BlockWithConsensusInfo>
    getCommittee(blockNumber?: BlockNumber, callback?: (error: Error, result: string[]) => void): Promise<string[]>
    getCommitteeSize(blockNumber?: BlockNumber, callback?: (error: Error, result: number) => void): Promise<number>
    getCouncil(blockNumber?: BlockNumber, callback?: (error: Error, result: string[]) => void): Promise<string[]>
    getCouncilSize(blockNumber?: BlockNumber, callback?: (error: Error, result: number) => void): Promise<number>

    getStorageAt(address: string, position: number, callback?: (error: Error, result: string) => void): Promise<string>
    getStorageAt(
        address: string,
        position: number,
        blockNumber: BlockNumber,
        callback?: (error: Error, result: string) => void
    ): Promise<string>
    isMining(callback?: (error: Error, result: boolean) => void): Promise<boolean>
    isSyncing(callback?: (error: Error, result: Syncing | boolean) => void): Promise<Syncing | boolean>

    call(callObject: CallObject, callback?: (error: Error, result: string) => void): Promise<string>
    call(callObject: CallObject, blockNumber: BlockNumber, callback?: (error: Error, result: string) => void): Promise<string>
    estimateGas(callObject: CallObject, callback?: (error: Error, result: string) => void): Promise<string>
    estimateGas(callObject: CallObject, blockNumber: BlockNumber, callback?: (error: Error, result: string) => void): Promise<string>
    estimateComputationCost(callObject: CallObject, callback?: (error: Error, result: string) => void): Promise<string>
    estimateComputationCost(
        callObject: CallObject,
        blockNumber: BlockNumber,
        callback?: (error: Error, result: string) => void
    ): Promise<string>

    getTransactionFromBlock(
        blockNumber: BlockNumber,
        index: number,
        callback?: (error: Error, result: TransactionForRPC) => void
    ): Promise<TransactionForRPC>
    getTransactionByBlockNumberAndIndex(
        blockNumber: 'genesis' | 'latest' | number | BN | BigNumber,
        index: number,
        callback?: (error: Error, result: TransactionForRPC) => void
    ): Promise<TransactionForRPC>
    getTransactionByBlockHashAndIndex(
        blockHash: string,
        index: number,
        callback?: (error: Error, result: TransactionForRPC) => void
    ): Promise<TransactionForRPC>
    getTransaction(
        transactionHash: string,
        callback?: (error: Error, result: TransactionForRPC | null) => void
    ): Promise<TransactionForRPC | null>
    getTransactionByHash(
        transactionHash: string,
        callback?: (error: Error, result: TransactionForRPC | null) => void
    ): Promise<TransactionForRPC | null>
    getTransactionBySenderTxHash(
        senderTxHash: string,
        callback?: (error: Error, result: TransactionForRPC | null) => void
    ): Promise<TransactionForRPC | null>
    getTransactionReceipt(
        transactionHash: string,
        callback?: (error: Error, result: TransactionReceipt | null) => void
    ): Promise<TransactionReceipt | null>
    getTransactionReceiptBySenderTxHash(
        senderTxHash: string,
        callback?: (error: Error, result: TransactionReceipt | null) => void
    ): Promise<TransactionReceipt | null>

    submitTransaction(
        signedTransaction: string | Transaction,
        callback?: (error: Error, hash: string) => void
    ): PromiEvent<TransactionReceipt>
    sendRawTransaction(
        signedTransaction: string | Transaction,
        callback?: (error: Error, hash: string) => void
    ): PromiEvent<TransactionReceipt>
    sendTransaction(
        transaction: TransactionForSendRPC | Transaction,
        callback?: (error: Error, hash: string) => void
    ): PromiEvent<TransactionReceipt>
    sendTransactionAsFeePayer(
        transaction: TransactionForSendRPC | Transaction,
        callback?: (error: Error, hash: string) => void
    ): PromiEvent<TransactionReceipt>
    signTransaction(
        transaction: TransactionForSendRPC | Transaction,
        callback?: (error: Error, result: RLPEncodedTransaction) => void
    ): Promise<RLPEncodedTransaction>
    signTransactionAsFeePayer(
        transaction: TransactionForSendRPC | FeeDelegatedTransaction,
        callback?: (error: Error, result: RLPEncodedTransaction) => void
    ): Promise<RLPEncodedTransaction>
    getDecodedAnchoringTransactionByHash(
        transactionHash: string,
        callback?: (error: Error, result: DecodedAnchoringTransaction) => void
    ): Promise<DecodedAnchoringTransaction>
    getFeeHistory(
        blockCount: string | number | BN | BigNumber,
        latestBlock: BlockNumber,
        rewardPercentiles: number[],
        callback?: (error: Error, result: FeeHistoryResult) => void
    ): Promise<FeeHistoryResult>
    getMaxPriorityFeePerGas(
        callback?: (error: Error, result: string) => void
    ): Promise<string>
    getUpperBoundGasPrice(
        callback?: (error: Error, result: string) => void
    ): Promise<string>
    getLowerBoundGasPrice(
        callback?: (error: Error, result: string) => void
    ): Promise<string>
    createAccessList(
        callObject: CallObject,
        blockNumber: BlockNumber,
        callback?: (error: Error, result: AccessListResult) => void
    ): Promise<AccessListResult>

    getChainId(callback?: (error: Error, result: string) => void): Promise<string>
    getClientVersion(callback?: (error: Error, result: string) => void): Promise<string>
    getGasPrice(callback?: (error: Error, result: string) => void): Promise<string>
    getGasPriceAt(callback?: (error: Error, result: string) => void): Promise<string>
    getGasPriceAt(blockNumber: BlockNumber, callback?: (error: Error, result: string) => void): Promise<string>
    isParallelDBWrite(callback?: (error: Error, result: boolean) => void): Promise<boolean>
    isSenderTxHashIndexingEnabled(callback?: (error: Error, result: boolean) => void): Promise<boolean>
    getProtocolVersion(callback?: (error: Error, result: string) => void): Promise<string>
    getRewardbase(callback?: (error: Error, result: string) => void): Promise<string>

    getFilterChanges(filterId: string, callback?: (error: Error, result: LogObject[]) => void): Promise<LogObject[]>
    getFilterLogs(filterId: string, callback?: (error: Error, result: LogObject[]) => void): Promise<LogObject[]>
    getLogs(options: LogsOptions, callback?: (error: Error, result: Log[]) => void): Promise<Log[]>
    newBlockFilter(callback?: (error: Error, result: string) => void): Promise<string>
    newFilter(options: LogsOptions, callback?: (error: Error, result: string) => void): Promise<string>
    newPendingTransactionFilter(callback?: (error: Error, result: string) => void): Promise<string>
    uninstallFilter(filterId: string, callback?: (error: Error, result: boolean) => void): Promise<boolean>
    sha3(data: string, callback?: (error: Error, result: string) => void): Promise<string>
}