commit 2b6867575cf45bf2d0870b2f5ed02fc3f4a69e67 · hailey.at/cocoon

+63 -59

README.md

···

       5
        
       

     

       6
        
       Cocoon is a PDS implementation in Go. It is highly experimental, and is not ready for any production use.

     

       7
        
       

     

       8
       -
       ### Impmlemented Endpoints

     

       9
        
       

     

       10
        
       > [!NOTE]

     

       11
       -
       Just because something is implemented doesn't mean it is finisehd. Tons of these are returning bad errors, don't do validation properly, etc. I'll make a "second pass" checklist at some point to do all of that.

     

       12
        
       

     

       13
       -
       #### Identity

     

       14
       -
       - [ ] com.atproto.identity.getRecommendedDidCredentials

     

       15
       -
       - [ ] com.atproto.identity.requestPlcOperationSignature

     

       16
       -
       - [x] com.atproto.identity.resolveHandle

     

       17
       -
       - [ ] com.atproto.identity.signPlcOperation

     

       18
       -
       - [ ] com.atproto.identity.submitPlcOperatioin

     

       19
       -
       - [x] com.atproto.identity.updateHandle

     

       20
        
       

     

       21
       -
       #### Repo

     

       22
       -
       - [x] com.atproto.repo.applyWrites

     

       23
       -
       - [x] com.atproto.repo.createRecord

     

       24
       -
       - [x] com.atproto.repo.putRecord

     

       25
       -
       - [x] com.atproto.repo.deleteRecord

     

       26
       -
       - [x] com.atproto.repo.describeRepo

     

       27
       -
       - [x] com.atproto.repo.getRecord

     

       28
       -
       - [x] com.atproto.repo.importRepo (Works "okay". You still have to handle PLC operations on your own when migrating. Use with extreme caution.)

     

       29
       -
       - [x] com.atproto.repo.listRecords

     

       30
       -
       - [ ] com.atproto.repo.listMissingBlobs

     

       31
        
       

     

       32
       -
       #### Server

     

       33
       -
       - [ ] com.atproto.server.activateAccount

     

       34
       -
       - [x] com.atproto.server.checkAccountStatus

     

       35
       -
       - [x] com.atproto.server.confirmEmail

     

       36
       -
       - [x] com.atproto.server.createAccount

     

       37
       -
       - [x] com.atproto.server.createInviteCode

     

       38
       -
       - [x] com.atproto.server.createInviteCodes

     

       39
       -
       - [ ] com.atproto.server.deactivateAccount

     

       40
       -
       - [ ] com.atproto.server.deleteAccount

     

       41
       -
       - [x] com.atproto.server.deleteSession

     

       42
       -
       - [x] com.atproto.server.describeServer

     

       43
       -
       - [ ] com.atproto.server.getAccountInviteCodes

     

       44
       -
       - [ ] com.atproto.server.getServiceAuth

     

       45
       -
       - ~[ ] com.atproto.server.listAppPasswords~ - not going to add app passwords

     

       46
       -
       - [x] com.atproto.server.refreshSession

     

       47
       -
       - [ ] com.atproto.server.requestAccountDelete

     

       48
       -
       - [x] com.atproto.server.requestEmailConfirmation

     

       49
       -
       - [x] com.atproto.server.requestEmailUpdate

     

       50
       -
       - [x] com.atproto.server.requestPasswordReset

     

       51
       -
       - [ ] com.atproto.server.reserveSigningKey

     

       52
       -
       - [x] com.atproto.server.resetPassword

     

       53
       -
       - ~[ ] com.atproto.server.revokeAppPassword~ - not going to add app passwords

     

       54
       -
       - [x] com.atproto.server.updateEmail

     

       55
        
       

     

       56
       -
       #### Sync

     

       57
       -
       - [x] com.atproto.sync.getBlob

     

       58
       -
       - [x] com.atproto.sync.getBlocks

     

       59
       -
       - [x] com.atproto.sync.getLatestCommit

     

       60
       -
       - [x] com.atproto.sync.getRecord

     

       61
       -
       - [x] com.atproto.sync.getRepoStatus

     

       62
       -
       - [x] com.atproto.sync.getRepo

     

       63
       -
       - [x] com.atproto.sync.listBlobs

     

       64
       -
       - [x] com.atproto.sync.listRepos

     

       65
       -
       - ~[ ] com.atproto.sync.notifyOfUpdate~ - BGS doesn't even have this implemented lol

     

       66
       -
       - [x] com.atproto.sync.requestCrawl

     

       67
       -
       - [x] com.atproto.sync.subscribeRepos

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       68
        
       

     

       69
       -
       #### Other

     

       70
       -
       - [ ] com.atproto.label.queryLabels

     

       71
       -
       - [x] com.atproto.moderation.createReport (Note: this should be handled by proxying, not actually implemented in the PDS)

     

       72
       -
       - [x] app.bsky.actor.getPreferences

     

       73
       -
       - [x] app.bsky.actor.putPreferences

     

       74
        
       

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       75
        
       

     

       76
        
       ## License

     

       77

