commit d92d3f76ae719c85a3fd2f76fabace6e5628d58c · edouard.paris/did-method-plc

+35 -10

packages/lib/src/client.ts

···

       1
       -
       import { cidForCbor } from '@atproto/common'

     

       2
        
       import { Keypair } from '@atproto/crypto'

     

       3
        
       import axios from 'axios'

     

       4
       -
       import { didForCreateOp, signOperation } from './operations'

     

       5
        
       import * as t from './types'

     

       6
        
       

     

       7
        
       export class Client {

     
···

       13
        
         }

     

       14
        
       

     

       15
        
         async getDocumentData(did: string): Promise<t.DocumentData> {

     

       16
       -
           const res = await axios.get(`${this.url}/data/${encodeURIComponent(did)}`)

     

       17
        
           return res.data

     

       18
        
         }

     

       19
        
       

     

       20
       -
         async getOperationLog(did: string): Promise<t.Operation[]> {

     

       21
       -
           const res = await axios.get(`${this.url}/log/${encodeURIComponent(did)}`)

     

       22
       -
           return res.data.log

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       23
        
         }

     

       24
        
       

     

       25
        
         postOpUrl(did: string): string {

     

       26
        
           return `${this.url}/${encodeURIComponent(did)}`

     

       27
        
         }

     

       28
        
       

     

       29
       -
         async getLastOp(did: string): Promise<t.Operation> {

     

       30
       -
           const res = await axios.get(`${this.url}/last/${encodeURIComponent(did)}`)

     

       0
        
       
     

       0
        
       
     

       31
        
           return res.data

     

       32
        
         }

     

       33
        
       

     
