0xweb/dequanto/src/prebuilt/openzeppelin/IArbSys.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 IArbSys 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: TIArbSysTypes;

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

    // 0x2b407a82
    async arbBlockHash (arbBlockNum: bigint): Promise<TEth.Hex> {
        return this.$read(this.$getAbiItem('function', 'arbBlockHash'), arbBlockNum);
    }

    // 0xa3b1b31d
    async arbBlockNumber (): Promise<bigint> {
        return this.$read(this.$getAbiItem('function', 'arbBlockNumber'));
    }

    // 0xd127f54a
    async arbChainID (): Promise<bigint> {
        return this.$read(this.$getAbiItem('function', 'arbChainID'));
    }

    // 0x051038f2
    async arbOSVersion (): Promise<bigint> {
        return this.$read(this.$getAbiItem('function', 'arbOSVersion'));
    }

    // 0xa94597ff
    async getStorageGasAvailable (): Promise<bigint> {
        return this.$read(this.$getAbiItem('function', 'getStorageGasAvailable'));
    }

    // 0x08bd624c
    async isTopLevelCall (): Promise<boolean> {
        return this.$read(this.$getAbiItem('function', 'isTopLevelCall'));
    }

    // 0x4dbbd506
    async mapL1SenderContractAddressToL2Alias (_sender: TAddress, unused: TAddress): Promise<TAddress> {
        return this.$read(this.$getAbiItem('function', 'mapL1SenderContractAddressToL2Alias'), _sender, unused);
    }

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

    // 0x7aeecd2a
    async sendMerkleTreeState (): Promise<{ size: bigint, root: TEth.Hex, partials: TEth.Hex[] }> {
        return this.$read(this.$getAbiItem('function', 'sendMerkleTreeState'));
    }

    // 0x928c169a
    async sendTxToL1 (sender: TSender, destination: TAddress, data: TEth.Hex): Promise<TxWriter> {
        return this.$write(this.$getAbiItem('function', 'sendTxToL1'), sender, destination, data);
    }

    // 0x175a260b
    async wasMyCallersAddressAliased (): Promise<boolean> {
        return this.$read(this.$getAbiItem('function', 'wasMyCallersAddressAliased'));
    }

    // 0x25e16063
    async withdrawEth (sender: TSender, destination: TAddress): Promise<TxWriter> {
        return this.$write(this.$getAbiItem('function', 'withdrawEth'), sender, destination);
    }

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

    onTransaction <TMethod extends keyof TIArbSysTypes['Methods']> (method: TMethod, options: Parameters<ContractBase['$onTransaction']>[0]): SubjectStream<{
        tx: TEth.Tx
        block: TEth.Block<TEth.Hex>
        calldata: {
            method: TMethod
            arguments: TIArbSysTypes['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;
    }

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

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

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

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

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

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

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

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

    async getPastLogsSendMerkleUpdate (options?: {
        fromBlock?: number | Date
        toBlock?: number | Date
        params?: { reserved?: bigint,hash?: TEth.Hex,position?: bigint }
    }): Promise<ITxLogItem<TEventParams<'SendMerkleUpdate'>>[]> {
        return await this.$getPastLogsParsed('SendMerkleUpdate', options) as any;
    }

    abi: TAbiItem[] = [{"anonymous":false,"inputs":[{"indexed":false,"internalType":"address","name":"caller","type":"address"},{"indexed":true,"internalType":"address","name":"destination","type":"address"},{"indexed":true,"internalType":"uint256","name":"uniqueId","type":"uint256"},{"indexed":true,"internalType":"uint256","name":"batchNumber","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"indexInBatch","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"arbBlockNum","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"ethBlockNum","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"timestamp","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"callvalue","type":"uint256"},{"indexed":false,"internalType":"bytes","name":"data","type":"bytes"}],"name":"L2ToL1Transaction","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"address","name":"caller","type":"address"},{"indexed":true,"internalType":"address","name":"destination","type":"address"},{"indexed":true,"internalType":"uint256","name":"hash","type":"uint256"},{"indexed":true,"internalType":"uint256","name":"position","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"arbBlockNum","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"ethBlockNum","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"timestamp","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"callvalue","type":"uint256"},{"indexed":false,"internalType":"bytes","name":"data","type":"bytes"}],"name":"L2ToL1Tx","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"uint256","name":"reserved","type":"uint256"},{"indexed":true,"internalType":"bytes32","name":"hash","type":"bytes32"},{"indexed":true,"internalType":"uint256","name":"position","type":"uint256"}],"name":"SendMerkleUpdate","type":"event"},{"inputs":[{"internalType":"uint256","name":"arbBlockNum","type":"uint256"}],"name":"arbBlockHash","outputs":[{"internalType":"bytes32","name":"","type":"bytes32"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"arbBlockNumber","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"arbChainID","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"arbOSVersion","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"getStorageGasAvailable","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"isTopLevelCall","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"sender","type":"address"},{"internalType":"address","name":"unused","type":"address"}],"name":"mapL1SenderContractAddressToL2Alias","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"pure","type":"function"},{"inputs":[],"name":"myCallersAddressWithoutAliasing","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"sendMerkleTreeState","outputs":[{"internalType":"uint256","name":"size","type":"uint256"},{"internalType":"bytes32","name":"root","type":"bytes32"},{"internalType":"bytes32[]","name":"partials","type":"bytes32[]"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"destination","type":"address"},{"internalType":"bytes","name":"data","type":"bytes"}],"name":"sendTxToL1","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"payable","type":"function"},{"inputs":[],"name":"wasMyCallersAddressAliased","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"destination","type":"address"}],"name":"withdrawEth","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"payable","type":"function"}]


}

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

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

