JSPM

@polkadot/api-derive

16.0.1
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 153018
  • Score
    100M100P100Q179352F
  • License Apache-2.0

Common functions used across Polkadot, derived from RPC calls and storage queries.

Package Exports

  • @polkadot/api-derive
  • @polkadot/api-derive/accounts
  • @polkadot/api-derive/accounts/accountId
  • @polkadot/api-derive/accounts/flags
  • @polkadot/api-derive/accounts/idAndIndex
  • @polkadot/api-derive/accounts/idToIndex
  • @polkadot/api-derive/accounts/identity
  • @polkadot/api-derive/accounts/indexToId
  • @polkadot/api-derive/accounts/indexes
  • @polkadot/api-derive/accounts/info
  • @polkadot/api-derive/accounts/types
  • @polkadot/api-derive/alliance
  • @polkadot/api-derive/augment
  • @polkadot/api-derive/bagsList
  • @polkadot/api-derive/bagsList/get
  • @polkadot/api-derive/bagsList/getExpanded
  • @polkadot/api-derive/bagsList/listNodes
  • @polkadot/api-derive/bagsList/types
  • @polkadot/api-derive/bagsList/util
  • @polkadot/api-derive/balances
  • @polkadot/api-derive/balances/account
  • @polkadot/api-derive/balances/all
  • @polkadot/api-derive/balances/types
  • @polkadot/api-derive/balances/votingBalances
  • @polkadot/api-derive/bounties
  • @polkadot/api-derive/bounties/bounties
  • @polkadot/api-derive/bounties/helpers/filterBountyProposals
  • @polkadot/api-derive/bundle
  • @polkadot/api-derive/chain
  • @polkadot/api-derive/chain/bestNumber
  • @polkadot/api-derive/chain/bestNumberFinalized
  • @polkadot/api-derive/chain/bestNumberLag
  • @polkadot/api-derive/chain/getBlock
  • @polkadot/api-derive/chain/getBlockByNumber
  • @polkadot/api-derive/chain/getHeader
  • @polkadot/api-derive/chain/subscribeFinalizedBlocks
  • @polkadot/api-derive/chain/subscribeFinalizedHeads
  • @polkadot/api-derive/chain/subscribeNewBlocks
  • @polkadot/api-derive/chain/subscribeNewHeads
  • @polkadot/api-derive/chain/util
  • @polkadot/api-derive/cjs/accounts/accountId
  • @polkadot/api-derive/cjs/accounts/flags
  • @polkadot/api-derive/cjs/accounts/idAndIndex
  • @polkadot/api-derive/cjs/accounts/idToIndex
  • @polkadot/api-derive/cjs/accounts/identity
  • @polkadot/api-derive/cjs/accounts/index
  • @polkadot/api-derive/cjs/accounts/indexToId
  • @polkadot/api-derive/cjs/accounts/indexes
  • @polkadot/api-derive/cjs/accounts/info
  • @polkadot/api-derive/cjs/accounts/types
  • @polkadot/api-derive/cjs/alliance/index
  • @polkadot/api-derive/cjs/augment
  • @polkadot/api-derive/cjs/bagsList/get
  • @polkadot/api-derive/cjs/bagsList/getExpanded
  • @polkadot/api-derive/cjs/bagsList/index
  • @polkadot/api-derive/cjs/bagsList/listNodes
  • @polkadot/api-derive/cjs/bagsList/types
  • @polkadot/api-derive/cjs/bagsList/util
  • @polkadot/api-derive/cjs/balances/account
  • @polkadot/api-derive/cjs/balances/all
  • @polkadot/api-derive/cjs/balances/index
  • @polkadot/api-derive/cjs/balances/types
  • @polkadot/api-derive/cjs/balances/votingBalances
  • @polkadot/api-derive/cjs/bounties/bounties
  • @polkadot/api-derive/cjs/bounties/helpers/filterBountyProposals
  • @polkadot/api-derive/cjs/bounties/index
  • @polkadot/api-derive/cjs/bundle
  • @polkadot/api-derive/cjs/chain/bestNumber
  • @polkadot/api-derive/cjs/chain/bestNumberFinalized
  • @polkadot/api-derive/cjs/chain/bestNumberLag
  • @polkadot/api-derive/cjs/chain/getBlock
  • @polkadot/api-derive/cjs/chain/getBlockByNumber
  • @polkadot/api-derive/cjs/chain/getHeader
  • @polkadot/api-derive/cjs/chain/index
  • @polkadot/api-derive/cjs/chain/subscribeFinalizedBlocks
  • @polkadot/api-derive/cjs/chain/subscribeFinalizedHeads
  • @polkadot/api-derive/cjs/chain/subscribeNewBlocks
  • @polkadot/api-derive/cjs/chain/subscribeNewHeads
  • @polkadot/api-derive/cjs/chain/util
  • @polkadot/api-derive/cjs/collective/helpers
  • @polkadot/api-derive/cjs/collective/index
  • @polkadot/api-derive/cjs/collective/members
  • @polkadot/api-derive/cjs/collective/prime
  • @polkadot/api-derive/cjs/collective/proposals
  • @polkadot/api-derive/cjs/collective/types
  • @polkadot/api-derive/cjs/contracts/fees
  • @polkadot/api-derive/cjs/contracts/index
  • @polkadot/api-derive/cjs/council/index
  • @polkadot/api-derive/cjs/council/types
  • @polkadot/api-derive/cjs/council/votes
  • @polkadot/api-derive/cjs/council/votesOf
  • @polkadot/api-derive/cjs/crowdloan/childKey
  • @polkadot/api-derive/cjs/crowdloan/contributions
  • @polkadot/api-derive/cjs/crowdloan/index
  • @polkadot/api-derive/cjs/crowdloan/ownContributions
  • @polkadot/api-derive/cjs/crowdloan/types
  • @polkadot/api-derive/cjs/crowdloan/util
  • @polkadot/api-derive/cjs/democracy/dispatchQueue
  • @polkadot/api-derive/cjs/democracy/index
  • @polkadot/api-derive/cjs/democracy/locks
  • @polkadot/api-derive/cjs/democracy/nextExternal
  • @polkadot/api-derive/cjs/democracy/preimages
  • @polkadot/api-derive/cjs/democracy/proposals
  • @polkadot/api-derive/cjs/democracy/referendumIds
  • @polkadot/api-derive/cjs/democracy/referendums
  • @polkadot/api-derive/cjs/democracy/referendumsActive
  • @polkadot/api-derive/cjs/democracy/referendumsFinished
  • @polkadot/api-derive/cjs/democracy/referendumsInfo
  • @polkadot/api-derive/cjs/democracy/sqrtElectorate
  • @polkadot/api-derive/cjs/democracy/types
  • @polkadot/api-derive/cjs/democracy/util
  • @polkadot/api-derive/cjs/derive
  • @polkadot/api-derive/cjs/elections/index
  • @polkadot/api-derive/cjs/elections/info
  • @polkadot/api-derive/cjs/elections/types
  • @polkadot/api-derive/cjs/imOnline/index
  • @polkadot/api-derive/cjs/imOnline/receivedHeartbeats
  • @polkadot/api-derive/cjs/index
  • @polkadot/api-derive/cjs/membership/index
  • @polkadot/api-derive/cjs/package.json
  • @polkadot/api-derive/cjs/packageDetect
  • @polkadot/api-derive/cjs/packageInfo
  • @polkadot/api-derive/cjs/parachains/index
  • @polkadot/api-derive/cjs/parachains/info
  • @polkadot/api-derive/cjs/parachains/overview
  • @polkadot/api-derive/cjs/parachains/types
  • @polkadot/api-derive/cjs/parachains/util
  • @polkadot/api-derive/cjs/session/index
  • @polkadot/api-derive/cjs/session/indexes
  • @polkadot/api-derive/cjs/session/info
  • @polkadot/api-derive/cjs/session/progress
  • @polkadot/api-derive/cjs/session/types
  • @polkadot/api-derive/cjs/society/candidates
  • @polkadot/api-derive/cjs/society/index
  • @polkadot/api-derive/cjs/society/info
  • @polkadot/api-derive/cjs/society/member
  • @polkadot/api-derive/cjs/society/members
  • @polkadot/api-derive/cjs/society/types
  • @polkadot/api-derive/cjs/staking/account
  • @polkadot/api-derive/cjs/staking/cache
  • @polkadot/api-derive/cjs/staking/currentPoints
  • @polkadot/api-derive/cjs/staking/electedInfo
  • @polkadot/api-derive/cjs/staking/erasExposure
  • @polkadot/api-derive/cjs/staking/erasHistoric
  • @polkadot/api-derive/cjs/staking/erasPoints
  • @polkadot/api-derive/cjs/staking/erasPrefs
  • @polkadot/api-derive/cjs/staking/erasRewards
  • @polkadot/api-derive/cjs/staking/erasSlashes
  • @polkadot/api-derive/cjs/staking/index
  • @polkadot/api-derive/cjs/staking/keys
  • @polkadot/api-derive/cjs/staking/overview
  • @polkadot/api-derive/cjs/staking/ownExposure
  • @polkadot/api-derive/cjs/staking/ownSlashes
  • @polkadot/api-derive/cjs/staking/query
  • @polkadot/api-derive/cjs/staking/stakerExposure
  • @polkadot/api-derive/cjs/staking/stakerPoints
  • @polkadot/api-derive/cjs/staking/stakerPrefs
  • @polkadot/api-derive/cjs/staking/stakerRewards
  • @polkadot/api-derive/cjs/staking/stakerSlashes
  • @polkadot/api-derive/cjs/staking/stashes
  • @polkadot/api-derive/cjs/staking/types
  • @polkadot/api-derive/cjs/staking/util
  • @polkadot/api-derive/cjs/staking/validators
  • @polkadot/api-derive/cjs/staking/waitingInfo
  • @polkadot/api-derive/cjs/technicalCommittee/index
  • @polkadot/api-derive/cjs/treasury/index
  • @polkadot/api-derive/cjs/treasury/proposals
  • @polkadot/api-derive/cjs/tx/constants
  • @polkadot/api-derive/cjs/tx/events
  • @polkadot/api-derive/cjs/tx/extrinsicInfo
  • @polkadot/api-derive/cjs/tx/index
  • @polkadot/api-derive/cjs/tx/signingInfo
  • @polkadot/api-derive/cjs/type/HeaderExtended
  • @polkadot/api-derive/cjs/type/SignedBlockExtended
  • @polkadot/api-derive/cjs/type/index
  • @polkadot/api-derive/cjs/type/types
  • @polkadot/api-derive/cjs/type/util
  • @polkadot/api-derive/cjs/types
  • @polkadot/api-derive/cjs/util/approvalFlagsToBools
  • @polkadot/api-derive/cjs/util/blockNumber
  • @polkadot/api-derive/cjs/util/cache
  • @polkadot/api-derive/cjs/util/cacheImpl
  • @polkadot/api-derive/cjs/util/first
  • @polkadot/api-derive/cjs/util/index
  • @polkadot/api-derive/cjs/util/lazy
  • @polkadot/api-derive/cjs/util/types
  • @polkadot/api-derive/collective
  • @polkadot/api-derive/collective/helpers
  • @polkadot/api-derive/collective/members
  • @polkadot/api-derive/collective/prime
  • @polkadot/api-derive/collective/proposals
  • @polkadot/api-derive/collective/types
  • @polkadot/api-derive/contracts
  • @polkadot/api-derive/contracts/fees
  • @polkadot/api-derive/council
  • @polkadot/api-derive/council/types
  • @polkadot/api-derive/council/votes
  • @polkadot/api-derive/council/votesOf
  • @polkadot/api-derive/crowdloan
  • @polkadot/api-derive/crowdloan/childKey
  • @polkadot/api-derive/crowdloan/contributions
  • @polkadot/api-derive/crowdloan/ownContributions
  • @polkadot/api-derive/crowdloan/types
  • @polkadot/api-derive/crowdloan/util
  • @polkadot/api-derive/democracy
  • @polkadot/api-derive/democracy/dispatchQueue
  • @polkadot/api-derive/democracy/locks
  • @polkadot/api-derive/democracy/nextExternal
  • @polkadot/api-derive/democracy/preimages
  • @polkadot/api-derive/democracy/proposals
  • @polkadot/api-derive/democracy/referendumIds
  • @polkadot/api-derive/democracy/referendums
  • @polkadot/api-derive/democracy/referendumsActive
  • @polkadot/api-derive/democracy/referendumsFinished
  • @polkadot/api-derive/democracy/referendumsInfo
  • @polkadot/api-derive/democracy/sqrtElectorate
  • @polkadot/api-derive/democracy/types
  • @polkadot/api-derive/democracy/util
  • @polkadot/api-derive/derive
  • @polkadot/api-derive/elections
  • @polkadot/api-derive/elections/info
  • @polkadot/api-derive/elections/types
  • @polkadot/api-derive/imOnline
  • @polkadot/api-derive/imOnline/receivedHeartbeats
  • @polkadot/api-derive/membership
  • @polkadot/api-derive/package.json
  • @polkadot/api-derive/packageDetect
  • @polkadot/api-derive/packageInfo
  • @polkadot/api-derive/packageInfo.js
  • @polkadot/api-derive/parachains
  • @polkadot/api-derive/parachains/info
  • @polkadot/api-derive/parachains/overview
  • @polkadot/api-derive/parachains/types
  • @polkadot/api-derive/parachains/util
  • @polkadot/api-derive/session
  • @polkadot/api-derive/session/indexes
  • @polkadot/api-derive/session/info
  • @polkadot/api-derive/session/progress
  • @polkadot/api-derive/session/types
  • @polkadot/api-derive/society
  • @polkadot/api-derive/society/candidates
  • @polkadot/api-derive/society/info
  • @polkadot/api-derive/society/member
  • @polkadot/api-derive/society/members
  • @polkadot/api-derive/society/types
  • @polkadot/api-derive/staking
  • @polkadot/api-derive/staking/account
  • @polkadot/api-derive/staking/cache
  • @polkadot/api-derive/staking/currentPoints
  • @polkadot/api-derive/staking/electedInfo
  • @polkadot/api-derive/staking/erasExposure
  • @polkadot/api-derive/staking/erasHistoric
  • @polkadot/api-derive/staking/erasPoints
  • @polkadot/api-derive/staking/erasPrefs
  • @polkadot/api-derive/staking/erasRewards
  • @polkadot/api-derive/staking/erasSlashes
  • @polkadot/api-derive/staking/keys
  • @polkadot/api-derive/staking/overview
  • @polkadot/api-derive/staking/ownExposure
  • @polkadot/api-derive/staking/ownSlashes
  • @polkadot/api-derive/staking/query
  • @polkadot/api-derive/staking/stakerExposure
  • @polkadot/api-derive/staking/stakerPoints
  • @polkadot/api-derive/staking/stakerPrefs
  • @polkadot/api-derive/staking/stakerRewards
  • @polkadot/api-derive/staking/stakerSlashes
  • @polkadot/api-derive/staking/stashes
  • @polkadot/api-derive/staking/types
  • @polkadot/api-derive/staking/util
  • @polkadot/api-derive/staking/validators
  • @polkadot/api-derive/staking/waitingInfo
  • @polkadot/api-derive/technicalCommittee
  • @polkadot/api-derive/treasury
  • @polkadot/api-derive/treasury/proposals
  • @polkadot/api-derive/tx
  • @polkadot/api-derive/tx/constants
  • @polkadot/api-derive/tx/events
  • @polkadot/api-derive/tx/extrinsicInfo
  • @polkadot/api-derive/tx/signingInfo
  • @polkadot/api-derive/type
  • @polkadot/api-derive/type/HeaderExtended
  • @polkadot/api-derive/type/SignedBlockExtended
  • @polkadot/api-derive/type/types
  • @polkadot/api-derive/type/util
  • @polkadot/api-derive/types
  • @polkadot/api-derive/util
  • @polkadot/api-derive/util/approvalFlagsToBools
  • @polkadot/api-derive/util/blockNumber
  • @polkadot/api-derive/util/cache
  • @polkadot/api-derive/util/cacheImpl
  • @polkadot/api-derive/util/first
  • @polkadot/api-derive/util/lazy
  • @polkadot/api-derive/util/types

Readme

@polkadot/api-derive

Collection of high-level utility functions built on top of the @polkadot/api library. Designed to simplify the process of querying complex on-chain data by combining multiple RPC calls, storage queries, and runtime logic into a single, callable function.

Instead of manually fetching and processing blockchain data, developers can use api.derive methods to retrieve information.

Available Derive Namespaces

The derive functions are categorized into namespaces based on different common Substrate modules. Accesible by calling api.derive.NAMESPACE (e.g. api.derive.balances). The available modules are as follows: