Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feat: new multisig operations subscription service #2654

Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions src/renderer/domains/collectives/model/referendum/model.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,19 +26,19 @@ const { pending, subscribe, unsubscribe, received, fulfilled } = createDataSubsc
>({
initial: $list,
fn: ({ api, palletType }, callback) => {
let currectAbortController = new AbortController();
let currentAbortController = new AbortController();
Asmadek marked this conversation as resolved.
Show resolved Hide resolved

const fetchPages = createPagesHandler({
fn: () => referendaPallet.storage.referendumInfoForPaged(palletType, api, 200),
map: mapReferendums,
});

fetchPages(currectAbortController, callback);
fetchPages(currentAbortController, callback);

const fn = () => {
currectAbortController.abort();
currectAbortController = new AbortController();
fetchPages(currectAbortController, callback);
currentAbortController.abort();
currentAbortController = new AbortController();
fetchPages(currentAbortController, callback);
};

/**
Expand All @@ -47,7 +47,7 @@ const { pending, subscribe, unsubscribe, received, fulfilled } = createDataSubsc
* @see https://github.com/paritytech/polkadot-sdk/blob/43cd6fd4370d3043272f64a79aeb9e6dc0edd13f/substrate/frame/collective/src/lib.rs#L459
*/
return polkadotjsHelpers.subscribeSystemEvents({ api, section: `${palletType}Referenda` }, fn).then(fn => () => {
currectAbortController.abort();
currentAbortController.abort();
fn();
});
},
Expand Down
7 changes: 7 additions & 0 deletions src/renderer/domains/multisig/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
import { multisigsDomainModel } from './model/multisigs/model';

export const multisigDomain = {
multisigs: multisigsDomainModel,
};

export type { Multisig } from './model/multisigs/types';
153 changes: 153 additions & 0 deletions src/renderer/domains/multisig/model/multisigs/model.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,153 @@
import { type ApiPromise } from '@polkadot/api';
import { createStore } from 'effector';
import { cloneDeep } from 'lodash';

import { type CallHash, type ChainId, type HexString } from '@/shared/core';
import { createDataSource, createDataSubscription } from '@/shared/effector';
import { nullable, setNestedValue } from '@/shared/lib/utils';
import { multisigPallet } from '@/shared/pallet/multisig';
import { polkadotjsHelpers } from '@/shared/polkadotjs-helpers';
import { type AccountId } from '@/shared/polkadotjs-schemas';

import { multisigOperationService } from './service';
import { type Multisig, type MultisigEvent } from './types';

type Store = Record<ChainId, Record<AccountId, Multisig[]>>;

type RequestParams = {
accountId: AccountId;
api: ApiPromise;
};

const $multisigOperations = createStore<Store>({});

const { request } = createDataSource<Store, RequestParams[], Record<ChainId, Multisig[]>>({
initial: $multisigOperations,
async fn(inputs) {
const result: Record<ChainId, Multisig[]> = {};

for (const { api, accountId } of inputs) {
const response = await multisigPallet.storage.multisigs(api, accountId);
const chainId = api.genesisHash.toHex();

for (const multisig of response) {
if (nullable(multisig.multisig)) continue;
result[chainId] = result[chainId] || [];

result[chainId].push({
status: 'pending',
accountId: multisig.key.accountId,
callHash: multisig.key.callHash as HexString,
depositor: multisig.multisig.depositor,
events: multisig.multisig.approvals.map(accountId => ({
accountId,
status: 'approved',
blockCreated: multisig.multisig!.when.height,
indexCreated: multisig.multisig!.when.index,
})),
blockCreated: multisig.multisig.when.height,
indexCreated: multisig.multisig.when.index,
deposit: multisig.multisig.deposit,
});
}
}

return result;
},
map(store, { params, result }) {
let newStore = {};

for (const { api, accountId } of params) {
const chainId = api.genesisHash.toHex();

newStore = setNestedValue(
store,
chainId,
accountId,
multisigOperationService.mergeMultisigOperations(store[chainId]?.[accountId] || [], result[chainId] || []),
Asmadek marked this conversation as resolved.
Show resolved Hide resolved
);
}

return newStore;
},
});

const { subscribe, unsubscribe } = createDataSubscription<
Store,
RequestParams[],
{ callHash: CallHash; multisigId: AccountId; chainId: ChainId } & MultisigEvent
>({
initial: $multisigOperations,
fn: (params, callback) => {
const unsubscribe: Promise<void | (() => void)>[] = [];
Asmadek marked this conversation as resolved.
Show resolved Hide resolved

for (const { accountId, api } of params) {
unsubscribe.push(
polkadotjsHelpers
Asmadek marked this conversation as resolved.
Show resolved Hide resolved
.subscribeSystemEvents(
{
api,
section: `multisig`,
// TODO: add NewMultisig event
methods: ['MultisigApproval', 'MultisigExecuted', 'MultisigCancelled'],
},
event => {
const accountIdId = 0;
Asmadek marked this conversation as resolved.
Show resolved Hide resolved
const timepointId = 1;
const multisigId = 2;
const callHashId = 3;

if (event.data[multisigId]?.toHex() !== accountId) return;

const blockCreated = (event.data[timepointId] as any).height.toNumber();

Check warning on line 102 in src/renderer/domains/multisig/model/multisigs/model.ts

View workflow job for this annotation

GitHub Actions / lint

Unexpected any. Specify a different type
const indexCreated = (event.data[timepointId] as any).index.toNumber();

Check warning on line 103 in src/renderer/domains/multisig/model/multisigs/model.ts

View workflow job for this annotation

GitHub Actions / lint

Unexpected any. Specify a different type

callback({
done: true,
value: {
multisigId: accountId,
chainId: api.genesisHash.toHex(),
callHash: event.data[callHashId]!.toHex(),
accountId: event.data[accountIdId]!.toHex() as AccountId,
status: event.method === 'MultisigCancelled' ? 'rejected' : 'approved',
indexCreated,
blockCreated,
},
});
},
)
.then(unsubscribe => {
unsubscribe();
}),
);
}

return () => {
Promise.all(unsubscribe);
};
},
map: (store, { result: { callHash, multisigId, chainId, ...event } }) => {
const newStore = cloneDeep(store);

newStore[chainId] = newStore[chainId] || {};
newStore[chainId][multisigId] = newStore[chainId][multisigId] || [];
Asmadek marked this conversation as resolved.
Show resolved Hide resolved

const multisig = newStore[chainId][multisigId].find(
multisig => multisig.callHash === callHash && multisig.status === 'pending',
);

if (multisig) {
multisig.events = multisigOperationService.mergeEvents(multisig.events, [event]);
}

return newStore;
},
});

export const multisigsDomainModel = {
$multisigOperations,

request,
subscribe,
unsubscribe,
};
44 changes: 44 additions & 0 deletions src/renderer/domains/multisig/model/multisigs/service.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
import { cloneDeep } from 'lodash';

import { type Multisig, type MultisigEvent } from './types';

export const multisigOperationService = {
isSameMultisig: (a: Multisig, b: Multisig) => {
const isSameCallHash = a.callHash === b.callHash;
const isSameTimepoint = a.blockCreated === b.blockCreated && a.indexCreated === b.indexCreated;
const isSameAccount = a.accountId === b.accountId;

return isSameCallHash && isSameTimepoint && isSameAccount;
},

isSameEvent: (a: MultisigEvent, b: MultisigEvent) => {
return a.accountId === b.accountId && a.blockCreated === b.blockCreated && a.indexCreated === b.indexCreated;
Asmadek marked this conversation as resolved.
Show resolved Hide resolved
},

mergeEvents: (oldEvents: MultisigEvent[], newEvents: MultisigEvent[]) => {
return [...oldEvents, ...newEvents.filter(e => !oldEvents.find(o => multisigOperationService.isSameEvent(o, e)))];
Asmadek marked this conversation as resolved.
Show resolved Hide resolved
},

mergeMultisig: (oldMultisig: Multisig, newMultisig: Multisig) => {
return {
...oldMultisig,
events: multisigOperationService.mergeEvents(oldMultisig.events, newMultisig.events),
};
},

mergeMultisigOperations: (oldMultisigs: Multisig[], newMultisigs: Multisig[]): Multisig[] => {
const result = cloneDeep(oldMultisigs);

for (const newMultisig of newMultisigs) {
const oldMultisig = result.find(m => multisigOperationService.isSameMultisig(m, newMultisig));

if (oldMultisig) {
oldMultisig.events = multisigOperationService.mergeEvents(oldMultisig.events, newMultisig.events);
} else {
result.push(newMultisig);
}
}

return result;
},
};
29 changes: 29 additions & 0 deletions src/renderer/domains/multisig/model/multisigs/types.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
import { type BN } from '@polkadot/util';

import { type CallData, type CallHash, type HexString } from '@/shared/core';
import { type AccountId } from '@/shared/polkadotjs-schemas';

export type Timepoint = {
height: number;
Asmadek marked this conversation as resolved.
Show resolved Hide resolved
index: number;
};

export type MultisigEvent = {
accountId: AccountId;
status: 'approved' | 'rejected';
blockCreated: number;
Asmadek marked this conversation as resolved.
Show resolved Hide resolved
indexCreated: number;
extrinsicHash?: HexString;
};

export type Multisig = {
status: 'pending' | 'cancelled' | 'executed' | 'error';
accountId: AccountId;
callHash: CallHash;
callData?: CallData;
deposit: BN;
depositor: AccountId;
blockCreated: number;
Asmadek marked this conversation as resolved.
Show resolved Hide resolved
indexCreated: number;
events: MultisigEvent[];
};
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ function subscribeVotingFor(
}

function subscribeReferendums(api: ApiPromise, callback: (referendums: IteratorResult<Referendum[], void>) => unknown) {
let currectAbortController = new AbortController();
let currentAbortController = new AbortController();

const fetchPages = async (abort: AbortController) => {
for await (const page of referendaPallet.storage.referendumInfoForPaged('governance', api, 500)) {
Expand All @@ -153,12 +153,12 @@ function subscribeReferendums(api: ApiPromise, callback: (referendums: IteratorR
callback({ done: true, value: undefined });
};

fetchPages(currectAbortController);
fetchPages(currentAbortController);

const fn = () => {
currectAbortController.abort();
currectAbortController = new AbortController();
fetchPages(currectAbortController);
currentAbortController.abort();
currentAbortController = new AbortController();
fetchPages(currentAbortController);
};

const unsubscribeSystemReferenda = polkadotjsHelpers.subscribeSystemEvents({ api, section: 'referenda' }, fn);
Expand All @@ -174,7 +174,7 @@ function subscribeReferendums(api: ApiPromise, callback: (referendums: IteratorR

return Promise.all([unsubscribeSystemReferenda, unsubscribeSystemConvictionVoting, unsubscribeExtrinsics]).then(
(fns) => () => {
currectAbortController.abort();
currentAbortController.abort();
for (const fn of fns) {
fn();
}
Expand Down
3 changes: 3 additions & 0 deletions src/renderer/features/multisig-operations/constants.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
export const ERROR = {
networkDisabled: 'Network disabled',
};
8 changes: 8 additions & 0 deletions src/renderer/features/multisig-operations/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
import { operationsModel } from './model/list';

export const multisigOperationsFeature = {
model: {
operations: operationsModel,
},
views: {},
};
24 changes: 24 additions & 0 deletions src/renderer/features/multisig-operations/model/list.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
import { sample } from 'effector';

import { multisigDomain } from '@/domains/multisig';

import { multisigOperationsFeatureStatus } from './status';

sample({
clock: multisigOperationsFeatureStatus.running,
target: [multisigDomain.multisigs.request, multisigDomain.multisigs.subscribe],
});

sample({
clock: multisigOperationsFeatureStatus.stopped,
target: multisigDomain.multisigs.unsubscribe,
});

const $operations = multisigDomain.multisigs.$multisigOperations.map((list) => list ?? {});

export const operationsModel = {
$operations,

$pending: multisigOperationsFeatureStatus.isStarting,
$fulfilled: multisigOperationsFeatureStatus.isRunning,
};
Loading
Loading