Class: Network
api/client/Network.Network
Handles all Network related functionality, including querying for historical events from middleware
Methods
getEventByIndexedArgs
▸ getEventByIndexedArgs(opts): Promise<null | EventIdentifier>
Retrieve a single event by any of its indexed arguments. Can be filtered using parameters
Parameters
| Name | Type | Description |
|---|---|---|
opts | Object | - |
opts.eventArg0? | string | event parameter value to filter by in position 0 |
opts.eventArg1? | string | event parameter value to filter by in position 1 |
opts.eventArg2? | string | event parameter value to filter by in position 2 |
opts.eventId | EventIdEnum | type of the event to fetch |
opts.moduleId | ModuleIdEnum | type of the module to fetch |
Returns
Promise<null | EventIdentifier>
Note
uses the middlewareV2
Defined in
getEventsByIndexedArgs
▸ getEventsByIndexedArgs(opts): Promise<null | EventIdentifier[]>
Retrieve a list of events. Can be filtered using parameters
Parameters
| Name | Type | Description |
|---|---|---|
opts | Object | - |
opts.eventArg0? | string | event parameter value to filter by in position 0 |
opts.eventArg1? | string | event parameter value to filter by in position 1 |
opts.eventArg2? | string | event parameter value to filter by in position 2 |
opts.eventId | EventIdEnum | type of the event to fetch |
opts.moduleId | ModuleIdEnum | type of the module to fetch |
opts.size? | BigNumber | page size |
opts.start? | BigNumber | page offset |
Returns
Promise<null | EventIdentifier[]>
Note
uses the middlewareV2
Defined in
getLatestBlock
▸ getLatestBlock(): Promise<BigNumber>
Retrieve the number of the latest finalized block in the chain
Returns
Promise<BigNumber>
Defined in
getMiddlewareLag
▸ getMiddlewareLag(): Promise<BigNumber>
Get the number of blocks the middleware needs to process to be synced with chain. The lag can be around somewhere upto 15 blocks, but this can increase if the block size being processed by the Middleware is too large. If the lag is too large, its recommended to check the indexer health to make sure the Middleware is processing the blocks.
Returns
Promise<BigNumber>
Note
uses the middleware V2
Defined in
getMiddlewareMetadata
▸ getMiddlewareMetadata(): Promise<null | MiddlewareMetadata>
Retrieve middleware metadata. Returns null if middleware is disabled
Returns
Promise<null | MiddlewareMetadata>
Note
uses the middleware V2
Defined in
getNetworkProperties
▸ getNetworkProperties(): Promise<NetworkProperties>
Retrieve information for the current network
Returns
Promise<NetworkProperties>
Defined in
getProtocolFees
▸ getProtocolFees(args): Promise<ProtocolFees[]>
Retrieve the protocol fees associated with running specific transactions
Parameters
| Name | Type | Description |
|---|---|---|
args | Object | - |
args.tags | TxTag[] | list of transaction tags (e.g. [TxTags.asset.CreateAsset, TxTags.asset.RegisterUniqueTicker] or ["asset.createAsset", "asset.registerTicker"]) |
Returns
Promise<ProtocolFees[]>
Defined in
getSs58Format
▸ getSs58Format(): BigNumber
Retrieve the chain's SS58 format
Returns
BigNumber
Defined in
getTransactionByHash
▸ getTransactionByHash(opts): Promise<null | ExtrinsicDataWithFees>
Retrieve a transaction by hash
Parameters
| Name | Type | Description |
|---|---|---|
opts | Object | - |
opts.txHash | string | hash of the transaction |
Returns
Promise<null | ExtrinsicDataWithFees>
Note
uses the middlewareV2
Defined in
getTreasuryAccount
▸ getTreasuryAccount(): Account
Get the treasury wallet address
Returns
Defined in
getTreasuryBalance
▸ getTreasuryBalance(): Promise<BigNumber>
Get the Treasury POLYX balance
Returns
Promise<BigNumber>
Note
can be subscribed to, if connected to node using a web socket
Defined in
▸ getTreasuryBalance(callback): Promise<UnsubCallback>
Parameters
| Name | Type |
|---|---|
callback | SubCallback<BigNumber> |
Returns
Promise<UnsubCallback>
Defined in
getVersion
▸ getVersion(): Promise<string>
Fetch the current network version (e.g. 3.1.0)
Returns
Promise<string>
Defined in
submitTransaction
▸ submitTransaction(txPayload, signature): Promise<SubmissionDetails>
Submits a transaction payload with its signature to the chain. signature should be hex encoded
Parameters
| Name | Type |
|---|---|
txPayload | TransactionPayload |
signature | string |
Returns
Promise<SubmissionDetails>
Throws
if the signature is not hex encoded
Defined in
supportsConfidentialAssets
▸ supportsConfidentialAssets(): boolean
Returns whether or not the connected chain node as support for confidential assets
Returns
boolean
Defined in
supportsSubscription
▸ supportsSubscription(): boolean
Returns if functions can be subscribed.
Returns
boolean
true if connected over ws(s)://, otherwise false
Defined in
transferPolyx
▸ transferPolyx(args, opts?): Promise<GenericPolymeshTransaction<void, void>>
Transfer an amount of POLYX to a specified Account
Parameters
| Name | Type |
|---|---|
args | TransferPolyxParams |
opts? | ProcedureOpts |
Returns
Promise<GenericPolymeshTransaction<void, void>>
Note
this method is of type ProcedureMethod, which means you can call transferPolyx.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it