@celo/connect/lib/connection.d.ts

Light Toolkit for connecting with the Celo network

import { StrongAddress } from '@celo/base';
import { EIP712TypedData } from '@celo/utils/lib/sign-typed-data-utils';
import { Signature } from '@celo/utils/lib/signatureUtils';
import Web3 from 'web3';
import { AbiCoder } from './abi-types';
import { Address, Block, BlockHeader, BlockNumber, CeloTx, CeloTxObject, CeloTxPending, CeloTxReceipt, Provider } from './types';
import { RpcCaller } from './utils/rpc-caller';
import { TxParamsNormalizer } from './utils/tx-params-normalizer';
import { TransactionResult } from './utils/tx-result';
import { ReadOnlyWallet } from './wallet';
type BN = ReturnType<Web3['utils']['toBN']>;
export interface ConnectionOptions {
    gasInflationFactor: number;
    feeCurrency?: StrongAddress;
    from?: StrongAddress;
}
/**
 * Connection is a Class for connecting to Celo, sending Transactions, etc
 * @param web3 an instance of web3
 * @param wallet a child class of {@link WalletBase}
 * @param handleRevert sets handleRevert on the web3.eth instance passed in
 */
export declare class Connection {
    readonly web3: Web3;
    wallet?: ReadOnlyWallet | undefined;
    private config;
    private _chainID;
    readonly paramsPopulator: TxParamsNormalizer;
    rpcCaller: RpcCaller;
    constructor(web3: Web3, wallet?: ReadOnlyWallet | undefined, handleRevert?: boolean);
    setProvider(provider: Provider): boolean;
    keccak256: (value: string | BN) => string;
    hexToAscii: (hex: string) => string;
    /**
     * Set default account for generated transactions (eg. tx.from )
     */
    set defaultAccount(address: StrongAddress | undefined);
    /**
     * Default account for generated transactions (eg. tx.from)
     */
    get defaultAccount(): StrongAddress | undefined;
    set defaultGasInflationFactor(factor: number);
    get defaultGasInflationFactor(): number;
    /**
     * Set the ERC20 address for the token to use to pay for transaction fees.
     * The ERC20 address SHOULD be whitelisted for gas, but this is not checked or enforced.
     *
     * Set to `null` to use CELO
     *
     * @param address ERC20 address
     */
    set defaultFeeCurrency(address: StrongAddress | undefined);
    get defaultFeeCurrency(): StrongAddress | undefined;
    isLocalAccount(address?: StrongAddress): boolean;
    addAccount(privateKey: string): void;
    removeAccount(address: string): void;
    getNodeAccounts(): Promise<StrongAddress[]>;
    getLocalAccounts(): StrongAddress[];
    getAccounts(): Promise<StrongAddress[]>;
    private toChecksumAddresses;
    isListening(): Promise<boolean>;
    isSyncing(): Promise<boolean>;
    /**
     * Send a transaction to celo-blockchain.
     *
     * Similar to `web3.eth.sendTransaction()` but with following differences:
     *  - applies connections tx's defaults
     *  - estimatesGas before sending
     *  - returns a `TransactionResult` instead of `PromiEvent`
     */
    sendTransaction: (tx: CeloTx) => Promise<TransactionResult>;
    sendTransactionObject: (txObj: CeloTxObject<any>, tx?: Omit<CeloTx, 'data'>) => Promise<TransactionResult>;
    signTypedData: (signer: string, typedData: EIP712TypedData, version?: 1 | 3 | 4 | 5 | null) => Promise<Signature>;
    sign: (dataToSign: string, address: Address | number) => Promise<string>;
    sendSignedTransaction: (signedTransactionData: string) => Promise<TransactionResult>;
    setFeeMarketGas: (tx: CeloTx) => Promise<CeloTx>;
    estimateGas: (tx: CeloTx, gasEstimator?: (tx: CeloTx) => Promise<number>, caller?: (tx: CeloTx) => Promise<string>) => Promise<number>;
    getAbiCoder(): AbiCoder;
    estimateGasWithInflationFactor: (tx: CeloTx, gasEstimator?: ((tx: CeloTx) => Promise<number>) | undefined, caller?: ((tx: CeloTx) => Promise<string>) | undefined) => Promise<number>;
    chainId: () => Promise<number>;
    getTransactionCount: (address: Address) => Promise<number>;
    nonce: (address: Address) => Promise<number>;
    coinbase: () => Promise<string>;
    gasPrice: (feeCurrency?: Address) => Promise<string>;
    getMaxPriorityFeePerGas: (feeCurrency?: Address) => Promise<string>;
    getBlockNumber: () => Promise<number>;
    private isBlockNumberHash;
    getBlock: (blockHashOrBlockNumber: BlockNumber, fullTxObjects?: boolean) => Promise<Block>;
    getBlockHeader: (blockHashOrBlockNumber: BlockNumber) => Promise<BlockHeader>;
    getBalance: (address: Address, defaultBlock?: BlockNumber) => Promise<string>;
    getTransaction: (transactionHash: string) => Promise<CeloTxPending>;
    getTransactionReceipt: (txhash: string) => Promise<CeloTxReceipt | null>;
    private fillTxDefaults;
    stop(): void;
}
export declare function isPresent(value: string | undefined | number | BN | bigint): value is string | number | BN | bigint;
export {};