@dxos/credentials 2.33.1-dev.83d113fe → 2.33.1-dev.eb88db79

package/src/greet/greeter.test.js

@@ -55,7 +55,7 @@ it('Good invitation', async () => {
   {
     const message = codecLoop({
       payload: {
-        __type_url: 'dxos.credentials.greet.Command',
+        '@type': 'dxos.credentials.greet.Command',
         command: Command.Type.BEGIN
       }
     });
@@ -71,7 +71,7 @@ it('Good invitation', async () => {
   {
     const message = codecLoop({
       payload: {
-        __type_url: 'dxos.credentials.greet.Command',
+        '@type': 'dxos.credentials.greet.Command',
         command: Command.Type.HANDSHAKE,
         secret: await secretProvider()
       }
@@ -91,7 +91,7 @@ it('Good invitation', async () => {
   {
     const message = {
       payload: {
-        __type_url: 'dxos.credentials.greet.Command',
+        '@type': 'dxos.credentials.greet.Command',
         command: Command.Type.NOTARIZE,
         secret: await secretProvider(),
         params: [
@@ -114,7 +114,7 @@ it('Good invitation', async () => {
     {
       const message = codecLoop({
         payload: {
-          __type_url: 'dxos.credentials.greet.Command',
+          '@type': 'dxos.credentials.greet.Command',
           command: Command.Type.FINISH,
           secret: await secretProvider()
         }
@@ -139,7 +139,7 @@ it('Bad invitation secret', async () => {
   {
     const message = codecLoop({
       payload: {
-        __type_url: 'dxos.credentials.greet.Command',
+        '@type': 'dxos.credentials.greet.Command',
         command: Command.Type.BEGIN
       }
     });
@@ -151,7 +151,7 @@ it('Bad invitation secret', async () => {
   {
     const message = codecLoop({
       payload: {
-        __type_url: 'dxos.credentials.greet.Command',
+        '@type': 'dxos.credentials.greet.Command',
         command: Command.Type.HANDSHAKE,
         secret: Buffer.from('wrong')
       }
@@ -174,7 +174,7 @@ it('Attempt to re-use invitation', async () => {
   {
     const message = codecLoop({
       payload: {
-        __type_url: 'dxos.credentials.greet.Command',
+        '@type': 'dxos.credentials.greet.Command',
         command: Command.Type.BEGIN
       }
     });
@@ -186,7 +186,7 @@ it('Attempt to re-use invitation', async () => {
   {
     const message = codecLoop({
       payload: {
-        __type_url: 'dxos.credentials.greet.Command',
+        '@type': 'dxos.credentials.greet.Command',
         command: Command.Type.HANDSHAKE,
         secret: await secretProvider()
       }
@@ -201,7 +201,7 @@ it('Attempt to re-use invitation', async () => {
   {
     const message = {
       payload: {
-        __type_url: 'dxos.credentials.greet.Command',
+        '@type': 'dxos.credentials.greet.Command',
         command: Command.Type.NOTARIZE,
         secret: await secretProvider(),
         params: [
@@ -249,14 +249,14 @@ it('WellKnownType params - BytesValue', async () => {
   const value = randomBytes();
 
   const command = codecLoop({
-    __type_url: 'dxos.credentials.Message',
+    '@type': 'dxos.credentials.Message',
     payload: {
-      __type_url: 'dxos.credentials.greet.Command',
+      '@type': 'dxos.credentials.greet.Command',
       command: Command.Type.CLAIM,
       secret: Buffer.from('123'),
       params: [
         {
-          __type_url: 'google.protobuf.BytesValue',
+          '@type': 'google.protobuf.BytesValue',
           value
         }
       ]

package/src/greet/greeter.ts

@@ -193,14 +193,14 @@ export class Greeter {
     await invitation.begin();
 
     return {
-      __type_url: 'dxos.credentials.greet.BeginResponse',
+      '@type': 'dxos.credentials.greet.BeginResponse',
       info: {
         id: {
-          __type_url: 'google.protobuf.BytesValue',
+          '@type': 'google.protobuf.BytesValue',
           value: invitation.id
         },
         authNonce: {
-          __type_url: 'google.protobuf.BytesValue',
+          '@type': 'google.protobuf.BytesValue',
           value: invitation.authNonce
         }
       }
@@ -214,7 +214,7 @@ export class Greeter {
 
     await invitation.handshake();
     return {
-      __type_url: 'dxos.credentials.greet.HandshakeResponse',
+      '@type': 'dxos.credentials.greet.HandshakeResponse',
       partyKey: invitation.partyKey,
       nonce: invitation.nonce
     };
@@ -260,7 +260,7 @@ export class Greeter {
 
     await invitation.notarize();
     return {
-      __type_url: 'dxos.credentials.greet.NotarizeResponse',
+      '@type': 'dxos.credentials.greet.NotarizeResponse',
       copies,
       hints
     };

package/src/greet/greeting-message.ts

@@ -10,11 +10,11 @@ const TYPE_URL_GREETING_COMMAND = 'dxos.credentials.greet.Command';
 
 /**
  * Create a Greeting 'BEGIN' command message.
- * @returns {{__type_url: string, command: *}}
+ * @returns {{'@type': string, command: *}}
  */
 export const createGreetingBeginMessage = (): WithTypeUrl<Command> => {
   return {
-    __type_url: TYPE_URL_GREETING_COMMAND,
+    '@type': TYPE_URL_GREETING_COMMAND,
     command: Command.Type.BEGIN,
     params: []
   };
@@ -28,7 +28,7 @@ export const createGreetingHandshakeMessage = (secret: Buffer, params = []): Wit
   assert(Array.isArray(params));
 
   return {
-    __type_url: TYPE_URL_GREETING_COMMAND,
+    '@type': TYPE_URL_GREETING_COMMAND,
     command: Command.Type.HANDSHAKE,
     params,
     secret
@@ -43,7 +43,7 @@ export const createGreetingNotarizeMessage = (secret: Buffer, credentialMessages
   assert(Array.isArray(credentialMessages));
 
   return {
-    __type_url: TYPE_URL_GREETING_COMMAND,
+    '@type': TYPE_URL_GREETING_COMMAND,
     command: Command.Type.NOTARIZE,
     params: credentialMessages,
     secret
@@ -57,7 +57,7 @@ export const createGreetingFinishMessage = (secret: Buffer): WithTypeUrl<Command
   assert(Buffer.isBuffer(secret), 'Secret is not a buffer.');
 
   return {
-    __type_url: TYPE_URL_GREETING_COMMAND,
+    '@type': TYPE_URL_GREETING_COMMAND,
     command: Command.Type.FINISH,
     secret,
     params: []
@@ -71,11 +71,11 @@ export const createGreetingClaimMessage = (invitationID: Buffer): WithTypeUrl<Co
   assert(Buffer.isBuffer(invitationID), 'invitationID is not a buffer.');
 
   return {
-    __type_url: TYPE_URL_GREETING_COMMAND,
+    '@type': TYPE_URL_GREETING_COMMAND,
     command: Command.Type.CLAIM,
     params: [
       {
-        __type_url: 'google.protobuf.BytesValue',
+        '@type': 'google.protobuf.BytesValue',
         value: invitationID
       }
     ]
@@ -86,14 +86,14 @@ export const createGreetingClaimMessage = (invitationID: Buffer): WithTypeUrl<Co
  * Crate a Greeting ClaimResponse message.
  * @param {Buffer} id   The ID of the new invitation.
  * @param {Buffer} rendezvousKey   The swarm key to use for Greeting.
- * @returns {{__type_url: string, payload: {__type_url: string, rendezvousKey: *, id: *}}}
+ * @returns {{'@type': string, payload: {'@type': string, rendezvousKey: *, id: *}}}
  */
 export const createGreetingClaimResponse = (id: Buffer, rendezvousKey: Buffer): WithTypeUrl<ClaimResponse> => {
   assert(id);
   assert(Buffer.isBuffer(rendezvousKey), 'rendezvousKey is not a buffer.');
 
   return {
-    __type_url: 'dxos.credentials.greet.ClaimResponse',
+    '@type': 'dxos.credentials.greet.ClaimResponse',
     id,
     rendezvousKey
   };

package/src/identity/identity-message.ts

@@ -9,12 +9,12 @@ import { unwrapEnvelopes, extractContents, unwrapMessage, wrapMessage } from '..
 import { DeviceInfo, IdentityInfo, KeyRecord, Message, SignedMessage, WithTypeUrl } from '../proto';
 
 /**
- * Return the __type_url, if present.
+ * Return the @type, if present.
  * @param message
  */
 function getTypeUrl (message: any) {
   // eslint-disable-next-line camelcase
-  return message?.__type_url;
+  return message?.['@type'];
 }
 
 /**
@@ -26,7 +26,7 @@ export const createDeviceInfoMessage = (keyring: Keyring, displayName: string, d
   assert(deviceKey);
 
   const message: WithTypeUrl<DeviceInfo> = {
-    __type_url: 'dxos.credentials.identity.DeviceInfo',
+    '@type': 'dxos.credentials.identity.DeviceInfo',
     publicKey: deviceKey.publicKey,
     displayName
   };
@@ -43,7 +43,7 @@ export const createIdentityInfoMessage = (keyring: Keyring, displayName: string,
   assert(identityKey);
 
   const message: WithTypeUrl<IdentityInfo> = {
-    __type_url: 'dxos.credentials.identity.IdentityInfo',
+    '@type': 'dxos.credentials.identity.IdentityInfo',
     publicKey: identityKey.publicKey,
     displayName
   };

package/src/keys/keyring-helpers.ts

@@ -132,11 +132,12 @@ export const canonicalStringify = (obj: any) => {
   return stableStringify(obj, {
     /* The point of signing and verifying is not that the internal, private state of the objects be
      * identical, but that the public contents can be verified not to have been altered. For that reason,
-     * really private fields (indicated by '__') are not included in the signature. In practice, this skips __type_url,
-     * and it also gives a mechanism for attaching other attributes to an object without breaking the signature.
+     * really private fields (indicated by '__') are not included in the signature.
+     * This gives a mechanism for attaching other attributes to an object without breaking the signature.
+     * We also skip @type.
      */
     replacer: (key: any, value: any) => {
-      if (key.toString().startsWith('__')) {
+      if (key.toString().startsWith('__') || key.toString() === '@type') {
         return undefined;
       }
       if (value) {

package/src/keys/keyring.ts

@@ -140,7 +140,7 @@ export class Keyring implements Signer {
     });
 
     return {
-      __type_url: 'dxos.credentials.SignedMessage',
+      '@type': 'dxos.credentials.SignedMessage',
       signed,
       signatures
     };
@@ -564,7 +564,7 @@ export class Keyring implements Signer {
     });
 
     return canonicalStringify({
-      __type_url: 'dxos.credentials.keys.KeyRecordList',
+      '@type': 'dxos.credentials.keys.KeyRecordList',
       keys
     });
   }

package/src/party/party-credential.ts

@@ -34,7 +34,7 @@ export const createPartyGenesisMessage = (
   assert(typeof admitKeyPair.type !== 'undefined');
 
   const message: WithTypeUrl<PartyCredential> = {
-    __type_url: TYPE_URL_PARTY_CREDENTIAL,
+    '@type': TYPE_URL_PARTY_CREDENTIAL,
     type: PartyCredential.Type.PARTY_GENESIS,
     partyGenesis: {
       partyKey: partyKeyPair.publicKey,
@@ -61,7 +61,7 @@ export const createKeyAdmitMessage = (
   partyKey = PublicKey.from(partyKey);
 
   const message: WithTypeUrl<PartyCredential> = {
-    __type_url: TYPE_URL_PARTY_CREDENTIAL,
+    '@type': TYPE_URL_PARTY_CREDENTIAL,
     type: PartyCredential.Type.KEY_ADMIT,
     keyAdmit: {
       partyKey,
@@ -87,7 +87,7 @@ export const createFeedAdmitMessage = (
   partyKey = PublicKey.from(partyKey);
 
   const message: WithTypeUrl<PartyCredential> = {
-    __type_url: TYPE_URL_PARTY_CREDENTIAL,
+    '@type': TYPE_URL_PARTY_CREDENTIAL,
     type: PartyCredential.Type.FEED_ADMIT,
     feedAdmit: {
       partyKey,
@@ -115,7 +115,7 @@ export const createEnvelopeMessage = (
   partyKey = PublicKey.from(partyKey);
 
   const message: WithTypeUrl<PartyCredential> = {
-    __type_url: TYPE_URL_PARTY_CREDENTIAL,
+    '@type': TYPE_URL_PARTY_CREDENTIAL,
     type: PartyCredential.Type.ENVELOPE,
     envelope: {
       partyKey,
@@ -134,7 +134,7 @@ export const createEnvelopeMessage = (
 export const isPartyCredentialMessage = (message: Message | SignedMessage) => {
   const signed = unwrapMessage(message) as SignedMessage;
   // eslint-disable-next-line camelcase
-  return signed?.signed?.payload?.__type_url === TYPE_URL_PARTY_CREDENTIAL;
+  return signed?.signed?.payload?.['@type'] === TYPE_URL_PARTY_CREDENTIAL;
 };
 
 /**
@@ -166,7 +166,7 @@ export function isSignedMessage (message: any): message is SignedMessage {
 // TODO(burdon): Typespec is too loose.
 export function wrapMessage (message: Message | SignedMessage | Command | Auth): WithTypeUrl<Message> {
   const payload = message as any;
-  return { __type_url: TYPE_URL_MESSAGE, payload } as WithTypeUrl<Message>;
+  return { '@type': TYPE_URL_MESSAGE, payload } as WithTypeUrl<Message>;
 }
 
 /**
@@ -286,10 +286,10 @@ export const createPartyInvitationMessage = (
   inviteeKey = PublicKey.from(inviteeKey);
 
   return {
-    __type_url: TYPE_URL_MESSAGE,
+    '@type': TYPE_URL_MESSAGE,
     payload:
       signer.sign({
-        __type_url: TYPE_URL_PARTY_INVITATION,
+        '@type': TYPE_URL_PARTY_INVITATION,
         id: randomBytes(),
         partyKey,
         issuerKey: issuerKey.publicKey,
@@ -307,8 +307,8 @@ export const isPartyInvitationMessage = (message: Message | SignedMessage) => {
   const signed = unwrapMessage(message);
 
   // eslint-disable-next-line camelcase
-  const payloadType = signed?.__type_url;
+  const payloadType = signed?.['@type'];
   // eslint-disable-next-line camelcase
-  const signedType = signed?.signed?.payload?.__type_url;
+  const signedType = signed?.signed?.payload?.['@type'];
   return payloadType === TYPE_URL_SIGNED_MESSAGE && signedType === TYPE_URL_PARTY_INVITATION;
 };

package/src/proto/any.ts

@@ -5,17 +5,17 @@
 import { TYPES } from './gen';
 
 // eslint-disable-next-line camelcase
-export type WithTypeUrl<T> = T & { __type_url: string }
+export type WithTypeUrl<T> = T & { '@type': string }
 
 export interface DecodedAny {
   // eslint-disable-next-line camelcase
-  __type_url: string,
+  '@type': string,
   [key: string]: any,
 }
 
 export type KnownAny = {
   [K in keyof TYPES]: {
   // eslint-disable-next-line camelcase
-  __type_url: K,
+  '@type': K,
 } & TYPES[K]
 }[keyof TYPES]

package/src/proto/gen/dxos/credentials/auth.ts

@@ -10,8 +10,24 @@ import * as google_protobuf from "../../google/protobuf";
  * The payload for a SignedMessage sent during handshake for replication authentication.
  */
 export interface Auth {
+    /**
+     * The publicKey of the target Party for these credentials.
+     */
     partyKey?: ReturnType<typeof substitutions["dxos.halo.keys.PubKey"]["decode"]>;
+    /**
+     * The publicKey of the authenticating Device.
+     */
     deviceKey?: ReturnType<typeof substitutions["dxos.halo.keys.PubKey"]["decode"]>;
+    /**
+     * The publicKey of the authenticating Identity.
+     */
     identityKey?: ReturnType<typeof substitutions["dxos.halo.keys.PubKey"]["decode"]>;
+    /**
+     * The publicKey of the authenticating Identity.
+     */
     feedKey?: ReturnType<typeof substitutions["dxos.halo.keys.PubKey"]["decode"]>;
+    /**
+     * FeedAdmit message to the should be written to a control feed in case the `feedKey` is not admitted to the party.
+     */
+    feedAdmit?: ReturnType<typeof substitutions["google.protobuf.Any"]["decode"]>;
 }

package/src/proto/gen/index.ts

@@ -49,5 +49,5 @@ export interface TYPES {
 }
 export interface SERVICES {
 }
-export const schemaJson = JSON.parse("{\"nested\":{\"dxos\":{\"nested\":{\"credentials\":{\"nested\":{\"auth\":{\"nested\":{\"Auth\":{\"fields\":{\"partyKey\":{\"type\":\"PubKey\",\"id\":1,\"comment\":null},\"deviceKey\":{\"type\":\"PubKey\",\"id\":2,\"comment\":null},\"identityKey\":{\"type\":\"PubKey\",\"id\":3,\"comment\":null},\"feedKey\":{\"type\":\"PubKey\",\"id\":4,\"comment\":null}},\"comment\":\"The payload for a SignedMessage sent during handshake for replication authentication.\"}}},\"greet\":{\"nested\":{\"BeginResponse\":{\"fields\":{\"info\":{\"keyType\":\"string\",\"type\":\"google.protobuf.Any\",\"id\":1,\"comment\":null}},\"comment\":null},\"ClaimResponse\":{\"fields\":{\"id\":{\"type\":\"bytes\",\"id\":1,\"comment\":null},\"rendezvousKey\":{\"type\":\"bytes\",\"id\":2,\"comment\":null}},\"comment\":null},\"Command\":{\"fields\":{\"command\":{\"type\":\"Type\",\"id\":1,\"comment\":null},\"secret\":{\"type\":\"bytes\",\"id\":2,\"comment\":null},\"params\":{\"rule\":\"repeated\",\"type\":\"google.protobuf.Any\",\"id\":10,\"comment\":null}},\"nested\":{\"Type\":{\"values\":{\"BEGIN\":0,\"HANDSHAKE\":1,\"NOTARIZE\":2,\"FINISH\":3,\"CLAIM\":10},\"comment\":null,\"comments\":{\"BEGIN\":null,\"HANDSHAKE\":null,\"NOTARIZE\":null,\"FINISH\":null,\"CLAIM\":null}}},\"comment\":\"A Greeter command.\"},\"HandshakeResponse\":{\"fields\":{\"nonce\":{\"type\":\"bytes\",\"id\":1,\"comment\":null},\"partyKey\":{\"type\":\"PubKey\",\"id\":2,\"comment\":null}},\"comment\":null},\"KeyHint\":{\"fields\":{\"publicKey\":{\"type\":\"PubKey\",\"id\":1,\"comment\":null},\"type\":{\"type\":\"KeyType\",\"id\":2,\"comment\":null}},\"comment\":null},\"NotarizeResponse\":{\"fields\":{\"copies\":{\"rule\":\"repeated\",\"type\":\"google.protobuf.Any\",\"id\":1,\"comment\":null},\"hints\":{\"rule\":\"repeated\",\"type\":\"KeyHint\",\"id\":2,\"comment\":null}},\"comment\":null}}},\"identity\":{\"nested\":{\"DeviceInfo\":{\"fields\":{\"publicKey\":{\"type\":\"PubKey\",\"id\":1,\"comment\":null},\"displayName\":{\"type\":\"string\",\"id\":2,\"comment\":null}},\"comment\":null},\"IdentityInfo\":{\"fields\":{\"publicKey\":{\"type\":\"PubKey\",\"id\":1,\"comment\":null},\"displayName\":{\"type\":\"string\",\"id\":2,\"comment\":null}},\"comment\":null}}},\"Message\":{\"fields\":{\"payload\":{\"rule\":\"required\",\"type\":\"google.protobuf.Any\",\"id\":1,\"comment\":null}},\"comment\":null},\"party\":{\"nested\":{\"Envelope\":{\"fields\":{\"partyKey\":{\"type\":\"PubKey\",\"id\":1,\"comment\":null},\"message\":{\"type\":\"Message\",\"id\":2,\"comment\":null}},\"comment\":null},\"FeedAdmit\":{\"fields\":{\"partyKey\":{\"type\":\"PubKey\",\"id\":1,\"comment\":null},\"feedKey\":{\"type\":\"PubKey\",\"id\":2,\"comment\":null}},\"comment\":null},\"FeedGenesis\":{\"fields\":{\"feedKey\":{\"type\":\"PubKey\",\"id\":1,\"comment\":null},\"ownerKey\":{\"type\":\"PubKey\",\"id\":2,\"comment\":null}},\"comment\":null},\"KeyAdmit\":{\"fields\":{\"partyKey\":{\"type\":\"PubKey\",\"id\":1,\"comment\":null},\"admitKey\":{\"type\":\"PubKey\",\"id\":2,\"comment\":null},\"admitKeyType\":{\"type\":\"KeyType\",\"id\":3,\"comment\":null}},\"comment\":null},\"PartyCredential\":{\"oneofs\":{\"contents\":{\"oneof\":[\"envelope\",\"partyGenesis\",\"keyAdmit\",\"feedAdmit\",\"feedGenesis\"],\"comment\":null}},\"fields\":{\"type\":{\"type\":\"Type\",\"id\":1,\"comment\":null},\"envelope\":{\"type\":\"Envelope\",\"id\":10,\"comment\":null},\"partyGenesis\":{\"type\":\"PartyGenesis\",\"id\":11,\"comment\":null},\"keyAdmit\":{\"type\":\"KeyAdmit\",\"id\":12,\"comment\":null},\"feedAdmit\":{\"type\":\"FeedAdmit\",\"id\":13,\"comment\":null},\"feedGenesis\":{\"type\":\"FeedGenesis\",\"id\":14,\"comment\":null}},\"nested\":{\"Type\":{\"values\":{\"ENVELOPE\":0,\"PARTY_GENESIS\":1,\"FEED_GENESIS\":2,\"KEY_ADMIT\":3,\"FEED_ADMIT\":4},\"comment\":null,\"comments\":{\"ENVELOPE\":null,\"PARTY_GENESIS\":null,\"FEED_GENESIS\":null,\"KEY_ADMIT\":null,\"FEED_ADMIT\":null}}},\"comment\":null},\"PartyGenesis\":{\"fields\":{\"partyKey\":{\"type\":\"PubKey\",\"id\":1,\"comment\":null},\"feedKey\":{\"type\":\"PubKey\",\"id\":2,\"comment\":null},\"admitKey\":{\"type\":\"PubKey\",\"id\":3,\"comment\":null},\"admitKeyType\":{\"type\":\"KeyType\",\"id\":4,\"comment\":null}},\"comment\":null},\"PartyInvitation\":{\"fields\":{\"id\":{\"type\":\"bytes\",\"id\":1,\"comment\":null},\"partyKey\":{\"type\":\"PubKey\",\"id\":2,\"comment\":null},\"issuerKey\":{\"type\":\"PubKey\",\"id\":3,\"comment\":null},\"inviteeKey\":{\"type\":\"PubKey\",\"id\":4,\"comment\":null}},\"comment\":null}}},\"SignedMessage\":{\"fields\":{\"signed\":{\"rule\":\"required\",\"type\":\"Signed\",\"id\":1,\"comment\":null},\"signatures\":{\"rule\":\"repeated\",\"type\":\"Signature\",\"id\":2,\"comment\":null}},\"nested\":{\"Signature\":{\"fields\":{\"key\":{\"rule\":\"required\",\"type\":\"PubKey\",\"id\":1,\"comment\":null},\"signature\":{\"rule\":\"required\",\"type\":\"bytes\",\"id\":2,\"comment\":null},\"keyChain\":{\"type\":\"KeyChain\",\"id\":3,\"comment\":null}},\"comment\":null},\"Signed\":{\"fields\":{\"created\":{\"rule\":\"required\",\"type\":\"string\",\"id\":1,\"comment\":null},\"nonce\":{\"rule\":\"required\",\"type\":\"bytes\",\"id\":2,\"comment\":null},\"payload\":{\"rule\":\"required\",\"type\":\"google.protobuf.Any\",\"id\":10,\"comment\":null}},\"comment\":null}},\"comment\":\"A generic container message used whenever messages are signed (e.g. PartyCredential)\"}}},\"halo\":{\"nested\":{\"keys\":{\"nested\":{\"KeyChain\":{\"fields\":{\"publicKey\":{\"rule\":\"required\",\"type\":\"PubKey\",\"id\":1,\"comment\":null},\"message\":{\"rule\":\"required\",\"type\":\"SignedMessage\",\"id\":2,\"comment\":null},\"parents\":{\"rule\":\"repeated\",\"type\":\"KeyChain\",\"id\":3,\"comment\":null}},\"comment\":null},\"KeyRecord\":{\"fields\":{\"type\":{\"rule\":\"required\",\"type\":\"KeyType\",\"id\":1,\"comment\":\"- The `KeyType` type of the key. This is often unknown for keys from other sources.\"},\"publicKey\":{\"rule\":\"required\",\"type\":\"PubKey\",\"id\":2,\"comment\":\"- The public key as a Buffer (required).\"},\"secretKey\":{\"type\":\"PrivKey\",\"id\":3,\"comment\":\"- The secret key as a Buffer (this will never be visible outside the Keyring).\"},\"hint\":{\"type\":\"bool\",\"id\":4,\"comment\":\"- Is this key from a Greeting \\\"hint\\\"?\"},\"own\":{\"type\":\"bool\",\"id\":5,\"comment\":\"- Is this our key? Usually true if `secretKey` is present,\\nmay be false for \\\"inception keys\\\" such as the Party key.\"},\"trusted\":{\"type\":\"bool\",\"id\":6,\"comment\":\"- Is this key to be trusted?\"},\"added\":{\"type\":\"string\",\"id\":7,\"comment\":\"- An RFC-3339 date/time string for when the key was added to the Keyring.\"},\"created\":{\"type\":\"string\",\"id\":8,\"comment\":\"- An RFC-3339 date/time string for when the key was created.\"}},\"comment\":null},\"KeyRecordList\":{\"fields\":{\"keys\":{\"rule\":\"repeated\",\"type\":\"KeyRecord\",\"id\":1,\"comment\":null}},\"comment\":null},\"KeyType\":{\"values\":{\"UNKNOWN\":0,\"IDENTITY\":1,\"DEVICE\":2,\"PARTY\":3,\"FEED\":4,\"DXNS_ADDRESS\":5},\"comment\":null,\"comments\":{\"UNKNOWN\":null,\"IDENTITY\":null,\"DEVICE\":null,\"PARTY\":null,\"FEED\":null,\"DXNS_ADDRESS\":null}},\"PrivKey\":{\"fields\":{\"data\":{\"type\":\"bytes\",\"id\":1,\"comment\":null}},\"comment\":null},\"PubKey\":{\"fields\":{\"data\":{\"type\":\"bytes\",\"id\":1,\"comment\":null}},\"comment\":null}}}}}}},\"google\":{\"nested\":{\"protobuf\":{\"nested\":{\"Any\":{\"fields\":{\"type_url\":{\"type\":\"string\",\"id\":1},\"value\":{\"type\":\"bytes\",\"id\":2}},\"comment\":null},\"BoolValue\":{\"fields\":{\"value\":{\"type\":\"bool\",\"id\":1}},\"comment\":null},\"BytesValue\":{\"fields\":{\"value\":{\"type\":\"bytes\",\"id\":1}},\"comment\":null},\"DoubleValue\":{\"fields\":{\"value\":{\"type\":\"double\",\"id\":1}},\"comment\":null},\"FloatValue\":{\"fields\":{\"value\":{\"type\":\"float\",\"id\":1}},\"comment\":null},\"Int32Value\":{\"fields\":{\"value\":{\"type\":\"int32\",\"id\":1}},\"comment\":null},\"Int64Value\":{\"fields\":{\"value\":{\"type\":\"int64\",\"id\":1}},\"comment\":null},\"StringValue\":{\"fields\":{\"value\":{\"type\":\"string\",\"id\":1}},\"comment\":null},\"UInt32Value\":{\"fields\":{\"value\":{\"type\":\"uint32\",\"id\":1}},\"comment\":null},\"UInt64Value\":{\"fields\":{\"value\":{\"type\":\"uint64\",\"id\":1}},\"comment\":null}}}}}}}");
+export const schemaJson = JSON.parse("{\"nested\":{\"dxos\":{\"nested\":{\"credentials\":{\"nested\":{\"auth\":{\"nested\":{\"Auth\":{\"fields\":{\"partyKey\":{\"type\":\"PubKey\",\"id\":1,\"comment\":\"The publicKey of the target Party for these credentials.\"},\"deviceKey\":{\"type\":\"PubKey\",\"id\":2,\"comment\":\"The publicKey of the authenticating Device.\"},\"identityKey\":{\"type\":\"PubKey\",\"id\":3,\"comment\":\"The publicKey of the authenticating Identity.\"},\"feedKey\":{\"type\":\"PubKey\",\"id\":4,\"comment\":\"The publicKey of the authenticating Identity.\"},\"feedAdmit\":{\"type\":\"google.protobuf.Any\",\"id\":5,\"comment\":\"FeedAdmit message to the should be written to a control feed in case the `feedKey` is not admitted to the party.\"}},\"comment\":\"The payload for a SignedMessage sent during handshake for replication authentication.\"}}},\"greet\":{\"nested\":{\"BeginResponse\":{\"fields\":{\"info\":{\"keyType\":\"string\",\"type\":\"google.protobuf.Any\",\"id\":1,\"comment\":null}},\"comment\":null},\"ClaimResponse\":{\"fields\":{\"id\":{\"type\":\"bytes\",\"id\":1,\"comment\":null},\"rendezvousKey\":{\"type\":\"bytes\",\"id\":2,\"comment\":null}},\"comment\":null},\"Command\":{\"fields\":{\"command\":{\"type\":\"Type\",\"id\":1,\"comment\":null},\"secret\":{\"type\":\"bytes\",\"id\":2,\"comment\":null},\"params\":{\"rule\":\"repeated\",\"type\":\"google.protobuf.Any\",\"id\":10,\"comment\":null}},\"nested\":{\"Type\":{\"values\":{\"BEGIN\":0,\"HANDSHAKE\":1,\"NOTARIZE\":2,\"FINISH\":3,\"CLAIM\":10},\"comment\":null,\"comments\":{\"BEGIN\":null,\"HANDSHAKE\":null,\"NOTARIZE\":null,\"FINISH\":null,\"CLAIM\":null}}},\"comment\":\"A Greeter command.\"},\"HandshakeResponse\":{\"fields\":{\"nonce\":{\"type\":\"bytes\",\"id\":1,\"comment\":null},\"partyKey\":{\"type\":\"PubKey\",\"id\":2,\"comment\":null}},\"comment\":null},\"KeyHint\":{\"fields\":{\"publicKey\":{\"type\":\"PubKey\",\"id\":1,\"comment\":null},\"type\":{\"type\":\"KeyType\",\"id\":2,\"comment\":null}},\"comment\":null},\"NotarizeResponse\":{\"fields\":{\"copies\":{\"rule\":\"repeated\",\"type\":\"google.protobuf.Any\",\"id\":1,\"comment\":null},\"hints\":{\"rule\":\"repeated\",\"type\":\"KeyHint\",\"id\":2,\"comment\":null}},\"comment\":null}}},\"identity\":{\"nested\":{\"DeviceInfo\":{\"fields\":{\"publicKey\":{\"type\":\"PubKey\",\"id\":1,\"comment\":null},\"displayName\":{\"type\":\"string\",\"id\":2,\"comment\":null}},\"comment\":null},\"IdentityInfo\":{\"fields\":{\"publicKey\":{\"type\":\"PubKey\",\"id\":1,\"comment\":null},\"displayName\":{\"type\":\"string\",\"id\":2,\"comment\":null}},\"comment\":null}}},\"Message\":{\"fields\":{\"payload\":{\"rule\":\"required\",\"type\":\"google.protobuf.Any\",\"id\":1,\"comment\":null}},\"comment\":null},\"party\":{\"nested\":{\"Envelope\":{\"fields\":{\"partyKey\":{\"type\":\"PubKey\",\"id\":1,\"comment\":null},\"message\":{\"type\":\"Message\",\"id\":2,\"comment\":null}},\"comment\":null},\"FeedAdmit\":{\"fields\":{\"partyKey\":{\"type\":\"PubKey\",\"id\":1,\"comment\":null},\"feedKey\":{\"type\":\"PubKey\",\"id\":2,\"comment\":null}},\"comment\":null},\"FeedGenesis\":{\"fields\":{\"feedKey\":{\"type\":\"PubKey\",\"id\":1,\"comment\":null},\"ownerKey\":{\"type\":\"PubKey\",\"id\":2,\"comment\":null}},\"comment\":null},\"KeyAdmit\":{\"fields\":{\"partyKey\":{\"type\":\"PubKey\",\"id\":1,\"comment\":null},\"admitKey\":{\"type\":\"PubKey\",\"id\":2,\"comment\":null},\"admitKeyType\":{\"type\":\"KeyType\",\"id\":3,\"comment\":null}},\"comment\":null},\"PartyCredential\":{\"oneofs\":{\"contents\":{\"oneof\":[\"envelope\",\"partyGenesis\",\"keyAdmit\",\"feedAdmit\",\"feedGenesis\"],\"comment\":null}},\"fields\":{\"type\":{\"type\":\"Type\",\"id\":1,\"comment\":null},\"envelope\":{\"type\":\"Envelope\",\"id\":10,\"comment\":null},\"partyGenesis\":{\"type\":\"PartyGenesis\",\"id\":11,\"comment\":null},\"keyAdmit\":{\"type\":\"KeyAdmit\",\"id\":12,\"comment\":null},\"feedAdmit\":{\"type\":\"FeedAdmit\",\"id\":13,\"comment\":null},\"feedGenesis\":{\"type\":\"FeedGenesis\",\"id\":14,\"comment\":null}},\"nested\":{\"Type\":{\"values\":{\"ENVELOPE\":0,\"PARTY_GENESIS\":1,\"FEED_GENESIS\":2,\"KEY_ADMIT\":3,\"FEED_ADMIT\":4},\"comment\":null,\"comments\":{\"ENVELOPE\":null,\"PARTY_GENESIS\":null,\"FEED_GENESIS\":null,\"KEY_ADMIT\":null,\"FEED_ADMIT\":null}}},\"comment\":null},\"PartyGenesis\":{\"fields\":{\"partyKey\":{\"type\":\"PubKey\",\"id\":1,\"comment\":null},\"feedKey\":{\"type\":\"PubKey\",\"id\":2,\"comment\":null},\"admitKey\":{\"type\":\"PubKey\",\"id\":3,\"comment\":null},\"admitKeyType\":{\"type\":\"KeyType\",\"id\":4,\"comment\":null}},\"comment\":null},\"PartyInvitation\":{\"fields\":{\"id\":{\"type\":\"bytes\",\"id\":1,\"comment\":null},\"partyKey\":{\"type\":\"PubKey\",\"id\":2,\"comment\":null},\"issuerKey\":{\"type\":\"PubKey\",\"id\":3,\"comment\":null},\"inviteeKey\":{\"type\":\"PubKey\",\"id\":4,\"comment\":null}},\"comment\":null}}},\"SignedMessage\":{\"fields\":{\"signed\":{\"rule\":\"required\",\"type\":\"Signed\",\"id\":1,\"comment\":null},\"signatures\":{\"rule\":\"repeated\",\"type\":\"Signature\",\"id\":2,\"comment\":null}},\"nested\":{\"Signature\":{\"fields\":{\"key\":{\"rule\":\"required\",\"type\":\"PubKey\",\"id\":1,\"comment\":null},\"signature\":{\"rule\":\"required\",\"type\":\"bytes\",\"id\":2,\"comment\":null},\"keyChain\":{\"type\":\"KeyChain\",\"id\":3,\"comment\":null}},\"comment\":null},\"Signed\":{\"fields\":{\"created\":{\"rule\":\"required\",\"type\":\"string\",\"id\":1,\"comment\":null},\"nonce\":{\"rule\":\"required\",\"type\":\"bytes\",\"id\":2,\"comment\":null},\"payload\":{\"rule\":\"required\",\"type\":\"google.protobuf.Any\",\"id\":10,\"comment\":null}},\"comment\":null}},\"comment\":\"A generic container message used whenever messages are signed (e.g. PartyCredential)\"}}},\"halo\":{\"nested\":{\"keys\":{\"nested\":{\"KeyChain\":{\"fields\":{\"publicKey\":{\"rule\":\"required\",\"type\":\"PubKey\",\"id\":1,\"comment\":null},\"message\":{\"rule\":\"required\",\"type\":\"SignedMessage\",\"id\":2,\"comment\":null},\"parents\":{\"rule\":\"repeated\",\"type\":\"KeyChain\",\"id\":3,\"comment\":null}},\"comment\":null},\"KeyRecord\":{\"fields\":{\"type\":{\"rule\":\"required\",\"type\":\"KeyType\",\"id\":1,\"comment\":\"- The `KeyType` type of the key. This is often unknown for keys from other sources.\"},\"publicKey\":{\"rule\":\"required\",\"type\":\"PubKey\",\"id\":2,\"comment\":\"- The public key as a Buffer (required).\"},\"secretKey\":{\"type\":\"PrivKey\",\"id\":3,\"comment\":\"- The secret key as a Buffer (this will never be visible outside the Keyring).\"},\"hint\":{\"type\":\"bool\",\"id\":4,\"comment\":\"- Is this key from a Greeting \\\"hint\\\"?\"},\"own\":{\"type\":\"bool\",\"id\":5,\"comment\":\"- Is this our key? Usually true if `secretKey` is present,\\nmay be false for \\\"inception keys\\\" such as the Party key.\"},\"trusted\":{\"type\":\"bool\",\"id\":6,\"comment\":\"- Is this key to be trusted?\"},\"added\":{\"type\":\"string\",\"id\":7,\"comment\":\"- An RFC-3339 date/time string for when the key was added to the Keyring.\"},\"created\":{\"type\":\"string\",\"id\":8,\"comment\":\"- An RFC-3339 date/time string for when the key was created.\"}},\"comment\":null},\"KeyRecordList\":{\"fields\":{\"keys\":{\"rule\":\"repeated\",\"type\":\"KeyRecord\",\"id\":1,\"comment\":null}},\"comment\":null},\"KeyType\":{\"values\":{\"UNKNOWN\":0,\"IDENTITY\":1,\"DEVICE\":2,\"PARTY\":3,\"FEED\":4,\"DXNS_ADDRESS\":5},\"comment\":null,\"comments\":{\"UNKNOWN\":null,\"IDENTITY\":null,\"DEVICE\":null,\"PARTY\":null,\"FEED\":null,\"DXNS_ADDRESS\":null}},\"PrivKey\":{\"fields\":{\"data\":{\"type\":\"bytes\",\"id\":1,\"comment\":null}},\"comment\":null},\"PubKey\":{\"fields\":{\"data\":{\"type\":\"bytes\",\"id\":1,\"comment\":null}},\"comment\":null}}}}}}},\"google\":{\"nested\":{\"protobuf\":{\"nested\":{\"Any\":{\"fields\":{\"type_url\":{\"type\":\"string\",\"id\":1},\"value\":{\"type\":\"bytes\",\"id\":2}},\"comment\":null},\"BoolValue\":{\"fields\":{\"value\":{\"type\":\"bool\",\"id\":1}},\"comment\":null},\"BytesValue\":{\"fields\":{\"value\":{\"type\":\"bytes\",\"id\":1}},\"comment\":null},\"DoubleValue\":{\"fields\":{\"value\":{\"type\":\"double\",\"id\":1}},\"comment\":null},\"FloatValue\":{\"fields\":{\"value\":{\"type\":\"float\",\"id\":1}},\"comment\":null},\"Int32Value\":{\"fields\":{\"value\":{\"type\":\"int32\",\"id\":1}},\"comment\":null},\"Int64Value\":{\"fields\":{\"value\":{\"type\":\"int64\",\"id\":1}},\"comment\":null},\"StringValue\":{\"fields\":{\"value\":{\"type\":\"string\",\"id\":1}},\"comment\":null},\"UInt32Value\":{\"fields\":{\"value\":{\"type\":\"uint32\",\"id\":1}},\"comment\":null},\"UInt64Value\":{\"fields\":{\"value\":{\"type\":\"uint64\",\"id\":1}},\"comment\":null}}}}}}}");
 export const schema = Schema.fromJson<TYPES, SERVICES>(schemaJson, substitutions);