Merge branch 'main' into negotiated-topic-invitation-class

Author: neekolas

src/Client.ts

@@ -24,7 +24,7 @@ import {
 } from './MessageContent'
 import { decompress, compress } from './Compression'
 import { xmtpEnvelope, messageApi, fetcher } from '@xmtp/proto'
-import { DecodeContactBundle } from './ContactBundle'
+import { decodeContactBundle } from './ContactBundle'
 import ApiClient, { SortDirection } from './ApiClient'
 import { Authenticator } from './authn'
 const { Compression } = xmtpEnvelope
@@ -565,7 +565,7 @@ async function getUserContactFromNetwork(
 
   for await (const env of stream) {
     if (!env.message) continue
-    const bundle = DecodeContactBundle(b64Decode(env.message.toString()))
+    const bundle = decodeContactBundle(b64Decode(env.message.toString()))
     const keyBundle = bundle.keyBundle
 
     const address = keyBundle?.walletSignatureAddress()

src/ContactBundle.ts

@@ -55,7 +55,7 @@ export class ContactBundleV2 implements contact.ContactBundleV2 {
 export type ContactBundle = ContactBundleV1 | ContactBundleV2
 
 // This is the primary function for reading contact bundles off the wire.
-export function DecodeContactBundle(bytes: Uint8Array): ContactBundle {
+export function decodeContactBundle(bytes: Uint8Array): ContactBundle {
   let cb: contact.ContactBundle
   try {
     cb = contact.ContactBundle.decode(bytes)

src/crypto/PrivateKeyBundle.ts

@@ -12,6 +12,7 @@ import { NoMatchingPreKeyError } from './errors'
 export class PrivateKeyBundleV2 implements proto.PrivateKeyBundleV2 {
   identityKey: SignedPrivateKey
   preKeys: SignedPrivateKey[]
+  version = 2
 
   constructor(bundle: proto.PrivateKeyBundleV2) {
     if (!bundle.identityKey) {
@@ -132,6 +133,7 @@ export class PrivateKeyBundleV2 implements proto.PrivateKeyBundleV2 {
 export class PrivateKeyBundleV1 implements proto.PrivateKeyBundleV1 {
   identityKey: PrivateKey
   preKeys: PrivateKey[]
+  version = 1
 
   constructor(bundle: proto.PrivateKeyBundleV1) {
     if (!bundle.identityKey) {
@@ -229,7 +231,7 @@ export class PrivateKeyBundleV1 implements proto.PrivateKeyBundleV1 {
 
 export type PrivateKeyBundle = PrivateKeyBundleV1 | PrivateKeyBundleV2
 
-export function DecodePrivateKeyBundle(bytes: Uint8Array): PrivateKeyBundle {
+export function decodePrivateKeyBundle(bytes: Uint8Array): PrivateKeyBundle {
   const b = proto.PrivateKeyBundle.decode(bytes)
   if (b.v1) {
     return new PrivateKeyBundleV1(b.v1)

src/crypto/index.ts

@@ -4,7 +4,7 @@ import {
   PrivateKeyBundleV1,
   PrivateKeyBundleV2,
   PrivateKeyBundle,
-  DecodePrivateKeyBundle,
+  decodePrivateKeyBundle,
 } from './PrivateKeyBundle'
 import { UnsignedPublicKey, SignedPublicKey, PublicKey } from './PublicKey'
 import Signature, { WalletSigner } from './Signature'
@@ -23,7 +23,7 @@ export {
   PrivateKey,
   SignedPrivateKey,
   PrivateKeyBundle,
-  DecodePrivateKeyBundle,
+  decodePrivateKeyBundle,
   PrivateKeyBundleV1,
   PrivateKeyBundleV2,
   Signature,

src/store/EncryptedStore.ts

@@ -2,7 +2,7 @@ import { Store } from './Store'
 import { Signer } from 'ethers'
 import {
   PrivateKeyBundleV1,
-  DecodePrivateKeyBundle,
+  decodePrivateKeyBundle,
   decrypt,
   encrypt,
 } from '../crypto'
@@ -129,7 +129,8 @@ function getEncryptedBundle(
 // to decode the bundle as a legacy bundle. Additionally return whether the bundle is in the expected format.
 function getPrivateBundle(bytes: Uint8Array): [PrivateKeyBundleV1, boolean] {
   try {
-    const b = DecodePrivateKeyBundle(bytes) as PrivateKeyBundleV1
+    // TODO: add support for V2
+    const b = decodePrivateKeyBundle(bytes) as PrivateKeyBundleV1
     return [b, false]
   } catch (e) {
     // Adds a default fallback for older versions of the proto

src/store/StaticKeyStore.ts

@@ -1,5 +1,5 @@
 import {
-  DecodePrivateKeyBundle,
+  decodePrivateKeyBundle,
   PrivateKeyBundleV1,
 } from '../crypto/PrivateKeyBundle'
 import { KeyStore } from './KeyStore'
@@ -11,7 +11,8 @@ export default class StaticKeyStore implements KeyStore {
   }
 
   async loadPrivateKeyBundle(): Promise<PrivateKeyBundleV1> {
-    return DecodePrivateKeyBundle(this.value) as PrivateKeyBundleV1
+    // TODO: add support for V2
+    return decodePrivateKeyBundle(this.value) as PrivateKeyBundleV1
   }
 
   async storePrivateKeyBundle(): Promise<void> {

test/ContactBundle.test.ts

@@ -2,7 +2,7 @@ import * as assert from 'assert'
 import {
   ContactBundleV1,
   ContactBundleV2,
-  DecodeContactBundle,
+  decodeContactBundle,
 } from '../src/ContactBundle'
 import {
   PrivateKeyBundleV1,
@@ -18,13 +18,13 @@ describe('ContactBundles', function () {
     const priv = await PrivateKeyBundleV1.generate()
     const pub = priv.getPublicKeyBundle()
     let bytes = pub.toBytes()
-    const cb = DecodeContactBundle(bytes)
+    const cb = decodeContactBundle(bytes)
     expect(cb.keyBundle).toBeInstanceOf(PublicKeyBundle)
     assert.ok(pub.equals(cb.keyBundle as PublicKeyBundle))
 
     const cb1 = new ContactBundleV1({ keyBundle: priv.getPublicKeyBundle() })
     bytes = cb1.toBytes()
-    const cb2 = DecodeContactBundle(bytes)
+    const cb2 = decodeContactBundle(bytes)
     expect(cb2.keyBundle).toBeInstanceOf(PublicKeyBundle)
     assert.ok(pub.equals(cb2.keyBundle as PublicKeyBundle))
 
@@ -37,7 +37,7 @@ describe('ContactBundles', function () {
     const pub = priv.getPublicKeyBundle()
     const cb1 = new ContactBundleV2({ keyBundle: priv.getPublicKeyBundle() })
     let bytes = cb1.toBytes()
-    const cb2 = DecodeContactBundle(bytes)
+    const cb2 = decodeContactBundle(bytes)
     expect(cb2.keyBundle).toBeInstanceOf(SignedPublicKeyBundle)
     assert.ok(pub.equals(cb2.keyBundle as SignedPublicKeyBundle))
 

test/crypto/PrivateKeyBundle.test.ts

@@ -1,6 +1,6 @@
 import * as assert from 'assert'
 import {
-  DecodePrivateKeyBundle,
+  decodePrivateKeyBundle,
   PrivateKey,
   PrivateKeyBundleV1,
   PrivateKeyBundleV2,
@@ -12,7 +12,7 @@ import {
 } from '../../src/store'
 import { hexToBytes } from '../../src/crypto/utils'
 import { newWallet } from '../helpers'
-import { DecodeContactBundle } from '../../src/ContactBundle'
+import { decodeContactBundle } from '../../src/ContactBundle'
 
 describe('Crypto', function () {
   describe('PrivateKeyBundle', function () {
@@ -21,10 +21,11 @@ describe('Crypto', function () {
       // generate key bundle
       const bundle = await PrivateKeyBundleV2.generate(wallet)
       const bytes = bundle.encode()
-      const bundle2 = DecodePrivateKeyBundle(bytes)
+      const bundle2 = decodePrivateKeyBundle(bytes)
       expect(bundle2).toBeInstanceOf(PrivateKeyBundleV2)
-      assert.ok(bundle.equals(bundle2 as PrivateKeyBundleV2))
-      assert.ok(
+      expect(bundle2.version).toBe(2)
+      expect(bundle.equals(bundle2 as PrivateKeyBundleV2))
+      expect(
         bundle
           .getPublicKeyBundle()
           .equals((bundle2 as PrivateKeyBundleV2).getPublicKeyBundle())