Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IbcAPI

Hierarchy

  • BaseAPI
    • IbcAPI

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

lcd

lcd: LCDClient

Methods

channels

  • channels(chainID: string, params?: APIParams): Promise<{ channels: IdentifiedChannel[]; pagination: Pagination }>

  • query all the IBC channels of a chain

    Parameters

    • chainID: string

      chain id

    • params: APIParams = {}

    Returns Promise<{ channels: IdentifiedChannel[]; pagination: Pagination }>

clientState

  • clientState(client_id: string, chainID: string, params?: APIParams): Promise<IdentifiedClientState>

  • query an IBC light client

    Parameters

    • client_id: string

      client state unique identifier

    • chainID: string

      chain id

    • params: APIParams = {}

    Returns Promise<IdentifiedClientState>

clientStates

  • clientStates(chainID: string, params?: Partial<PaginationOptions & APIParams>): Promise<[IdentifiedClientState[], Pagination]>

  • query all the IBC light clients of a chain

    Parameters

    • chainID: string

      chain id

    • params: Partial<PaginationOptions & APIParams> = {}

    Returns Promise<[IdentifiedClientState[], Pagination]>

clientStatus

  • clientStatus(client_id: string, chainID: string, params?: APIParams): Promise<Status>

  • query the status of an IBC light client

    Parameters

    • client_id: string

      client state unique identifier

    • chainID: string

      chain id

    • params: APIParams = {}

    Returns Promise<Status>

connection

  • connection(connection_id: string, chainID: string, params?: APIParams): Promise<IdentifiedConnection>

  • query an IBC connection end

    Parameters

    • connection_id: string

      connection unique identifier

    • chainID: string

      chain id

    • params: APIParams = {}

    Returns Promise<IdentifiedConnection>

connectionChannels

  • connectionChannels(connection_id: string, chainID: string, params?: APIParams): Promise<[Channel[], Height, Pagination]>

  • query all the channels associated with a connection end

    Parameters

    • connection_id: string

      connection unique identifier

    • chainID: string

      chain id

    • params: APIParams = {}

    Returns Promise<[Channel[], Height, Pagination]>

connections

  • connections(chainID: string, params?: APIParams): Promise<[IdentifiedConnection[], Pagination]>

  • query all the IBC connections of a chain

    Parameters

    • chainID: string

      chain id

    • params: APIParams = {}

    Returns Promise<[IdentifiedConnection[], Pagination]>

consensusStates

  • consensusStates(client_id: string, chainID: string, params?: Partial<PaginationOptions & APIParams>): Promise<[ClientConsensusStates, Pagination]>

  • query all the consensus state associated with a given client

    Parameters

    • client_id: string

      client identifier

    • chainID: string

      chain id

    • params: Partial<PaginationOptions & APIParams> = {}

    Returns Promise<[ClientConsensusStates, Pagination]>

getReqFromAddress

  • getReqFromAddress(address: string): APIRequester

getReqFromChainID

  • getReqFromChainID(chainID: string): APIRequester

interchainAccountHostParameters

  • interchainAccountHostParameters(chainID: string, params?: APIParams): Promise<Params>

  • Gets paramaters for interchain account host.

    Parameters

    • chainID: string

      chain id

    • params: APIParams = {}

    Returns Promise<Params>

parameters

port

  • port(channel_id: string, port_id: string, chainID: string, params?: APIParams): Promise<Port>

  • query the information of the port at given channel

    Parameters

    • channel_id: string

      channel identifier

    • port_id: string

      port name

    • chainID: string

      chain id

    • params: APIParams = {}

    Returns Promise<Port>