0xweb/dequanto/src/prebuilt/openzeppelin/ICrossDomainMessenger.ts

Contract package manager and other web3 tools

/**
 *  AUTO-Generated Class: 2024-05-17 00:25
 *  Implementation: https://etherscan.io/address/undefined#code
 */
import di from 'a-di';
import { TAddress } from '@dequanto/models/TAddress';
import { TAccount } from '@dequanto/models/TAccount';
import { TBufferLike } from '@dequanto/models/TBufferLike';
import { ClientEventsStream, TClientEventsStreamData } from '@dequanto/clients/ClientEventsStream';
import { ContractBase } from '@dequanto/contracts/ContractBase';
import { ContractBaseUtils } from '@dequanto/contracts/utils/ContractBaseUtils';
import { ContractStorageReaderBase } from '@dequanto/contracts/ContractStorageReaderBase';
import { TxWriter } from '@dequanto/txs/TxWriter';
import { ITxLogItem } from '@dequanto/txs/receipt/ITxLogItem';
import { Web3Client } from '@dequanto/clients/Web3Client';
import { IBlockchainExplorer } from '@dequanto/explorer/IBlockchainExplorer';
import { SubjectStream } from '@dequanto/class/SubjectStream';


import type { ContractWriter } from '@dequanto/contracts/ContractWriter';
import type { TAbiItem } from '@dequanto/types/TAbi';
import type { TEth } from '@dequanto/models/TEth';
import type { TOverrideReturns } from '@dequanto/utils/types';


import { Etherscan } from '@dequanto/explorer/Etherscan'
import { EthWeb3Client } from '@dequanto/clients/EthWeb3Client'



export class ICrossDomainMessenger extends ContractBase {
    constructor(
        public address: TEth.Address = null,
        public client: Web3Client = di.resolve(EthWeb3Client, ),
        public explorer: IBlockchainExplorer = di.resolve(Etherscan, ),
    ) {
        super(address, client, explorer)


    }

    Types: TICrossDomainMessengerTypes;

    $meta = {
        "class": "./src/prebuilt/openzeppelin/ICrossDomainMessenger.ts"
    }

    // 0x3dbb202b
    async sendMessage (sender: TSender, _target: TAddress, _message: TEth.Hex, _gasLimit: number): Promise<TxWriter> {
        return this.$write(this.$getAbiItem('function', 'sendMessage'), sender, _target, _message, _gasLimit);
    }

    // 0x6e296e45
    async xDomainMessageSender (): Promise<TAddress> {
        return this.$read(this.$getAbiItem('function', 'xDomainMessageSender'));
    }

    $call () {
        return super.$call() as IICrossDomainMessengerTxCaller;
    }
    $signed (): TOverrideReturns<IICrossDomainMessengerTxCaller, Promise<{ signed: TEth.Hex, error?: Error & { data?: { type: string, params } } }>> {
        return super.$signed() as any;
    }
    $data (): IICrossDomainMessengerTxData {
        return super.$data() as IICrossDomainMessengerTxData;
    }
    $gas (): TOverrideReturns<IICrossDomainMessengerTxCaller, Promise<{ gas?: bigint, price?: bigint, error?: Error & { data?: { type: string, params } } }>> {
        return super.$gas() as any;
    }

    onTransaction <TMethod extends keyof TICrossDomainMessengerTypes['Methods']> (method: TMethod, options: Parameters<ContractBase['$onTransaction']>[0]): SubjectStream<{
        tx: TEth.Tx
        block: TEth.Block<TEth.Hex>
        calldata: {
            method: TMethod
            arguments: TICrossDomainMessengerTypes['Methods'][TMethod]['arguments']
        }
    }> {
        options ??= {};
        options.filter ??= {};
        options.filter.method = method;
        return <any> this.$onTransaction(options);
    }

    onLog (event: keyof TEvents, cb?: (event: TClientEventsStreamData) => void): ClientEventsStream<TClientEventsStreamData> {
        return this.$onLog(event, cb);
    }

    async getPastLogs <TEventName extends keyof TEvents> (
        events: TEventName[]
        , options?: TEventLogOptions<TEventParams<TEventName>>
    ): Promise<ITxLogItem<TEventParams<TEventName>, TEventName>[]>
    async getPastLogs <TEventName extends keyof TEvents> (
        event: TEventName
        , options?: TEventLogOptions<TEventParams<TEventName>>
    ): Promise<ITxLogItem<TEventParams<TEventName>, TEventName>[]>
    async getPastLogs (mix: any, options?): Promise<any> {
        return await super.getPastLogs(mix, options) as any;
    }

    onFailedRelayedMessage (fn?: (event: TClientEventsStreamData<TEventArguments<'FailedRelayedMessage'>>) => void): ClientEventsStream<TClientEventsStreamData<TEventArguments<'FailedRelayedMessage'>>> {
        return this.$onLog('FailedRelayedMessage', fn);
    }

    onRelayedMessage (fn?: (event: TClientEventsStreamData<TEventArguments<'RelayedMessage'>>) => void): ClientEventsStream<TClientEventsStreamData<TEventArguments<'RelayedMessage'>>> {
        return this.$onLog('RelayedMessage', fn);
    }