···

       37
        
           key: Keypair,

     

       38
        
         ) {

     

       39
        
           const lastOp = await this.getLastOp(did)

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       40
        
           const prev = await cidForCbor(lastOp)

     

       41
       -
           const { signingKey, rotationKeys, handles, services } = lastOp

     

       42
        
           const op = await signOperation(

     

       43
        
             {

     

       44
        
               signingKey,

     
···

       69
        
           return did

     

       70
        
         }

     

       71
        
       

     

       72
       -
         async sendOperation(did: string, op: t.Operation) {

     

       73
        
           await axios.post(this.postOpUrl(did), op)

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       74
        
         }

     

       75
        
       

     

       76
        
         async health() {

···

       1
       +
       import { check, cidForCbor } from '@atproto/common'

     

       2
        
       import { Keypair } from '@atproto/crypto'

     

       3
        
       import axios from 'axios'

     

       4
       +
       import { didForCreateOp, normalizeOp, signOperation } from './operations'

     

       5
        
       import * as t from './types'

     

       6
        
       

     

       7
        
       export class Client {

     
···

       13
        
         }

     

       14
        
       

     

       15
        
         async getDocumentData(did: string): Promise<t.DocumentData> {

     

       16
       +
           const res = await axios.get(`${this.url}/${encodeURIComponent(did)}/data`)

     

       17
        
           return res.data

     

       18
        
         }

     

       19
        
       

     

       20
       +
         async getOperationLog(did: string): Promise<t.CompatibleOpOrTombstone[]> {

     

       21
       +
           const res = await axios.get(`${this.url}/${encodeURIComponent(did)}/log`)

     

       22
       +
           return res.data

     

       23
       +
         }

     

       24
       +
       

     

       25
       +
         async getAuditableLog(did: string): Promise<t.ExportedOp[]> {

     

       26
       +
           const res = await axios.get(

     

       27
       +
             `${this.url}/${encodeURIComponent(did)}/log/audit`,

     

       28
       +
           )

     

       29
       +
           return res.data

     

       30
        
         }

     

       31
        
       

     

       32
        
         postOpUrl(did: string): string {

     

       33
        
           return `${this.url}/${encodeURIComponent(did)}`

     

       34
        
         }

     

       35
        
       

     

       36
       +
         async getLastOp(did: string): Promise<t.CompatibleOpOrTombstone> {

     

       37
       +
           const res = await axios.get(

     

       38
       +
             `${this.url}/${encodeURIComponent(did)}/log/last`,

     

       39
       +
           )

     

       40
        
           return res.data

     

       41
        
         }

     

       42
        
       

     
···

       46
        
           key: Keypair,

     

       47
        
         ) {

     

       48
        
           const lastOp = await this.getLastOp(did)

     

       49
       +
           if (check.is(lastOp, t.def.tombstone)) {

     

       50
       +
             throw new Error('Cannot apply op to tombstone')

     

       51
       +
           }

     

       52
        
           const prev = await cidForCbor(lastOp)

     

       53
       +
           const { signingKey, rotationKeys, handles, services } = normalizeOp(lastOp)

     

       54
        
           const op = await signOperation(

     

       55
        
             {

     

       56
        
               signingKey,

     
···

       81
        
           return did

     

       82
        
         }

     

       83
        
       

     

       84
       +
         async sendOperation(did: string, op: t.OpOrTombstone) {

     

       85
        
           await axios.post(this.postOpUrl(did), op)

     

       86
       +
         }

     

       87
       +
       

     

       88
       +
         async export(after?: string, count?: number): Promise<t.ExportedOp[]> {

     

       89
       +
           const url = new URL(`${this.url}/export`)

     

       90
       +
           if (after) {

     

       91
       +
             url.searchParams.append('after', after)

     

       92
       +
           }

     

       93
       +
           if (count !== undefined) {

     

       94
       +
             url.searchParams.append('count', count.toString(10))

     

       95
       +
           }

     

       96
       +
           const res = await axios.get(url.toString())

     

       97
       +
           const lines = res.data.split('\n')

     

       98
       +
           return lines.map((l) => JSON.parse(l))

     

       99
        
         }

     

       100
        
       

     

       101
        
         async health() {

+11

packages/lib/src/types.ts

···

       68
        
       })

     

       69
        
       export type IndexedOperation = z.infer<typeof indexedOperation>

     

       70
        
       

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       71
        
       export const didDocVerificationMethod = z.object({

     

       72
        
         id: z.string(),

     

       73
        
         type: z.string(),

     
···

       102
        
         opOrTombstone,

     

       103
        
         compatibleOp,

     

       104
        
         compatibleOpOrTombstone,

     

       0
        
       
     

       0
        
       
     

       105
        
         didDocument,

     

       106
        
       }

···

       68
        
       })

     

       69
        
       export type IndexedOperation = z.infer<typeof indexedOperation>

     

       70
        
       

     

       71
       +
       export const exportedOp = z.object({

     

       72
       +
         did: z.string(),

     

       73
       +
         operation: compatibleOpOrTombstone,

     

       74
       +
         cid: z.string(),

     

       75
       +
         nullified: z.boolean(),

     

       76
       +
         createdAt: z.string(),

     

       77
       +
       })

     

       78
       +
       export type ExportedOp = z.infer<typeof exportedOp>

     

       79
       +
       

     

       80
        
       export const didDocVerificationMethod = z.object({

     

       81
        
         id: z.string(),

     

       82
        
         type: z.string(),

     
···

       111
        
         opOrTombstone,

     

       112
        
         compatibleOp,

     

       113
        
         compatibleOpOrTombstone,

     

       114
       +
         indexedOperation,

     

       115
       +
         exportedOp,

     

       116
        
         didDocument,

     

       117
        
       }

+1 -1

packages/lib/tests/compatibility.test.ts

···

       78
        
       

     

       79
        
           const result = await assureValidNextOp(did, [indexedLegacy], nextOp)

     

       80
        
           expect(result.nullified.length).toBe(0)

     

       81
       -
           expect(result.prev?.equals(legacyCid))

     

       82
        
         })

     

       83
        
       })

···

       78
        
       

     

       79
        
           const result = await assureValidNextOp(did, [indexedLegacy], nextOp)

     

       80
        
           expect(result.nullified.length).toBe(0)

     

       81
       +
           expect(result.prev?.equals(legacyCid)).toBeTruthy()

     

       82
        
         })

     

       83
        
       })

+3 -3

packages/lib/tests/recovery.test.ts

···

       106
        
           expect(res.nullified.length).toBe(2)

     

       107
        
           expect(res.nullified[0].equals(log[1].cid))

     

       108
        
           expect(res.nullified[1].equals(log[2].cid))

     

       109
       -
           expect(res.prev?.equals(createCid))

     

       110
        
       

     

       111
        
           log = [log[0], rotate.indexed]

     

       112
        
         })

     
