Releases: polkadot-js/api
Releases · polkadot-js/api
v1.16.1
- Support for Polkadot CC1 types & signed extensions
- Add support for Babe VRF secondary digests (author extraction)
- Adjust
Perbill/Permill
toHuman()
formatting to output percentage - Support for latest Substrate types & metadata
- Update to latest TypeScript, eslint & typescript-eslint
@polkadot/util
2.11
v1.15.1
- Adjust
keyPrefix()
with DoubleMap args (Thanks to https://github.com/KiChjang) - Added
WeightToFeeCoefficient
type (Thanks to https://github.com/danforbes) - Spelling fixes for console logs (Thanks to https://github.com/JoshOrndorff)
- Spelling fixes in cookbook (Thanks to https://github.com/pawelnguyen)
- Add
transactionVersion
getter in payloads (Thanks to https://github.com/amaurymartiny) - Adjust
stakerRewards
derive ordering for improved on-payout refreshes - Baseline implementation for derive caching infrastructure
- Adjust
Multiplier
type toFixed128
(as per latest Substrate) - Updated to latest Substrate metadata & add new types
v1.14.1
- Important
DispatchInfo
changedpaysFee
to an enum, if using an older version use,DispatchInfo: 'DispatchInfoTo244'
- Align imOnline
Heartbeat
with Substrate (Thanks to https://github.com/arjanz) - Adust EVM types to include
Vicinity
(Thanks to https://github.com/drewstone) - Add
derive.democracy.locks
to return extended lock info based on votes - Ensure metadata is only requested once upon startup (bypass on upgrade subscriptions)
- Expand testing around
ExtrinsicEra
construction - Expand
Registry
to direct access to available signed extensions (in addition to exposed types) - Cater for new
CheckSpecVersion
andCheckTxVersion
signed extensions (withSignerPayload
adjustments) - Cater for new
PrevalidateAttests
signed extensions (Polkadot claims) - Don't re-calculate submittable extrinsic hash on status checks (optimization)
- Support for both old/new Tuples in
democracy.depositOf
in derives - Fix democracy
ProxyState
types - Extends types for Polkadot claims
- Update
@polkadot/util
to 2.10
v1.13.1
- Add support for ECDSA keypairs in extrinsic signers (Thanks to https://github.com/akru)
- Rework type generation to use templating for better maintenance (Thanks to https://github.com/xlc)
- Adjust extrinsic
sign/signAsync
signature to optional options (Thanks to https://github.com/KiChjang) - Support round-robin endpoints in the
WsProvider
with array of urls (Thanks to https://github.com/hoani) - Remove static test-only metadata for Polkadot dev chains (not updated regularly, Substrate dev to remain)
- Revert error swallow for wrong preimage data (temp. override for Kusama upgrade with no migration)
- Fix
.encodedLength
calculation on[Type; N]
types - Add new
rpc.grandpa.roundState
RPC - Update types & metadata as per latest Substrate master
- Adjust Centrifuge starting version
v1.12.1
- Fix
CompactAssignments
types (Thanks to https://github.com/arjanz) - Provider ayo-connect now allows for interval config (Thanks to https://github.com/jnaviask)
- Cleanup generation for c-like enums (Thanks to https://github.com/monitz87)
- Allow subscription to all storage keys, alignment with Substrate (Thanks to https://github.com/xlc)
- Cater for vote delegations in democracy derives
- Cleanup account derive flags where to allow for optional council modules
- Allow generic types in ApiPromise.combineLatest
- Update to latest substrate metadata
v1.11.1
- Important Substrate master has an updated
Weight
(tou64
), on older chains applyWeight: 'u32'
(This does affect event decoding if wrongly set) - Allow user type augmentation to work with different versions of rxjs (Thanks to https://github.com/monitz87)
- Align augmented generation with camelCase (Thanks to https://github.com/monitz87)
- Fix bitfield endian encoding (Thanks to investigation by https://github.com/xlc)
- Add account flag derives via
accounts.flags(accountId)
(Thanks to https://github.com/kwingram25) - Fix entries decoding for
Option<Number>
(& simplify, decoding correctly on rpc layer) - Add
system.{localPeerId, localListenAddresses}
&state.getReadProof
RPCs - Ensure proper propagation of
api.runtimeVersion
(used for signing) after upgrade - Field ordering fix for deprecated
Linkage
(used in linked maps) derive.account.info
now returns all field enum types decoded (not only raw)- Add banner with FAQ entries for node-template to aid with common issues
Digest
has been moved to definitions, removal ofGenericDigest
type- Support
Fixed128
type - Add
transactionVersion
toRuntimeVersion
struct - Enhance API support for non-subscription providers (skip subscription to runtimeVersion)
- Adjust types for Kusama 1057 (notably the new
StakingLedger
)
v1.10.1
- Important Substrate master has updated staking, on older chains apply
StakingLedger: 'StakingLedgerTo240'
- Add
rpc.system.chainType
to retrieve the chain type (Development. Local, Live & Custom) - Adjust types for Westend after the reset
- Adjust democracy derives, including the support of the frame-scheduler for scheduled deployments
- Allow staking derives to work with new staking payouts, specifically
tx.staking.payoutStakers
- Cleanups to derives for democracy & staking to be more performant
- Add Centrifuge base types to
@polkadot/types-known
- Adjust with all the latest substrate master types
- Internally all private/protected methods/variables are now
_
prefixed (Aligning with theprivate/protected
indicators in the TS definitions) - Update metadata/docs-from-metadata to the latest Substrate
v1.9.1
- Breaking change (TypeScript with derives only) The return type names for
api.derive.*
have been adjusted for consistency, all starting withDerive*
(previously a mixture ofDerived*
andDerive*
) - Breaking change (derives only) Additional cleanups of democracy proposal & referenda derives, including support for new Polkadot/Substrate vote retrievals
- Tx signing via
signAndSend
&signAsync
now tries to use the last finalized block (depending on finalized drift) - Add support for
api.rpc.childstate.*
Substrate RPCs, older nodes with still populateapi.rpc.state.*
with the child methods - Adjust
Error.message
on RPC failures to not include the (already known) method signature - Split
@polkadot/types/known
into@polkadot/types-known
, allowing for base API overrides - Extended
api.derive.democracy
to cater for dispatchQueue and externals - Extended
api.derive.council
to cater for new phragmen elections - Use new
queryStorageAt
for query.entries
, removing unneeded subscriptions (use as available) - Fix
BTreeSet
initialization when it forms part of query interfaces - Fix encoding for
Vec<u8>
-related types as part of constants - Internal adjustment of interface type locations (no impact on imports via
@polkadot/types/interfaces
)
v1.8.1
- Breaking change The format for any custom RPCs have been changed alongside API-internal changes to allow for better RPC management. If you are currently using custom RPCs (or planning to do so), look at the updated documentation
- Breaking change Alongside API RPC changes, the
@polkadot/jsonrpc
package has been removed. Since it was never documented and only used internally, this should not have adverse impacts. All RPC definitions itself has now been moved to the relevant modules inside@polkadot/types/interfaces
- Important Substrate has an updated democracy module. If using an older chain add the
ReferendumInfo: 'ReferendumInfoTo239'
type when using referendums - The
isRetracted
Extrinsic status is now a warning, not a fatal error, correctly aligning with Polkadot/Substrate - The Substrate extrinsic phase definitions has been expanded with
Initialization
to align with the latest versions - Add support for all known substrate RPC methods
- Extend account derives to include status flags, e.g.
isCouncil
,isSudo
, ... - Adjusted referendum derives to cater for bot new/old democracy. Derived
referendumInfo
now includesstatus
field, notinfo
- Add
initWasm
flag to API options, that when set tofalse
does not init the WASM portion (leaving it to the user elsewhere)
v1.7.1
- Important Current versions of Polkadot/Substrate have dropped support for linked maps on storage entries. If you are using these queries to retrieve all entries, for instance
staking.{nominators,validators}()
and using an upgraded chain, you need to swap to retrieving entries via.entries()
or.keys()
for the keys. - Pull in support and types for latest Polkadot/Substrate
- Add support for the new Substrate
state_getKeysPaged
RPC, including use in storage keys - Move
derive.staking.controllers
toderive.staking.stashes
, reflecting actual content - Cater for adjusted storage (non-linked mapped) for
derive.staking.stashes
queries (with old-compat) - Expanded
derive.staking.*
derives, including addition ofderive.staking.own*
- Re-add fixed (with tests) checks for query args, previously disabled in 1.6.2