commit 7ed6378a0e6aafe8ec5a03814b382ba047a6a13e · edouard.paris/did-method-plc

+29 -6

packages/lib/src/client.ts

···

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

     

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

     

       3
       3
        
       import axios from 'axios'

     

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

     

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

     

       5
       5
        
       import * as t from './types'

     

       6
       6
        
       

     

       7
       7
        
       export class Client {

     
···

       27
       27
        
         }

     

       28
       28
        
       

     

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

     

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

     

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

     

       31
       31
        
           return res.data

     

       32
       32
        
         }

     

       33
       33
        
       

     

       34
       34
       -
         async applyPartialOp(did: string, delta: Partial<t.Operation>, key: Keypair) {

     

       34
       34
       +
         async applyPartialOp(

     

       35
       35
       +
           did: string,

     

       36
       36
       +
           delta: Partial<t.UnsignedOperation>,

     

       37
       37
       +
           key: Keypair,

     

       38
       38
       +
         ) {

     

       35
       39
        
           const lastOp = await this.getLastOp(did)

     

       36
       40
        
           const prev = await cidForCbor(lastOp)

     

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

     

       37
       42
        
           const op = await signOperation(

     

       38
       43
        
             {

     

       39
       39
       -
               ...lastOp,

     

       40
       40
       -
               ...delta,

     

       44
       44
       +
               signingKey,

     

       45
       45
       +
               rotationKeys,

     

       46
       46
       +
               handles,

     

       47
       47
       +
               services,

     

       41
       48
        
               prev: prev.toString(),

     

       49
       49
       +
               ...delta,

     

       42
       50
        
             },

     

       43
       51
        
             key,

     

       44
       52
        
           )

     

       45
       45
       -
           console.log(op)

     

       46
       53
        
           await this.sendOperation(did, op)

     

       54
       54
       +
         }

     

       55
       55
       +
       

     

       56
       56
       +
         async create(

     

       57
       57
       +
           op: Omit<t.UnsignedOperation, 'prev'>,

     

       58
       58
       +
           key: Keypair,

     

       59
       59
       +
         ): Promise<string> {

     

       60
       60
       +
           const createOp = await signOperation(

     

       61
       61
       +
             {

     

       62
       62
       +
               ...op,

     

       63
       63
       +
               prev: null,

     

       64
       64
       +
             },

     

       65
       65
       +
             key,

     

       66
       66
       +
           )

     

       67
       67
       +
           const did = await didForCreateOp(createOp)

     

       68
       68
       +
           await this.sendOperation(did, createOp)

     

       69
       69
       +
           return did

     

       47
       70
        
         }

     

       48
       71
        
       

     

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

+13 -2

packages/server/src/logger.ts

···

       1
       1
        
       import pino from 'pino'

     

       2
       2
        
       import pinoHttp from 'pino-http'

     

       3
       3
        
       

     

       4
       4
       -
       // @TODO fix this up

     

       5
       5
       -
       export const logger = pino()

     

       4
       4
       +
       const enabledEnv = process.env.LOG_ENABLED

     

       5
       5
       +
       const enabled =

     

       6
       6
       +
         enabledEnv === 'true' || enabledEnv === 't' || enabledEnv === '1'

     

       7
       7
       +
       const level = process.env.LOG_LEVEL || 'info'

     

       8
       8
       +
       

     

       9
       9
       +
       const config = {

     

       10
       10
       +
         enabled,

     

       11
       11
       +
         level,

     

       12
       12
       +
       }

     

       13
       13
       +
       

     

       14
       14
       +
       const logger = process.env.LOG_DESTINATION

     

       15
       15
       +
         ? pino(config, pino.destination(process.env.LOG_DESTINATION))

     

       16
       16
       +
         : pino(config)

     

       6
       17
        
       

     

       7
       18
        
       export const loggerMiddleware = pinoHttp({

     

       8
       19
        
         logger,

+3 -3

packages/server/src/routes.ts

···

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

     

       53
       53
        
           }

     

       54
       54
        
           const data = await plc.validateOperationLog(did, log)

     

       55
       55
       -
           res.send(data)

     

       55
       55
       +
           res.json(data)

     

       56
       56
        
         })

     

       57
       57
        
       

     

       58
       58
        
         // Get operation log for a DID

     