···

       124
        
           const res = await data.assureValidNextOp(did, log, rotate.op)

     

       125
        
           expect(res.nullified.length).toBe(1)

     

       126
        
           expect(res.nullified[0].equals(log[1].cid))

     

       127
       -
           expect(res.prev?.equals(createCid))

     

       128
        
       

     

       129
        
           log = [log[0], rotate.indexed]

     

       130
        
         })

     
···

       185
        
           )

     

       186
        
           expect(result.nullified.length).toBe(1)

     

       187
        
           expect(result.nullified[0].equals(cid))

     

       188
       -
           expect(result.prev?.equals(createCid))

     

       189
        
         })

     

       190
        
       })

···

       106
        
           expect(res.nullified.length).toBe(2)

     

       107
        
           expect(res.nullified[0].equals(log[1].cid))

     

       108
        
           expect(res.nullified[1].equals(log[2].cid))

     

       109
       +
           expect(res.prev?.equals(createCid)).toBeTruthy()

     

       110
        
       

     

       111
        
           log = [log[0], rotate.indexed]

     

       112
        
         })

     
···

       124
        
           const res = await data.assureValidNextOp(did, log, rotate.op)

     

       125
        
           expect(res.nullified.length).toBe(1)

     

       126
        
           expect(res.nullified[0].equals(log[1].cid))

     

       127
       +
           expect(res.prev?.equals(createCid)).toBeTruthy()

     

       128
        
       

     

       129
        
           log = [log[0], rotate.indexed]

     

       130
        
         })

     
···

       185
        
           )

     

       186
        
           expect(result.nullified.length).toBe(1)

     

       187
        
           expect(result.nullified[0].equals(cid))

     

       188
       +
           expect(result.prev?.equals(createCid)).toBeTruthy()

     

       189
        
         })

     

       190
        
       })

+42 -46

packages/server/src/db/index.ts

···

       1
       -
       import { Generated, Kysely, Migrator, PostgresDialect, sql } from 'kysely'

     

       2
        
       import { Pool as PgPool, types as pgTypes } from 'pg'

     

       3
        
       import { CID } from 'multiformats/cid'

     

       4
       -
       import { cidForCbor, check } from '@atproto/common'

     

       5
        
       import * as plc from '@did-plc/lib'

     

       6
        
       import { ServerError } from '../error'

     

       7
        
       import * as migrations from '../migrations'

     

       8
       -
       import { OpLogExport, PlcDatabase } from './types'

     

       9
        
       import MockDatabase from './mock'

     

       10
        
       

     

       11
        
       export * from './mock'

     
···

       93
        
         }

     

       94
        
       

     

       95
        
         async validateAndAddOp(did: string, proposed: plc.Operation): Promise<void> {

     

       96
       -
           const ops = await this._opsForDid(did)

     

       97
        
           // throws if invalid

     

       98
        
           const { nullified, prev } = await plc.assureValidNextOp(did, ops, proposed)

     

       99
        
           const cid = await cidForCbor(proposed)

     
···

       158
        
           return found ? CID.parse(found.cid) : null

     

       159
        
         }

     

       160
        
       

     

       161
       -
         async opsForDid(did: string): Promise<plc.OpOrTombstone[]> {

     

       162
       -
           const ops = await this._opsForDid(did)

     

       163
       -
           return ops.map((op) => {

     

       164
       -
             if (check.is(op.operation, plc.def.createOpV1)) {

     

       165
       -
               return plc.normalizeOp(op.operation)

     

       166
       -
             }

     

       167
       -
             return op.operation

     

       168
       -
           })

     

       169
        
         }

     

       170
        
       

     

       171
       -
         async _opsForDid(did: string): Promise<plc.IndexedOperation[]> {

     

       172
       -
           const res = await this.db

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       173
        
             .selectFrom('operations')

     

       174
        
             .selectAll()

     

       175
        
             .where('did', '=', did)

     

       176
       -
             .where('nullified', '=', false)

     

       177
        
             .orderBy('createdAt', 'asc')

     

       178
       -
             .execute()

     

       179
       -
       

     

       0
        
       
     

       0
        
       
     

       180
        
           return res.map((row) => ({

     

       181
        
             did: row.did,

     

       182
        
             operation: row.operation,

     
···

       186
        
           }))

     

       187
        
         }

     

       188
        
       

     

       189
       -
         async fullExport(): Promise<Record<string, OpLogExport>> {

     

       190
       -
           return {}

     

       191
       -
           //   const res = await this.db

     

       192
       -
           //     .selectFrom('operations')

     

       193
       -
           //     .selectAll()

     

       194
       -
           //     .orderBy('did')

     

       195
       -
           //     .orderBy('createdAt')

     

       196
       -
           //     .execute()

     

       197
       -
           //   return res.reduce((acc, cur) => {

     

       198
       -
           //     acc[cur.did] ??= []

     

       199
       -
           //     acc[cur.did].push({

     

       200
       -
           //       op: cur.operation),

     

       201
       -
           //       nullified: cur.nullified === 1,

     

       202
       -
           //       createdAt: cur.createdAt,

     

       203
       -
           //     })

     

       204
       -
           //     return acc

     

       205
       -
           //   }, {} as Record<string, OpLogExport>)

     

       206
        
         }

     

       207
       -
       }

     

       208
        
       

     

       209
       -
       export default Database

     

       210
       -
       

     

       211
       -
       interface OperationsTable {

     

       212
       -
         did: string

     

       213
       -
         operation: plc.CompatibleOpOrTombstone

     

       214
       -
         cid: string

     

       215
       -
         nullified: boolean

     

       216
       -
         createdAt: Generated<Date>

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       217
        
       }

     

       218
        
       

     

       219
       -
       interface DatabaseSchema {

     

       220
       -
         operations: OperationsTable

     

       221
       -
       }

