Disable device sync (#1628)

* Enable sync in agent start

* Update @xmtp/cli version

* "Disable device sync in agents"

* Add appVersion and disableSync

* Update appVersion handling

Author: humanagent

agents/bots/csx/index.ts

@@ -32,6 +32,7 @@ const agent = await Agent.createFromEnv({
     (process.env.RAILWAY_VOLUME_MOUNT_PATH ?? ".") +
     `/${process.env.XMTP_ENV}-csx-${inboxId.slice(0, 8)}.db3`,
   appVersion: APP_VERSION,
+  disableDeviceSync: true,
 });
 
 // Handle uncaught errors

agents/bots/echo/index.ts

@@ -6,6 +6,7 @@ if (process.env.NODE_ENV !== "production") process.loadEnvFile(".env");
 
 const agent = await Agent.createFromEnv({
   appVersion: APP_VERSION,
+  disableDeviceSync: true,
 });
 
 let count = 0;

agents/bots/gang/index.ts

@@ -27,6 +27,7 @@ const agent = await Agent.createFromEnv({
     (process.env.RAILWAY_VOLUME_MOUNT_PATH ?? ".") +
     `/${process.env.XMTP_ENV}-gang-${inboxId.slice(0, 8)}.db3`,
   appVersion: APP_VERSION,
+  disableDeviceSync: true,
 });
 
 // Handle uncaught errors

cli/gen.ts

@@ -25,6 +25,9 @@ const MAX_RETRIES = 3;
 interface InboxData {
   accountAddress: string;
   walletKey: string;
+  appVersion: string;
+  disableDeviceSync: boolean;
+
   dbEncryptionKey: string;
   inboxId: string;
   installations: number;
@@ -318,6 +321,7 @@ async function smartUpdate({
             dbEncryptionKey,
             dbPath: `${LOGPATH}/${env}-${inbox.accountAddress}-install-0`,
             appVersion: APP_VERSION,
+            disableDeviceSync: true,
             env,
           });
           const { currentInstallations } = await checkInstallations(
@@ -336,6 +340,7 @@ async function smartUpdate({
                   dbPath: `${LOGPATH}/${env}-${inbox.accountAddress}-install-${j}`,
                   env,
                   appVersion: APP_VERSION,
+                  disableDeviceSync: true,
                 });
                 if (debugMode) {
                   process.stdout.write(
@@ -358,6 +363,7 @@ async function smartUpdate({
                   dbPath: `${LOGPATH}/${env}-${inbox.accountAddress}-install-${j}`,
                   env,
                   appVersion: APP_VERSION,
+                  disableDeviceSync: true,
                 });
                 if (debugMode) {
                   process.stdout.write(
@@ -404,6 +410,7 @@ async function smartUpdate({
                 dbPath: `${LOGPATH}/${env}-${accountAddress}-install-${j}`,
                 env,
                 appVersion: APP_VERSION,
+                disableDeviceSync: true,
               });
               if (j === 0 && env === envs[0]) inboxId = client.inboxId;
               totalCreated++;
@@ -420,6 +427,8 @@ async function smartUpdate({
             dbEncryptionKey,
             inboxId,
             installations: installationCount,
+            appVersion: APP_VERSION,
+            disableDeviceSync: true,
           });
           consecutiveFailures = 0;
           writeJson(targetFilePath, existingInboxes);

copilot/.claude/docs/build-agents/create-a-client.mdx

@@ -20,6 +20,8 @@ const dbEncryptionKey = fromString(encryptionKey, "hex");
 
 const agent = await Agent.create(signer, {
   env: "dev", // or 'production'
+  disableDeviceSync: true,
+  appVersion: "agent-name/1.0.0",
   dbEncryptionKey: dbEncryptionKey, // save it for later
 });
 ```
@@ -96,6 +98,10 @@ env?: 'local' | 'dev' | 'production';
  * deprecations and required upgrades.
  */
 appVersion?: string;
+/**
+ * Disable device sync.
+ */
+disableDeviceSync?: boolean;
 /**
  * apiUrl can be used to override the `env` flag and connect to a
  * specific endpoint

helpers/versions.ts

@@ -202,6 +202,7 @@ export const regressionClient = async (
       loggingLevel,
       apiUrl,
       appVersion: APP_VERSION,
+      disableDeviceSync: true,
       codecs: [new ReactionCodec(), new ReplyCodec()],
     });
   } catch (error) {
@@ -229,6 +230,7 @@ export const regressionClient = async (
         loggingLevel,
         apiUrl,
         appVersion: APP_VERSION,
+        disableDeviceSync: true,
         codecs: [new ReactionCodec(), new ReplyCodec()],
       });
     } else {

inboxes/README.md

@@ -31,6 +31,8 @@ const signer = createSigner(testInbox.walletKey);
 const client = await Client.create(signer, {
   dbEncryptionKey: getEncryptionKeyFromHex(testInbox.dbEncryptionKey),
   env: "dev",
+  disableDeviceSync: true,
+  appVersion: "agent-name/1.0.0",
 });
 ```
 

inboxes/utils.ts

@@ -11,6 +11,8 @@ export interface InboxData {
   accountAddress: string;
   walletKey: string;
   dbEncryptionKey: string;
+  disableDeviceSync: boolean;
+  appVersion: string;
   inboxId: string;
   installations: number;
 }

measurements/concurrency.test.ts

@@ -41,6 +41,7 @@ describe(testName, () => {
     primaryClient = await Client.create(primarySigner, {
       dbEncryptionKey: primaryEncryptionKey,
       env: env.XMTP_ENV as XmtpEnv,
+      disableDeviceSync: true,
       appVersion: APP_VERSION,
     });
 
@@ -51,6 +52,7 @@ describe(testName, () => {
     secondaryClient = await Client.create(secondarySigner, {
       dbEncryptionKey: secondaryEncryptionKey,
       env: env.XMTP_ENV as XmtpEnv,
+      disableDeviceSync: true,
       appVersion: APP_VERSION,
     });