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: tell users when they have unrecoverable spaces #67

Open
wants to merge 2 commits into
base: old-main
Choose a base branch
from
Open
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
49 changes: 44 additions & 5 deletions src/app/page.tsx
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
'use client'

import { useW3, Space } from '@w3ui/react'
import { useW3, Space, Delegation, DIDKey, Abilities } from '@w3ui/react'
import { DidIcon } from '@/components/DidIcon'
import { ShieldCheckIcon, ShieldExclamationIcon } from '@heroicons/react/24/outline'
import Link from 'next/link'
import { SpacesNav } from './space/layout'
import { H2 } from '@/components/Text'
import SidebarLayout from '@/components/SidebarLayout'
import { ReactNode } from 'react'
import { useClaims } from '@/hooks'

export default function HomePage () {
return (
Expand All @@ -16,26 +18,57 @@ export default function HomePage () {
)
}

type RecoverableCapabilities = { [key: DIDKey]: Abilities }

/**
* A heuristic for determining the "recoverable capabilities" of
* spaces represented by a set of Delegations.
*
* First, finds any delegations that delegation * on ucan:*
* Next, searches through all proofs of these delegations,
* creating a map from resource names (assumed to be spaces) to a list
* of capabilities, like:
*
* {
* 'did:key:zkfirstspace': ['*']
* 'did:key:zksecondSpace': ['upload/add', 'store/add']
* }
*/
function guessRecoverableCapabilities(delegations: Delegation[]): RecoverableCapabilities {
return delegations.filter(d => ((d.capabilities[0].can === '*') && (d.capabilities[0].with === 'ucan:*')))
.map(d => d.proofs as Delegation[])
.reduce((m: any, proofs: Delegation[]) => [...m, ...proofs], [])
.reduce((m: any, proof: Delegation) => {
for (const capability of proof.capabilities) {
m[capability.with] = [...(m[capability.with] || []), capability.can]
}
return m
}, {})
}

function SpacePage (): ReactNode {
const [{ spaces }] = useW3()
const [{ spaces, client }] = useW3()
const { data: delegations } = useClaims(client)

if (spaces.length === 0) {
return <div></div>
}

const recoverableCapabilities = delegations && guessRecoverableCapabilities(delegations)

return (
<>
<SpacesNav />
<H2>Pick a Space</H2>
<div className='max-w-lg border rounded-md border-zinc-700'>
{ spaces.map(s => <Item space={s} key={s.did()} /> ) }
{spaces.map(s => <Item space={s} key={s.did()} recoverableAbilities={recoverableCapabilities ? (recoverableCapabilities[s.did()] || []) : undefined} />)}
</div>
</>
)
}

function Item ({space}: {space: Space}) {
return (
function Item ({ space, recoverableAbilities }: { space: Space, recoverableAbilities?: Abilities }) {
return (
<Link href={`/space/${space.did()}`} className='flex flex-row items-start gap-2 p-3 text-white text-left bg-gray-900/30 hover:bg-gray-900/60 border-b last:border-0 border-zinc-700'>
<DidIcon did={space.did()} />
<div className='grow overflow-hidden whitespace-nowrap text-ellipsis'>
Expand All @@ -46,6 +79,12 @@ function Item ({space}: {space: Space}) {
{space.did()}
</span>
</div>
{(typeof recoverableAbilities !== 'undefined') && (
(recoverableAbilities.length == 0) ? (
<ShieldExclamationIcon title="Space Not Recoverable" className='h-6 h-6 text-rose-300' />
) : (
<ShieldCheckIcon title="Space Recoverable" className='h-6 w-6 text-emerald-300'/>
))}
</Link>
)
}
13 changes: 12 additions & 1 deletion src/hooks.tsx
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
import { Account, PlanGetSuccess } from '@w3ui/react'
import { Account, Capabilities, Client, Delegation, PlanGetSuccess, Tuple } from '@w3ui/react'
import useSWR from 'swr'
import { claimAccess } from '@web3-storage/access/agent'


export const usePlan = (account: Account) =>
useSWR<PlanGetSuccess | undefined>(`/plan/${account?.did() ?? ''}`, {
Expand All @@ -10,4 +12,13 @@ export const usePlan = (account: Account) =>
return result.ok
},
onError: err => console.error(err.message, err.cause)
})

export const useClaims = (client: Client | undefined) =>
useSWR<Tuple<Delegation<Capabilities>> | undefined>(client && `/claims/${client.agent.did()}`, {
fetcher: async () => {
if (!client) return
return await client.capability.access.claim()
},
onError: err => console.error(err.message, err.cause)
})
Loading