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

Gasless fix proposal dates #1199

Merged
merged 7 commits into from
Feb 12, 2024
Merged
Show file tree
Hide file tree
Changes from 6 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
19 changes: 10 additions & 9 deletions src/context/createGaslessProposal.tsx
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
import {
CreateMajorityVotingProposalParams,
Erc20TokenDetails,
Erc20WrapperTokenDetails,
VoteValues,
Expand All @@ -24,8 +23,9 @@ import {
StepsMap,
StepStatus,
useFunctionStepper,
} from 'hooks/useFunctionStepper';
import {useCensus3Client, useCensus3CreateToken} from 'hooks/useCensus3';
} from '../hooks/useFunctionStepper';
import {useCensus3Client, useCensus3CreateToken} from '../hooks/useCensus3';
import {GaslessProposalCreationParams} from '../utils/types';

export enum GaslessProposalStepId {
REGISTER_VOCDONI_ACCOUNT = 'REGISTER_VOCDONI_ACCOUNT',
Expand Down Expand Up @@ -57,7 +57,7 @@ export type UseCreateElectionProps = Omit<

interface IProposalToElectionProps {
metadata: ProposalMetadata;
data: CreateMajorityVotingProposalParams;
data: GaslessProposalCreationParams;
census: Census;
}

Expand All @@ -70,8 +70,8 @@ const proposalToElection = ({
title: metadata.title,
description: metadata.description,
question: metadata.summary,
startDate: data.startDate,
endDate: data.endDate!,
startDate: data.gaslessStartDate,
endDate: data.gaslessEndDate,
meta: data, // Store all DAO metadata to retrieve it easily
census: census,
};
Expand Down Expand Up @@ -221,10 +221,11 @@ const useCreateGaslessProposal = ({
const createProposal = useCallback(
async (
metadata: ProposalMetadata,
data: CreateMajorityVotingProposalParams,
data: GaslessProposalCreationParams,
handleOnchainProposal: (
electionId?: string,
vochainCensus?: TokenCensus
vochainCensus?: TokenCensus,
gaslessParams?: GaslessProposalCreationParams
) => Promise<Error | undefined>
) => {
if (globalState === StepStatus.ERROR) {
Expand Down Expand Up @@ -261,7 +262,7 @@ const useCreateGaslessProposal = ({
// 3. Register the proposal onchain
await doStep(
GaslessProposalStepId.CREATE_ONCHAIN_PROPOSAL,
async () => await handleOnchainProposal(electionId, census)
async () => await handleOnchainProposal(electionId, census, data)
);

// 4. All ready
Expand Down
105 changes: 62 additions & 43 deletions src/context/createProposal.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,12 @@ import {proposalStorage} from 'utils/localStorage/proposalStorage';
import {Proposal} from 'utils/paths';
import {getNonEmptyActions} from 'utils/proposals';
import {isNativeToken} from 'utils/tokens';
import {ProposalFormData, ProposalId, ProposalResource} from 'utils/types';
import {
GaslessProposalCreationParams,
ProposalFormData,
ProposalId,
ProposalResource,
} from 'utils/types';
import GaslessProposalModal from '../containers/transactionModals/gaslessProposalModal';
import {StepStatus} from '../hooks/useFunctionStepper';
import {useCreateGaslessProposal} from './createGaslessProposal';
Expand All @@ -105,13 +110,6 @@ type Props = {
children: ReactNode;
};

// This omitted Gasless params are added after Vocdoni election created
// This type is used to store information needed before creating the proposal in the vochain
type PartialGaslessParams = Omit<
CreateGasslessProposalParams,
'vochainProposalId' | 'censusURI' | 'censusRoot' | 'totalVotingPower'
>;

const CreateProposalWrapper: React.FC<Props> = ({
showTxModal,
setShowTxModal,
Expand Down Expand Up @@ -157,7 +155,7 @@ const CreateProposalWrapper: React.FC<Props> = ({

const [proposalId, setProposalId] = useState<string>();
const [proposalCreationData, setProposalCreationData] = useState<
CreateMajorityVotingProposalParams | PartialGaslessParams
CreateMajorityVotingProposalParams | GaslessProposalCreationParams
>();
const [creationProcessState, setCreationProcessState] =
useState<TransactionState>(TransactionState.WAITING);
Expand Down Expand Up @@ -553,10 +551,13 @@ const CreateProposalWrapper: React.FC<Props> = ({
// In case the endDate is close to being minimum durable, (and we starting immediately)
// to avoid passing late-date possibly, we just rely on SDK to set proper Date
if (
// If is Gasless, undefined is not allowed on vocdoni SDK election creation, and is not suposed to happen
// since SC not allow durations lower than 1 hour
!gasless &&
endDateTime.valueOf() <= minEndDateTimeMills &&
startSwitch === 'now'
) {
/* Pass enddate as undefined to SDK to auto-calculate min endDate */
/* Pass end date as undefined to SDK to auto-calculate min endDate */
endDateTime = undefined;
}
} else {
Expand Down Expand Up @@ -617,16 +618,29 @@ const CreateProposalWrapper: React.FC<Props> = ({
]);

const getOffChainProposalParams = useCallback(
(params: CreateMajorityVotingProposalParams): PartialGaslessParams => {
(
params: CreateMajorityVotingProposalParams
): GaslessProposalCreationParams => {
const gaslessEndDate = new Date(params.endDate!);
gaslessEndDate.setMinutes(params.endDate!.getMinutes() + 1);
let gaslessStartDate;
if (params.startDate) {
gaslessStartDate = new Date(params.startDate);
gaslessStartDate.setMinutes(params.startDate.getMinutes() - 1);
}
return {
...params,
// If the value is undefined will take the expiration time defined at DAO creation level.
// We want this because the expiration date is defined when the dao is created.
// We could define a different expiration date for this proposal but is not designed
// to do this at ux level. (kon)
tallyEndDate: undefined,
startDate: params.startDate,
// We ensure that the onchain endate is not undefined, during the calculation of the CreateMajorityVotingProposalParams
endDate: params.endDate!,
// Add offset to the end date to avoid onchain proposal finish before the offchain proposal
gaslessEndDate,
// Add offset to ensure offchain is started when proposal starts
gaslessStartDate,
};
},
[]
Expand All @@ -640,15 +654,16 @@ const CreateProposalWrapper: React.FC<Props> = ({
}
if (!proposalCreationData) return;

return gasless
? (pluginClient as GaslessVotingClient).estimation.createProposal(
proposalCreationData as CreateGasslessProposalParams
)
: (
pluginClient as TokenVotingClient | MultisigClient
).estimation.createProposal(
proposalCreationData as CreateMajorityVotingProposalParams
);
if (gasless) {
return (pluginClient as GaslessVotingClient).estimation.createProposal(
proposalCreationData as CreateGasslessProposalParams
);
}
return (
pluginClient as TokenVotingClient | MultisigClient
).estimation.createProposal(
proposalCreationData as CreateMajorityVotingProposalParams
);
}, [gasless, pluginClient, proposalCreationData]);

const {
Expand Down Expand Up @@ -821,7 +836,11 @@ const CreateProposalWrapper: React.FC<Props> = ({
}, [pluginAddress, pluginType, queryClient]);

const handlePublishProposal = useCallback(
async (vochainProposalId?: string, vochainCensus?: TokenCensus) => {
async (
vochainProposalId?: string,
vochainCensus?: TokenCensus,
gaslessParams?: CreateMajorityVotingProposalParams
) => {
if (!pluginClient) {
return new Error('ERC20 SDK client is not initialized correctly');
}
Expand All @@ -842,17 +861,14 @@ const CreateProposalWrapper: React.FC<Props> = ({
});

let proposalIterator: AsyncGenerator<ProposalCreationStepValue>;
if (gasless && vochainProposalId && vochainCensus) {
if (gasless && vochainProposalId && vochainCensus && gaslessParams) {
// This is the last step of a gasless proposal creation
// If some of the previous steps failed, and the user press the try again button, the end date is the same as when
// the user opened the modal. So I get fresh calculated params, to check if the start date is on 6 minutes (for
// example), the end date will be updated from now to 6 minutes more.
const updatedParams = getOffChainProposalParams(
(await getProposalCreationParams()).params
);

const params: CreateGasslessProposalParams = {
...(updatedParams as PartialGaslessParams),
...getOffChainProposalParams(gaslessParams),
censusRoot: vochainCensus.censusId!,
censusURI: vochainCensus.censusURI!,
totalVotingPower: vochainCensus.weight!,
Expand Down Expand Up @@ -949,7 +965,6 @@ const CreateProposalWrapper: React.FC<Props> = ({
gasless,
isOnWrongNetwork,
getOffChainProposalParams,
getProposalCreationParams,
handleCloseModal,
open,
network,
Expand All @@ -966,25 +981,19 @@ const CreateProposalWrapper: React.FC<Props> = ({
}

const {params, metadata} = await getProposalCreationParams();
if (!params.endDate) {
const startDate = params.startDate || new Date();
params.endDate = new Date(
startDate.valueOf() +
daysToMills(minDays || 0) +
hoursToMills(minHours || 0) +
minutesToMills(minMinutes || 0)
);
}
await createProposal(metadata, params, handlePublishProposal);

await createProposal(
metadata,
getOffChainProposalParams(params),
handlePublishProposal
);
}, [
pluginClient,
daoToken,
getProposalCreationParams,
createProposal,
getOffChainProposalParams,
handlePublishProposal,
minDays,
minHours,
minMinutes,
]);

/*************************************************
Expand All @@ -995,8 +1004,18 @@ const CreateProposalWrapper: React.FC<Props> = ({
async function setProposalData() {
if (showTxModal && creationProcessState === TransactionState.WAITING) {
if (gasless) {
const {params: gaslessParams} = await getProposalCreationParams();
setProposalCreationData(getOffChainProposalParams(gaslessParams));
// const {params} = await getProposalCreationParams();
// // console.log(
// // 'XXXXXXXXXXXXXXXXX',
// // (await getProposalCreationParams()).params.endDate,
// // gaslessParamsxx.endDate,
// // getOffChainProposalParams(gaslessParamsxx).endDate
// // );
setProposalCreationData(
getOffChainProposalParams(
(await getProposalCreationParams()).params
)
);
} else {
const {params} = await getProposalCreationParams();
setProposalCreationData(params);
Expand Down
12 changes: 12 additions & 0 deletions src/utils/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ import {
VersionTag,
} from '@aragon/sdk-client-common';
import {
CreateGasslessProposalParams,
GaslessPluginVotingSettings,
GaslessVotingProposal,
GaslessVotingProposalListItem,
Expand Down Expand Up @@ -193,6 +194,17 @@ export type DetailedProposal =
| MultisigProposal
| TokenVotingProposal
| GaslessVotingProposal;

// This omitted Gasless params are added after Vocdoni election created
// This type is used to store information needed before creating the proposal in the vochain
export type GaslessProposalCreationParams = Omit<
CreateGasslessProposalParams,
'vochainProposalId' | 'censusURI' | 'censusRoot' | 'totalVotingPower'
> & {
gaslessStartDate: Date | undefined;
gaslessEndDate: Date;
};

export type ProposalListItem =
| TokenVotingProposalListItem
| MultisigProposalListItem
Expand Down
Loading