@dxos/credentials 2.33.8 → 2.33.9-dev.0cfaca1b

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (100) hide show
  1. package/.rush/temp/package-deps_build.json +21 -21
  2. package/.rush/temp/package-deps_build_test.json +21 -21
  3. package/.rush/temp/shrinkwrap-deps.json +27 -19
  4. package/credentials.build.log +10 -9
  5. package/dist/src/auth/auth-message.js +2 -2
  6. package/dist/src/auth/auth-message.js.map +1 -1
  7. package/dist/src/auth/auth-plugin.d.ts.map +1 -1
  8. package/dist/src/auth/auth-plugin.js +4 -4
  9. package/dist/src/auth/auth-plugin.js.map +1 -1
  10. package/dist/src/auth/auth-plugin.test.js +3 -3
  11. package/dist/src/auth/auth-plugin.test.js.map +1 -1
  12. package/dist/src/greet/greeter-plugin.test.js +7 -12
  13. package/dist/src/greet/greeter-plugin.test.js.map +1 -1
  14. package/dist/src/greet/greeter.d.ts +3 -5
  15. package/dist/src/greet/greeter.d.ts.map +1 -1
  16. package/dist/src/greet/greeter.js +14 -18
  17. package/dist/src/greet/greeter.js.map +1 -1
  18. package/dist/src/greet/greeter.test.js +4 -10
  19. package/dist/src/greet/greeter.test.js.map +1 -1
  20. package/dist/src/greet/greeting-command-plugin.d.ts.map +1 -1
  21. package/dist/src/greet/greeting-command-plugin.js +11 -11
  22. package/dist/src/greet/greeting-command-plugin.js.map +1 -1
  23. package/dist/src/greet/greeting-message.js +9 -9
  24. package/dist/src/greet/greeting-message.js.map +1 -1
  25. package/dist/src/greet/party-invitation-claim-handler.js +5 -5
  26. package/dist/src/greet/party-invitation-claim-handler.js.map +1 -1
  27. package/dist/src/identity/identity-message-processor.d.ts.map +1 -1
  28. package/dist/src/identity/identity-message-processor.js +6 -6
  29. package/dist/src/identity/identity-message-processor.js.map +1 -1
  30. package/dist/src/identity/identity-message.js +7 -7
  31. package/dist/src/identity/identity-message.js.map +1 -1
  32. package/dist/src/identity/seedphrase.js +2 -2
  33. package/dist/src/identity/seedphrase.js.map +1 -1
  34. package/dist/src/keys/keyring-helpers.js +12 -12
  35. package/dist/src/keys/keyring-helpers.js.map +1 -1
  36. package/dist/src/keys/keyring.js +18 -18
  37. package/dist/src/keys/keyring.js.map +1 -1
  38. package/dist/src/keys/keyring.test.js +7 -7
  39. package/dist/src/keys/keyring.test.js.map +1 -1
  40. package/dist/src/keys/keystore.js +5 -5
  41. package/dist/src/keys/keystore.js.map +1 -1
  42. package/dist/src/party/party-credential.js +9 -9
  43. package/dist/src/party/party-credential.js.map +1 -1
  44. package/dist/src/party/party-invitation-manager.js +5 -5
  45. package/dist/src/party/party-invitation-manager.js.map +1 -1
  46. package/dist/src/party/party-state.d.ts.map +1 -1
  47. package/dist/src/party/party-state.js +21 -21
  48. package/dist/src/party/party-state.js.map +1 -1
  49. package/dist/src/proto/gen/dxos/credentials/auth.d.ts +12 -3
  50. package/dist/src/proto/gen/dxos/credentials/auth.d.ts.map +1 -1
  51. package/dist/src/proto/gen/dxos/credentials/greet.d.ts +39 -8
  52. package/dist/src/proto/gen/dxos/credentials/greet.d.ts.map +1 -1
  53. package/dist/src/proto/gen/dxos/credentials/greet.js +4 -0
  54. package/dist/src/proto/gen/dxos/credentials/greet.js.map +1 -1
  55. package/dist/src/proto/gen/dxos/credentials/identity.d.ts +12 -4
  56. package/dist/src/proto/gen/dxos/credentials/identity.d.ts.map +1 -1
  57. package/dist/src/proto/gen/dxos/credentials/party.d.ts +50 -18
  58. package/dist/src/proto/gen/dxos/credentials/party.d.ts.map +1 -1
  59. package/dist/src/proto/gen/dxos/credentials/party.js +4 -0
  60. package/dist/src/proto/gen/dxos/credentials/party.js.map +1 -1
  61. package/dist/src/proto/gen/dxos/credentials.d.ts +39 -0
  62. package/dist/src/proto/gen/dxos/credentials.d.ts.map +1 -1
  63. package/dist/src/proto/gen/dxos/halo/keys.d.ts +44 -2
  64. package/dist/src/proto/gen/dxos/halo/keys.d.ts.map +1 -1
  65. package/dist/src/proto/gen/dxos/halo/keys.js +4 -0
  66. package/dist/src/proto/gen/dxos/halo/keys.js.map +1 -1
  67. package/dist/src/proto/gen/google/protobuf.d.ts +11 -11
  68. package/dist/src/proto/gen/google/protobuf.d.ts.map +1 -1
  69. package/dist/src/proto/gen/index.d.ts.map +1 -1
  70. package/dist/src/proto/gen/index.js +1 -1
  71. package/dist/src/proto/gen/index.js.map +1 -1
  72. package/dist/tsconfig.tsbuildinfo +1 -1
  73. package/package.json +16 -12
  74. package/src/auth/auth-message.ts +1 -1
  75. package/src/auth/auth-plugin.test.ts +1 -1
  76. package/src/auth/auth-plugin.ts +1 -1
  77. package/src/greet/greeter-plugin.test.ts +8 -14
  78. package/src/greet/greeter.test.js +6 -15
  79. package/src/greet/greeter.ts +10 -14
  80. package/src/greet/greeting-command-plugin.ts +1 -1
  81. package/src/greet/greeting-message.ts +1 -1
  82. package/src/greet/party-invitation-claim-handler.ts +1 -1
  83. package/src/identity/identity-message-processor.ts +1 -1
  84. package/src/identity/identity-message.ts +1 -1
  85. package/src/identity/seedphrase.ts +1 -1
  86. package/src/keys/keyring-helpers.ts +1 -1
  87. package/src/keys/keyring.test.ts +1 -1
  88. package/src/keys/keyring.ts +1 -1
  89. package/src/keys/keystore.ts +1 -1
  90. package/src/party/party-credential.ts +1 -1
  91. package/src/party/party-invitation-manager.ts +1 -1
  92. package/src/party/party-state.ts +1 -1
  93. package/src/proto/gen/dxos/credentials/auth.ts +12 -3
  94. package/src/proto/gen/dxos/credentials/greet.ts +39 -8
  95. package/src/proto/gen/dxos/credentials/identity.ts +12 -4
  96. package/src/proto/gen/dxos/credentials/party.ts +50 -18
  97. package/src/proto/gen/dxos/credentials.ts +39 -0
  98. package/src/proto/gen/dxos/halo/keys.ts +44 -2
  99. package/src/proto/gen/google/protobuf.ts +11 -11
  100. package/src/proto/gen/index.ts +1 -1
