perf: prefer interface over type alias

.changeset/young-ends-grow.md

@@ -0,0 +1,11 @@
+---
+"@reactive-dot/wallet-polkadot-vault": patch
+"@reactive-dot/wallet-readonly": patch
+"@reactive-dot/wallet-ledger": patch
+"@reactive-dot/wallet-mimir": patch
+"@reactive-dot/react": patch
+"@reactive-dot/core": patch
+"@reactive-dot/vue": patch
+---
+
+Prefer `interface` over `type` alias for object types and use `extends` instead of intersection types (`&`), yielding better TypeScript type-checking performance and more consistent error messages.

examples/react/.papi/descriptors/package.json

@@ -1,15 +1,10 @@
 {
-  "name": "@polkadot-api/descriptors",
   "version": "0.1.0-autogenerated.12798067100670306101",
+  "name": "@polkadot-api/descriptors",
   "files": [
     "dist"
   ],
   "type": "module",
-  "sideEffects": false,
-  "main": "./dist/index.js",
-  "module": "./dist/index.js",
-  "browser": "./dist/index.js",
-  "types": "./dist/index.d.ts",
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
@@ -19,7 +14,12 @@
     },
     "./package.json": "./package.json"
   },
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "browser": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "sideEffects": false,
   "peerDependencies": {
-    "polkadot-api": ">=2.0.1"
+    "polkadot-api": ">=2.0.0"
   }
 }

examples/react/src/account-select.tsx

@@ -2,9 +2,9 @@ import type { WalletAccount } from "@reactive-dot/core/wallets.js";
 import { useConnectedWallets, useAccounts } from "@reactive-dot/react";
 import { type ReactNode, useState } from "react";
 
-type AccountSelectProps = {
+interface AccountSelectProps {
   children: (account: WalletAccount) => ReactNode;
-};
+}
 
 export function AccountSelect({ children }: AccountSelectProps) {
   const connectedWallets = useConnectedWallets();

examples/react/src/app.tsx

@@ -50,7 +50,9 @@ export function App() {
   );
 }
 
-type ExampleProps = { chainName: string };
+interface ExampleProps {
+  chainName: string;
+}
 
 function Example({ chainName }: ExampleProps) {
   const resetQueryError = useQueryErrorResetter();

examples/react/src/ink-contract.tsx

@@ -17,9 +17,9 @@ export function InkContracts() {
   );
 }
 
