Merge branch 'develop'

Author: nykma

docs/api.apib

@@ -72,7 +72,7 @@ See [README.md](./README.md)
     + action (string, required) - Action (`create` / `delete`)
     + platform (string, required) - Target platform. See table above for all available platforms. See table in [README.md](./README.md) for all available values.
     + identity (string, required) - Identity in target platform to proof. Usually a "username" or "screen name". See [README.md](./README.md).
-    + public_key (string, required) - Public key of NextID Persona to connect to. Should be secp256k1 curve (for now), 65-bytes or 33-bytes long (uncompressed / compressed) and stringified into hex form (`/^0x[0-9a-f]{65,130}$/`).
+    + public_key (string, required) - Public key of NextID Avatar to connect to. Should be secp256k1 curve (for now), 65-bytes or 33-bytes long (uncompressed / compressed) and stringified into hex form (`/^0x[0-9a-f]{65,130}$/`).
 
   + Body
 
@@ -117,10 +117,10 @@ See [README.md](./README.md)
     + platform (string, required) - Target platform. See table above for all available platforms. See table above for all available values.
     + identity (string, required) - Identity in target platform to proof. Usually a "username" or "screen name". See [README.md](./README.md).
     + proof_location (string, optional) - Location where public-accessible proof post is set. See [README.md](./README.md).
-    + public_key (string, required) - Public key of NextID Persona to connect to. Should be secp256k1 curve (for now), 65-bytes or 33-bytes long (uncompressed / compressed) and stringified into hex form (`/^0x[0-9a-f]{65,130}$/`).
+    + public_key (string, required) - Public key of NextID Avatar to connect to. Should be secp256k1 curve (for now), 65-bytes or 33-bytes long (uncompressed / compressed) and stringified into hex form (`/^0x[0-9a-f]{65,130}$/`).
     + extra (object, optional) - Extra info for specific platform needed.
       + wallet_signature (string, optional) - (needed for `platform: ethereum`) Signature signed by ETH wallet (w/ same sign payload), BASE64-ed.
-      + signature (string, optional) - (needed for `platform: ethereum`) Signature signed by Persona private key (w/ same sign payload), BASE64-ed.
+      + signature (string, optional) - (needed for `platform: ethereum`) Signature signed by Avatar private key (w/ same sign payload), BASE64-ed.
     + uuid (string, required) - UUID of this chain link. Use the exact value from `POST /v1/proof/payload`.
     + created_at (string, required) - Creation time of this chain link (UNIX timestamp, unit: second). Use the exact value from `POST /v1/proof/payload`.
 
@@ -181,9 +181,9 @@ Request failed.
       + current (number, required) - current page number.
       + next (number, required) - Next page. `0` if current page is the last one.
     + ids (array[object], required) - All IDs found. Will be empty array if not found.
-      + persona (string, required) - Persona public key
-      + last_arweave_id (string, required) - Arweave transaction ID of last proof this persona signed
-      + proofs (array[object], required) - All proofs under this persona
+      + avatar (string, required) - Avatar public key
+      + last_arweave_id (string, required) - Arweave transaction ID of last proof this avatar signed
+      + proofs (array[object], required) - All proofs under this Avatar
         + platform (string, required) - Platform
         + identity (string, required) - Identity on that platform
         + created_at (string, required) - Creation time of this proof. (timestamp, unit: second)
