caver-js/types/packages/caver-transaction/src/index.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 { KlaytnCall } from '../../caver-rpc/src/klay'
import { AccessList } from './utils/accessList'
import { AccessTuple } from './utils/accessTuple'
import { AbstractTransaction } from './transactionTypes/abstractTransaction'
import { AccountUpdate } from './transactionTypes/accountUpdate/accountUpdate'
import { FeeDelegatedAccountUpdate } from './transactionTypes/accountUpdate/feeDelegatedAccountUpdate'
import { FeeDelegatedAccountUpdateWithRatio } from './transactionTypes/accountUpdate/feeDelegatedAccountUpdateWithRatio'
import { Cancel } from './transactionTypes/cancel/cancel'
import { FeeDelegatedCancel } from './transactionTypes/cancel/feeDelegatedCancel'
import { FeeDelegatedCancelWithRatio } from './transactionTypes/cancel/feeDelegatedCancelWithRatio'
import { ChainDataAnchoring } from './transactionTypes/chainDataAnchoring/chainDataAnchoring'
import { FeeDelegatedChainDataAnchoring } from './transactionTypes/chainDataAnchoring/feeDelegatedChainDataAnchoring'
import { FeeDelegatedChainDataAnchoringWithRatio } from './transactionTypes/chainDataAnchoring/feeDelegatedChainDataAnchoringWithRatio'
import { EthereumAccessList } from './transactionTypes/ethereumTypedTransaction/ethereumAccessList'
import { EthereumDynamicFee } from './transactionTypes/ethereumTypedTransaction/ethereumDynamicFee'
import { LegacyTransaction } from './transactionTypes/legacyTransaction/legacyTransaction'
import { FeeDelegatedSmartContractDeploy } from './transactionTypes/smartContractDeploy/feeDelegatedSmartContractDeploy'
import { FeeDelegatedSmartContractDeployWithRatio } from './transactionTypes/smartContractDeploy/feeDelegatedSmartContractDeployWithRatio'
import { SmartContractDeploy } from './transactionTypes/smartContractDeploy/smartContractDeploy'
import { FeeDelegatedSmartContractExecution } from './transactionTypes/smartContractExecution/feeDelegatedSmartContractExecution'
import { FeeDelegatedSmartContractExecutionWithRatio } from './transactionTypes/smartContractExecution/feeDelegatedSmartContractExecutionWithRatio'
import { SmartContractExecution } from './transactionTypes/smartContractExecution/smartContractExecution'
import { FeeDelegatedValueTransfer } from './transactionTypes/valueTransfer/feeDelegatedValueTransfer'
import { FeeDelegatedValueTransferWithRatio } from './transactionTypes/valueTransfer/feeDelegatedValueTransferWithRatio'
import { ValueTransfer } from './transactionTypes/valueTransfer/valueTransfer'
import { FeeDelegatedValueTransferMemo } from './transactionTypes/valueTransferMemo/feeDelegatedValueTransferMemo'
import { FeeDelegatedValueTransferMemoWithRatio } from './transactionTypes/valueTransferMemo/feeDelegatedValueTransferMemoWithRatio'
import { ValueTransferMemo } from './transactionTypes/valueTransferMemo/valueTransferMemo'

import * as Wrappers from './transactionTypes/wrappers/transactionWrappers'

export * from './transactionDecoder/transactionDecoder'
export * from './transactionHelper/transactionHelper'
export * from './transactionHasher/transactionHasher'
export * from './transactionTypes/abstractTransaction'
export * from './transactionTypes/abstractFeeDelegatedTransaction'
export * from './transactionTypes/abstractFeeDelegatedWithRatioTransaction'
export * from './transactionTypes/abstractFeeDelegatedWithRatioTransaction'
export * from './transactionTypes/accountUpdate/accountUpdate'
export * from './transactionTypes/accountUpdate/feeDelegatedAccountUpdate'
export * from './transactionTypes/accountUpdate/feeDelegatedAccountUpdateWithRatio'
export * from './transactionTypes/cancel/cancel'
export * from './transactionTypes/cancel/feeDelegatedCancel'
export * from './transactionTypes/cancel/feeDelegatedCancelWithRatio'
export * from './transactionTypes/chainDataAnchoring/chainDataAnchoring'
export * from './transactionTypes/chainDataAnchoring/feeDelegatedChainDataAnchoring'
export * from './transactionTypes/chainDataAnchoring/feeDelegatedChainDataAnchoringWithRatio'
export * from './transactionTypes/legacyTransaction/legacyTransaction'
export * from './transactionTypes/smartContractDeploy/smartContractDeploy'
export * from './transactionTypes/smartContractDeploy/feeDelegatedSmartContractDeploy'
export * from './transactionTypes/smartContractDeploy/feeDelegatedSmartContractDeployWithRatio'
export * from './transactionTypes/smartContractExecution/smartContractExecution'
export * from './transactionTypes/smartContractExecution/feeDelegatedSmartContractExecution'
export * from './transactionTypes/smartContractExecution/feeDelegatedSmartContractExecutionWithRatio'
export * from './transactionTypes/valueTransfer/valueTransfer'
export * from './transactionTypes/valueTransfer/feeDelegatedValueTransfer'
export * from './transactionTypes/valueTransfer/feeDelegatedValueTransferWithRatio'
export * from './transactionTypes/valueTransferMemo/valueTransferMemo'
export * from './transactionTypes/valueTransferMemo/feeDelegatedValueTransferMemo'
export * from './transactionTypes/valueTransferMemo/feeDelegatedValueTransferMemoWithRatio'
export * from './transactionTypes/ethereumTypedTransaction/ethereumAccessList'
export * from './transactionTypes/ethereumTypedTransaction/ethereumDynamicFee'
export * from './utils/accessList'
export * from './utils/accessTuple'
export * from './transactionTypes/wrappers/transactionWrappers'