···

       1
       +
       import { Kysely, Migrator, PostgresDialect, sql } from 'kysely'

     

       2
        
       import { Pool as PgPool, types as pgTypes } from 'pg'

     

       3
        
       import { CID } from 'multiformats/cid'

     

       4
       +
       import { cidForCbor } from '@atproto/common'

     

       5
        
       import * as plc from '@did-plc/lib'

     

       6
        
       import { ServerError } from '../error'

     

       7
        
       import * as migrations from '../migrations'

     

       8
       +
       import { DatabaseSchema, PlcDatabase } from './types'

     

       9
        
       import MockDatabase from './mock'

     

       10
        
       

     

       11
        
       export * from './mock'

     
···

       93
        
         }

     

       94
        
       

     

       95
        
         async validateAndAddOp(did: string, proposed: plc.Operation): Promise<void> {

     

       96
       +
           const ops = await this.indexedOpsForDid(did)

     

       97
        
           // throws if invalid

     

       98
        
           const { nullified, prev } = await plc.assureValidNextOp(did, ops, proposed)

     

       99
        
           const cid = await cidForCbor(proposed)

     
···

       158
        
           return found ? CID.parse(found.cid) : null

     

       159
        
         }

     

       160
        
       

     

       161
       +
         async opsForDid(did: string): Promise<plc.CompatibleOpOrTombstone[]> {

     

       162
       +
           const ops = await this.indexedOpsForDid(did)

     

       163
       +
           return ops.map((op) => op.operation)

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       164
        
         }

     

       165
        
       

     

       166
       +
         async indexedOpsForDid(

     

       167
       +
           did: string,

     

       168
       +
           includeNullified = false,

     

       169
       +
         ): Promise<plc.IndexedOperation[]> {

     

       170
       +
           let builder = this.db

     

       171
        
             .selectFrom('operations')

     

       172
        
             .selectAll()

     

       173
        
             .where('did', '=', did)

     

       0
        
       
     

       174
        
             .orderBy('createdAt', 'asc')

     

       175
       +
           if (!includeNullified) {

     

       176
       +
             builder = builder.where('nullified', '=', false)

     

       177
       +
           }

     

       178
       +
           const res = await builder.execute()

     

       179
        
           return res.map((row) => ({

     

       180
        
             did: row.did,

     

       181
        
             operation: row.operation,

     
···

       185
        
           }))

     

       186
        
         }

     

       187
        
       

     

       188
       +
         async lastOpForDid(did: string): Promise<plc.CompatibleOpOrTombstone | null> {

     

       189
       +
           const res = await this.db

     

       190
       +
             .selectFrom('operations')

     

       191
       +
             .selectAll()

     

       192
       +
             .where('did', '=', did)

     

       193
       +
             .where('nullified', '=', false)

     

       194
       +
             .orderBy('createdAt', 'desc')

     

       195
       +
             .limit(1)

     

       196
       +
             .executeTakeFirst()

     

       197
       +
           return res?.operation ?? null

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       198
        
         }

     

       0
        
       
     

       199
        
       

     

       200
       +
         async exportOps(count: number, after?: Date): Promise<plc.ExportedOp[]> {

     

       201
       +
           let builder = this.db

     

       202
       +
             .selectFrom('operations')

     

       203
       +
             .selectAll()

     

       204
       +
             .orderBy('createdAt', 'asc')

     

       205
       +
             .limit(count)

     

       206
       +
           if (after) {

     

       207
       +
             builder = builder.where('createdAt', '>', after)

     

       208
       +
           }

     

       209
       +
           const res = await builder.execute()

     

       210
       +
           return res.map((row) => ({

     

       211
       +
             ...row,

     

       212
       +
             createdAt: row.createdAt.toISOString(),

     

       213
       +
           }))

     

       214
       +
         }

     

       215
        
       }

     

       216
        
       

     

       217
       +
       export default Database

     

       0
        
       
     

       0

