api_client_Network.Network
@polymeshassociation/polymesh-sdk / Modules / api/client/Network / Network
Class: Network
api/client/Network.Network
Handles all Network related functionality, including querying for historical events from middleware
Table of contents
Methods
Methods
getEventByIndexedArgs
▸ getEventByIndexedArgs(opts): Promise<null | EventIdentifier>
Retrieve a single event by any of its indexed arguments. Can be filtered using parameters
note uses the middleware
Parameters
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>
Defined in
getEventsByIndexedArgs
▸ getEventsByIndexedArgs(opts): Promise<null | EventIdentifier[]>
Retrieve a list of events. Can be filtered using parameters
note uses the middleware
Parameters
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[]>
Defined in
getLatestBlock
▸ getLatestBlock(): Promise<BigNumber>
Retrieve the number of the latest block in the chain
Returns
Promise<BigNumber>
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
args
Object
-
args.tags
TxTag[]
list of transaction tags (i.e. [TxTags.asset.CreateAsset, TxTags.asset.RegisterTicker] 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
note uses the middleware
Parameters
opts
Object
-
opts.txHash
string
hash of the transaction
Returns
Promise<null | ExtrinsicDataWithFees>
Defined in
getTreasuryAccount
▸ getTreasuryAccount(): Account
Get the treasury wallet address
Returns
Defined in
getTreasuryBalance
▸ getTreasuryBalance(): Promise<BigNumber>
Get the Treasury POLYX balance
note can be subscribed to
Returns
Promise<BigNumber>
Defined in
▸ getTreasuryBalance(callback): Promise<UnsubCallback>
Parameters
callback
SubCallback<BigNumber>
Returns
Promise<UnsubCallback>
Defined in
getVersion
▸ getVersion(): Promise<string>
Fetch the current network version (i.e. 3.1.0)
Returns
Promise<string>
Defined in
transferPolyx
▸ transferPolyx(args, opts?): Promise<TransactionQueue<void, void, unknown[][]>>
Transfer an amount of POLYX to a specified Account
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
Parameters
opts?
Returns
Promise<TransactionQueue<void, void, unknown[][]>>
Defined in
Last updated
Was this helpful?