Class LightClientRPC

Hierarchy

LightClientRPC

Index

Constructors

constructor

Methods

Constructors

constructor

new LightClientRPC(uri: string): LightClientRPC

- Defined in packages/light-client/src/rpc.ts:28
Parameters
- uri: string
  
  light client uri
Returns LightClientRPC

Methods

fetchHeader

fetchHeader(blockHash: string): Promise<FetchHeaderResult>

- Defined in packages/light-client/src/rpc.ts:39
Parameters
- blockHash: string
Returns Promise<FetchHeaderResult>

fetchTransaction

fetchTransaction(txHash: string): Promise<FetchTransactionResult>

- Defined in packages/light-client/src/rpc.ts:49
Parameters
- txHash: string
Returns Promise<FetchTransactionResult>

getCells

getCells<WithData>(searchKey: GetCellsSearchKey<WithData>, order: Order, limit: HexString, cursor?: undefined | string): Promise<GetLiveCellsResult<WithData>>

- Defined in packages/light-client/src/rpc.ts:83
Type parameters
- WithData: boolean
Parameters
- searchKey: GetCellsSearchKey<WithData>
- order: Order
- limit: HexString
- Optional cursor: undefined | string
Returns Promise<GetLiveCellsResult<WithData>>

getCellsCapacity

getCellsCapacity(searchKey: SearchKey): Promise<CellsCapacity>

- Defined in packages/light-client/src/rpc.ts:93
Parameters
- searchKey: SearchKey
Returns Promise<CellsCapacity>

getGenesisBlock

getGenesisBlock(): Promise<Block>

- Defined in packages/light-client/src/rpc.ts:102
Returns Promise<Block>

getHeader

getHeader(blockHash: string): Promise<Header>

- Defined in packages/light-client/src/rpc.ts:44
Parameters
- blockHash: string
Returns Promise<Header>

getScripts

getScripts(): Promise<Array<LightClientScript>>

- Defined in packages/light-client/src/rpc.ts:68
Returns Promise<Array<LightClientScript>>

getTipHeader

getTipHeader(): Promise<Header>

- Defined in packages/light-client/src/rpc.ts:35
Returns Promise<Header>

getTransaction

getTransaction(txHash: string): Promise<TransactionWithHeader>

- Defined in packages/light-client/src/rpc.ts:56
Parameters
- txHash: string
Returns Promise<TransactionWithHeader>

getTransactions

getTransactions<Grouped>(searchKey: GetTransactionsSearchKey<Grouped>, order: Order, limit: HexString, cursor?: undefined | string): Promise<LightClientTransactionList<Grouped>>

- Defined in packages/light-client/src/rpc.ts:106
Type parameters
- Grouped: boolean
Parameters
- searchKey: GetTransactionsSearchKey<Grouped>
- order: Order
- limit: HexString
- Optional cursor: undefined | string
Returns Promise<LightClientTransactionList<Grouped>>

sendTransaction

sendTransaction(tx: RawTransaction): Promise<Hash>

- Defined in packages/light-client/src/rpc.ts:61
Parameters
- tx: RawTransaction
Returns Promise<Hash>

setScripts

setScripts(scripts: Array<LightClientScript>): Promise<void>

- Defined in packages/light-client/src/rpc.ts:72
Parameters
- scripts: Array<LightClientScript>
Returns Promise<void>

Generated using TypeDoc