Building upon #812, #948 & #1334. This proposal requests funding for the continuation of ReactiveDOT, alongside its related projects (DOTConsole, DOTConnect).
Reactive DOT is a library designed to:
Various updates were made to the public-facing API, moving many components to internal APIs, except for those identified as highly stable:
Current code coverage details are available here: https://app.codecov.io/gh/tien/reactive-dot/
Continued documentation updates and maintenance for new features include:
create-polkadot-app, a CLI tool designed to quickly bootstrap Polkadot DApps using PAPI, ReactiveDOT, and DOTConnect. My role was primarily advisory, with Parity employees handling the core development.Although the API is currently highly stable and ready for a v1.0.0 release, I've opted to remain in the pre-1.0 phase to retain flexibility for additional features work (will be outlined in later sections).
Useful for building screens with a large number of subscriptions, requiring targeted optimization, i.e. infinite lazy loadable list.
PR: https://github.com/tien/reactive-dot/pull/525
Documentation: https://reactivedot.dev/react/guides/performance#controlling-subscriptions
Demonstration: https://x.com/TienNguyenK/status/1895581356908065277
PR: https://github.com/tien/reactive-dot/pull/368
Demonstration: https://x.com/TienNguyenK/status/1896888190499443132
As per how plug-n-play wallet was designed, integration is optional, and dependencies must be explicitly added with:
yarn add @reactive-dot/wallet-mimir
import { defineConfig } from "@reactive-dot/core";
import { MimirWalletProvider } from "@reactive-dot/mimir";
export const config = defineConfig({
// ...
wallets: [new MimirWalletProvider()],
});
PR: https://github.com/tien/reactive-dot/pull/517
Announcement by Mimir: https://x.com/Mimir_global/status/1894576922228916584
React 19 changed how suspense works, resulting in micro-suspense render even for resolved promises. For users, this means occasionally seeing sub-second flickers of loading state.
From countless hours researching & debugging (including on how React works internally), a solution was found and fixed via:
Mainly used as a testing ground for ReactiveDOT, demonstrating how little code is needed for building highly performant, light-client first DApp.
Besides working on my own projects, I also help out other projects within the ecosystem whenever possible, you can check my activities here.
Whereas chain queries are default-reactive. Contract queries are chain-agnostic and default non-reactive. Integration goals, besides basic Ink support, will be to aid developers in dealing with the contract's default-non-reactive nature. In short, beating the dev experience of the current gold standard of Contract FE DApp development: Ethereum's WAGMI.
Currently, if you need to derive values based on the results of multiple queries, the UI will remain suspended until all data has fully loaded. This approach isn't ideal when you'd prefer to display partial UI content as soon as some data becomes available.
Here's a current scenario:
function Component() {
const items = useLazyLoadQuery((builder) =>
builder.readStorageEntries("Pallet", "Items", []),
);
// This causes significant UI suspension time
const itemAmounts = useLazyLoadQuery((builder) =>
builder.readStorages(
"Pallet",
"ItemAmount",
items.map(([key]) => key),
),
);
// Ideally, we'd derive values progressively from loaded data
const sortedItems = useMemo(
() =>
items
.map((item, index) => ({ ...item, amount: itemAmounts.at(index)! }))
.toSorted((a, b) => a.amount - b.amount),
[items, itemAmounts],
);
return (
<ol>
{sortedItems.map((item, index) => (
<li key={index}>{/* ... */}</li>
))}
</ol>
);
}
A better approach might involve introducing an API like this:
import { pending } from "@reactive-dot/core";
function Component() {
const items = useLazyLoadQuery((builder) =>
builder.readStorageEntries("Pallet", "Items", []),
);
const itemAmounts = useLazyLoadQuery((builder) =>
builder.readStorages(
"Pallet",
"ItemAmount",
items.map(([key]) => key),
{
concurrency: "wait-for-none", // Immediately returns available data without suspending; alternative strategies like `wait-for-one` could also be implemented
},
),
);
const sortedItems = useMemo(
() =>
items
.map((item, index) => {
const itemAmount = itemAmounts.at(index)!;
return { ...item, amount: itemAmount === pending ? 0 : itemAmount };
})
.toSorted((a, b) => a.amount - b.amount),
[items, itemAmounts],
);
return (
<ol>
{sortedItems.map((item, index) => (
<li key={index}>{/* ... */}</li>
))}
</ol>
);
}
This proposed API enables partial UI rendering, making your components more responsive and improving overall user experience.
ReactiveDOT suspense-powered query ideal usage is as follows:
function ChildComponent({ id }) {
const [item1, item2] = useLazyLoadQuery((builder) =>
builder
.readStorage("Pallet1", "Storage1", [id])
.readStorage("Pallet2", "Storage2", [id]),
);
return (
<article>
<header>{item1}</header>
<p>{item2}</p>
</article>
);
}
function ParentComponent() {
const overviewInfo = useLazyLoadQuery((builder) =>
builder.readStorage("Pallet3", "Storage3", []),
);
const ids = [
/* ... */
];
return (
<section>
<header>{overviewInfo}</header>
<ul>
{ids.map((id) => (
<li key={id}>
<Suspense fallback={<p>Loading item {id}</p>}>
<ChildComponent id={id} />
</Suspense>
</li>
))}
</ul>
</section>
);
}
export function App() {
return (
<Suspense fallback={<p>Loading</p>}>
<ParentComponent />
</Suspense>
);
}
Where a component requests exactly and only what it needs, and directly map this data to UI elements. This bottom-up approach ensures components remain lean, load quickly, render fast, and are easy to understand and maintain.
However, this ideal scenario isn't always achievable because values often need to be derived or reduced from complex storage structures. Current approaches include:
useLazyLoadQuery: Easy to implement and effective for simpler cases but susceptible to suspense waterfalls.useLazyLoadQuery: Technically optimal but may negatively impact developer experience due to increased complexity and additional code requirements.Planned R&D aims to provide developers with enhanced hooks and utilities, simplifying the composition of queries that are both suspendable and resistant to suspense waterfalls. This could occur either:
Note: These challenges could potentially be resolved entirely through WASM view functions, making ReactiveDOT's ideal usage consistently effective.
Currently, the test coverage is approximately ~70%, with more than 90% coverage already achieved for core logic packages (@reactive-dot/core, @reactive-dot/utils, @reactive-dot/wallet-*). The remaining gaps are primarily within the render layer (@reactive-dot/react, @reactive-dot/vue).
End-to-end (E2E) tests will likely be necessary to reach the targeted coverage. These tests may be implemented using tools like chopsticks or zombienet.
Further enhancements will be guided by community feedback or requirements identified to support the ongoing testing and development of ReactiveDOT.
Threshold
Dear Proposer,
Thank you for your proposal. Our first vote on this proposal is AYE.
The Medium Spender track requires 50% quorum and simple majority of non-abstain voters according to our voting policy. This proposal has received five aye and zero nay votes from ten members, with one member abstaining. Below is a summary of our members' comments:
The full discussion can be found in our internal voting.
Kind regards,
Permanence DAO