···

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

     

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

     

       64
       64
        
           }

     

       65
       65
       -
           res.send({ log })

     

       65
       65
       +
           res.json({ log })

     

       66
       66
        
         })

     

       67
       67
        
       

     

       68
       68
        
         // Get operation log for a DID

     
···

       73
       73
        
           if (!curr) {

     

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

     

       75
       75
        
           }

     

       76
       76
       -
           res.send(curr)

     

       76
       76
       +
           res.json(curr)

     

       77
       77
        
         })

     

       78
       78
        
       

     

       79
       79
        
         // Update or create a DID doc

+142 -108

packages/server/tests/server.test.ts

···

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

     

       5
       5
        
       import { AxiosError } from 'axios'

     

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

     

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

     

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

     

       8
       8
        
       

     

       9
       9
        
       describe('PLC server', () => {

     

       10
       10
        
         let handle = 'alice.example.com'

     
···

       40
       40
        
         })

     

       41
       41
        
       

     

       42
       42
        
         it('registers a did', async () => {

     

       43
       43
       -
           const op = await plc.signOperation(

     

       43
       43
       +
           did = await client.create(

     

       44
       44
        
             {

     

       45
       45
        
               signingKey: signingKey.did(),

     

       46
       46
        
               rotationKeys: [rotationKey1.did(), rotationKey2.did()],

     
···

       48
       48
        
               services: {

     

       49
       49
        
                 atpPds,

     

       50
       50
        
               },

     

       51
       51
       -
               prev: null,

     

       52
       51
        
             },

     

       53
       52
        
             rotationKey1,

     

       54
       53
        
           )

     

       55
       55
       -
           did = await didForCreateOp(op)

     

       56
       56
       -
           await client.sendOperation(did, op)

     

       57
       54
        
         })

     

       58
       55
        
       

     

       59
       56
        
         it('retrieves did doc data', async () => {

     
···

       77
       74
        
             rotationKey1,

     

       78
       75
        
           )

     

       79
       76
        
       

     

       80
       80
       -
           return

     

       81
       81
       -
       

     

       82
       77
        
           await client.applyPartialOp(

     

       83
       78
        
             did,

     

       84
       79
        
             { rotationKeys: [newRotationKey.did(), rotationKey2.did()] },

     

       85
       85
       -
             newRotationKey,

     

       80
       80
       +
             rotationKey1,

     

       86
       81
        
           )

     

       87
       82
        
           rotationKey1 = newRotationKey

     

       88
       83
        
       

     
···

       97
       92
        
           expect(doc.services).toEqual({ atpPds })

     

       98
       93
        
         })

     

       99
       94
        
       

     

       100
       100
       -
         // it('does not allow key types that we do not support', async () => {

     

       101
       101
       -
         //   // an ed25519 key which we don't yet support

     

       102
       102
       -
         //   const newSigningKey =

     

       103
       103
       -
         //     'did:key:z6MkjwbBXZnFqL8su24wGL2Fdjti6GSLv9SWdYGswfazUPm9'

     

       95
       95
       +
         it('does not allow key types that we do not support', async () => {

     

       96
       96
       +
           // an ed25519 key which we don't yet support

     

       97
       97
       +
           const newSigningKey =

     

       98
       98
       +
             'did:key:z6MkjwbBXZnFqL8su24wGL2Fdjti6GSLv9SWdYGswfazUPm9'

     

       104
       99
        
       

     

       105
       105
       -
         //   const promise = client.rotateSigningKey(did, newSigningKey, signingKey)

     

       106
       106
       -
         //   await expect(promise).rejects.toThrow(AxiosError)

     

       107
       107
       -
         // })

     

       100
       100
       +
           const promise = client.applyPartialOp(

     

       101
       101
       +
             did,

     

       102
       102
       +
             { signingKey: newSigningKey },

     

       103
       103
       +
             rotationKey1,

     

       104
       104
       +
           )

     

       105
       105
       +
           await expect(promise).rejects.toThrow(AxiosError)

     

       106
       106
       +
         })

     

       108
       107
        
       

     

       109
       109
       -
         // it('retrieves the operation log', async () => {

     

       110
       110
       -
         //   const doc = await client.getDocumentData(did)

     

       111
       111
       -
         //   const ops = await client.getOperationLog(did)

     

       112
       112
       -
         //   const computedDoc = await document.validateOperationLog(did, ops)

     

       113
       113
       -
         //   expect(computedDoc).toEqual(doc)

     

       114
       114
       -
         // })

     

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

     

       109
       109
       +
           const doc = await client.getDocumentData(did)

     

       110
       110
       +
           const ops = await client.getOperationLog(did)

     

       111
       111
       +
           const computedDoc = await plc.validateOperationLog(did, ops)

     

       112
       112
       +
           expect(computedDoc).toEqual(doc)

     

       113
       113
       +
         })

     

       115
       114
        
       

     

       116
       116
       -
         // it('rejects on bad updates', async () => {

     

       117
       117
       -
         //   const newKey = await EcdsaKeypair.create()

     

       118
       118
       -
         //   const operation = client.rotateRecoveryKey(did, newKey.did(), newKey)

     

       119
       119
       -
         //   await expect(operation).rejects.toThrow()

     

       120
       120
       -
         // })

     

       115
       115
       +
         it('rejects on bad updates', async () => {

     

       116
       116
       +
           const newKey = await EcdsaKeypair.create()

     

       117
       117
       +
           const operation = client.applyPartialOp(

     

       118
       118
       +
             did,

     

       119
       119
       +
             { signingKey: newKey.did() },

     

       120
       120
       +
             newKey,

     

       121
       121
       +
           )

     

       122
       122
       +
           await expect(operation).rejects.toThrow()

     

       123
       123
       +
         })

     

       121
       124
        
       

     

       122
       122
       -
         // it('allows for recovery through a forked history', async () => {

     

       123
       123
       -
         //   const attackerKey = await EcdsaKeypair.create()

     

       124
       124
       -
         //   await client.rotateSigningKey(did, attackerKey.did(), signingKey)

     

       125
       125
       -
         //   await client.rotateRecoveryKey(did, attackerKey.did(), attackerKey)

     

       125
       125
       +
         it('allows for recovery through a forked history', async () => {

     

       126
       126
       +
           const attackerKey = await EcdsaKeypair.create()

     

       127
       127
       +
           await client.applyPartialOp(

     

       128
       128
       +
             did,

     

       129
       129
       +
             { signingKey: attackerKey.did(), rotationKeys: [attackerKey.did()] },

     

       130
       130
       +
             rotationKey2,

     

       131
       131
       +
           )

     

       126
       132
        
       

     

       127
       127
       -
         //   const newKey = await EcdsaKeypair.create()

     

       128
       128
       -
         //   const ops = await client.getOperationLog(did)

     

       129
       129
       -
         //   const forkPoint = ops[ops.length - 3]

     

       130
       130
       -
         //   const forkCid = await cidForCbor(forkPoint)

     

       131
       131
       -
         //   await client.rotateSigningKey(did, newKey.did(), recoveryKey, forkCid)

     

       132
       132
       -
         //   signingKey = newKey

     

       133
       133
       +
           const newKey = await EcdsaKeypair.create()

     

       134
       134
       +
           const ops = await client.getOperationLog(did)

     

       135
       135
       +
           const forkPoint = ops.at(-2)

     

       136
       136
       +
           if (!forkPoint) {

     

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

     

       138
       138
       +
           }

     

       139
       139
       +
           const forkCid = await cidForCbor(forkPoint)

     

       140
       140
       +
           const op = await signOperation(

     

       141
       141
       +
             {

     

       142
       142
       +
               signingKey: signingKey.did(),

     

       143
       143
       +
               rotationKeys: [newKey.did()],

     

       144
       144
       +
               handles: forkPoint.handles,

     

       145
       145
       +
               services: forkPoint.services,

     

       146
       146
       +
               prev: forkCid.toString(),

     

       147
       147
       +
             },

     

       148
       148
       +
             rotationKey1,

     

       149
       149
       +
           )

     

       150
       150
       +
           await client.sendOperation(did, op)

     

       133
       151
        
       

     

       134
       134
       -
         //   const doc = await client.getDocumentData(did)

     

       135
       135
       -
         //   expect(doc.did).toEqual(did)

     

       136
       136
       -
         //   expect(doc.signingKey).toEqual(signingKey.did())

     

       137
       137
       -
         //   expect(doc.recoveryKey).toEqual(recoveryKey.did())

     

       138
       138
       -
         //   expect(doc.handle).toEqual(handle)

     

       139
       139
       -
         //   expect(doc.atpPds).toEqual(atpPds)

     

       140
       140
       -
         // })

     

       152
       152
       +
           rotationKey1 = newKey

     

       141
       153
        
       

     

       142
       142
       -
         // it('retrieves the did doc', async () => {

     

       143
       143
       -
         //   const data = await client.getDocumentData(did)

     

       144
       144
       -
         //   const doc = await client.getDocument(did)

     

       145
       145
       -
         //   expect(doc).toEqual(document.formatDidDoc(data))

     

       146
       146
       -
         // })

     

       154
       154
       +
           const doc = await client.getDocumentData(did)

     

       155
       155
       +
           expect(doc.did).toEqual(did)

     

       156
       156
       +
           expect(doc.signingKey).toEqual(signingKey.did())

     

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

     

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

     

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

     

       160
       160
       +
         })

     

       147
       161
        
       

     

       148
       148
       -
         // it('handles concurrent requests to many docs', async () => {

     

       149
       149
       -
         //   const COUNT = 100

     

       150
       150
       -
         //   const keys: EcdsaKeypair[] = []

     

       151
       151
       -
         //   for (let i = 0; i < COUNT; i++) {

     

       152
       152
       -
         //     keys.push(await EcdsaKeypair.create())

     

       153
       153
       -
         //   }

     

       154
       154
       -
         //   await Promise.all(

     

       155
       155
       -
         //     keys.map(async (key, index) => {

     

       156
       156
       -
         //       await client.createDid(key, key.did(), `user${index}`, `example.com`)

     

       157
       157
       -
         //     }),

     

       158
       158
       -
         //   )

     

       159
       159
       -
         // })

     

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

     

       163
       163
       +
           const data = await client.getDocumentData(did)

     

       164
       164
       +
           const doc = await client.getDocument(did)

     

       165
       165
       +
           expect(doc).toEqual(plc.formatDidDoc(data))

     

       166
       166
       +
         })

     

       160
       167
        
       

     

       161
       161
       -
         // it('resolves races into a coherent history with no forks', async () => {

     

       162
       162
       -
         //   const COUNT = 100

     

       163
       163
       -
         //   const keys: EcdsaKeypair[] = []

     

       164
       164
       -
         //   for (let i = 0; i < COUNT; i++) {

     

       165
       165
       -
         //     keys.push(await EcdsaKeypair.create())

     

       166
       166
       -
         //   }

     

       167
       167
       -
         //   const prev = await client.getPrev(did)

     

       168
       168
       +
         it('handles concurrent requests to many docs', async () => {

     

       169
       169
       +
           const COUNT = 100

     

       170
       170
       +
           const keys: EcdsaKeypair[] = []

     

       171
       171
       +
           for (let i = 0; i < COUNT; i++) {

     

       172
       172
       +
             keys.push(await EcdsaKeypair.create())

     

       173
       173
       +
           }

     

       174
       174
       +
           await Promise.all(

     

       175
       175
       +
             keys.map(async (key, index) => {

     

       176
       176
       +
               await client.create(

     

       177
       177
       +
                 {

     

       178
       178
       +
                   signingKey: key.did(),

     

       179
       179
       +
                   rotationKeys: [key.did()],

     

       180
       180
       +
                   handles: [`user${index}`],

     

       181
       181
       +
                   services: {

     

       182
       182
       +
                     atpPds: `example.com`,

     

       183
       183
       +
                   },

     

       184
       184
       +
                 },

     

       185
       185
       +
                 key,

     

       186
       186
       +
               )

     

       187
       187
       +
             }),

     

       188
       188
       +
           )

     

       189
       189
       +
         })

     

       190
       190
       +
       

     

       191
       191
       +
         it('resolves races into a coherent history with no forks', async () => {

     

       192
       192
       +
           const COUNT = 100

     

       193
       193
       +
           const keys: EcdsaKeypair[] = []

     

       194
       194
       +
           for (let i = 0; i < COUNT; i++) {

     

       195
       195
       +
             keys.push(await EcdsaKeypair.create())

     

       196
       196
       +
           }

     

       197
       197
       +
           // const prev = await client.getPrev(did)

     

       168
       198
        
       

     

       169
       169
       -
         //   let successes = 0

     

       170
       170
       -
         //   let failures = 0

     

       171
       171
       -
         //   await Promise.all(

     

       172
       172
       -
         //     keys.map(async (key) => {

     

       173
       173
       -
         //       try {

     

       174
       174
       -
         //         await client.rotateSigningKey(did, key.did(), signingKey, prev)

     

       175
       175
       -
         //         successes++

     

       176
       176
       -
         //       } catch (err) {

     

       177
       177
       -
         //         failures++

     

       178
       178
       -
         //       }

     

       179
       179
       -
         //     }),

     

       180
       180
       -
         //   )

     

       181
       181
       -
         //   expect(successes).toBe(1)

     

       182
       182
       -
         //   expect(failures).toBe(99)

     

       199
       199
       +
           let successes = 0

     

       200
       200
       +
           let failures = 0

     

       201
       201
       +
           await Promise.all(

     

       202
       202
       +
             keys.map(async (key) => {

     

       203
       203
       +
               try {

     

       204
       204
       +
                 await client.applyPartialOp(

     

       205
       205
       +
                   did,

     

       206
       206
       +
                   { signingKey: key.did() },

     

       207
       207
       +
                   rotationKey1,

     

       208
       208
       +
                 )

     

       209
       209
       +
                 successes++

     

       210
       210
       +
               } catch (err) {

     

       211
       211
       +
                 failures++

     

       212
       212
       +
               }

     

       213
       213
       +
             }),

     

       214
       214
       +
           )

     

       215
       215
       +
           expect(successes).toBe(1)

     

       216
       216
       +
           expect(failures).toBe(99)

     

       183
       217
        
       

     

       184
       184
       -
         //   const ops = await client.getOperationLog(did)

     

       185
       185
       -
         //   await document.validateOperationLog(did, ops)

     

       186
       186
       -
         // })

     

       218
       218
       +
           const ops = await client.getOperationLog(did)

     

       219
       219
       +
           await plc.validateOperationLog(did, ops)

     

       220
       220
       +
         })

     

       187
       221
        
       

     

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

     

       189
       189
       -
         //   const { data, status } = await client.health()

     

       190
       190
       -
         //   expect(status).toEqual(200)

     

       191
       191
       -
         //   expect(data).toEqual({ version: '0.0.0' })

     

       192
       192
       -
         // })

     

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

     

       223
       223
       +
           const { data, status } = await client.health()

     

       224
       224
       +
           expect(status).toEqual(200)

     

       225
       225
       +
           expect(data).toEqual({ version: '0.0.0' })

     

       226
       226
       +
         })

     

       193
       227
        
       

     

       194
       194
       -
         // it('healthcheck fails when database is unavailable.', async () => {

     

       195
       195
       -
         //   await db.db.destroy()

     

       196
       196
       -
         //   let error: AxiosError

     

       197
       197
       -
         //   try {

     

       198
       198
       -
         //     await client.health()

     

       199
       199
       -
         //     throw new Error('Healthcheck should have failed')

     

       200
       200
       -
         //   } catch (err) {

     

       201
       201
       -
         //     if (err instanceof AxiosError) {

     

       202
       202
       -
         //       error = err

     

       203
       203
       -
         //     } else {

     

       204
       204
       -
         //       throw err

     

       205
       205
       -
         //     }

     

       206
       206
       -
         //   }

     

       207
       207
       -
         //   expect(error.response?.status).toEqual(503)

     

       208
       208
       -
         //   expect(error.response?.data).toEqual({

     

       209
       209
       -
         //     version: '0.0.0',

     

       210
       210
       -
         //     error: 'Service Unavailable',

     

       211
       211
       -
         //   })

     

       212
       212
       -
         // })

     

       228
       228
       +
         it('healthcheck fails when database is unavailable.', async () => {

     

       229
       229
       +
           await db.db.destroy()

     

       230
       230
       +
           let error: AxiosError

     

       231
       231
       +
           try {

     

       232
       232
       +
             await client.health()

     

       233
       233
       +
             throw new Error('Healthcheck should have failed')

     

       234
       234
       +
           } catch (err) {

     

       235
       235
       +
             if (err instanceof AxiosError) {

     

       236
       236
       +
               error = err

     

       237
       237
       +
             } else {

     

       238
       238
       +
               throw err

     

       239
       239
       +
             }

     

       240
       240
       +
           }

     

       241
       241
       +
           expect(error.response?.status).toEqual(503)

     

       242
       242
       +
           expect(error.response?.data).toEqual({

     

       243
       243
       +
             version: '0.0.0',

     

       244
       244
       +
             error: 'Service Unavailable',

     

       245
       245
       +
           })

     

       246
       246
       +
         })

     

       213
       247
        
       })