diff --git a/packages/api-derive/src/tx/extrinsicInfo.ts b/packages/api-derive/src/tx/extrinsicInfo.ts new file mode 100644 index 0000000000..da44573600 --- /dev/null +++ b/packages/api-derive/src/tx/extrinsicInfo.ts @@ -0,0 +1,123 @@ +// Copyright 2017-2025 @polkadot/api-derive authors & contributors +// SPDX-License-Identifier: Apache-2.0 + +import type { Observable } from 'rxjs'; +import type { GenericExtrinsic } from '@polkadot/types'; +import type { EventRecord, Hash } from '@polkadot/types/interfaces'; +import type { DeriveApi } from '../types.js'; + +import { map } from 'rxjs'; + +import { memo } from '../util/index.js'; + +interface ExtrinsicInfo { + blockHash: Hash | string, + blockNumber: number, + extrinsic: GenericExtrinsic, + events: EventRecord[] + success: boolean +} + +interface ExtrinsicsInfo { + blockHash: Hash | string, + blockNumber: number, + extrinsics: { + events: EventRecord[] + extrinsic: GenericExtrinsic, + success: boolean + }[], +} + +/** + * @name extrinsicInfo + * @param { Hash } at The block hash to query at. + * @param { Uint8Array | string } transactionHash A transaction hash as U8 array or string. + * @description Retrieves the extrinsic information and its events. + * @example + * ```javascript + * const blockHash = api.registry.createType( + * 'Hash', + * '0xb772e4949d2f3eb5ba356aa43f885cc4f9097ee9812c5436543f3846a0491729' + * ); + * const extrinsicInfo = await api.derive.tx.extrinsicInfo( + * blockHash, + * '0xcd96520b05e0c4648ea365f3f063f27c5cdd8be10d41a1c44566428c91f37dcb' + * ); + * + * console.log(extrinsicInfo.extrinsic.toHuman()); + * ``` + */ +export function extrinsicInfo (instanceId: string, api: DeriveApi): (at: Hash, transactionHash: Uint8Array | string) => Observable { + return memo(instanceId, (at: Hash, transactionHash: Uint8Array | string): Observable => { + return api.derive.tx.events(at).pipe(map(({ block, events }) => { + const index = block.block.extrinsics.findIndex((ext) => ext.hash.toString() === transactionHash); + + if (index === -1) { + return null; + } + + const extEvents = events.filter( + ({ phase }) => phase.isApplyExtrinsic && phase.asApplyExtrinsic.eq(index) + ); + + return { + blockHash: block.hash.toHex(), + blockNumber: block.block.header.number.toNumber(), + events: extEvents, + extrinsic: block.block.extrinsics[index], + success: (extEvents.findIndex((ev) => ev.event.method === 'ExtrinsicSuccess') !== -1) + }; + })); + }); +} + +/** + * @name accountExtrinsics + * @description Retrieves information about every extrinsic submitted by an account at a given block. + * @param { Hash } at The block hash to query at. + * @param { Uint8Array | strings } accountId The account identifier to query. + * @example + * ```javascript + const blockHash = api.registry.createType( + 'Hash', + '0xb772e4949d2f3eb5ba356aa43f885cc4f9097ee9812c5436543f3846a0491729' + ); + const extrinsicsInfo = await api.derive.tx.accountExtrinsics( + blockHash, + '0x21895DdfD4640b4e0aDCa2865b907f2CE6e6B777' + ); + + console.log(extrinsicsInfo.extrinsics[0]).extrinsic.toHuman(); + * ``` + */ +export function accountExtrinsics (instanceId: string, api: DeriveApi): (at: Hash, accountId: Uint8Array | string) => Observable { + return memo(instanceId, (at: Hash, accountId: Uint8Array | string): Observable => { + return api.derive.tx.events(at).pipe(map(({ block, events }) => { + const indexes: number[] = []; + + return { + blockHash: block.hash.toHex(), + blockNumber: block.block.header.number.toNumber(), + extrinsics: block.block.extrinsics.filter((ext, index) => { + if (ext.signer.toString() === accountId) { + indexes.push(index); + + return true; + } + + return false; + }).map((ext, i) => { + const extEvents = events.filter( + ({ phase }) => phase.isApplyExtrinsic && phase.asApplyExtrinsic.eq(indexes[i]) + ); + + return { + events: extEvents, + extrinsic: ext, + success: (extEvents.findIndex((ev) => ev.event.method === 'ExtrinsicSuccess') !== -1) + }; + }) + }; + })); + }); +} diff --git a/packages/api-derive/src/tx/index.ts b/packages/api-derive/src/tx/index.ts index 3793bf030b..c26e59d692 100644 --- a/packages/api-derive/src/tx/index.ts +++ b/packages/api-derive/src/tx/index.ts @@ -2,4 +2,5 @@ // SPDX-License-Identifier: Apache-2.0 export * from './events.js'; +export * from './extrinsicInfo.js'; export * from './signingInfo.js';