DefinitelyTyped/types/contract-proxy-kit/index.d.ts

// Type definitions for contract-proxy-kit 1.0
// Project: https://github.com/gnosis/contract-proxy-kit#readme
// Definitions by: Alan Lu <https://github.com/cag>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// Minimum TypeScript Version: 3.6

import { ethers } from 'ethers';

export = CPK;

declare namespace CPK {
    interface NetworkConfigEntry {
        masterCopyAddress: string;
        proxyFactoryAddress: string;
        multiSendAddress: string;
        fallbackHandlerAddress: string;
    }

    interface CommonConfig {
        networks?: {
            [id: string]: NetworkConfigEntry;
        };
    }

    interface Web3SpecificConfig extends CommonConfig {
        web3: object;
        ownerAccount?: string;
    }

    interface EthersSpecificConfig extends CommonConfig {
        ethers: typeof ethers;
        signer: ethers.Signer;
    }

    type CPKConfig = Web3SpecificConfig | EthersSpecificConfig;

    interface Transaction {
        operation: 0 | 1;
        to: string;
        value: number | string | object;
        data: string;
    }

    type TransactionOptions = object;

    interface TransactionResult {
        hash: string;
        promiEvent?: object;
        transactionResponse?: ethers.providers.TransactionResponse;
    }
}

declare class CPK {
    static CALL: 0;
    static DELEGATECALL: 1;

    static create(opts: CPK.CPKConfig): Promise<CPK>;

    getOwnerAccount(): Promise<string>;
    get address(): string;
    execTransactions(
        transactions: ReadonlyArray<CPK.Transaction>,
        options?: CPK.TransactionOptions,
    ): Promise<CPK.TransactionResult>;
}