export type Transaction =
    | LegacyTransaction
    | ValueTransfer
    | FeeDelegatedValueTransfer
    | FeeDelegatedValueTransferWithRatio
    | ValueTransferMemo
    | FeeDelegatedValueTransferMemo
    | FeeDelegatedValueTransferMemoWithRatio
    | AccountUpdate
    | FeeDelegatedAccountUpdate
    | FeeDelegatedAccountUpdateWithRatio
    | SmartContractDeploy
    | FeeDelegatedSmartContractDeploy
    | FeeDelegatedSmartContractDeployWithRatio
    | SmartContractExecution
    | FeeDelegatedSmartContractExecution
    | FeeDelegatedSmartContractExecutionWithRatio
    | Cancel
    | FeeDelegatedCancel
    | FeeDelegatedCancelWithRatio
    | ChainDataAnchoring
    | FeeDelegatedChainDataAnchoring
    | FeeDelegatedChainDataAnchoringWithRatio
    | EthereumAccessList
    | EthereumDynamicFee

export type FeeDelegatedTransaction =
    | FeeDelegatedValueTransfer
    | FeeDelegatedValueTransferWithRatio
    | FeeDelegatedValueTransferMemo
    | FeeDelegatedValueTransferMemoWithRatio
    | FeeDelegatedAccountUpdate
    | FeeDelegatedAccountUpdateWithRatio
    | FeeDelegatedSmartContractDeploy
    | FeeDelegatedSmartContractDeployWithRatio
    | FeeDelegatedSmartContractExecution
    | FeeDelegatedSmartContractExecutionWithRatio
    | FeeDelegatedCancel
    | FeeDelegatedCancelWithRatio
    | FeeDelegatedChainDataAnchoring
    | FeeDelegatedChainDataAnchoringWithRatio

export class TransactionModule {
    constructor(klaytnCall: KlaytnCall)

    decode(rlpEncoded: string): Transaction
    getTransactionByHash(transactionHash: string): Promise<AbstractTransaction>
    recoverPublicKeys(rawTx: string): string[]
    recoverFeePayerPublicKeys(rawTx: string): string[]

    legacyTransaction: Wrappers.LegacyTransactionWrapper
    valueTransfer: Wrappers.ValueTransferWrapper
    feeDelegatedValueTransfer: Wrappers.FeeDelegatedValueTransferWrapper
    feeDelegatedValueTransferWithRatio: Wrappers.FeeDelegatedValueTransferWithRatioWrapper
    valueTransferMemo: Wrappers.ValueTransferMemoWrapper
    feeDelegatedValueTransferMemo: Wrappers.FeeDelegatedValueTransferMemoWrapper
    feeDelegatedValueTransferMemoWithRatio: Wrappers.FeeDelegatedValueTransferMemoWithRatioWrapper
    accountUpdate: Wrappers.AccountUpdateWrapper
    feeDelegatedAccountUpdate: Wrappers.FeeDelegatedAccountUpdateWrapper
    feeDelegatedAccountUpdateWithRatio: Wrappers.FeeDelegatedAccountUpdateWithRatioWrapper
    smartContractDeploy: Wrappers.SmartContractDeployWrapper
    feeDelegatedSmartContractDeploy: Wrappers.FeeDelegatedSmartContractDeployWrapper
    feeDelegatedSmartContractDeployWithRatio: Wrappers.FeeDelegatedSmartContractDeployWithRatioWrapper
    smartContractExecution: Wrappers.SmartContractExecutionWrapper
    feeDelegatedSmartContractExecution: Wrappers.FeeDelegatedSmartContractExecutionWrapper
    feeDelegatedSmartContractExecutionWithRatio: Wrappers.FeeDelegatedSmartContractExecutionWithRatioWrapper
    cancel: Wrappers.CancelWrapper
    feeDelegatedCancel: Wrappers.FeeDelegatedCancelWrapper
    feeDelegatedCancelWithRatio: Wrappers.FeeDelegatedCancelWithRatioWrapper
    chainDataAnchoring: Wrappers.ChainDataAnchoringWrapper
    feeDelegatedChainDataAnchoring: Wrappers.FeeDelegatedChainDataAnchoringWrapper
    feeDelegatedChainDataAnchoringWithRatio: Wrappers.FeeDelegatedChainDataAnchoringWithRatioWrapper
    ethereumAccessList: Wrappers.EthereumAccessListWrapper
    ethereumDynamicFee: Wrappers.EthereumDynamicFeeWrapper

    type: { [key: string]: string }
    tag: { [key: string]: string }

    utils: {
        accessList: typeof AccessList
        accessTuple: typeof AccessTuple
    }

    klaytnCall: KlaytnCall
    private _klaytnCall: KlaytnCall
}