129 lines
3.0 KiB
TypeScript
129 lines
3.0 KiB
TypeScript
declare module 'ethereumjs-tx' {
|
|
import BN from 'bn.js';
|
|
import { Buffer } from 'buffer';
|
|
|
|
/*
|
|
type fieldName =
|
|
| 'nonce'
|
|
| 'gasPrice'
|
|
| 'gasLimit'
|
|
| 'to'
|
|
| 'value'
|
|
| 'data'
|
|
| 'v'
|
|
| 'r'
|
|
| 's';
|
|
|
|
type Field = {
|
|
name: fieldName;
|
|
length?: 32 | 20;
|
|
allowLess?: boolean;
|
|
allowZero?: boolean;
|
|
default?: Buffer;
|
|
};
|
|
*/
|
|
|
|
export interface TxObj {
|
|
chainId?: number | null;
|
|
gasLimit?: Buffer | BN | string | number | null;
|
|
gasPrice?: Buffer | BN | string | number | null;
|
|
to?: Buffer | BN | string | number | null;
|
|
nonce?: Buffer | BN | string | number | null;
|
|
data?: Buffer | BN | string | number | null;
|
|
v?: Buffer | BN | string | number | null;
|
|
r?: Buffer | BN | string | number | null;
|
|
s?: Buffer | BN | string | number | null;
|
|
value?: Buffer | BN | string | number | null;
|
|
}
|
|
|
|
class EthereumJSTx {
|
|
public _chainId: number;
|
|
public raw: Buffer;
|
|
public gasLimit: Buffer;
|
|
public gasPrice: Buffer;
|
|
public to: Buffer;
|
|
public nonce: Buffer;
|
|
public data: Buffer;
|
|
public value: Buffer;
|
|
public from: Buffer;
|
|
public v: Buffer;
|
|
public r: Buffer;
|
|
public s: Buffer;
|
|
constructor(data: TxObj | string | Buffer);
|
|
|
|
/**
|
|
* If the tx's `to` is to the creation address
|
|
* @return {Boolean}
|
|
*/
|
|
public toCreationAddress(): string;
|
|
|
|
/**
|
|
* Computes a sha3-256 hash of the serialized tx
|
|
* @param {Boolean} [includeSignature=true] whether or not to inculde the signature
|
|
* @return {Buffer}
|
|
*/
|
|
public hash(bool: boolean): Buffer;
|
|
|
|
/**
|
|
* returns the public key of the sender
|
|
* @return {number}
|
|
*/
|
|
public getChainId(): number;
|
|
|
|
/**
|
|
* returns the sender's address
|
|
* @return {Buffer}
|
|
*/
|
|
public getSenderAddress(): Buffer;
|
|
|
|
/**
|
|
* returns the public key of the sender
|
|
* @return {Buffer}
|
|
*/
|
|
public getSenderPublicKey(): Buffer;
|
|
|
|
/**
|
|
* Determines if the signature is valid
|
|
* @return {Boolean}
|
|
*/
|
|
public verifySignature(): boolean;
|
|
|
|
/**
|
|
* sign a transaction with a given a private key
|
|
* @param {Buffer} privateKey
|
|
*/
|
|
public sign(privateKey: Buffer): void;
|
|
|
|
/**
|
|
* The amount of gas paid for the data in this tx
|
|
* @return {BN}
|
|
*/
|
|
public getDataFee(): BN;
|
|
|
|
/**
|
|
* the minimum amount of gas the tx must have (DataFee + TxFee + Creation Fee)
|
|
* @return {BN}
|
|
*/
|
|
public getBaseFee(): BN;
|
|
|
|
/**
|
|
* the up front amount that an account must have for this transaction to be valid
|
|
* @return {BN}
|
|
*/
|
|
public getUpfrontCost(): BN;
|
|
|
|
/**
|
|
* validates the signature and checks to see if it has enough gas
|
|
* @param {Boolean} [stringError=false] whether to return a string with a dscription of why the validation failed or return a Bloolean
|
|
* @return {Boolean|String}
|
|
*/
|
|
public validate(stringError: boolean): boolean | string;
|
|
|
|
public toJSON(): any;
|
|
|
|
public serialize(): Buffer;
|
|
}
|
|
|
|
export default EthereumJSTx;
|
|
}
|