Options
All
  • Public
  • Public/Protected
  • All
Menu

@web3-systems/react-multichain

Index

Namespaces

Enumerations

Interfaces

Variables

Functions

Variables

IsDatabaseClientReady

IsDatabaseClientReady: { defaultProps: { IsReady: string; NotReady: string; label: string } } = ...

Type declaration

    • (__namedParameters: IsDatabaseClientReadyProps): Element

    • Parameters

      • __namedParameters: IsDatabaseClientReadyProps

      Returns Element

  • defaultProps: { IsReady: string; NotReady: string; label: string }
    • IsReady: string
    • NotReady: string
    • label: string

IsProviderClientReady

IsProviderClientReady: { defaultProps: { IsReady: string; NotReady: string; label: string } } = ...

Type declaration

    • (__namedParameters: IsProviderClientReadyProps): Element

    • Parameters

      • __namedParameters: IsProviderClientReadyProps

      Returns Element

  • defaultProps: { IsReady: string; NotReady: string; label: string }
    • IsReady: string
    • NotReady: string
    • label: string

IsScannerClientReady

IsScannerClientReady: { defaultProps: { IsReady: string; NotReady: string; label: string } } = ...

Type declaration

    • (__namedParameters: IsScannerClientReadyProps): Element

    • Parameters

      • __namedParameters: IsScannerClientReadyProps

      Returns Element

  • defaultProps: { IsReady: string; NotReady: string; label: string }
    • IsReady: string
    • NotReady: string
    • label: string

MultiChainContext

MultiChainContext: Context<{ isDatabaseClientReady: boolean; isProviderClientReady: boolean; isReady: boolean; isScannerClientReady: boolean; observers: any; getDatabase: any; getDatabaseClient: any; getProvider: any; getProviderClient: any; getScanner: any; getScannerClient: any }> = ...

Functions

AccountsTable

  • AccountsTable(__namedParameters: AccountsTableProps): Element

Const ContractsAddressListSearchAndImport

  • ContractsAddressListSearchAndImport(__namedParameters: ContractsAddressListSearchAndImportProps): Element

ContractsTable

  • ContractsTable(__namedParameters: ContractsTableProps): Element

Const DatabaseListCollections

  • DatabaseListCollections(__namedParameters: DatabaseListCollectionsProps): Element

Const DeleteDocument

  • DeleteDocument(__namedParameters: DeleteDocumentProps): Element

MultiChainProvider

  • MultiChainProvider(props: MultiChainProviderProps): ReactNode
  • name

    MultiChainProvider

    description

    State management for reads/writes requests across multiple EVM chains.

    Parameters

    • props: MultiChainProviderProps

    Returns ReactNode

    ReactNode

bulkConstructContract

  • bulkConstructContract(client: undefined | MultiChainDatabaseClient, scannerclient: undefined | MultiscanClient, addresses: string[], keywords: string[], chainId: number, setState: Function): Promise<any>

  • Parameters

    • client: undefined | MultiChainDatabaseClient
    • scannerclient: undefined | MultiscanClient
    • addresses: string[]
    • keywords: string[]
    • chainId: number
    • setState: Function

    Returns Promise<any>

databaseInsert

  • databaseInsert(client: MultichainInMemoryDatabase, collection: string, document: any, chainId: number, setState: any): void

entityBulkPut

  • entityBulkPut(client: undefined | MultiChainDatabaseClient, table: string, documents: any[], chainId: number, setState: Function): Promise<void>

entityFind

  • entityFind(client: undefined | MultiChainDatabaseClient, table: string, _query: any, chainId: number, setState: any): Promise<void>

findOrAddDocumentWithId

  • findOrAddDocumentWithId(client: undefined | MultiChainDatabaseClient, table: string, id: string, chainId?: number): Promise<any>

useBulkConstructContract

  • useBulkConstructContract(addresses: string[], keywords: string[], chainId?: number): HookuseBulkConstructContractsOutput

useBulkGetOrConstructContracts

  • useBulkGetOrConstructContracts(addresses: string, chainId?: number): HookuseBulkConstructContractsOutput

useChain

  • useChain(chainId?: number): HookUseChainOutput
  • name

    useChain

    description

    Connect to the scanner, provider and database for the given chainId.

    Parameters

    • chainId: number = 1

    Returns HookUseChainOutput

    HookUseChainOutput

useClients

  • useClients(chainId?: number): HookUseClientsOutput
  • name

    useClients

    description

    Connect to scanner, provider and database class instances.

    Parameters

    • chainId: number = 1

    Returns HookUseClientsOutput

    HookUseClientsOutput

useClientsInitialized

  • useClientsInitialized(clients: any): any

useDatabaseFind

  • useDatabaseFind(entity: string, query: any, chainId?: number): HookUseDatabaseFind

useDatabaseGetAccounts

  • useDatabaseGetAccounts(query?: any, chainId?: number): HookUseDatabaseGetAccounts

useDatabaseGetContracts

  • useDatabaseGetContracts(query?: any, chainId?: number): HookUseDatabaseGetContracts

useGetAccount

  • useGetAccount(address: string, chainId?: number): HookUseGetAccount
  • name

    useGetAccount

    description

    Fetch account entity

    dev

    Fetches account entity

    Parameters

    • address: string
    • Optional chainId: number

    Returns HookUseGetAccount

useGetAccountTransactions

  • useGetAccountTransactions(address: string, filter?: "from" | "to" | "self" | "all", chainId?: number): HookUseGetAccountTransactionsOutput
  • name

    useGetAccountTransactions

    description

    Fetch inbound/outbound transactions for an account.

    dev

    Fetches transactions from the scanner and database clients. First checking the cache, then fetching from the scanner if the cache is invalid.

    Parameters

    • address: string
    • filter: "from" | "to" | "self" | "all" = 'from'
    • Optional chainId: number

    Returns HookUseGetAccountTransactionsOutput

useGetContract

  • useGetContract(address: string, chainId?: number): HookUseGetContractOutput
  • name

    useGetContract

    description

    Fetch smart contract

    dev

    Fetches smart contract from the database and/or scanner clients.

    Parameters

    • address: string
    • Optional chainId: number

    Returns HookUseGetContractOutput

useIndexedDBEntityDelete

  • useIndexedDBEntityDelete(table: string, id: any, chainId?: number): HookUseIndexedDBEntityDelete

useIndexedDBEntityFilter

  • useIndexedDBEntityFilter(entity: string, query?: any, chainId?: number): HookUseIndexedDBEntityFilter

useIndexedDBEntityList

  • useIndexedDBEntityList(entity: string, chainId?: number): HookUseIndexedDBEntityList

useInitializeDefaultCollections

  • useInitializeDefaultCollections(chainId?: number): boolean

useIsDatabaseClientReady

  • useIsDatabaseClientReady(): boolean

useIsProviderClientReady

  • useIsProviderClientReady(): boolean

useIsScannerClientReady

  • useIsScannerClientReady(): boolean

useMultiChain

useOnDatabaseReady

  • useOnDatabaseReady(action: Function, clientReady: boolean): void

useSyncHookStates

  • useSyncHookStates(setState: Function, meta: any, hookState: any): void

Generated using TypeDoc