···

       5
        
       

     

       6
        
       Cocoon is a PDS implementation in Go. It is highly experimental, and is not ready for any production use.

     

       7
        
       

     

       8
       +
       ## Implemented Endpoints

     

       9
        
       

     

       10
        
       > [!NOTE]

     

       11
       +
       Just because something is implemented doesn't mean it is finished. Tons of these are returning bad errors, don't do validation properly, etc. I'll make a "second pass" checklist at some point to do all of that.

     

       12
        
       

     

       13
       +
       ### Identity

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       14
        
       

     

       15
       +
       - [ ] `com.atproto.identity.getRecommendedDidCredentials`

     

       16
       +
       - [ ] `com.atproto.identity.requestPlcOperationSignature`

     

       17
       +
       - [x] `com.atproto.identity.resolveHandle`

     

       18
       +
       - [ ] `com.atproto.identity.signPlcOperation`

     

       19
       +
       - [ ] `com.atproto.identity.submitPlcOperation`

     

       20
       +
       - [x] `com.atproto.identity.updateHandle`

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       21
        
       

     

       22
       +
       ### Repo

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       23
        
       

     

       24
       +
       - [x] `com.atproto.repo.applyWrites`

     

       25
       +
       - [x] `com.atproto.repo.createRecord`

     

       26
       +
       - [x] `com.atproto.repo.putRecord`

     

       27
       +
       - [x] `com.atproto.repo.deleteRecord`

     

       28
       +
       - [x] `com.atproto.repo.describeRepo`

     

       29
       +
       - [x] `com.atproto.repo.getRecord`

     

       30
       +
       - [x] `com.atproto.repo.importRepo` (Works "okay". You still have to handle PLC operations on your own when migrating. Use with extreme caution.)

     

       31
       +
       - [x] `com.atproto.repo.listRecords`

     

       32
       +
       - [ ] `com.atproto.repo.listMissingBlobs`

     

       33
       +
       

     

       34
       +
       ### Server

     

       35
       +
       

     

       36
       +
       - [ ] `com.atproto.server.activateAccount`

     

       37
       +
       - [x] `com.atproto.server.checkAccountStatus`

     

       38
       +
       - [x] `com.atproto.server.confirmEmail`

     

       39
       +
       - [x] `com.atproto.server.createAccount`

     

       40
       +
       - [x] `com.atproto.server.createInviteCode`

     

       41
       +
       - [x] `com.atproto.server.createInviteCodes`

     

       42
       +
       - [ ] `com.atproto.server.deactivateAccount`

     

       43
       +
       - [ ] `com.atproto.server.deleteAccount`

     

       44
       +
       - [x] `com.atproto.server.deleteSession`

     

       45
       +
       - [x] `com.atproto.server.describeServer`

     

       46
       +
       - [ ] `com.atproto.server.getAccountInviteCodes`

     

       47
       +
       - [ ] `com.atproto.server.getServiceAuth`

     

       48
       +
       - ~~[ ] `com.atproto.server.listAppPasswords`~~ - not going to add app passwords

     

       49
       +
       - [x] `com.atproto.server.refreshSession`

     

       50
       +
       - [ ] `com.atproto.server.requestAccountDelete`

     

       51
       +
       - [x] `com.atproto.server.requestEmailConfirmation`

     

       52
       +
       - [x] `com.atproto.server.requestEmailUpdate`

     

       53
       +
       - [x] `com.atproto.server.requestPasswordReset`

     

       54
       +
       - [ ] `com.atproto.server.reserveSigningKey`

     

       55
       +
       - [x] `com.atproto.server.resetPassword`

     

       56
       +
       - ~~[] `com.atproto.server.revokeAppPassword`~~ - not going to add app passwords

     

       57
       +
       - [x] `com.atproto.server.updateEmail`

     

       58
        
       

     

       59
       +
       ### Sync

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       60
        
       

     

       61
       +
       - [x] `com.atproto.sync.getBlob`

     

       62
       +
       - [x] `com.atproto.sync.getBlocks`

     

       63
       +
       - [x] `com.atproto.sync.getLatestCommit`

     

       64
       +
       - [x] `com.atproto.sync.getRecord`

     

       65
       +
       - [x] `com.atproto.sync.getRepoStatus`

     

       66
       +
       - [x] `com.atproto.sync.getRepo`

     

       67
       +
       - [x] `com.atproto.sync.listBlobs`

     

       68
       +
       - [x] `com.atproto.sync.listRepos`

     

       69
       +
       - ~~[ ] `com.atproto.sync.notifyOfUpdate`~~ - BGS doesn't even have this implemented lol

     

       70
       +
       - [x] `com.atproto.sync.requestCrawl`

     

       71
       +
       - [x] `com.atproto.sync.subscribeRepos`

     

       72
       +
       

     

       73
       +
       ### Other

     

       74
       +
       

     

       75
       +
       - [ ] `com.atproto.label.queryLabels`

     

       76
       +
       - [x] `com.atproto.moderation.createReport` (Note: this should be handled by proxying, not actually implemented in the PDS)

     

       77
       +
       - [x] `app.bsky.actor.getPreferences`

     

       78
       +
       - [x] `app.bsky.actor.putPreferences`

     

       79
        
       

     

       80
        
       ## License

     

       81

