3.7 KiB
@polkadot/rpc-provider/https
name: HttpProvider
summary: The HTTP Provider allows sending requests using HTTP to a HTTP RPC server TCP port.
description: It does not support subscriptions so you won't be able to listen to events such as new blocks or balance changes. It is usually preferrable using the WsProvider.
example:
import Api from '@polkadot/api/promise';
import HttpProvider from '@polkadot/rpc-provider/http';
const provider = new HttpProvider('http://127.0.0.1:9933');
const api = new Api(provider);
see: WsProvider
Hierarchy
HttpProvider
Implements
ProviderInterface
Constructors
constructor
⊕ new HttpProvider(endpoint?: string): HttpProvider
Defined in http/index.ts:43
Parameters:
| Param | Type | Default value | Description |
|---|---|---|---|
Default value endpoint |
string |
defaults.HTTP_URL | The endpoint url starting with http:// |
Returns: HttpProvider
Methods
isConnected
▸ isConnected(): boolean
Defined in http/index.ts:60
summary: Whether the node is connected or not.
Returns: boolean
true if connected
on
▸ on(type: ProviderInterface$Emitted, sub: ProviderInterface$EmitCb): void
Defined in http/index.ts:68
summary: Events are not supported with the HttpProvider, see WsProvider.
description: HTTP Provider does not have 'on' emitters. WebSockets should be used instead.
Parameters:
| Param | Type |
|---|---|
| type | ProviderInterface$Emitted |
| sub | ProviderInterface$EmitCb |
Returns: void
send
▸ send(method: string, params: Array<any>): Promise<any>
Defined in http/index.ts:75
summary: Send HTTP POST Request with Body to configured HTTP Endpoint.
Parameters:
| Param | Type |
|---|---|
| method | string |
| params | Array<any> |
Returns: Promise<any>
subscribe
▸ subscribe(types: string, method: string, params: Array<any>, cb: ProviderInterface$Callback): Promise<number>
Defined in http/index.ts:97
summary: Subscriptions are not supported with the HttpProvider, see WsProvider.
Parameters:
| Param | Type |
|---|---|
| types | string |
| method | string |
| params | Array<any> |
| cb | ProviderInterface$Callback |
Returns: Promise<number>
unsubscribe
▸ unsubscribe(type: string, method: string, id: number): Promise<boolean>
Defined in http/index.ts:106
summary: Subscriptions are not supported with the HttpProvider, see WsProvider.
Parameters:
| Param | Type |
|---|---|
| type | string |
| method | string |
| id | number |
Returns: Promise<boolean>