@@ -201,7 +201,7 @@ Request failed.
             "next": 2
           },
           "ids": [{
-            "persona": "0x04c7cacde73af939c35d527b34e0556ea84bab27e6c0ed7c6c59be70f6d2db59c206b23529977117dc8a5d61fa848f94950422b79d1c142bcf623862e49f9e6575",
+            "avatar": "0x04c7cacde73af939c35d527b34e0556ea84bab27e6c0ed7c6c59be70f6d2db59c206b23529977117dc8a5d61fa848f94950422b79d1c142bcf623862e49f9e6575",
             "proofs": [{
               "platform": "twitter",
               "identity": "my_twitter_screen_name",
@@ -218,7 +218,7 @@ Request failed.
               "invalid_reason": ""
             }]
           }, {
-            "persona": "0xANOTHER",
+            "avatar": "0xANOTHER",
             "proofs": [{
               "platform": "ethereum",
               "identity": "0x114514......",
@@ -238,7 +238,7 @@ Request failed.
 
     + platform (string, required) - Proof platform.
     + identity (string, required) - Identity on target platform.
-    + public_key (string, required) - Public key of NextID Persona to connect to. Should be secp256k1 curve (for now), 65-bytes or 33-bytes long (uncompressed / compressed) and stringified into hex form (`/^0x[0-9a-f]{65,130}$/`)
+    + public_key (string, required) - Public key of NextID Avatar to connect to. Should be secp256k1 curve (for now), 65-bytes or 33-bytes long (uncompressed / compressed) and stringified into hex form (`/^0x[0-9a-f]{65,130}$/`)
 
   + Example
 
@@ -302,7 +302,7 @@ Found.
         + identity (string, required) - Identity on that platform
         + proof_location (string, required) - Location where public-accessible proof post is set. See [README.md](./README.md).
         + created_at (string, required) - Creation time of this proof. (timestamp, unit: second)
-        + signature (string, required) - generate signature_payload and persona_private_key
+        + signature (string, required) - generate signature_payload and avatar_private_key
         + signature_payload (string, required) - Raw string to be sent to `personal_sign`
         + extra (string, optional) -  Extra info for specific platform needed.
         + uuid (string, required) - UUID of this chain link. Use the exact value from `POST /v1/proof/payload`.
@@ -328,6 +328,7 @@ Found.
                     "signature":"gMUJ75eewkdaNrFp7bafzckv9+rlW7rVaxkB7/sYzYgFdFltYG+gn0lYzVNgrAdHWZPmu2giwJniGG7HG9iNigE=",
                     "signature_payload":"",
                     "uuid":"",
+                    "arweave_id": "",
                     "extra":{
 
                     }
@@ -373,7 +374,7 @@ Found.
         + identity (string, required) - Identity on that platform. See [Docs](https://docs.next.id/rest-api/platforms) for the meaning of this field..
         + proof_location (string, required) - Location where public-accessible proof post is set. See [Docs](https://docs.next.id/rest-api/platforms).
         + created_at (string, required) - Creation time of this proof. (timestamp, unit: second)
-        + signature (string, required) - generate signature_payload and persona_private_key
+        + signature (string, required) - generate signature_payload and avatar_private_key
         + signature_payload (string, required) - Raw string to be sent to `personal_sign`
         + extra (string, optional) -  Extra info for specific platform needed.
         + uuid (string, required) - UUID of this chain link. Use the exact value from `POST /v1/proof/payload`.
@@ -394,6 +395,7 @@ Found.
                     "signature": "gMUJ75eewkdaNrFp7bafzckv9+rlW7rVaxkB7/sYzYgFdFltYG+gn0lYzVNgrAdHWZPmu2giwJniGG7HG9iNigE=",
                     "signature_payload": "",
                     "uuid": "",
+                    "arweave_id": "",
                     "extra": {}
                 }
             ]

docs/proof_chain.md

@@ -46,7 +46,7 @@ interface Link {
 // Main struct
 interface Chain {
     version: VERSION;
-    persona: {
+    avatar: {
         public_key: PublicKey,
         curve: "secp256k1",
     };
@@ -60,7 +60,7 @@ interface Chain {
 ```javascript
 {
     "version": "1",
-    "persona": {
+    "avatar": {
         "public_key": "0x0485554db28de6fefb7fe532164b67372a5e9d78dfd7f77e09a8b274f777c3e64f2e20353df005a83dbe4c5ca663638621ce4d1dd0c9586ab3fc71286b74741ed8",
         "curve": "secp256k1"
     },
@@ -103,10 +103,10 @@ function sign_link(link: Link): Signature {
     // Sign this using web3 personal_sign method
     // Specifically:
     let personal_signature_payload = keccak256("\x19Ethereum Signed Message:\n" + signature_payload.length + signature_payload)
-    let signature_bin: Buffer = persona_private_key.sign(personal_signature_payload)
+    let signature_bin: Buffer = avatar_private_key.sign(personal_signature_payload)
     let signature = "0x" + Base16.encode(signature_bin, {case: 'lower'})
 
-    // const signature = web3.eth.personal.sign(signature_payload, persona_private_key);
+    // const signature = web3.eth.personal.sign(signature_payload, avatar_private_key);
 
     // Final artifact should be a format like below:
     assert(signature.match(/^0x[0-9a-f]{130}$/))