+22 -7

packages/server/src/db/mock.ts

···

       1
        
       import { cidForCbor, check } from '@atproto/common'

     

       2
        
       import * as plc from '@did-plc/lib'

     

       3
        
       import { ServerError } from '../error'

     

       4
       -
       import { OpLogExport, PlcDatabase } from './types'

     

       5
        
       

     

       6
        
       type Contents = Record<string, plc.IndexedOperation[]>

     

       7
        
       

     
···

       43
        
           }

     

       44
        
         }

     

       45
        
       

     

       46
       -
         async opsForDid(did: string): Promise<plc.OpOrTombstone[]> {

     

       47
       -
           const ops = await this._opsForDid(did)

     

       48
        
           return ops.map((op) => {

     

       49
        
             if (check.is(op.operation, plc.def.createOpV1)) {

     

       50
        
               return plc.normalizeOp(op.operation)

     
···

       53
        
           })

     

       54
        
         }

     

       55
        
       

     

       56
       -
         async _opsForDid(did: string): Promise<plc.IndexedOperation[]> {

     

       57
       -
           return this.contents[did] ?? []

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       58
        
         }

     

       59
        
       

     

       60
       -
         async fullExport(): Promise<Record<string, OpLogExport>> {

     

       61
       -
           return {}

     

       0
        
       
     

       62
        
         }

     

       63
        
       }

     

       64

···

       1
        
       import { cidForCbor, check } from '@atproto/common'

     

       2
        
       import * as plc from '@did-plc/lib'

     

       3
        
       import { ServerError } from '../error'

     

       4
       +
       import { PlcDatabase } from './types'

     

       5
        
       

     

       6
        
       type Contents = Record<string, plc.IndexedOperation[]>

     

       7
        
       

     
···

       43
        
           }

     

       44
        
         }

     

       45
        
       

     

       46
       +
         async opsForDid(did: string): Promise<plc.CompatibleOpOrTombstone[]> {

     

       47
       +
           const ops = await this.indexedOpsForDid(did)

     

       48
        
           return ops.map((op) => {

     

       49
        
             if (check.is(op.operation, plc.def.createOpV1)) {

     

       50
        
               return plc.normalizeOp(op.operation)

     
···

       53
        
           })

     

       54
        
         }

     

       55
        
       

     

       56
       +
         async indexedOpsForDid(

     

       57
       +
           did: string,

     

       58
       +
           includeNull = false,

     

       59
       +
         ): Promise<plc.IndexedOperation[]> {

     

       60
       +
           const ops = this.contents[did] ?? []

     

       61
       +
           if (includeNull) {

     

       62
       +
             return ops

     

       63
       +
           }

     

       64
       +
           return ops.filter((op) => op.nullified === false)

     

       65
       +
         }

     

       66
       +
       

     

       67
       +
         async lastOpForDid(did: string): Promise<plc.CompatibleOpOrTombstone | null> {

     

       68
       +
           const op = this.contents[did]?.at(-1)

     

       69
       +
       

     

       70
       +
           if (!op) return null

     

       71
       +
           return op.operation

     

       72
        
         }

     

       73
        
       

     

       74
       +
         // disabled in mocks

     

       75
       +
         async exportOps(_count: number, _after?: Date): Promise<plc.ExportedOp[]> {

     

       76
       +
           return []

     

       77
        
         }

     

       78
        
       }

     

       79

