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: update milestone logic to slot #7925

Merged
merged 8 commits into from
Feb 1, 2024
Merged
Show file tree
Hide file tree
Changes from all 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
4 changes: 2 additions & 2 deletions docs/guides/coding-conventions/naming.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ The following are some general rules about code naming that we follow:
mps?: number
health?: number
healthTxt?: NetworkStsHealthTxt
curMilestone?: number
curSlot?: number
}
```

Expand All @@ -54,7 +54,7 @@ The following are some general rules about code naming that we follow:
messagesPerSecond?: number
health?: number
healthText?: NetworkStatusHealthText
currentMilestone?: number
currentSlot?: number
}
```

Expand Down
7 changes: 1 addition & 6 deletions packages/desktop/components/ProposalStatusInfo.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -54,11 +54,6 @@
<InformationTooltip {anchor} {position} {title} {body} />
{/if}
{:else}
<ProposalStatusTimelineTooltip
bind:anchor
milestones={proposal.milestones}
status={proposal?.status}
{position}
/>
<ProposalStatusTimelineTooltip bind:anchor slots={proposal.slots} status={proposal?.status} {position} />
{/if}
{/if}
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@

import { formatDate, localize } from '@core/i18n'
import { networkStatus } from '@core/network'
import { DATE_FORMAT, milestoneToDate } from '@core/utils'
import { DATE_FORMAT, slotToDate } from '@core/utils'

import { ProposalStatus } from '@contexts/governance/enums'

export let milestones: Record<ProposalStatus, number>
export let slots: Record<ProposalStatus, number>
export let status: string
export let anchor: HTMLElement
export let position: Position = Position.Right
Expand Down Expand Up @@ -40,10 +40,7 @@
overrideColor={eventProgress < index}
classes={eventProgress < index ? 'text-gray-400 dark:text-gray-700' : ''}
>
{formatDate(
milestoneToDate($networkStatus.currentMilestone, milestones[ProposalStatus[status]]),
DATE_FORMAT
)}
{formatDate(slotToDate($networkStatus.currentSlot, slots[ProposalStatus[status]]), DATE_FORMAT)}
</Text>
<Text
type={TextType.h5}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
import { OnboardingButton } from '@ui'

import { localize } from '@core/i18n'
import { FAUCET_URLS, nodeInfo } from '@core/network'
import { FAUCET_URLS, nodeInfo, nodeInfoNetworkName } from '@core/network'
import { activeProfile } from '@core/profile'

import { openPopup, PopupId } from '@auxiliary/popup'
Expand All @@ -20,7 +20,7 @@
values: { token: $nodeInfo.baseToken.name },
})}
secondaryText={localize('general.faucetRequestDescription', {
values: { network: $nodeInfo.protocol.networkName },
values: { network: $nodeInfoNetworkName },
})}
onClick={onGetTokensClick}
/>
Expand Down
17 changes: 7 additions & 10 deletions packages/desktop/components/panes/ProposalInformationPane.svelte
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<script lang="ts">
import { Height, KeyValueBox, Pane, Text } from '@ui'
import { formatDate, localize } from '@core/i18n'
import { DATE_FORMAT, IKeyValueBoxList, milestoneToDate, truncateString } from '@core/utils'
import { DATE_FORMAT, IKeyValueBoxList, slotToDate, truncateString } from '@core/utils'
import { networkStatus } from '@core/network/stores'
import { ProposalStatus } from '@contexts/governance/enums'
import { selectedProposal } from '@contexts/governance/stores'
Expand All @@ -10,7 +10,7 @@

interface IProposalDateData {
propertyKey: 'votingOpens' | 'countingStarts' | 'countingEnds' | 'countingEnded'
milestone: number
slot: number
}

