v4.15.1

Upgrade priority: Medium. Recommended for all chains where Xcm is used (addition of new XcmOrigin)

Contributed:

• Added ChargeAssetTxPayment extension (Thanks to https://github.com/apopiak)

Changes:

• Allow for type decoding of nested fixed vectors, tuples and structs
• Added childstate_getKeysPaged RPC
• Add XcmOrigin mapping for OriginCaller generation
• Align static metadata with latest Substrate
• Adjust error message for contracts V3 (extrinsic from runtime)
• Correct module optionality in api.derive.balances.account
• Add alias for GenericAddress -> GenericMultiAddress
• Adjust metadata doc generation (keep spaces between subsequent lines)

v4.14.1

Upgrade priority: Low. Internal adjustment only, no major external usage changes.

Contributed:

• Adjust types for uniques (Thanks to https://github.com/hamidra)
• Add ValidationCodeHash type (Thanks to https://github.com/andresilva)
• Extend OriginCaller type creation (Thanks to https://github.com/xlc)

Changes:

• Do strict length checking on [u8; <length>] type inputs
• Adjust keys/entries retrieval batch sizes
• Add upgrade block for Kusama 9040
• Use BN imports from @polkadot/util

v4.13.1

Upgrade priority: Medium. Required for users connecting to Statemine and future Kusama upgrades.

Changes:

• Overrides for westmint spec (same as statemint)
• Adjust tx.session.setKeys TS augmentation to allow string & Uint8Array keys
• Add & adjust types for latest Cumulus code
• Added 9031-9033 upgrade block for Westend
• Update static metadata to latest Substrate
• Optimize map retrieval with split page sizes for keys & values
• Sanitizing BN imports to type-only as required

v4.12.1

Upgrade priority: Low. Internal adjustment only, no major external usage changes.

Changelog:

• Update FundInfo type with Polkadot (Thanks to https://github.com/arjanz)

Changes:

• Allow storage queries with default keys values
• Align identity Data to limit to 32 bytes in the Raw enum (as per Substrate)
• Align static (test & docs-only) metadata with latest Substrate master
• Added 9030 upgrade blocks for Kusama & Westend
• Cleanup of Eth pallet RPC definitions
• Cleanup README for @polkadot/rpc-core (recommended for internal-usage only)
• Cleanup internal tests (no dangling handles, cater for Jest 27)

v4.11.2

Upgrade priority: Low. Recommended where users are having TS mismatches with type definitions created on older versions.

Changes:

• Add backwards-compatible TS-only AugmentedQueryDoubleMap type (unused now in type generation)

v4.11.1

Upgrade priority. Low. Recommended for users using staking entries on Polkadot and users of Substrate master.

Changes:

• Fix metadata v13 storage decoding on NMap
• Add augmentation & keys/entries for NMap types
• Return additional error information from internal u8a decoding failures
• Adjust Westend types for 16 nominators-only
• Add support for DisallowSigned (as per shell runtime) extension
• Display small hex-slice with u8a decoding failures
• Add state_getChildReadProof RPC
• Cleanup Rococo known types (only as used)
• Under Node.js allow for WS receiving up to 16MB messages
• Update entries/keys for max of 256 items per call

v4.10.1

Upgrade priority: Medium. Recommended for uses of Polkadot/Kusama 9010 runtimes.

• Breaking change Support for the contracts V2 compatibility has been dropped in @polkadot/api-contract

Contributed:

• Expose RPC definitions via .meta (Thanks to https://github.com/jiqiang90)
• Adjust staking derives for chain-specific optional fields (https://github.com/WoeOm)
• Update base Centrifuge types (Thanks to https://github.com/branan)

Changes:

• Allow for Bounded* type usage (as per latest Substrate)
• Adjust internal TS definitions for providers
• Fix ContractRx query result definitions (no extra Observable)
• Handle contract call RPC result directly as Raw (returned as hex)
• Use BN_* constants as non-specified defaults in contract interfaces
• Remove all type overrides for node/node-template (API tracks latest)
• Contracts ABI now supports metadata version where indexes are 0-based
• Remove support for the old-style V2 contracts from @polkadot/api-contract
• Adjust historic decoration, return as-at registry via getHeader, getMetadata & getRuntimeVersion
• Adjust VecFixed to allow for the handling of hex inputs
• Adjust Compact<*> to allow for wrapped toBigInt() conversions
• Fix isPedantic decoding to correctly handle Text
• Cater for new phragmenElection module naming
• Add Kusama & Westend 9010 upgrade blocks
• Adjust CompactSolution for 24 nominators
• Bump static metadata to latest Substrate

v4.9.1

Upgrade priority: Medium. Required for the next v0.9.0 Polkadot/Kusama chain upgrades where parachains are used.

• Breaking change The previously deprecated contracts interfaces, has been removed. Update to <myContract>.query.*, <myContract>.tx.* and <myCode>.tx.* interfaces as per the previous code usage hints.
• Important By default the isPedantic mode is now switched on for storage queries. This means that the API will fail on any types where the input/output decoding doesn't match 100%

Changes:

• Re-add isPedantic check on storage decoding
• ConsensusEngineId now implements [u8;4] (mapping closer to Rust source)
• Additional Xcm types
• Adjust parachain types
• Remove error logging on createType (details passed in error)
• Adjust ContractInfo type as per latest Substrate
• Adjust DigestItem type as per latest Substrate
• Adjust re-encoding of BitVec based on decoded length
• Added contracts_instantiate, state_traceBlock & system_reservedPeers RPCs
• Prepare for auto-capability detection with historic .at queries
• Add known upgrade block for Westend 900 & 9000
• Remove all deprecated interfaces inside @polkadot/api-contracts
• Initial support for NMap storage keys
• Support metadata v13 from Substrate (upcoming upgrade)
• Optimize historic metadata retrieval from rpc core

v4.8.1

Upgrade priority: Low. Recommended when using or developing for parachains.

Changes:

• De-alias xcm Outcome (used in multiple pallettes)
• Adjust xcm types as per latest, e.g. XcmError
• Fix generate of well-known storage keys (e.g. :code)
• Optimize metadata unknown type validation
• Allow metadata creation for Map or Record
• Expose additional camelCase method on AbiMessage (maps to decorated name)
• Added explicit double-byte ss58 AccountId encoding test
• Add known upgrade block for Polkadot v30
• Cleanup WebSocket handlers when close event has been received
• Update to latest Substrate metadata

v4.7.2

Upgrade priority: Low. Recommended for users of 4.7.1 using nvm

Changes:

• Update .nvmrc to reflect engines changes
• Update EthBlock/EthHeader types (as per Rust origin)
• Updated Xcm OriginKind enum
• Add derives for membership
• Cleanups on encodedLength calculations