+17 -8

packages/server/src/db/types.ts

···

       1
        
       import * as plc from '@did-plc/lib'

     

       0
        
       
     

       2
        
       

     

       3
        
       export interface PlcDatabase {

     

       4
        
         close(): Promise<void>

     

       5
        
         healthCheck(): Promise<void>

     

       6
        
         validateAndAddOp(did: string, proposed: plc.Operation): Promise<void>

     

       7
       -
         opsForDid(did: string): Promise<plc.OpOrTombstone[]>

     

       8
       -
         _opsForDid(did: string): Promise<plc.IndexedOperation[]>

     

       9
       -
         fullExport(): Promise<Record<string, OpLogExport>>

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       10
        
       }

     

       11
        
       

     

       12
       -
       export type OpLogExport = OpExport[]

     

       13
       -
       

     

       14
       -
       export type OpExport = {

     

       15
       -
         op: Record<string, unknown>

     

       16
        
         nullified: boolean

     

       17
       -
         createdAt: string

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       18
        
       }

···

       1
        
       import * as plc from '@did-plc/lib'

     

       2
       +
       import { Generated } from 'kysely'

     

       3
        
       

     

       4
        
       export interface PlcDatabase {

     

       5
        
         close(): Promise<void>

     

       6
        
         healthCheck(): Promise<void>

     

       7
        
         validateAndAddOp(did: string, proposed: plc.Operation): Promise<void>

     

       8
       +
         opsForDid(did: string): Promise<plc.CompatibleOpOrTombstone[]>

     

       9
       +
         indexedOpsForDid(

     

       10
       +
           did: string,

     

       11
       +
           includeNull?: boolean,

     

       12
       +
         ): Promise<plc.IndexedOperation[]>

     

       13
       +
         lastOpForDid(did: string): Promise<plc.CompatibleOpOrTombstone | null>

     

       14
       +
         exportOps(count: number, after?: Date): Promise<plc.ExportedOp[]>

     

       15
        
       }

     

       16
        
       

     

       17
       +
       export interface OperationsTable {

     

       18
       +
         did: string

     

       19
       +
         operation: plc.CompatibleOpOrTombstone

     

       20
       +
         cid: string

     

       21
        
         nullified: boolean

     

       22
       +
         createdAt: Generated<Date>

     

       23
       +
       }

     

       24
       +
       

     

       25
       +
       export interface DatabaseSchema {

     

       26
       +
         operations: OperationsTable

     

       27
        
       }

+36 -13

packages/server/src/routes.ts

···

       18
        
           res.send({ version })

     

       19
        
         })

     

       20
        
       

     

       21
       -
         // @TODO paginate & test this

     

       22
        
         router.get('/export', async function (req, res) {

     

       23
       -
           const fullExport = await ctx.db.fullExport()

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       24
        
           res.setHeader('content-type', 'application/jsonlines')

     

       25
        
           res.status(200)

     

       26
       -
           for (const [did, ops] of Object.entries(fullExport)) {

     

       27
       -
             const line = JSON.stringify({ did, ops })

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       28
        
             res.write(line)

     

       29
       -
             res.write('\n')

     

       30
        
           }

     

       31
        
           res.end()

     

       32
        
         })

     