$: proposalDateData = getNextProposalDateData($selectedProposal?.status)
Expand All @@ -20,22 +20,22 @@
case ProposalStatus.Upcoming:
return {
propertyKey: 'votingOpens',
milestone: $selectedProposal?.milestones?.commencing,
slot: $selectedProposal?.slots?.commencing,
}
case ProposalStatus.Commencing:
return {
propertyKey: 'countingStarts',
milestone: $selectedProposal?.milestones?.holding,
slot: $selectedProposal?.slots?.holding,
}
case ProposalStatus.Holding:
return {
propertyKey: 'countingEnds',
milestone: $selectedProposal?.milestones?.ended,
slot: $selectedProposal?.slots?.ended,
}
case ProposalStatus.Ended:
return {
propertyKey: 'countingEnded',
milestone: $selectedProposal?.milestones?.ended,
slot: $selectedProposal?.slots?.ended,
}
default:
return undefined
Expand All @@ -46,10 +46,7 @@
$: proposalInformation = {
...(proposalDateData?.propertyKey && {
[proposalDateData.propertyKey]: {
data: formatDate(
milestoneToDate($networkStatus.currentMilestone, proposalDateData.milestone),
DATE_FORMAT
),
data: formatDate(slotToDate($networkStatus.currentSlot, proposalDateData.slot), DATE_FORMAT),
},
}),
eventId: {
Expand Down
4 changes: 2 additions & 2 deletions packages/desktop/components/popups/FaucetRequestPopup.svelte
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<script lang="ts">
import { requestTokensFromFaucet } from '@contexts/developer'
import { localize } from '@core/i18n'
import { nodeInfo } from '@core/network'
import { nodeInfo, nodeInfoNetworkName } from '@core/network'
import { closePopup } from '@auxiliary/popup'
import { Button, Error, Text, FontWeight, TextType } from 'shared/components'
import { handleError } from '@core/error/handlers/handleError'
Expand Down Expand Up @@ -36,7 +36,7 @@
<div class="w-full flex-col space-y-2">
<Text type={TextType.p} classes="text-left">
{localize('popups.faucetRequest.body', {
values: { token: $nodeInfo.baseToken.name, network: $nodeInfo.protocol.networkName },
values: { token: $nodeInfo.baseToken.name, network: $nodeInfoNetworkName },
})}
</Text>
{#if error}
Expand Down
43 changes: 23 additions & 20 deletions packages/desktop/components/popups/NodeInfoPopup.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -27,28 +27,31 @@
url: { localeKey: 'general.url', nodeInfoPath: undefined },
name: { localeKey: 'general.name', nodeInfoPath: 'name' },
version: { localeKey: 'general.version', nodeInfoPath: 'version' },
pruningIndex: { localeKey: 'general.pruningIndex', nodeInfoPath: 'status.pruningIndex' },
features: { localeKey: 'general.features', nodeInfoPath: 'features' },
pruningEpoch: { localeKey: 'general.pruningEpoch', nodeInfoPath: 'status.pruningEpoch' },
// features: { localeKey: 'general.features', nodeInfoPath: 'features' },
},
[NodeInfoTab.Metrics]: {
blocksPerSecond: { localeKey: 'metrics.blocksPerSecond', nodeInfoPath: 'metrics.blocksPerSecond' },
referencedBlocksPerSecond: {
localeKey: 'metrics.referencedBlocksPerSecond',
nodeInfoPath: 'metrics.referencedBlocksPerSecond',
},
referencedRate: { localeKey: 'metrics.referencedRate', nodeInfoPath: 'metrics.referencedRate' },
latestMilestone: { localeKey: 'metrics.latestMilestone', nodeInfoPath: 'status.latestMilestone.index' },
confirmedMilestone: {
localeKey: 'metrics.confirmedMilestone',
nodeInfoPath: 'status.confirmedMilestone.index',
confirmedBlocksPerSecond: {
localeKey: 'metrics.confirmedBlocksPerSecond',
nodeInfoPath: 'metrics.confirmedBlocksPerSecond',
},
confirmationRate: { localeKey: 'metrics.confirmationRate', nodeInfoPath: 'metrics.confirmationRate' },
// latestSlot: { localeKey: 'metrics.latestSlot', nodeInfoPath: 'status.latestSlot.index' },
// confirmedSlot: {
// localeKey: 'metrics.confirmedSlot',
// nodeInfoPath: 'status.confirmedSlot.index',
// },
},
[NodeInfoTab.Protocol]: {
network: { localeKey: 'protocol.network', nodeInfoPath: 'protocol.networkName' },
bech32Hrp: { localeKey: 'protocol.bech32Hrp', nodeInfoPath: 'protocol.bech32Hrp' },
tokenSupply: { localeKey: 'protocol.tokenSupply', nodeInfoPath: 'protocol.tokenSupply' },
version: { localeKey: 'protocol.version', nodeInfoPath: 'protocol.version' },
minPowScore: { localeKey: 'protocol.minPowScore', nodeInfoPath: 'protocol.minPowScore' },
network: { localeKey: 'protocol.network', nodeInfoPath: 'protocolParameters[0].parameters.networkName' },
bech32Hrp: { localeKey: 'protocol.bech32Hrp', nodeInfoPath: 'protocolParameters[0].parameters.bech32Hrp' },
tokenSupply: {
localeKey: 'protocol.tokenSupply',
nodeInfoPath: 'protocolParameters[0].parameters.tokenSupply',
},
version: { localeKey: 'protocol.version', nodeInfoPath: 'protocolParameters[0].parameters.version' },
// minPowScore: { localeKey: 'protocol.minPowScore', nodeInfoPath: 'protocol.minPowScore' },
},
[NodeInfoTab.BaseToken]: {
token: { localeKey: 'baseToken.token', nodeInfoPath: 'baseToken.name' },
Expand Down Expand Up @@ -80,10 +83,10 @@
nodeInfoValue = node.url
} else {
nodeInfoValue = resolveObjectPath(nodeInfo, nodeInfoTabObject[key]?.nodeInfoPath, null)
if (key === 'referencedRate' || key === 'blocksPerSecond' || key === 'referencedBlocksPerSecond') {
if (key === 'confirmationRate' || key === 'blocksPerSecond' || key === 'confirmedBlocksPerSecond') {
const numberValue = Number(nodeInfoValue)
if (numberValue >= 0) {
if (key === 'referencedRate') {
if (key === 'confirmationRate') {
nodeInfoValue = `${formatNumber(Math.min(numberValue, 100), 1, 1)}%`
} else {
nodeInfoValue = formatNumber(numberValue, 1, 1)
Expand Down Expand Up @@ -111,15 +114,15 @@
}

onMount(() => {
getNodeInfo(node?.url, node?.auth)
getNodeInfo(node.url, node.auth)
.then((nodeInfoResponse) => {
nodeInfo = nodeInfoResponse.nodeInfo
})
.catch((err) => {
closePopup()
showAppNotification({
type: 'error',
message: localize(err?.error),
message: localize(err.error),
})
})
})
Expand Down
6 changes: 3 additions & 3 deletions packages/desktop/views/dashboard/Dashboard.svelte
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<script lang="ts">
import { handleDeepLink } from '@auxiliary/deep-link'
import { localize } from '@core/i18n'
import { nodeInfo, NetworkId } from '@core/network'
import { NetworkId, nodeInfoNetworkName } from '@core/network'
import {
activeProfile,
hasStrongholdLocked,
Expand Down Expand Up @@ -98,12 +98,12 @@

Platform.DeepLinkManager.checkDeepLinkRequestExists()

if ($activeProfile?.isDeveloperProfile && !developerProfileNotificationId && $nodeInfo) {
if ($activeProfile?.isDeveloperProfile && !developerProfileNotificationId && $nodeInfoNetworkName) {
// Show developer profile warning
developerProfileNotificationId = showAppNotification({
type: 'warning',
message: localize('indicators.developerProfileIndicator.warningText', {
values: { networkName: $nodeInfo.protocolParameters[0].parameters.networkName },
values: { networkName: $nodeInfoNetworkName },
}),
})
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
import { handleError } from '@core/error/handlers'
import { localize } from '@core/i18n'
import { networkStatus } from '@core/network/stores'
import { getBestTimeDuration, milestoneToDate } from '@core/utils'
import { getBestTimeDuration, slotToDate } from '@core/utils'
import { visibleSelectedWalletAssets } from '@core/wallet/stores'
import { formatTokenAmountBestMatch } from '@core/wallet/utils'

Expand Down Expand Up @@ -56,13 +56,13 @@

$: selectedProposalOverview = $participationOverviewForSelectedWallet?.participations?.[$selectedProposal?.id]
$: trackedParticipations = Object.values(selectedProposalOverview ?? {})
$: currentMilestone = $networkStatus.currentMilestone
$: currentSlot = $networkStatus.currentSlot

// Reactively start updating votes once component has mounted and participation overview is available.
$: hasMounted &&
$selectedParticipationEventStatus &&
trackedParticipations &&
currentMilestone &&
currentSlot &&
setVotedAnswerValuesAndTotalVotes()
$: hasMounted && selectedProposalOverview && updateIsVoting()

Expand Down Expand Up @@ -121,6 +121,7 @@
}
}

// TODO(2.0): Update ProposalStatus when ParticipationEventData and TrackedParticipationOverview has been updated
cpl121 marked this conversation as resolved.
Show resolved Hide resolved
function setVotedAnswerValuesAndTotalVotes(): void {
let lastActiveOverview: TrackedParticipationOverview
switch ($selectedParticipationEventStatus?.status) {
Expand All @@ -137,7 +138,7 @@
break
case ProposalStatus.Ended:
lastActiveOverview = trackedParticipations?.find(
(overview) => overview.endMilestoneIndex > $selectedProposal.milestones.ended
(overview) => overview.endMilestoneIndex > $selectedProposal.slots.ended
)
totalVotes = calculateTotalVotesForTrackedParticipations(trackedParticipations)
break
Expand Down Expand Up @@ -186,10 +187,8 @@
}

const millis =
milestoneToDate(
$networkStatus.currentMilestone,
$selectedProposal.milestones[ProposalStatus.Commencing]
).getTime() - new Date().getTime()
slotToDate($networkStatus.currentSlot, $selectedProposal.milestones[ProposalStatus.Commencing]).getTime() -
new Date().getTime()
const timeString = getBestTimeDuration(millis, 'second')
return localize('views.governance.details.hintVote', { values: { time: timeString } })
}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
<script lang="ts">
import { localize } from '@core/i18n'
import { NetworkHealth, networkStatus, NETWORK_HEALTH_COLORS, nodeInfo } from '@core/network'
import { NetworkHealth, networkStatus, NETWORK_HEALTH_COLORS, nodeInfoNetworkName } from '@core/network'
import { NetworkSettingsRoute } from '@core/router'
import { Text } from 'shared/components'
import SettingsSection from '../SettingsSection.svelte'

$: health = $networkStatus.health ?? NetworkHealth.Disconnected
</script>

{#if $nodeInfo}
{#if $nodeInfoNetworkName}
<SettingsSection setting={NetworkSettingsRoute.NetworkInformation}>
<div class="flex flex-row justify-between">
<div class="flex flex-col space-y-1">
<Text secondary>
{localize('views.settings.networkInformation.connectedTo')}:
</Text>
<Text highlighted>{$nodeInfo.protocol.networkName}</Text>
<Text highlighted>{$nodeInfoNetworkName}</Text>
</div>
<div class="flex flex-col space-y-1">
<Text secondary>{localize('views.dashboard.network.status')}:</Text>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,10 @@
// Check network of node matches selected id
if (
networkId !== NetworkId.Custom &&
networkId !== getNetworkIdFromNetworkName(nodeInfoResponse?.nodeInfo?.protocol?.networkName)
networkId !==
getNetworkIdFromNetworkName(
nodeInfoResponse?.nodeInfo?.protocolParameters?.[0]?.parameters?.networkName
)
) {
throw new Error('error.node.differentNetwork')
}
Expand Down
12 changes: 8 additions & 4 deletions packages/shared/components/NodeConfigurationForm.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
import { NetworkId } from '@core/network'
import { EMPTY_NODE } from '@core/network/constants'
import { INode, INodeInfoResponse } from '@core/network/interfaces'
import { nodeInfo } from '@core/network/stores'
import { nodeInfoNetworkName } from '@core/network/stores'
import { checkNetworkId, checkNodeUrlValidity, getNetworkNameFromNetworkId } from '@core/network/utils'
import { activeProfile } from '@core/profile'
import { IDropdownItem, cleanUrl } from '@core/utils'
Expand Down Expand Up @@ -91,10 +91,10 @@
return Promise.reject({ type: 'validationError', error: formError })
}
}
const networkName = nodeInfoResponse?.nodeInfo?.protocol.networkName
const networkName = nodeInfoResponse?.nodeInfo?.protocolParameters?.[0]?.parameters?.networkName

if (options.checkSameNetwork) {
const isInSameNetwork = !!$nodeInfo && $nodeInfo.protocol.networkName === networkName
const isInSameNetwork = !!$nodeInfoNetworkName && $nodeInfoNetworkName === networkName
if (!isInSameNetwork) {
formError = localize('error.node.differentNetwork')
return Promise.reject({ type: 'validationError', error: formError })
Expand All @@ -109,7 +109,11 @@
}

if (options.validateClientOptions && currentClientOptions) {
const errorNetworkId = checkNetworkId(networkName, currentClientOptions.network, isDeveloperProfile)
const errorNetworkId = checkNetworkId(
networkName,
currentClientOptions.networkInfo?.protocolParameters?.networkName,
isDeveloperProfile
)
if (errorNetworkId) {
formError = localize(errorNetworkId?.locale, errorNetworkId?.values) ?? ''
return Promise.reject({ type: 'validationError', error: formError })
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ export interface IRegisteredProposals {

export interface IProposalMetadata {
id: string
milestones?: Record<ProposalStatus, number>
slots?: Record<ProposalStatus, number>
organization?: IOrganization
type: ProposalType
questions: Question[]
Expand Down
Loading
Loading