    onSentMessage (fn?: (event: TClientEventsStreamData<TEventArguments<'SentMessage'>>) => void): ClientEventsStream<TClientEventsStreamData<TEventArguments<'SentMessage'>>> {
        return this.$onLog('SentMessage', fn);
    }

    extractLogsFailedRelayedMessage (tx: TEth.TxReceipt): ITxLogItem<TEventParams<'FailedRelayedMessage'>>[] {
        let abi = this.$getAbiItem('event', 'FailedRelayedMessage');
        return this.$extractLogs(tx, abi) as any as ITxLogItem<TEventParams<'FailedRelayedMessage'>>[];
    }

    extractLogsRelayedMessage (tx: TEth.TxReceipt): ITxLogItem<TEventParams<'RelayedMessage'>>[] {
        let abi = this.$getAbiItem('event', 'RelayedMessage');
        return this.$extractLogs(tx, abi) as any as ITxLogItem<TEventParams<'RelayedMessage'>>[];
    }

    extractLogsSentMessage (tx: TEth.TxReceipt): ITxLogItem<TEventParams<'SentMessage'>>[] {
        let abi = this.$getAbiItem('event', 'SentMessage');
        return this.$extractLogs(tx, abi) as any as ITxLogItem<TEventParams<'SentMessage'>>[];
    }

    async getPastLogsFailedRelayedMessage (options?: {
        fromBlock?: number | Date
        toBlock?: number | Date
        params?: { msgHash?: TEth.Hex }
    }): Promise<ITxLogItem<TEventParams<'FailedRelayedMessage'>>[]> {
        return await this.$getPastLogsParsed('FailedRelayedMessage', options) as any;
    }

    async getPastLogsRelayedMessage (options?: {
        fromBlock?: number | Date
        toBlock?: number | Date
        params?: { msgHash?: TEth.Hex }
    }): Promise<ITxLogItem<TEventParams<'RelayedMessage'>>[]> {
        return await this.$getPastLogsParsed('RelayedMessage', options) as any;
    }

    async getPastLogsSentMessage (options?: {
        fromBlock?: number | Date
        toBlock?: number | Date
        params?: { target?: TAddress }
    }): Promise<ITxLogItem<TEventParams<'SentMessage'>>[]> {
        return await this.$getPastLogsParsed('SentMessage', options) as any;
    }

    abi: TAbiItem[] = [{"anonymous":false,"inputs":[{"indexed":true,"internalType":"bytes32","name":"msgHash","type":"bytes32"}],"name":"FailedRelayedMessage","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"bytes32","name":"msgHash","type":"bytes32"}],"name":"RelayedMessage","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"target","type":"address"},{"indexed":false,"internalType":"address","name":"sender","type":"address"},{"indexed":false,"internalType":"bytes","name":"message","type":"bytes"},{"indexed":false,"internalType":"uint256","name":"messageNonce","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"gasLimit","type":"uint256"}],"name":"SentMessage","type":"event"},{"inputs":[{"internalType":"address","name":"_target","type":"address"},{"internalType":"bytes","name":"_message","type":"bytes"},{"internalType":"uint32","name":"_gasLimit","type":"uint32"}],"name":"sendMessage","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"xDomainMessageSender","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"}]


}

type TSender = TAccount & {
    value?: string | number | bigint
}

type TEventLogOptions<TParams> = {
    fromBlock?: number | Date
    toBlock?: number | Date
    params?: TParams
}

export type TICrossDomainMessengerTypes = {
    Events: {
        FailedRelayedMessage: {
            outputParams: { msgHash: TEth.Hex },
            outputArgs:   [ msgHash: TEth.Hex ],
        }
        RelayedMessage: {
            outputParams: { msgHash: TEth.Hex },
            outputArgs:   [ msgHash: TEth.Hex ],
        }
        SentMessage: {
            outputParams: { target: TAddress, _sender: TAddress, message: TEth.Hex, messageNonce: bigint, gasLimit: bigint },
            outputArgs:   [ target: TAddress, _sender: TAddress, message: TEth.Hex, messageNonce: bigint, gasLimit: bigint ],
        }
    },
    Methods: {
        sendMessage: {
          method: "sendMessage"
          arguments: [ _target: TAddress, _message: TEth.Hex, _gasLimit: number ]
        }
        xDomainMessageSender: {
          method: "xDomainMessageSender"
          arguments: [  ]
        }
    }
}



interface IICrossDomainMessengerTxCaller {
    sendMessage (sender: TSender, _target: TAddress, _message: TEth.Hex, _gasLimit: number): Promise<{ error?: Error & { data?: { type: string, params } }, result? }>
}


interface IICrossDomainMessengerTxData {
    sendMessage (sender: TSender, _target: TAddress, _message: TEth.Hex, _gasLimit: number): Promise<TEth.TxLike>
}


type TEvents = TICrossDomainMessengerTypes['Events'];
type TEventParams<TEventName extends keyof TEvents> = Partial<TEvents[TEventName]['outputParams']>;
type TEventArguments<TEventName extends keyof TEvents> = Partial<TEvents[TEventName]['outputArgs']>;