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

+50 -1

packages/lib/README.md

···

       1
       1
       -
       # DID PLC Library

     

       1
       1
       +
       

     

       2
       2
       +
       @did-plc/lib - DID PLC Typescript Client Library

     

       3
       3
       +
       ================================================

     

       4
       4
       +
       

     

       5
       5
       +
       [![NPM](https://img.shields.io/npm/v/@did-plc/lib)](https://www.npmjs.com/package/@did-plc/lib)

     

       6
       6
       +
       [![Github CI Status](https://github.com/bluesky-social/did-method-plc/actions/workflows/repo.yaml/badge.svg)](https://github.com/bluesky-social/did-method-plc/actions/workflows/repo.yaml)

     

       7
       7
       +
       

     

       8
       8
       +
       This library provides both a simple client for the PLC directory, and an implementation of the PLC method itself (using a cryptographically signed operation log).

     

       9
       9
       +
       

     

       10
       10
       +
       ## Client Usage

     

       11
       11
       +
       

     

       12
       12
       +
       Fetching account data from directory:

     

       13
       13
       +
       

     

       14
       14
       +
       ```typescript

     

       15
       15
       +
       import * as plc from '@did-plc/lib'

     

       16
       16
       +
       

     

       17
       17
       +
       client = new plc.Client('https://plc.directory')

     

       18
       18
       +
       

     

       19
       19
       +
       let exampleDid = 'did:plc:yk4dd2qkboz2yv6tpubpc6co'

     

       20
       20
       +
       

     

       21
       21
       +
       // current account data, in terse object format

     

       22
       22
       +
       const data = await client.getDocumentData(exampleDid)

     

       23
       23
       +
       

     

       24
       24
       +
       // or, the full DID Document

     

       25
       25
       +
       const didDoc = await client.getDocument(exampleDid)

     

       26
       26
       +
       ```

     

       27
       27
       +
       

     

       28
       28
       +
       Registering a new DID PLC:

     

       29
       29
       +
       

     

       30
       30
       +
       ```typescript

     

       31
       31
       +
       import { Secp256k1Keypair } from '@atproto/crypto'

     

       32
       32
       +
       import * as plc from '@did-plc/lib'

     

       33
       33
       +
       

     

       34
       34
       +
       // please test against a sandbox or local development server

     

       35
       35
       +
       client = new plc.Client('http://localhost:2582')

     

       36
       36
       +
       

     

       37
       37
       +
       let signingKey = await Secp256k1Keypair.create()

     

       38
       38
       +
       let rotationKey = await Secp256k1Keypair.create()

     

       39
       39
       +
       

     

       40
       40
       +
       did = await client.createDid({

     

       41
       41
       +
           signingKey: signingKey.did(),

     

       42
       42
       +
           handle: 'handle.example.com',

     

       43
       43
       +
           pds: 'https://pds.example.com',

     

       44
       44
       +
           rotationKeys: [rotationKey.did()],

     

       45
       45
       +
           signer: rotationKey,

     

       46
       46
       +
       })

     

       47
       47
       +
       ```

     

       2
       48
        
       

     

       49
       49
       +
       ## License

     

       50
       50
       +
       

     

       51
       51
       +
       MIT / Apache 2.0 dual-licensed.

+13 -1

packages/lib/package.json

···

       1
       1
        
       {

     

       2
       2
        
         "name": "@did-plc/lib",

     

       3
       3
        
         "version": "0.0.4",

     

       4
       4
       -
         "main": "dist/index.js",

     

       5
       4
        
         "license": "MIT",

     

       5
       5
       +
         "description": "DID PLC Typescript Client Library",

     

       6
       6
       +
         "keywords": [

     

       7
       7
       +
           "did-plc",

     

       8
       8
       +
           "did",

     

       9
       9
       +
           "atproto"

     

       10
       10
       +
         ],

     

       11
       11
       +
         "homepage": "https://web.plc.directory",

     

       12
       12
       +
         "repository": {

     

       13
       13
       +
           "type": "git",

     

       14
       14
       +
           "url": "https://github.com/bluesky-social/did-method-plc",

     

       15
       15
       +
           "directory": "packages/lib"

     

       16
       16
       +
         },

     

       17
       17
       +
         "main": "dist/index.js",

     

       6
       18
        
         "scripts": {

     

       7
       19
        
           "test": "jest",

     

       8
       20
        
           "prettier": "prettier --check src/",

+11 -1

packages/server/README.md

···

       1
       1
       -
       # DID PLC Server

     

       1
       1
       +
       

     

       2
       2
       +
       @did-plc/server - DID PLC Directory Service

     

       3
       3
       +
       ===========================================

     

       4
       4
       +
       

     

       5
       5
       +
       Reference implementation of the PLC DID method, in Typescript.

     

       6
       6
       +
       

     

       7
       7
       +
       This is the software that runs the <https://plc.directory> service.

     

       8
       8
       +
       

     

       9
       9
       +
       ## License

     

       10
       10
       +
       

     

       11
       11
       +
       MIT / Apache 2.0 dual-licensed.

+13 -1

packages/server/package.json

···

       1
       1
        
       {

     

       2
       2
        
         "name": "@did-plc/server",

     

       3
       3
        
         "version": "0.0.1",

     

       4
       4
       -
         "main": "dist/index.js",

     

       5
       4
        
         "license": "MIT",

     

       5
       5
       +
         "description": "DID PLC Directory Service",

     

       6
       6
       +
         "keywords": [

     

       7
       7
       +
           "did-plc",

     

       8
       8
       +
           "did",

     

       9
       9
       +
           "atproto"

     

       10
       10
       +
         ],

     

       11
       11
       +
         "homepage": "https://web.plc.directory",

     

       12
       12
       +
         "repository": {

     

       13
       13
       +
           "type": "git",

     

       14
       14
       +
           "url": "https://github.com/bluesky-social/did-method-plc",

     

       15
       15
       +
           "directory": "packages/server"

     

       16
       16
       +
         },

     

       17
       17
       +
         "main": "dist/index.js",

     

       6
       18
        
         "scripts": {

     

       7
       19
        
           "start": "node dist/bin.js",

     

       8
       20
        
           "test": "./pg/with-test-db.sh jest",