@@ -2,8 +2,8 @@
2
2
  // Copyright 2019 DXOS.org
3
3
  //
4
4
 
5
- import assert from 'assert';
6
5
  import debug from 'debug';
6
+ import assert from 'node:assert';
7
7
 
8
8
  import { ERR_EXTENSION_RESPONSE_FAILED } from '@dxos/mesh-protocol';
9
9
  import { PublicKeyLike, PublicKey } from '@dxos/protocols';
@@ -11,7 +11,7 @@ import { arraysEqual } from '@dxos/util';
11
11
 
12
12
  import { Keyring } from '../keys';
13
13
  import { getPartyCredentialMessageType } from '../party';
14
- import { PartyCredential, Message, KeyHint, Command, NotarizeResponse, WithTypeUrl, KeyType } from '../proto';
14
+ import { PartyCredential, Message, Command, NotarizeResponse, WithTypeUrl } from '../proto';
15
15
  import { PeerId } from '../typedefs';
16
16
  import {
17
17
  ERR_GREET_INVALID_COMMAND,
@@ -28,7 +28,6 @@ import { Invitation, InvitationOnFinish, SecretProvider, SecretValidator } from
28
28
  const log = debug('dxos:halo:greet');
29
29
 
30
30
  export type PartyWriter = (params: Message[]) => Promise<Message[]>;
31
- export type HintProvider = (params: Message[]) => Promise<KeyHint[]>;
32
31
 
33
32
  /**
34
33
  * Reference Greeter that uses useable, single-use "invitations" to authenticate the invitee.
@@ -36,7 +35,6 @@ export type HintProvider = (params: Message[]) => Promise<KeyHint[]>;
36
35
  export class Greeter {
37
36
  _partyKey?: PublicKey;
38
37
  _partyWriter?: PartyWriter;
39
- _hintProvider?: HintProvider;
40
38
  _invitations = new Map<string, Invitation>();
41
39
 
42
40
  /**
@@ -44,18 +42,19 @@ export class Greeter {
44
42
  * TODO(telackey): Does it make sense to separate out the Invitee functionality?
45
43
  * @param {PublicKeyLike} [partyKey] The publicKey of the target Party.
46
44
  * @param {function} [partyWriter] Callback function to write messages to the Party.
47
- * @param {function} [hintProvider] Callback function to gather feed and key hints to give to the invitee.
48
45
  */
49
- constructor (partyKey?: PublicKeyLike, partyWriter?: PartyWriter, hintProvider?: HintProvider) {
50
- if (partyKey || partyWriter || hintProvider) {
46
+ constructor (
47
+ partyKey?: PublicKeyLike,
48
+ private readonly _genesisFeedKey?: PublicKey,
49
+ partyWriter?: PartyWriter
50
+ ) {
51
+ if (partyKey || partyWriter) {
51
52
  assert(partyKey);
52
53
  assert(partyWriter);
53
- assert(hintProvider);
54
54
  }
55
55
 
56
56
  this._partyKey = partyKey ? PublicKey.from(partyKey) : undefined;
57
57
  this._partyWriter = partyWriter;
58
- this._hintProvider = hintProvider;
59
58
  }
60
59
 
61
60
  /**
@@ -250,19 +249,16 @@ export class Greeter {
250
249
  log('Admitting new node after successful greeting.');
251
250
 
252
251
  assert(this._partyWriter);
253
- assert(this._hintProvider);
254
252
 
255
253
  // Write the supplied messages to the target Party.
256
254
  const copies = await this._partyWriter(params);
257
255
 
258
- // Retrieve the hinted feed and key info for the invitee.
259
- const hints = await this._hintProvider(params);
260
-
261
256
  await invitation.notarize();
257
+ assert(this._genesisFeedKey);
262
258
  return {
263
259
  '@type': 'dxos.credentials.greet.NotarizeResponse',
264
260
  copies,
265
- feedHints: hints.filter(hint => hint.type === KeyType.FEED).map(hint => hint.publicKey!)
261
+ genesisFeed: this._genesisFeedKey
266
262
  };
267
263
  }
268
264
  }
@@ -7,9 +7,9 @@
7
7
  * and moved somewhere more abstract (RpcProtocolPlugin?).
8
8
  */
9
9
 
10
- import assert from 'assert';
11
10
  import debug from 'debug';
12
11
  import { EventEmitter } from 'events';
12
+ import assert from 'node:assert';
13
13
 
14
14
  import { WithTypeUrl } from '@dxos/codec-protobuf';
15
15
  import { Extension, ERR_EXTENSION_RESPONSE_FAILED, Protocol } from '@dxos/mesh-protocol';
@@ -2,7 +2,7 @@
2
2
  // Copyright 2020 DXOS.org
3
3
  //
4
4
 
5
- import assert from 'assert';
5
+ import assert from 'node:assert';
6
6
 
7
7
  import { ClaimResponse, Command, SignedMessage, Message, WithTypeUrl } from '../proto';
8
8
 
@@ -2,8 +2,8 @@
2
2
  // Copyright 2020 DXOS.org
3
3
  //
4
4
 
5
- import assert from 'assert';
6
5
  import debug from 'debug';
6
+ import assert from 'node:assert';
7
7
 
8
8
  import { ERR_EXTENSION_RESPONSE_FAILED } from '@dxos/mesh-protocol';
9
9
 
@@ -2,9 +2,9 @@
2
2
  // Copyright 2020 DXOS.org
3
3
  //
4
4
 
5
- import assert from 'assert';
6
5
  import debug from 'debug';
7
6
  import { EventEmitter } from 'events';
7
+ import assert from 'node:assert';
8
8
 
9
9
  import { PublicKey, PublicKeyLike } from '@dxos/protocols';
10
10
 
@@ -2,7 +2,7 @@
2
2
  // Copyright 2020 DXOS.org
3
3
  //
4
4
 
5
- import assert from 'assert';
5
+ import assert from 'node:assert';
6
6
 
7
7
  import { Keyring } from '../keys';
8
8
  import { unwrapEnvelopes, extractContents, unwrapMessage, wrapMessage } from '../party';
@@ -2,8 +2,8 @@
2
2
  // Copyright 2020 DXOS.org
3
3
  //
4
4
 
5
- import assert from 'assert';
6
5
  import { generateMnemonic, mnemonicToSeedSync } from 'bip39';
6
+ import assert from 'node:assert';
7
7
 
8
8
  import { createKeyPair } from '@dxos/crypto';
9
9
 
@@ -6,8 +6,8 @@
6
6
  // TODO(burdon): Factor out helpers.
7
7
  //
8
8
 
9
- import assert from 'assert';
10
9
  import stableStringify from 'json-stable-stringify';
10
+ import assert from 'node:assert';
11
11
 
12
12
  import { createKeyPair, KeyPair } from '@dxos/crypto';
13
13
  import { PublicKey, PublicKeyLike, PUBLIC_KEY_LENGTH, SECRET_KEY_LENGTH } from '@dxos/protocols';
@@ -4,8 +4,8 @@
4
4
 
5
5
  // DXOS testing browser.
6
6
 
7
- import assert from 'assert';
8
7
  import expect from 'expect';
8
+ import assert from 'node:assert';
9
9
 
10
10
  import { createKeyPair, randomBytes, verify } from '@dxos/crypto';
11
11
  import { PublicKey } from '@dxos/protocols';
@@ -2,8 +2,8 @@
2
2
  // Copyright 2019 DXOS.org
3
3
  //
4
4
 
5
- import assert from 'assert';
6
5
  import memdown from 'memdown';
6
+ import assert from 'node:assert';
7
7
 
8
8
  import { Event } from '@dxos/async';
9
9
  import {
@@ -2,12 +2,12 @@
2
2
  // Copyright 2019 DXOS.org
3
3
  //
4
4
 
5
- import assert from 'assert';
6
5
  import bufferJson from 'buffer-json-encoding';
7
6
  import debug from 'debug';
8
7
  import encode from 'encoding-down';
9
8
  import levelup, { LevelUp } from 'levelup';
10
9
  import memdown from 'memdown';
10
+ import assert from 'node:assert';
11
11
  import toArray from 'stream-to-array';
12
12
 
13
13
  import { PublicKey } from '@dxos/protocols';
@@ -2,7 +2,7 @@
2
2
  // Copyright 2019 DXOS.org
3
3
  //
4
4
 
5
- import assert from 'assert';
5
+ import assert from 'node:assert';
6
6
 
7
7
  import { randomBytes } from '@dxos/crypto';
8
8
  import { PublicKey, PublicKeyLike } from '@dxos/protocols';
@@ -2,8 +2,8 @@
2
2
  // Copyright 2020 DXOS.org
3
3
  //
4
4
 
5
- import assert from 'assert';
6
5
  import debug from 'debug';
6
+ import assert from 'node:assert';
7
7
 
8
8
  import { PublicKey } from '@dxos/protocols';
9
9
 
@@ -2,9 +2,9 @@
2
2
  // Copyright 2019 DXOS.org
3
3
  //
4
4
 
5
- import assert from 'assert';
6
5
  import debug from 'debug';
7
6
  import { EventEmitter } from 'events';
7
+ import assert from 'node:assert';
8
8
 
9
9
  import { discoveryKey } from '@dxos/crypto';
10
10
  import { PublicKey, PublicKeyLike } from '@dxos/protocols';
@@ -8,26 +8,35 @@ import * as dxos_halo_keys from "../halo/keys";
8
8
  import * as google_protobuf from "../../google/protobuf";
9
9
  /**
10
10
  * The payload for a SignedMessage sent during handshake for replication authentication.
11
+ *
12
+ * Defined in:
13
+ * {@link file://./../../../../../../../common/protocols/src/proto/dxos/halo/auth.proto}
11
14
  */
12
15
  export interface Auth {
13
16
  /**
14
17
  * The publicKey of the target Party for these credentials.
15
18
  */
16
- partyKey?: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
19
+ partyKey: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
17
20
  /**
18
21
  * The publicKey of the authenticating Device.
19
22
  */
20
- deviceKey?: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
23
+ deviceKey: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
21
24
  /**
22
25
  * The publicKey of the authenticating Identity.
23
26
  */
24
- identityKey?: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
27
+ identityKey: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
25
28
  /**
26
29
  * The publicKey of the authenticating Identity.
30
+ *
31
+ * Options:
32
+ * - proto3_optional = true
27
33
  */
28
34
  feedKey?: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
29
35
  /**
30
36
  * FeedAdmit message to the should be written to a control feed in case the `feedKey` is not admitted to the party.
37
+ *
38
+ * Options:
39
+ * - proto3_optional = true
31
40
  */
32
41
  feedAdmit?: ReturnType<(typeof substitutions)["google.protobuf.Any"]["decode"]>;
33
42
  }
@@ -8,13 +8,24 @@ import * as dxos_halo_keys from "../halo/keys";
8
8
  import * as google_protobuf from "../../google/protobuf";
9
9
  /**
10
10
  * A Greeter command.
11
+ *
12
+ * Defined in:
13
+ * {@link file://./../../../../../../../common/protocols/src/proto/dxos/halo/greet.proto}
11
14
  */
12
15
  export interface Command {
13
- command?: Command.Type;
16
+ command: Command.Type;
17
+ /**
18
+ * Options:
19
+ * - proto3_optional = true
20
+ */
14
21
  secret?: Uint8Array;
15
22
  params?: ReturnType<(typeof substitutions)["google.protobuf.Any"]["decode"]>[];
16
23
  }
17
24
  export namespace Command {
25
+ /**
26
+ * Defined in:
27
+ * {@link file://./../../../../../../../common/protocols/src/proto/dxos/halo/greet.proto}
28
+ */
18
29
  export enum Type {
19
30
  BEGIN = 0,
20
31
  HANDSHAKE = 1,
@@ -23,22 +34,42 @@ export namespace Command {
23
34
  CLAIM = 10
24
35
  }
25
36
  }
37
+ /**
38
+ * Defined in:
39
+ * {@link file://./../../../../../../../common/protocols/src/proto/dxos/halo/greet.proto}
40
+ */
26
41
  export interface BeginResponse {
27
42
  info?: Partial<Record<string, ReturnType<(typeof substitutions)["google.protobuf.Any"]["decode"]>>>;
28
43
  }
44
+ /**
45
+ * Defined in:
46
+ * {@link file://./../../../../../../../common/protocols/src/proto/dxos/halo/greet.proto}
47
+ */
29
48
  export interface HandshakeResponse {
30
- nonce?: Uint8Array;
31
- partyKey?: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
49
+ nonce: Uint8Array;
50
+ partyKey: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
32
51
  }
52
+ /**
53
+ * Defined in:
54
+ * {@link file://./../../../../../../../common/protocols/src/proto/dxos/halo/greet.proto}
55
+ */
33
56
  export interface NotarizeResponse {
34
57
  copies?: ReturnType<(typeof substitutions)["google.protobuf.Any"]["decode"]>[];
35
- feedHints?: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>[];
58
+ genesisFeed: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
36
59
  }
60
+ /**
61
+ * Defined in:
62
+ * {@link file://./../../../../../../../common/protocols/src/proto/dxos/halo/greet.proto}
63
+ */
37
64
  export interface KeyHint {
38
- publicKey?: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
39
- type?: dxos_halo_keys.KeyType;
65
+ publicKey: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
66
+ type: dxos_halo_keys.KeyType;
40
67
  }
68
+ /**
69
+ * Defined in:
70
+ * {@link file://./../../../../../../../common/protocols/src/proto/dxos/halo/greet.proto}
71
+ */
41
72
  export interface ClaimResponse {
42
- id?: Uint8Array;
43
- rendezvousKey?: Uint8Array;
73
+ id: Uint8Array;
74
+ rendezvousKey: Uint8Array;
44
75
  }
@@ -6,11 +6,19 @@ import * as dxos_credentials_greet from "./greet";
6
6
  import * as dxos_credentials_party from "./party";
7
7
  import * as dxos_halo_keys from "../halo/keys";
8
8
  import * as google_protobuf from "../../google/protobuf";
9
+ /**
10
+ * Defined in:
11
+ * {@link file://./../../../../../../../common/protocols/src/proto/dxos/halo/identity.proto}
12
+ */
9
13
  export interface IdentityInfo {
10
- publicKey?: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
11
- displayName?: string;
14
+ publicKey: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
15
+ displayName: string;
12
16
  }
17
+ /**
18
+ * Defined in:
19
+ * {@link file://./../../../../../../../common/protocols/src/proto/dxos/halo/identity.proto}
20
+ */
13
21
  export interface DeviceInfo {
14
- publicKey?: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
15
- displayName?: string;
22
+ publicKey: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
23
+ displayName: string;
16
24
  }
@@ -6,8 +6,12 @@ import * as dxos_credentials_greet from "./greet";
6
6
  import * as dxos_credentials_identity from "./identity";
7
7
  import * as dxos_halo_keys from "../halo/keys";
8
8
  import * as google_protobuf from "../../google/protobuf";
9
+ /**
10
+ * Defined in:
11
+ * {@link file://./../../../../../../../common/protocols/src/proto/dxos/halo/party.proto}
12
+ */
9
13
  export interface PartyCredential {
10
- type?: PartyCredential.Type;
14
+ type: PartyCredential.Type;
11
15
  envelope?: Envelope;
12
16
  partyGenesis?: PartyGenesis;
13
17
  keyAdmit?: KeyAdmit;
@@ -15,6 +19,10 @@ export interface PartyCredential {
15
19
  feedGenesis?: FeedGenesis;
16
20
  }
17
21
  export namespace PartyCredential {
22
+ /**
23
+ * Defined in:
24
+ * {@link file://./../../../../../../../common/protocols/src/proto/dxos/halo/party.proto}
25
+ */
18
26
  export enum Type {
19
27
  ENVELOPE = 0,
20
28
  PARTY_GENESIS = 1,
@@ -23,32 +31,56 @@ export namespace PartyCredential {
23
31
  FEED_ADMIT = 4
24
32
  }
25
33
  }
34
+ /**
35
+ * Defined in:
36
+ * {@link file://./../../../../../../../common/protocols/src/proto/dxos/halo/party.proto}
37
+ */
26
38
  export interface PartyGenesis {
27
- partyKey?: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
28
- feedKey?: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
29
- admitKey?: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
30
- admitKeyType?: dxos_halo_keys.KeyType;
39
+ partyKey: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
40
+ feedKey: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
41
+ admitKey: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
42
+ admitKeyType: dxos_halo_keys.KeyType;
31
43
  }
44
+ /**
45
+ * Defined in:
46
+ * {@link file://./../../../../../../../common/protocols/src/proto/dxos/halo/party.proto}
47
+ */
32
48
  export interface KeyAdmit {
33
- partyKey?: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
34
- admitKey?: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
35
- admitKeyType?: dxos_halo_keys.KeyType;
49
+ partyKey: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
50
+ admitKey: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
51
+ admitKeyType: dxos_halo_keys.KeyType;
36
52
  }
53
+ /**
54
+ * Defined in:
55
+ * {@link file://./../../../../../../../common/protocols/src/proto/dxos/halo/party.proto}
56
+ */
37
57
  export interface FeedAdmit {
38
- partyKey?: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
39
- feedKey?: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
58
+ partyKey: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
59
+ feedKey: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
40
60
  }
61
+ /**
62
+ * Defined in:
63
+ * {@link file://./../../../../../../../common/protocols/src/proto/dxos/halo/party.proto}
64
+ */
41
65
  export interface FeedGenesis {
42
- feedKey?: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
43
- ownerKey?: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
66
+ feedKey: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
67
+ ownerKey: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
44
68
  }
69
+ /**
70
+ * Defined in:
71
+ * {@link file://./../../../../../../../common/protocols/src/proto/dxos/halo/party.proto}
72
+ */
45
73
  export interface Envelope {
46
- partyKey?: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
47
- message?: dxos_credentials.Message;
74
+ partyKey: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
75
+ message: dxos_credentials.Message;
48
76
  }
77
+ /**
78
+ * Defined in:
79
+ * {@link file://./../../../../../../../common/protocols/src/proto/dxos/halo/party.proto}
80
+ */
49
81
  export interface PartyInvitation {
50
- id?: Uint8Array;
51
- partyKey?: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
52
- issuerKey?: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
53
- inviteeKey?: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
82
+ id: Uint8Array;
83
+ partyKey: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
84
+ issuerKey: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
85
+ inviteeKey: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
54
86
  }
@@ -6,25 +6,64 @@ import * as dxos_credentials_identity from "./credentials/identity";
6
6
  import * as dxos_credentials_party from "./credentials/party";
7
7
  import * as dxos_halo_keys from "./halo/keys";
8
8
  import * as google_protobuf from "../google/protobuf";
9
+ /**
10
+ * Defined in:
11
+ * {@link file://./../../../../../../common/protocols/src/proto/dxos/halo/signed.proto}
12
+ */
9
13
  export interface Message {
10
14
  payload: ReturnType<(typeof substitutions)["google.protobuf.Any"]["decode"]>;
11
15
  }
12
16
  /**
13
17
  * A generic container message used whenever messages are signed (e.g. PartyCredential)
18
+ *
19
+ * Defined in:
20
+ * {@link file://./../../../../../../common/protocols/src/proto/dxos/halo/signed.proto}
14
21
  */
15
22
  export interface SignedMessage {
23
+ /**
24
+ * The signed message contents.
25
+ */
16
26
  signed: SignedMessage.Signed;
27
+ /**
28
+ * An array of Signatures, one for each key that signed the message.
29
+ */
17
30
  signatures?: SignedMessage.Signature[];
18
31
  }
19
32
  export namespace SignedMessage {
33
+ /**
34
+ * Defined in:
35
+ * {@link file://./../../../../../../common/protocols/src/proto/dxos/halo/signed.proto}
36
+ */
20
37
  export interface Signed {
38
+ /**
39
+ * RFC-3339 datetime string.
40
+ */
21
41
  created: string;
22
42
  nonce: Uint8Array;
43
+ /**
44
+ * The payload to be signed.
45
+ */
23
46
  payload: ReturnType<(typeof substitutions)["google.protobuf.Any"]["decode"]>;
24
47
  }
48
+ /**
49
+ * Defined in:
50
+ * {@link file://./../../../../../../common/protocols/src/proto/dxos/halo/signed.proto}
51
+ */
25
52
  export interface Signature {
53
+ /**
54
+ * The publicKey of the keypair that made this signature.
55
+ */
26
56
  key: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
57
+ /**
58
+ * The bytes of the signature.
59
+ */
27
60
  signature: Uint8Array;
61
+ /**
62
+ * The certification chain of SignedMessages for this key.
63
+ *
64
+ * Options:
65
+ * - proto3_optional = true
66
+ */
28
67
  keyChain?: dxos_halo_keys.KeyChain;
29
68
  }
30
69
  }
@@ -6,6 +6,10 @@ import * as dxos_credentials_greet from "../credentials/greet";
6
6
  import * as dxos_credentials_identity from "../credentials/identity";
7
7
  import * as dxos_credentials_party from "../credentials/party";
8
8
  import * as google_protobuf from "../../google/protobuf";
9
+ /**
10
+ * Defined in:
11
+ * {@link file://./../../../../../../../common/protocols/src/proto/dxos/halo/keys.proto}
12
+ */
9
13
  export enum KeyType {
10
14
  UNKNOWN = 0,
11
15
  IDENTITY = 1,
@@ -14,12 +18,24 @@ export enum KeyType {
14
18
  FEED = 4,
15
19
  DXNS_ADDRESS = 5
16
20
  }
21
+ /**
22
+ * Defined in:
23
+ * {@link file://./../../../../../../../common/protocols/src/proto/dxos/halo/keys.proto}
24
+ */
17
25
  export interface PubKey {
18
- data?: Uint8Array;
26
+ data: Uint8Array;
19
27
  }
28
+ /**
29
+ * Defined in:
30
+ * {@link file://./../../../../../../../common/protocols/src/proto/dxos/halo/keys.proto}
31
+ */
20
32
  export interface PrivKey {
21
- data?: Uint8Array;
33
+ data: Uint8Array;
22
34
  }
35
+ /**
36
+ * Defined in:
37
+ * {@link file://./../../../../../../../common/protocols/src/proto/dxos/halo/keys.proto}
38
+ */
23
39
  export interface KeyRecord {
24
40
  /**
25
41
  * The `KeyType` type of the key. This is often unknown for keys from other sources.
@@ -31,33 +47,59 @@ export interface KeyRecord {
31
47
  publicKey: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
32
48
  /**
33
49
  * The secret key as a Buffer (this will never be visible outside the Keyring).
50
+ *
51
+ * Options:
52
+ * - proto3_optional = true
34
53
  */
35
54
  secretKey?: ReturnType<(typeof substitutions)["dxos.halo.keys.PrivKey"]["decode"]>;
36
55
  /**
37
56
  * Is this key from a Greeting "hint"?
57
+ *
58
+ * Options:
59
+ * - proto3_optional = true
38
60
  */
39
61
  hint?: boolean;
40
62
  /**
41
63
  * Determines if this is our key?
42
64
  * Usually true if `secretKey` is present; may be false for "inception keys" such as the Party key.
65
+ *
66
+ * Options:
67
+ * - proto3_optional = true
43
68
  */
44
69
  own?: boolean;
45
70
  /**
46
71
  * Is this key to be trusted?
72
+ *
73
+ * Options:
74
+ * - proto3_optional = true
47
75
  */
48
76
  trusted?: boolean;
49
77
  /**
50
78
  * An RFC-3339 date/time string for when the key was added to the Keyring.
79
+ *
80
+ * Options:
81
+ * - proto3_optional = true
51
82
  */
52
83
  added?: string;
53
84
  /**
54
85
  * An RFC-3339 date/time string for when the key was created.
86
+ *
87
+ * Options:
88
+ * - proto3_optional = true
55
89
  */
56
90
  created?: string;
57
91
  }
92
+ /**
93
+ * Defined in:
94
+ * {@link file://./../../../../../../../common/protocols/src/proto/dxos/halo/keys.proto}
95
+ */
58
96
  export interface KeyRecordList {
59
97
  keys?: KeyRecord[];
60
98
  }
99
+ /**
100
+ * Defined in:
101
+ * {@link file://./../../../../../../../common/protocols/src/proto/dxos/halo/keys.proto}
102
+ */
61
103
  export interface KeyChain {
62
104
  publicKey: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
63
105
  message: dxos_credentials.SignedMessage;