pkarr service

impl/cmd/cli/identity.go

@@ -109,7 +109,7 @@ var identityAddCmd = &cobra.Command{
 		}
 
 		// put the identity into the dht
-		id, err := d.Put(context.Background(), pubKey, *putReq)
+		id, err := d.Put(context.Background(), *putReq)
 		if err != nil {
 			logrus.WithError(err).Error("failed to put identity into dht")
 			return err
@@ -169,7 +169,7 @@ var identityGetCmd = &cobra.Command{
 			return err
 		}
 
-		msg, err := dht.ParsePKARRGetResponse(gotRR)
+		msg, err := dht.ParsePKARRGetResponse(*gotRR)
 		if err != nil {
 			logrus.WithError(err).Error("failed to parse get response")
 			return err

impl/docs/swagger.yaml

@@ -149,6 +149,23 @@ definitions:
         description: Status is always equal to `OK`.
         type: string
     type: object
+  pkg_server.GetPKARRResponse:
+    properties:
+      seq:
+        type: integer
+      sig:
+        items:
+          type: integer
+        type: array
+      v:
+        items:
+          type: integer
+        type: array
+    required:
+    - seq
+    - sig
+    - v
+    type: object
   pkg_server.ListDIDsResponse:
     properties:
       dids:
@@ -158,6 +175,23 @@ definitions:
     type: object
   pkg_server.PublishDIDRequest:
     type: object
+  pkg_server.PublishPKARRRequest:
+    properties:
+      seq:
+        type: integer
+      sig:
+        items:
+          type: integer
+        type: array
+      v:
+        items:
+          type: integer
+        type: array
+    required:
+    - seq
+    - sig
+    - v
+    type: object
 host: '{{.Server.APIHost}}'
 info:
   contact:
@@ -171,6 +205,66 @@ info:
   title: DID DHT Service API
   version: '{{.SVN}}'
 paths:
+  /{id}:
+    get:
+      consumes:
+      - application/json
+      description: Read a PKARR record from the DHT
+      parameters:
+      - description: ID
+        in: path
+        name: id
+        required: true
+        type: string
+      produces:
+      - application/json
+      responses:
+        "200":
+          description: OK
+          schema:
+            $ref: '#/definitions/pkg_server.GetPKARRResponse'
+        "400":
+          description: Bad request
+          schema:
+            type: string
+        "404":
+          description: Not found
+          schema:
+            type: string
+        "500":
+          description: Internal server error
+          schema:
+            type: string
+      summary: Read a PKARR record from the DHT
+      tags:
+      - PKARR
+    put:
+      consumes:
+      - application/json
+      description: Publishes a PKARR to the DHT
+      parameters:
+      - description: Publish PKARR Request
+        in: body
+        name: request
+        required: true
+        schema:
+          $ref: '#/definitions/pkg_server.PublishPKARRRequest'
+      produces:
+      - application/json
+      responses:
+        "202":
+          description: Accepted
+        "400":
+          description: Bad request
+          schema:
+            type: string
+        "500":
+          description: Internal server error
+          schema:
+            type: string
+      summary: Publish a PKARR to the DHT
+      tags:
+      - PKARR
   /health:
     get:
       consumes:

impl/pkg/dht/dht.go

@@ -2,12 +2,11 @@ package dht
 
 import (
 	"context"
-	"crypto/ed25519"
 
+	errutil "github.com/TBD54566975/ssi-sdk/util"
 	"github.com/anacrolix/dht/v2"
 	"github.com/anacrolix/dht/v2/bep44"
 	"github.com/anacrolix/dht/v2/exts/getput"
-	"github.com/anacrolix/torrent/bencode"
 	"github.com/anacrolix/torrent/types/infohash"
 	"github.com/sirupsen/logrus"
 
@@ -30,35 +29,31 @@ func NewDHT(bootstrapPeers []string) (*DHT, error) {
 	return &DHT{Server: s}, nil
 }
 
+// Put puts the given BEP-44 value into the DHT and returns its z32-encoded key.
+func (d *DHT) Put(ctx context.Context, request bep44.Put) (string, error) {
+	t, err := getput.Put(ctx, request.Target(), d.Server, nil, func(int64) bep44.Put {
+		return request
+	})
+	if err != nil {
+		return "", errutil.LoggingNewErrorf("failed to put key into dht, tried %d nodes, got %d responses", t.NumAddrsTried, t.NumResponses)
+	}
+	return util.Z32Encode(request.K[:]), nil
+}
+
 // Get returns the BEP-44 value for the given key from the DHT.
 // The key is a z32-encoded string, such as "yj47pezutnpw9pyudeeai8cx8z8d6wg35genrkoqf9k3rmfzy58o".
-func (d *DHT) Get(ctx context.Context, key string) ([]byte, error) {
+func (d *DHT) Get(ctx context.Context, key string) (*bep44.Put, error) {
 	z32Decoded, err := util.Z32Decode(key)
 	if err != nil {
 		logrus.WithError(err).Error("failed to decode key")
 		return nil, err
 	}
 	res, t, err := getput.Get(ctx, infohash.HashBytes(z32Decoded), d.Server, nil, nil)
 	if err != nil {
-		logrus.WithError(err).Errorf("failed to get key<%s> from dht; tried %d nodes, got %d responses", key, t.NumAddrsTried, t.NumResponses)
-		return nil, err
-	}
-	var payload string
-	if err = bencode.Unmarshal(res.V, &payload); err != nil {
-		logrus.WithError(err).Error("failed to unmarshal payload value")
-		return nil, err
-	}
-	return []byte(payload), nil
-}
-
-// Put puts the given BEP-44 value into the DHT and returns its z32-encoded key.
-func (d *DHT) Put(ctx context.Context, key ed25519.PublicKey, request bep44.Put) (string, error) {
-	t, err := getput.Put(ctx, request.Target(), d.Server, nil, func(int64) bep44.Put {
-		return request
-	})
-	if err != nil {
-		logrus.WithError(err).Errorf("failed to put key into dht, tried %d nodes, got %d responses", t.NumAddrsTried, t.NumResponses)
-		return "", err
+		return nil, errutil.LoggingNewErrorf("failed to get key<%s> from dht; tried %d nodes, got %d responses", key, t.NumAddrsTried, t.NumResponses)
 	}
-	return util.Z32Encode(key), nil
+	return &bep44.Put{
+		V:   res.V,
+		Seq: res.Seq,
+	}, nil
 }

impl/pkg/dht/dht_test.go

@@ -27,7 +27,7 @@ func TestGetPutDHT(t *testing.T) {
 	}
 	put.Sign(privKey)
 
-	id, err := d.Put(context.Background(), pubKey, *put)
+	id, err := d.Put(context.Background(), *put)
 	require.NoError(t, err)
 	require.NotEmpty(t, id)