Merge pull request #208 from xmtp/beta

V7 Release

Author: neekolas

.github/workflows/release.yml

@@ -3,6 +3,7 @@ on:
   push:
     branches:
       - main
+      - beta
 jobs:
   release:
     name: Release

README.md

@@ -80,7 +80,7 @@ webpack: (config, { isServer }) => {
 
 ## Usage
 
-The API revolves around a network Client that allows retrieving and sending messages to other network participants. A Client must be connected to a wallet on startup. If this is the very first time the Client is created, the client will generate a key bundle that is used to encrypt and authenticate messages. The key bundle persists encrypted in the network using a wallet signature, or optionally in local storage. The public side of the key bundle is also regularly advertised on the network to allow parties to establish shared encryption keys. All this happens transparently, without requiring any additional code.
+The API revolves around a network Client that allows retrieving and sending messages to other network participants. A Client must be connected to a wallet on startup. If this is the very first time the Client is created, the client will generate a key bundle that is used to encrypt and authenticate messages. The key bundle persists encrypted in the network using a wallet signature. The public side of the key bundle is also regularly advertised on the network to allow parties to establish shared encryption keys. All this happens transparently, without requiring any additional code.
 
 ```ts
 import { Client } from '@xmtp/xmtp-js'
@@ -128,7 +128,7 @@ The client's network connection and key storage method can be configured with th
 | env            | `dev`                 | Connect to the specified XMTP network environment. Valid values also include `production` and `local`. For important details about working with these environments, see [XMTP `production` and `dev` network environments](#xmtp-production-and-dev-network-environments). |
 | apiUrl         | `undefined`           | Manually specify an API URL to use. If specified, value of `env` will be ignored.                                                                                                                                                                                          |
 |                |
-| keyStoreType   | `networkTopicStoreV1` | Persist the wallet's key bundle to the network, or optionally to `localStorage`.                                                                                                                                                                                           |
+| keyStoreType   | `networkTopicStoreV1` | Persist the wallet's key bundle to the network, or use `static` to provide private keys manually.                                                                                                                                                                          |
 | codecs         | `[TextCodec]`         | Add codecs to support additional content types.                                                                                                                                                                                                                            |
 | maxContentSize | `100M`                | Maximum message content size in bytes.                                                                                                                                                                                                                                     |
 
@@ -267,6 +267,53 @@ const isOnProdNetwork = await Client.canMessage(
 )
 ```
 
+#### Handling multiple conversations with the same blockchain address
+
+With XMTP, you can have multiple ongoing conversations with the same blockchain address. For example, you might want to have a conversation scoped to your particular application, or even a conversation scoped to a particular item in your application.
+
+To accomplish this, just set the `conversationId` when you are creating a conversation. We recommend conversation IDs start with a domain, to help avoid unwanted collisions between your application and other apps on the XMTP network.
+
+```ts
+// Start a scoped conversation with ID mydomain.xyz/foo
+const conversation1 = await xmtp.conversations.newConversation(
+  '0x3F11b27F323b62B159D2642964fa27C46C841897',
+  {
+    conversationId: 'mydomain.xyz/foo',
+  }
+)
+
+// Start a scoped conversation with ID mydomain.xyz/bar. And add some metadata
+const conversation2 = await xmtp.conversations.newConversation(
+  '0x3F11b27F323b62B159D2642964fa27C46C841897',
+  {
+    conversationId: 'mydomain.xyz/bar',
+    metadata: {
+      title: 'Bar conversation',
+    },
+  }
+)
+
+// Get all the conversations
+const conversations = await xmtp.conversations.list()
+// Filter for the ones from your application
+const myAppConversations = conversations.filter(
+  (convo) =>
+    convo.context?.conversationId &&
+    convo.context.conversationId.startsWith('mydomain.xyz/')
+)
+
+for (const conversation of myAppConversations) {
+  const conversationId = conversation.context?.conversationId
+  if (conversationId === 'mydomain.xyz/foo') {
+    await conversation.send('foo')
+  }
+  if (conversationId === 'mydomain.xyz/bar') {
+    await conversation.send('bar')
+    console.log(conversation.context?.metadata.title)
+  }
+}
+```
+
 #### Different types of content
 
 All the send functions support `SendOptions` as an optional parameter. The `contentType` option allows specifying different types of content than the default simple string, which is identified with content type identifier `ContentTypeText`. Support for other types of content can be added by registering additional `ContentCodecs` with the `Client`. Every codec is associated with a content type identifier, `ContentTypeId`, which is used to signal to the Client which codec should be used to process the content that is being sent or received. See [XIP-5](https://github.com/xmtp/XIPs/blob/main/XIPs/xip-5-message-content-types.md) for more details on codecs and content types.

package-lock.json

@@ -17,10 +17,10 @@
     "clean": "node tools/cleanup && npm run clean:proto",
     "clean:proto": "rm -rf src/proto/*.ts",
     "package": "npm pack",
-    "prepare": "npm run build",
+    "prepublish": "npm run build",
     "test": "npm run test:node",
-    "test:node": "jest --no-cache --runInBand --env='node' --forceExit --testTimeout=30000",
-    "test:jsdom": "jest --no-cache --runInBand --env='./jest.jsdom.env.js' --forceExit --testTimeout=30000",
+    "test:node": "jest --no-cache --env='node' --forceExit --testTimeout=30000",
+    "test:jsdom": "jest --no-cache --env='./jest.jsdom.env.js' --forceExit --testTimeout=30000",
     "test:cov": "jest --coverage --no-cache --runInBand",
     "lint": "prettier --check . && eslint .",
     "autolint": "prettier --write . && eslint --fix .",
@@ -55,16 +55,18 @@
   "release": {
     "branches": [
       "main",
-      "next"
+      {
+        "name": "beta",
+        "prerelease": true
+      }
     ]
   },
   "dependencies": {
     "@noble/secp256k1": "^1.5.2",
     "@stardazed/streams-polyfill": "^2.4.0",
-    "@xmtp/proto": "^3.2.0",
+    "@xmtp/proto": "^3.4.0",
     "ethers": "^5.5.3",
-    "long": "^5.2.0",
-    "node-localstorage": "^2.2.1"
+    "long": "^5.2.0"
   },
   "devDependencies": {
     "@commitlint/cli": "^16.1.0",

package.json

@@ -1,6 +1,6 @@
 import { messageApi } from '@xmtp/proto'
 import { NotifyStreamEntityArrival } from '@xmtp/proto/ts/dist/types/fetch.pb'
-import { dateToNs, retry, sleep } from './utils'
+import { retry, sleep, toNanoString } from './utils'
 import AuthCache from './authn/AuthCache'
 import { Authenticator } from './authn'
 import { version } from '../package.json'
@@ -10,6 +10,7 @@ const RETRY_SLEEP_TIME = 100
 const ERR_CODE_UNAUTHENTICATED = 16
 
 const clientVersionHeaderKey = 'X-Client-Version'
+const appVersionHeaderKey = 'X-App-Version'
 
 export type GrpcError = Error & { code?: number }
 
@@ -40,16 +41,13 @@ export type SubscribeParams = {
 
 export type ApiClientOptions = {
   maxRetries?: number
+  appVersion?: string
 }
 
 export type SubscribeCallback = NotifyStreamEntityArrival<messageApi.Envelope>
 
 export type UnsubscribeFn = () => Promise<void>
 
-const toNanoString = (d: Date | undefined): undefined | string => {
-  return d && dateToNs(d).toString()
-}
-
 const isAbortError = (err?: Error): boolean => {
   if (!err) {
     return false
@@ -79,11 +77,13 @@ export default class ApiClient {
   pathPrefix: string
   maxRetries: number
   private authCache?: AuthCache
+  appVersion: string | undefined
   version: string
 
   constructor(pathPrefix: string, opts?: ApiClientOptions) {
     this.pathPrefix = pathPrefix
     this.maxRetries = opts?.maxRetries || 5
+    this.appVersion = opts?.appVersion
     this.version = 'xmtp-js/' + version
   }
 
@@ -98,9 +98,7 @@ export default class ApiClient {
         {
           pathPrefix: this.pathPrefix,
           mode: 'cors',
-          headers: new Headers({
-            [clientVersionHeaderKey]: this.version,
-          }),
+          headers: this.headers(),
         },
       ],
       this.maxRetries,
@@ -114,6 +112,8 @@ export default class ApiClient {
     attemptNumber = 0
   ): ReturnType<typeof MessageApi.Publish> {
     const authToken = await this.getToken()
+    const headers = this.headers()
+    headers.set('Authorization', `Bearer ${authToken}`)
     try {
       return await retry(
         MessageApi.Publish,
@@ -122,10 +122,7 @@ export default class ApiClient {
           {
             pathPrefix: this.pathPrefix,
             mode: 'cors',
-            headers: new Headers({
-              Authorization: `Bearer ${authToken}`,
-              [clientVersionHeaderKey]: this.version,
-            }),
+            headers,
           },
         ],
         this.maxRetries,
@@ -159,9 +156,7 @@ export default class ApiClient {
         pathPrefix: this.pathPrefix,
         signal: abortController.signal,
         mode: 'cors',
-        headers: new Headers({
-          [clientVersionHeaderKey]: this.version,
-        }),
+        headers: this.headers(),
       }).catch(async (err: GrpcError) => {
         if (isAbortError(err)) {
           return
@@ -315,4 +310,13 @@ export default class ApiClient {
   ): void {
     this.authCache = new AuthCache(authenticator, cacheExpirySeconds)
   }
+
+  headers(): Headers {
+    const headers = new Headers()
+    headers.set(clientVersionHeaderKey, this.version)
+    if (this.appVersion) {
+      headers.set(appVersionHeaderKey, this.appVersion)
+    }
+    return headers
+  }
 }