api, api-{augment, base, contract, derive}, rpc-{augment, core, provider}, types, types-{augment, codec, create, known} 15.7.2

Author: github-actions[bot]

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## master
 
+- api, api-{augment, base, contract, derive}, rpc-{augment, core, provider}, types, types-{augment, codec, create, known} 15.7.2
 - api, api-{augment, base, contract, derive}, rpc-{augment, core, provider}, types, types-{augment, codec, create, known} 15.7.1
 - phishing 0.25.4
 - api, api-{augment, base, contract, derive}, rpc-{augment, core, provider}, types, types-{augment, codec, create, known} 15.6.1

api-augment/packageInfo.ts

@@ -1,3 +1,3 @@
 
 
-export const packageInfo = { name: '@polkadot/api-augment', path: new URL(import.meta.url).pathname, type: 'deno', version: '15.7.1' };
+export const packageInfo = { name: '@polkadot/api-augment', path: new URL(import.meta.url).pathname, type: 'deno', version: '15.7.2' };

api-base/packageInfo.ts

@@ -1,3 +1,3 @@
 
 
-export const packageInfo = { name: '@polkadot/api-base', path: new URL(import.meta.url).pathname, type: 'deno', version: '15.7.1' };
+export const packageInfo = { name: '@polkadot/api-base', path: new URL(import.meta.url).pathname, type: 'deno', version: '15.7.2' };

api-contract/packageInfo.ts

@@ -1,3 +1,3 @@
 
 
-export const packageInfo = { name: '@polkadot/api-contract', path: new URL(import.meta.url).pathname, type: 'deno', version: '15.7.1' };
+export const packageInfo = { name: '@polkadot/api-contract', path: new URL(import.meta.url).pathname, type: 'deno', version: '15.7.2' };

api-derive/README.md

@@ -3,3 +3,28 @@
 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:
+
+- [accounts](https://github.com/polkadot-js/api/tree/master/packages/api-derive/src/accounts)
+- [alliance](https://github.com/polkadot-js/api/tree/master/packages/api-derive/src/alliance)
+- [bagsList](https://github.com/polkadot-js/api/tree/master/packages/api-derive/src/bagsList)
+- [balances](https://github.com/polkadot-js/api/tree/master/packages/api-derive/src/balances)
+- [bounties](https://github.com/polkadot-js/api/tree/master/packages/api-derive/src/bounties)
+- [chain](https://github.com/polkadot-js/api/tree/master/packages/api-derive/src/chain)
+- [contracts](https://github.com/polkadot-js/api/tree/master/packages/api-derive/src/contracts)
+- [council](https://github.com/polkadot-js/api/tree/master/packages/api-derive/src/council)
+- [crowdloan](https://github.com/polkadot-js/api/tree/master/packages/api-derive/src/crowdloan)
+- [democracy](https://github.com/polkadot-js/api/tree/master/packages/api-derive/src/democracy)
+- [elections](https://github.com/polkadot-js/api/tree/master/packages/api-derive/src/elections)
+- [imOnline](https://github.com/polkadot-js/api/tree/master/packages/api-derive/src/imOnline)
+- [membership](https://github.com/polkadot-js/api/tree/master/packages/api-derive/src/membership)
+- [parachains](https://github.com/polkadot-js/api/tree/master/packages/api-derive/src/parachains)
+- [session](https://github.com/polkadot-js/api/tree/master/packages/api-derive/src/session)
+- [society](https://github.com/polkadot-js/api/tree/master/packages/api-derive/src/society)
+- [staking](https://github.com/polkadot-js/api/tree/master/packages/api-derive/src/staking)
+- [technicalCommittee](https://github.com/polkadot-js/api/tree/master/packages/api-derive/src/technicalCommittee)
+- [treasury](https://github.com/polkadot-js/api/tree/master/packages/api-derive/src/treasury)
+- [tx](https://github.com/polkadot-js/api/tree/master/packages/api-derive/src/tx)

api-derive/accounts/accountId.ts

@@ -13,7 +13,15 @@ import { memo } from '../util/index.ts';
 /**
  * @name accountId
  * @param {(Address | AccountId | AccountIndex | string | null)} address An accounts address in various formats.
- * @description  An [[AccountId]]
+ * @description Resolves an address (in different formats) to its corresponding `AccountId`.
+ * @example
+ * ```javascript
+ * const ALICE = "F7Hs";
+ *
+ * api.derive.accounts.accountId(ALICE, (accountId) => {
+ *   console.log(`Resolved AccountId: ${accountId}`);
+ * });
+ * ```
  */
 export function accountId (instanceId: string, api: DeriveApi): (address?: Address | AccountId | AccountIndex | string | null) => Observable<AccountId> {
   return memo(instanceId, (address?: Address | AccountId | AccountIndex | string | null): Observable<AccountId> => {

api-derive/accounts/flags.ts

@@ -66,8 +66,18 @@ export function _flags (instanceId: string, api: DeriveApi): () => Observable<Fl
 }
 
 /**
- * @name info
- * @description Returns account membership flags
+ * @name flags
+ * @param {(AccountId | Address | string | null)} address The account identifier.
+ * @description Retrieves the membership flags for a given account.
+ * @example
+ * const ALICE = "F7Hs";
+ *
+ * api.derive.accounts.flags(ALICE, (flags) => {
+ *   console.log(
+ *     `Account Flags:`,
+ *     Object.keys(flags).map((flag) => `${flag}: ${flags[flag]}`)
+ *   );
+ * });
  */
 export function flags (instanceId: string, api: DeriveApi): (address?: AccountId | Address | string | null) => Observable<DeriveAccountFlags> {
   return memo(instanceId, (address?: AccountId | Address | string | null): Observable<DeriveAccountFlags> =>

api-derive/accounts/idAndIndex.ts

@@ -12,11 +12,9 @@ import { memo } from '../util/index.ts';
 
 /**
  * @name idAndIndex
- * @param {(Address | AccountId | AccountIndex | Uint8Array | string | null)} address - An accounts address in various formats.
- * @description  An array containing the [[AccountId]] and [[AccountIndex]] as optional values.
+ * @param {(Address | AccountId | AccountIndex | Uint8Array | string | null)} address An accounts address in various formats.
+ * @description An array containing the [[AccountId]] and [[AccountIndex]] as optional values.
  * @example
- * <BR>
- *
  * ```javascript
  * api.derive.accounts.idAndIndex('F7Hs', ([id, ix]) => {
  *   console.log(`AccountId #${id} with corresponding AccountIndex ${ix}`);

api-derive/accounts/idToIndex.ts

@@ -9,11 +9,9 @@ import { memo } from '../util/index.ts';
 
 /**
  * @name idToIndex
- * @param {( AccountId | string )} accountId - An accounts Id in different formats.
- * @returns Returns the corresponding AccountIndex.
+ * @description Retrieves the corresponding AccountIndex.
+ * @param {( AccountId | string )} accountId An accounts Id in different formats.
  * @example
- * <BR>
- *
  * ```javascript
  * const ALICE = '5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY';
  * api.derive.accounts.idToIndex(ALICE, (accountIndex) => {

api-derive/accounts/identity.ts

@@ -122,7 +122,19 @@ export function _identity (instanceId: string, api: DeriveApi): (accountId?: Acc
 
 /**
  * @name identity
- * @description Returns identity info for an account
+ * @description Retrieves the on chain identity information for a given account.
+ * @param {(AccountId | Uint8Array | string)} accoutId The account identifier to query the identity for.
+ * @example
+ * ```javascript
+ * const ALICE = "13xAUH";
+ *
+ * api.derive.accounts.identity(ALICE, (identity) => {
+ *   console.log(
+ *     "Account Identity:",
+ *     Object.keys(identity).map((key) => `${key}: ${identity[key]}`)
+ *   );
+ * });
+ * ```
  */
 export function identity (instanceId: string, api: DeriveApi): (accountId?: AccountId | Uint8Array | string) => Observable<DeriveAccountRegistration> {
   return memo(instanceId, (accountId?: AccountId | Uint8Array | string): Observable<DeriveAccountRegistration> =>
@@ -160,11 +172,32 @@ function getSubIdentities (identity: DeriveAccountRegistration, api: DeriveApi,
   );
 }
 
+/**
+ * @name hasIdentity
+ * @description Checks if a specific account has an identity registered on chain.
+ * @param {(AccountId | Uint8Array | string)} accoutId The account identifier to query.
+ * @example
+ * ```javascript
+ * const ALICE = "13AU";
+ * console.log(await api.derive.accounts.hasIdentity(ALICE));
+ * ```
+ */
 export const hasIdentity = /*#__PURE__*/ firstMemo(
   (api: DeriveApi, accountId: AccountId | Uint8Array | string) =>
     api.derive.accounts.hasIdentityMulti([accountId])
 );
 
+/**
+ * @name hasIdentityMulti
+ * @description Checks whether multiple accounts have on chain identities registered.
+ * @param {(AccountId | Uint8Array | string)[]} accountIds Array of account identifiers to query.
+ * @example
+ * ```javascript
+ * const ALICE = "13AU";
+ * const BOB = "16WW";
+ * console.log(await api.derive.accounts.hasIdentityMulti([ALICE, BOB]));
+ * ```
+ */
 export function hasIdentityMulti (instanceId: string, api: DeriveApi): (accountIds: (AccountId | Uint8Array | string)[]) => Observable<DeriveHasIdentity[]> {
   return memo(instanceId, (accountIds: (AccountId | Uint8Array | string)[]): Observable<DeriveHasIdentity[]> =>
     api.query.identity?.identityOf