Releases: polkadot-js/api
Releases · polkadot-js/api
v0.97.1
- Breaking change Add the passing on an explicit
Registry
to all calls tocreateType
as well as all codec classes. If you are upgrading form an older version, use the migration guide to walk through the changes required. - Breaking change The metadata classes have been moved from
@polkadot/types
into@polkadot/metadata
. If you explicitly createMetadata
classes, you now would need to do so with theimport Metadata from '@polkadot/metadata';
This is a decorated class, where the previous metadata is now available onMetadata.metadata
, alongside decoratedconsts.*
',tx.*
andquery.*
. - Breaking change Session
Keys
defaults to 4 keys now (Substrate master), depending on your node config, you would want to override with e.g.Keys: 'SessionKeys3'
(1, 2, 3, 4, 5 & 6) - Breaking change
ValidatorPrefs
now default to the new percentage commission model, to use the previousvalidatorPayment
, you can override withValidatorPrefs: 'ValidatorPrefsTo196'
api.derive.*
now has built-in memomization- Various fixes and cleanups to
api.derive.*
including era length progress and vesting calculations - Aligned all types with the latest Polkadot & Substrate, including Kusama CC3
- Support for Metadata V9, which adjusts the hashing methods of storage entries
- Support for Metadata V10 (still un-released), which includes prefixed map support
v0.96.1
- Updated types for latest Kusama
- Add
filterRecords
(in addition tofindRecord
) on submittable results - Various ABI v2 contract fixes
- Update derive for elections (incl. RunnersUp) and heartbeat derives (with blocks & messages)
- Add vesting totals & locked breakdowns to derive balances
- Update council derives for the latest Substrate master support (with constants)
- Derive cleanups, including sharing of instances between the API and internal to derives
v0.95.2
- Support Extrinsic V4 with additional signature indicator (Latest Polkadot/Substrate/Kusama)
- Adjust subscription update checks to avoid duplicated data updates
- Support Metadata V8 (exposes per-module
decl_error
definitions) - Support next generation contracts ABI (with additional type definitions)
- Support for
BTreeMap<K, V>
types and definitions - All latest Polkadot & Substrate types (as per master branches)
- Breaking change
Call.injectMethods
is moved toCall.injectMetadata
to align withEvents
(This should not be used externally, however mentioned as breaking here)
v0.94.1
- Add handling of
Result<Ok, Error>
definitions - Adjust API cloning now takes RPC filters from source into account
- Simplification of isPedantic checks and less overhead on StorageData types
- Cleanups and fixes around RPC and derive type definitions
- Fix
derive.imOnline.receivedHeatbeats
to query via indexes - Adjustment of
api.derive.elections.{approvalsOf|approvalsOfAt}
to allow ss58 address input - Cleanup
Enum
.eq
handling to be more exhaustive - Add documentation for custom extrinsic formats (advanced chains)
- Update to latest substrate master metadata
v0.93.1
- Support for Kusama CC2
- In extrinsic submission, use
rpc.account.nextIndex
to retrieve the nonce when available - For TypeScript users
api.query.*.*
is now properly typed for default Substrate calls, i.e.api.query.balances.freeBalance(...)
will return aBalance
type. Additionally theapi.queryMulti
and.multi
on queries not allow generic type params. - Add
api.rpc.accounts.nextIndex
,api.rpc.contracts.call
andapi.rpc.rpc.methods
calls. Optional calls (such as account/contracts) is decorated based on the results fromrpc.methods
, so they don't show up on nodes where they are not active. - Updated types to support the latest Polkadot/Substrate master changes
- Support recursive type registration (self-referencing via
Box
) in addition to better sanitation of user-defined-types - Documentation and example updates (thanks mostly to contributions)
v0.92.1
- The API now correctly sets the ss58 prefix as retrieved from the chain properties via
ss58Format
- Bump to
@polkadot/util
1.4.1, removing use ofExtError
- The
Keyring
from@polkadot/keyring
is now exposed on the API as well. You can doimport { Keyring } from '@polkadot/api'
- this alleviates the need for extra dependencies (apart from@polkadot/api
), and since the keyring is critical for signing operations, aligns everything in one bundle - Support the latest Polkadot & Substrate master branches (incl. metadata updates)
- Getting started documentation has been made available
v0.91.1
- This release was focussed on stability, with a number of cleanups and bug-fixes
- Adjustments for Substrate 1.x chain detection (with auto-types) and Substrate 2.x support has been extended with all latest types
- The getRuntimeVersion and subscribeRuntimeVersion RPCs are now only available on the rpc.state.* endpoints. This aligns with the Substrate implementation.
- The author_insertKey RPC's last argument publicKey is now required, as to reflect Substrate implementation.
- Support for extrinsics with versions that is not in the base Substrate implementation (V1-V3) can now be done by providing an implementation for ExtrinsicUnknown
- Redeemed balance calculation if api.derive now returns the correct values again (bugfix)
added the yarn chain:info [--ws URL] utility to extract a calls-only metadata version - Missing types are now logged via a console.warn, not via .error
- Extrinsic, ExtrinsicPayload & SignerPayload is registered in the type registry and can be overriden now