-type ContractProps = {
+interface ContractProps {
   address: string;
-};
+}
 
 function Psp22TokenInfo({ address }: ContractProps) {
   const [timestamp, [tokenName, tokenDecimals, tokenSymbol, totalSupply]] = useLazyLoadQuery(

examples/react/src/query.tsx

@@ -121,9 +121,9 @@ function SpendableBalances() {
   );
 }
 
-type SpendableBalanceProps = {
+interface SpendableBalanceProps {
   account: PolkadotAccount;
-};
+}
 
 function SpendableBalance({ account }: SpendableBalanceProps) {
   return (
@@ -180,10 +180,10 @@ function PendingPoolRewards() {
   );
 }
 
-type PendingRewardsProps = {
+interface PendingRewardsProps {
   account: PolkadotAccount;
   rewards: bigint;
-};
+}
 
 function PendingRewards({ account, rewards }: PendingRewardsProps) {
   return (

examples/react/src/wallet-connection.tsx

@@ -27,9 +27,9 @@ export function WalletConnection() {
   );
 }
 
-type WalletItemProps = {
+interface WalletItemProps {
   wallet: Wallet;
-};
+}
 
 function WalletItem({ wallet }: WalletItemProps) {
   const connectedWallets = useConnectedWallets();

examples/vue/.papi/descriptors/package.json

@@ -1,15 +1,10 @@
 {
-  "name": "@polkadot-api/descriptors",
   "version": "0.1.0-autogenerated.12798067100670306101",
+  "name": "@polkadot-api/descriptors",
   "files": [
     "dist"
   ],
   "type": "module",
-  "sideEffects": false,
-  "main": "./dist/index.js",
-  "module": "./dist/index.js",
-  "browser": "./dist/index.js",
-  "types": "./dist/index.d.ts",
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
@@ -19,7 +14,12 @@
     },
     "./package.json": "./package.json"
   },
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "browser": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "sideEffects": false,
   "peerDependencies": {
-    "polkadot-api": ">=2.0.1"
+    "polkadot-api": ">=2.0.0"
   }
 }

packages/core/src/actions/get-block-extrinsics.ts

@@ -46,11 +46,11 @@ type Extra = Partial<{
   [key: string]: unknown;
 }>;
 
-type Call = {
+interface Call {
   module: string;
   func: string;
   args: unknown;
-};
+}
 
 type Extrinsic = { version: number; call: Call } & (
   | { signed: false }

packages/core/src/actions/get-block.test.ts

@@ -3,7 +3,9 @@ import type { PolkadotClient } from "polkadot-api";
 import { of } from "rxjs";
 import { expect, it } from "vitest";
 
-type DummyBlock = { id: string };
+interface DummyBlock {
+  id: string;
+}
 
 it("should return the best block when options.tag is 'best'", () =>
   new Promise<void>((resolve) => {

packages/core/src/actions/get-block.ts

@@ -1,9 +1,9 @@
 import type { PolkadotClient } from "polkadot-api";
 import { map } from "rxjs";
 
-export type GetBlockOptions = {
+export interface GetBlockOptions {
   tag?: "best" | "finalized";
-};
+}
 
 export function getBlock<TOptions extends GetBlockOptions>(
   client: PolkadotClient,

packages/core/src/config.ts

@@ -5,15 +5,15 @@ import type { Wallet, WalletProvider } from "./wallets/index.js";
 import type { JsonRpcProvider } from "polkadot-api";
 import type { ChainDefinition } from "polkadot-api";
 
-export type ChainConfig = {
+export interface ChainConfig {
   readonly descriptor: ChainDefinition | UnsafeDescriptor;
   readonly provider: Gettable<JsonRpcProvider | LightClientProvider>;
-};
+}
 
-export type Config<
+export interface Config<
   TChains extends Readonly<Record<string, ChainConfig>> = Readonly<Record<string, ChainConfig>>,
   TTargetChainIds extends Extract<keyof TChains, string>[] = Extract<keyof TChains, string>[],
-> = {
+> {
   readonly chains: TChains;
   readonly targetChains?: TTargetChainIds;
   readonly wallets?: Array<WalletProvider | Wallet>;
@@ -31,7 +31,7 @@ export type Config<
    * @defaultValue false
    */
   readonly ssr?: boolean;
-};
+}
 
 export function defineConfig<
   const TChains extends Readonly<Record<string, ChainConfig>>,

packages/core/src/contract/ink/query-builder.ts

@@ -9,11 +9,11 @@ import type { ExcludeProperties, Finality, FlatHead, StringKeyOf } from "../../t
 import type { UnwrapResult } from "./result.js";
 import type { GenericInkDescriptors } from "./types.js";
 
-type StorageReadInstruction = BaseInstruction<"storage"> & {
+interface StorageReadInstruction extends BaseInstruction<"storage"> {
   path: string;
   key: unknown | undefined;
   at: Finality | undefined;
-};
+}
 
 type MultiStorageReadInstruction = MultiInstruction<StorageReadInstruction, "key", "keys">;
 
@@ -22,12 +22,12 @@ export type InferStorageReadInstructionPayload<
   TDescriptor extends GenericInkDescriptors,
 > = TDescriptor["__types"]["storage"][TInstruction["path"]]["value"];
 
-type MessageSendInstruction = BaseInstruction<"message"> & {
+interface MessageSendInstruction extends BaseInstruction<"message"> {
   name: string;
   body: unknown;
   origin: Address | undefined;
   at: Finality | undefined;
-};
+}
 
 type MultiMessageSendInstruction = MultiInstruction<MessageSendInstruction, "body", "bodies">;
 

packages/core/src/contract/ink/watch-event.test.ts

@@ -27,7 +27,7 @@ const mockContract = {
   },
 } as unknown as InkContract;
 
-type MockBlockEvents = {
+interface MockBlockEvents {
   block: unknown;
   events: Array<{
     payload: {
@@ -36,7 +36,7 @@ type MockBlockEvents = {
       topics: string[];
     };
   }>;
-};
+}
 
 const contractEmitted$ = new Subject<MockBlockEvents>();
 const mockApi = {

packages/core/src/contract/mutation-builder.ts

@@ -6,7 +6,7 @@ import type { SolidityTxBody } from "./solidity/types.js";
 import type { Abi, ExtractAbiFunctionNames } from "abitype";
 import type { Transaction } from "polkadot-api";
 
-export type MutationBuilder = {
+export interface MutationBuilder {
   <
     TDescriptor extends GenericInkDescriptors,
     TMessageName extends StringKeyOf<
@@ -28,4 +28,4 @@ export type MutationBuilder = {
       ? [body?: SolidityTxBody<TAbi, TFunctionName>]
       : [body: SolidityTxBody<TAbi, TFunctionName>]
   ): MaybePromise<Transaction>;
-};
+}

packages/core/src/contract/solidity/query-builder.ts

@@ -11,11 +11,11 @@ import type {
   ExtractAbiFunctionNames,
 } from "abitype";
 
-export type FunctionCallInstruction = BaseInstruction<"function"> & {
+export interface FunctionCallInstruction extends BaseInstruction<"function"> {
   name: string;
   args: unknown[];
   at: Finality | undefined;
-};
+}
 
 export type InferFunctionCallInstructionPayload<
   TInstruction extends FunctionCallInstruction,

packages/core/src/contract/solidity/watch-event.test.ts

@@ -12,13 +12,13 @@ const transferEvent = AbiEvent.from(
 
 const bsEvent = AbiEvent.from("event Bs(address indexed clown)");
 
-type MockEvent = {
+interface MockEvent {
   payload: {
     contract: SizedHex<20>;
     data: Uint8Array;
     topics: SizedHex<32>[];
   };
-};
+}
 
 type MockBlock = Record<string, never>;
 

packages/core/src/contract/types.ts

@@ -18,17 +18,17 @@ import type {
 
 export type ContractAddress = Address | SizedHex<20>;
 
-export type ContractEvent<TName extends string = string, TData = unknown> = {
+export interface ContractEvent<TName extends string = string, TData = unknown> {
   block: BlockInfo;
   contract: Address;
   name: TName;
   data: TData;
-};
+}
 
-export type Gas = {
+export interface Gas {
   ref_time: bigint;
   proof_size: bigint;
-};
+}
 
 export type StorageError = Enum<{
   DoesntExist: undefined;
@@ -216,7 +216,7 @@ export type ContractPallets = PalletsTypedef<
   {}
 >;
 
-export type GenericDefinition<TPallet, TApis> = {
+export interface GenericDefinition<TPallet, TApis> {
   descriptors: Promise<any> & {
     pallets: TPallet;
     apis: TApis;
@@ -225,6 +225,6 @@ export type GenericDefinition<TPallet, TApis> = {
   metadataTypes: any;
   getMetadata: any;
   genesis: any;
-};
+}
 
 export type ContractCompatApi = TypedApi<GenericDefinition<ContractPallets, ContractApis>>;

packages/core/src/maths/spendable-balance.ts

@@ -1,12 +1,12 @@
 import { BigIntMath } from "@reactive-dot/utils";
 
-type SpendableBalanceParam = {
+interface SpendableBalanceParam {
   free: bigint;
   reserved: bigint;
   frozen: bigint;
   existentialDeposit: bigint;
   includesExistentialDeposit?: boolean;
-};
+}
 
 export function spendableBalance({
   free,

packages/core/src/mutation-event.ts

@@ -3,16 +3,16 @@ import type { ChainId } from "./chains.js";
 import type { Contract } from "./contract/contract.js";
 import type { Transaction } from "polkadot-api";
 
-export type MutationEvent = {
+export interface MutationEvent {
   id: `${string}-${string}-${string}-${string}-${string}`;
   chainId: ChainId;
   call?: Transaction["decodedCall"];
-};
+}
 
-export type ContractMutationEvent = MutationEvent & {
+export interface ContractMutationEvent extends MutationEvent {
   contractCalls: Array<{
     contract: Contract;
     address: Address;
     message: string;
   }>;
-};
+}