···

       48
        
         })

     

       49
        
       

     

       50
        
         // Get data for a DID document

     

       51
       -
         router.get('/data/:did', async function (req, res) {

     

       52
        
           const { did } = req.params

     

       53
        
           const log = await ctx.db.opsForDid(did)

     

       54
        
           if (log.length === 0) {

     
···

       62
        
         })

     

       63
        
       

     

       64
        
         // Get operation log for a DID

     

       65
       -
         router.get('/log/:did', async function (req, res) {

     

       66
        
           const { did } = req.params

     

       67
        
           const log = await ctx.db.opsForDid(did)

     

       68
        
           if (log.length === 0) {

     

       69
        
             throw new ServerError(404, `DID not registered: ${did}`)

     

       70
        
           }

     

       71
       -
           res.json({ log })

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       72
        
         })

     

       73
        
       

     

       74
        
         // Get the most recent operation in the log for a DID

     

       75
       -
         router.get('/last/:did', async function (req, res) {

     

       76
        
           const { did } = req.params

     

       77
       -
           const log = await ctx.db.opsForDid(did)

     

       78
       -
           const curr = log.at(-1)

     

       79
       -
           if (!curr) {

     

       80
        
             throw new ServerError(404, `DID not registered: ${did}`)

     

       81
        
           }

     

       82
       -
           res.json(curr)

     

       83
        
         })

     

       84
        
       

     

       85
        
         // Update or create a DID doc

···

       18
        
           res.send({ version })

     

       19
        
         })

     

       20
        
       

     

       21
       +
         // Export ops in the form of paginated json lines

     

       22
        
         router.get('/export', async function (req, res) {

     

       23
       +
           const parsedCount = req.count ? parseInt(req.count, 10) : 1000

     

       24
       +
           if (isNaN(parsedCount) || parsedCount < 1) {

     

       25
       +
             throw new ServerError(400, 'Invalid count parameter')

     

       26
       +
           }

     

       27
       +
           const count = Math.min(parsedCount, 1000)

     

       28
       +
           const after = req.query.after ? new Date(req.query.after) : undefined

     

       29
       +
           const ops = await ctx.db.exportOps(count, after)

     

       30
        
           res.setHeader('content-type', 'application/jsonlines')

     

       31
        
           res.status(200)

     

       32
       +
           for (let i = 0; i < ops.length; i++) {

     

       33
       +
             if (i > 0) {

     

       34
       +
               res.write('\n')

     

       35
       +
             }

     

       36
       +
             const line = JSON.stringify(ops[i])

     

       37
        
             res.write(line)

     

       0
        
       
     

       38
        
           }

     

       39
        
           res.end()

     

       40
        
         })

     