+45

cspell.json

···

       1
       +
       {

     

       2
       +
         "version": "0.2",

     

       3
       +
         "language": "en",

     

       4
       +
         "words": [

     

       5
       +
           "atproto",

     

       6
       +
           "bsky",

     

       7
       +
           "Cocoon",

     

       8
       +
           "PDS",

     

       9
       +
           "Plc",

     

       10
       +
           "plc",

     

       11
       +
           "repo",

     

       12
       +
           "InviteCodes",

     

       13
       +
           "InviteCode",

     

       14
       +
           "Invite",

     

       15
       +
           "Signin",

     

       16
       +
           "Signout",

     

       17
       +
           "JWKS",

     

       18
       +
           "dpop",

     

       19
       +
           "BGS",

     

       20
       +
           "pico",

     

       21
       +
           "picocss",

     

       22
       +
           "par",

     

       23
       +
           "blobs",

     

       24
       +
           "blob",

     

       25
       +
           "did",

     

       26
       +
           "DID",

     

       27
       +
           "OAuth",

     

       28
       +
           "oauth",

     

       29
       +
           "par",

     

       30
       +
           "Cocoon",

     

       31
       +
           "memcache",

     

       32
       +
           "db",

     

       33
       +
           "helpers",

     

       34
       +
           "middleware",

     

       35
       +
           "repo",

     

       36
       +
           "static",

     

       37
       +
           "pico",

     

       38
       +
           "picocss",

     

       39
       +
           "MIT",

     

       40
       +
           "Go"

     

       41
       +
         ],

     

       42
       +
         "ignorePaths": [

     

       43
       +
           "server/static/pico.css"

     

       44
       +
         ]

     

       45
       +
       }