export type TIArbSysTypes = {
    Events: {
        L2ToL1Transaction: {
            outputParams: { caller: TAddress, destination: TAddress, uniqueId: bigint, batchNumber: bigint, indexInBatch: bigint, arbBlockNum: bigint, ethBlockNum: bigint, timestamp: bigint, callvalue: bigint, data: TEth.Hex },
            outputArgs:   [ caller: TAddress, destination: TAddress, uniqueId: bigint, batchNumber: bigint, indexInBatch: bigint, arbBlockNum: bigint, ethBlockNum: bigint, timestamp: bigint, callvalue: bigint, data: TEth.Hex ],
        }
        L2ToL1Tx: {
            outputParams: { caller: TAddress, destination: TAddress, hash: bigint, position: bigint, arbBlockNum: bigint, ethBlockNum: bigint, timestamp: bigint, callvalue: bigint, data: TEth.Hex },
            outputArgs:   [ caller: TAddress, destination: TAddress, hash: bigint, position: bigint, arbBlockNum: bigint, ethBlockNum: bigint, timestamp: bigint, callvalue: bigint, data: TEth.Hex ],
        }
        SendMerkleUpdate: {
            outputParams: { reserved: bigint, hash: TEth.Hex, position: bigint },
            outputArgs:   [ reserved: bigint, hash: TEth.Hex, position: bigint ],
        }
    },
    Methods: {
        arbBlockHash: {
          method: "arbBlockHash"
          arguments: [ arbBlockNum: bigint ]
        }
        arbBlockNumber: {
          method: "arbBlockNumber"
          arguments: [  ]
        }
        arbChainID: {
          method: "arbChainID"
          arguments: [  ]
        }
        arbOSVersion: {
          method: "arbOSVersion"
          arguments: [  ]
        }
        getStorageGasAvailable: {
          method: "getStorageGasAvailable"
          arguments: [  ]
        }
        isTopLevelCall: {
          method: "isTopLevelCall"
          arguments: [  ]
        }
        mapL1SenderContractAddressToL2Alias: {
          method: "mapL1SenderContractAddressToL2Alias"
          arguments: [ _sender: TAddress, unused: TAddress ]
        }
        myCallersAddressWithoutAliasing: {
          method: "myCallersAddressWithoutAliasing"
          arguments: [  ]
        }
        sendMerkleTreeState: {
          method: "sendMerkleTreeState"
          arguments: [  ]
        }
        sendTxToL1: {
          method: "sendTxToL1"
          arguments: [ destination: TAddress, data: TEth.Hex ]
        }
        wasMyCallersAddressAliased: {
          method: "wasMyCallersAddressAliased"
          arguments: [  ]
        }
        withdrawEth: {
          method: "withdrawEth"
          arguments: [ destination: TAddress ]
        }
    }
}



interface IIArbSysTxCaller {
    sendTxToL1 (sender: TSender, destination: TAddress, data: TEth.Hex): Promise<{ error?: Error & { data?: { type: string, params } }, result? }>
    withdrawEth (sender: TSender, destination: TAddress): Promise<{ error?: Error & { data?: { type: string, params } }, result? }>
}


interface IIArbSysTxData {
    sendTxToL1 (sender: TSender, destination: TAddress, data: TEth.Hex): Promise<TEth.TxLike>
    withdrawEth (sender: TSender, destination: TAddress): Promise<TEth.TxLike>
}


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