···

       56
        
         })

     

       57
        
       

     

       58
        
         // Get data for a DID document

     

       59
       +
         router.get('/:did/data', async function (req, res) {

     

       60
        
           const { did } = req.params

     

       61
        
           const log = await ctx.db.opsForDid(did)

     

       62
        
           if (log.length === 0) {

     
···

       70
        
         })

     

       71
        
       

     

       72
        
         // Get operation log for a DID

     

       73
       +
         router.get('/:did/log', async function (req, res) {

     

       74
        
           const { did } = req.params

     

       75
        
           const log = await ctx.db.opsForDid(did)

     

       76
        
           if (log.length === 0) {

     

       77
        
             throw new ServerError(404, `DID not registered: ${did}`)

     

       78
        
           }

     

       79
       +
           res.json(log)

     

       80
       +
         })

     

       81
       +
       

     

       82
       +
         // Get operation log for a DID

     

       83
       +
         router.get('/:did/log/audit', async function (req, res) {

     

       84
       +
           const { did } = req.params

     

       85
       +
           const ops = await ctx.db.indexedOpsForDid(did, true)

     

       86
       +
           if (ops.length === 0) {

     

       87
       +
             throw new ServerError(404, `DID not registered: ${did}`)

     

       88
       +
           }

     

       89
       +
           const log = ops.map((op) => ({

     

       90
       +
             ...op,

     

       91
       +
             cid: op.cid.toString(),

     

       92
       +
             createdAt: op.createdAt.toISOString(),

     

       93
       +
           }))

     

       94
       +
       

     

       95
       +
           res.json(log)

     

       96
        
         })

     

       97
        
       

     

       98
        
         // Get the most recent operation in the log for a DID

     

       99
       +
         router.get('/:did/log/last', async function (req, res) {

     

       100
        
           const { did } = req.params

     

       101
       +
           const last = await ctx.db.lastOpForDid(did)

     

       102
       +
           if (!last) {

     

       0
        
       
     

       103
        
             throw new ServerError(404, `DID not registered: ${did}`)

     

       104
        
           }

     

       105
       +
           res.json(last)

     

       106
        
         })

     

       107
        
       

     

       108
        
         // Update or create a DID doc

+23 -2

packages/server/tests/server.test.ts

···

       1
        
       import { EcdsaKeypair } from '@atproto/crypto'

     

       2
        
       import * as plc from '@did-plc/lib'

     

       3
        
       import { CloseFn, runTestServer } from './_util'

     

       4
       -
       import { cidForCbor } from '@atproto/common'

     

       5
        
       import { AxiosError } from 'axios'

     

       6
        
       import { Database } from '../src'

     

       7
        
       import { signOperation } from '@did-plc/lib'

     
···

       133
        
           const newKey = await EcdsaKeypair.create()

     

       134
        
           const ops = await client.getOperationLog(did)

     

       135
        
           const forkPoint = ops.at(-2)

     

       136
       -
           if (!forkPoint) {

     

       137
        
             throw new Error('Could not find fork point')

     

       138
        
           }

     

       139
        
           const forkCid = await cidForCbor(forkPoint)

     
···

       157
        
           expect(doc.rotationKeys).toEqual([newKey.did()])

     

       158
        
           expect(doc.handles).toEqual([handle])

     

       159
        
           expect(doc.services).toEqual({ atpPds })

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       160
        
         })

     

       161
        
       

     

       162
        
         it('retrieves the did doc', async () => {

     
···

       217
        
       

     

       218
        
           const ops = await client.getOperationLog(did)

     

       219
        
           await plc.validateOperationLog(did, ops)

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       220
        
         })

     

       221
        
       

     

       222
        
         it('healthcheck succeeds when database is available.', async () => {

···

       1
        
       import { EcdsaKeypair } from '@atproto/crypto'

     

       2
        
       import * as plc from '@did-plc/lib'

     

       3
        
       import { CloseFn, runTestServer } from './_util'

     

       4
       +
       import { check, cidForCbor } from '@atproto/common'

     

       5
        
       import { AxiosError } from 'axios'

     

       6
        
       import { Database } from '../src'

     

       7
        
       import { signOperation } from '@did-plc/lib'

     
···

       133
        
           const newKey = await EcdsaKeypair.create()

     

       134
        
           const ops = await client.getOperationLog(did)

     

       135
        
           const forkPoint = ops.at(-2)

     

       136
       +
           if (!check.is(forkPoint, plc.def.operation)) {

     

       137
        
             throw new Error('Could not find fork point')

     

       138
        
           }

     

       139
        
           const forkCid = await cidForCbor(forkPoint)

     
···

       157
        
           expect(doc.rotationKeys).toEqual([newKey.did()])

     

       158
        
           expect(doc.handles).toEqual([handle])

     

       159
        
           expect(doc.services).toEqual({ atpPds })

     

       160
       +
         })

     

       161
       +
       

     

       162
       +
         it('retrieves the auditable operation log', async () => {

     

       163
       +
           const log = await client.getOperationLog(did)

     

       164
       +
           const auditable = await client.getAuditableLog(did)

     

       165
       +
           // has one nullifed op

     

       166
       +
           expect(auditable.length).toBe(log.length + 1)

     

       167
       +
           expect(auditable.filter((op) => op.nullified).length).toBe(1)

     

       168
       +
           expect(auditable.at(-2)?.nullified).toBe(true)

     

       169
       +
           expect(

     

       170
       +
             auditable.every((op) => check.is(op, plc.def.exportedOp)),

     

       171
       +
           ).toBeTruthy()

     

       172
        
         })

     

       173
        
       

     

       174
        
         it('retrieves the did doc', async () => {

     
···

       229
        
       

     

       230
        
           const ops = await client.getOperationLog(did)

     

       231
        
           await plc.validateOperationLog(did, ops)

     

       232
       +
         })

     

       233
       +
       

     

       234
       +
         it('exports the data set', async () => {

     

       235
       +
           const data = await client.export()

     

       236
       +
           expect(data.every((row) => check.is(row, plc.def.exportedOp))).toBeTruthy()

     

       237
       +
           expect(data.length).toBe(58)

     

       238
       +
           for (let i = 1; i < data.length; i++) {

     

       239
       +
             expect(data[i].createdAt >= data[i - 1].createdAt).toBeTruthy()

     

       240
       +
           }

     

       241
        
         })

     

       242
        
       

     

       243
        
         it('healthcheck succeeds when database is available.', async () => {