add the 'inviter' parameter to the migrateAvatar function to allow mi…

…grations after the migration period
aboutcircles · Nov 27, 2024 · c77a2fe · c77a2fe
1 parent 4dc1d85
commit c77a2fe
Show file tree

Hide file tree

Showing 13 changed files with 32 additions and 31 deletions.
diff --git a/package.json b/package.json
@@ -36,5 +36,5 @@
   },
   "name": "@cirlces-sdk/root",
   "license": "MIT",
-  "version": "0.14.0"
+  "version": "0.15.0-preview1"
 }
diff --git a/packages/abi-v1/package.json b/packages/abi-v1/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@circles-sdk/abi-v1",
-  "version": "0.14.0",
+  "version": "0.15.0-preview1",
   "description": "",
   "type": "module",
   "main": "./dist/index.js",

diff --git a/packages/abi-v2/package.json b/packages/abi-v2/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@circles-sdk/abi-v2",
-  "version": "0.14.0",
+  "version": "0.15.0-preview1",
   "description": "",
   "type": "module",
   "main": "./dist/index.js",

diff --git a/packages/adapter-cometh/package.json b/packages/adapter-cometh/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@circles-sdk/adapter-cometh",
-  "version": "0.14.0",
+  "version": "0.15.0-preview1",
   "description": "",
   "type": "module",
   "main": "./dist/index.js",
@@ -17,7 +17,7 @@
     "build": "rollup -c"
   },
   "dependencies": {
-    "@circles-sdk/adapter": "0.14.0",
+    "@circles-sdk/adapter": "0.15.0-preview1",
     "@cometh/connect-sdk": "1.2.29"
   },
   "keywords": [],

diff --git a/packages/adapter-ethers/package.json b/packages/adapter-ethers/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@circles-sdk/adapter-ethers",
-  "version": "0.14.0",
+  "version": "0.15.0-preview1",
   "description": "",
   "type": "module",
   "main": "./dist/index.js",
@@ -18,8 +18,8 @@
   },
   "dependencies": {
     "ethers": "^6.13.2",
-    "@circles-sdk/adapter": "0.14.0",
-    "@circles-sdk/utils": "0.14.0"
+    "@circles-sdk/adapter": "0.15.0-preview1",
+    "@circles-sdk/utils": "0.15.0-preview1"
   },
   "keywords": [],
   "author": "",

diff --git a/packages/adapter-safe-app/package.json b/packages/adapter-safe-app/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@circles-sdk/adapter-safe-app",
-  "version": "0.14.0",
+  "version": "0.15.0-preview1",
   "description": "",
   "type": "module",
   "main": "./dist/index.js",
@@ -17,7 +17,7 @@
     "build": "rollup -c"
   },
   "dependencies": {
-    "@circles-sdk/adapter": "0.14.0",
+    "@circles-sdk/adapter": "0.15.0-preview1",
     "@safe-global/safe-apps-sdk": "^9.1.0"
   },
   "keywords": [],

diff --git a/packages/adapter-safe/package.json b/packages/adapter-safe/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@circles-sdk/adapter-safe",
-  "version": "0.14.0",
+  "version": "0.15.0-preview1",
   "description": "",
   "type": "module",
   "main": "./dist/index.js",

diff --git a/packages/adapter/package.json b/packages/adapter/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@circles-sdk/adapter",
-  "version": "0.14.0",
+  "version": "0.15.0-preview1",
   "description": "",
   "type": "module",
   "main": "./dist/index.js",

diff --git a/packages/data/package.json b/packages/data/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@circles-sdk/data",
-  "version": "0.14.0",
+  "version": "0.15.0-preview1",
   "description": "",
   "type": "module",
   "main": "./dist/index.js",
@@ -17,7 +17,7 @@
     "build": "rollup -c"
   },
   "dependencies": {
-    "@circles-sdk/utils": "0.14.0"
+    "@circles-sdk/utils": "0.15.0-preview1"
   },
   "keywords": [],
   "author": "",

diff --git a/packages/profiles/package.json b/packages/profiles/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@circles-sdk/profiles",
-  "version": "0.14.0",
+  "version": "0.15.0-preview1",
   "description": "",
   "type": "module",
   "main": "./dist/index.js",
@@ -17,7 +17,7 @@
     "build": "rollup -c"
   },
   "dependencies": {
-    "@circles-sdk/utils": "0.14.0"
+    "@circles-sdk/utils": "0.15.0-preview1"
   },
   "keywords": [],
   "author": "",

diff --git a/packages/sdk/package.json b/packages/sdk/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@circles-sdk/sdk",
-  "version": "0.14.0",
+  "version": "0.15.0-preview1",
   "description": "",
   "type": "module",
   "main": "./dist/index.js",
@@ -17,11 +17,11 @@
   "author": "",
   "license": "MIT",
   "dependencies": {
-    "@circles-sdk/abi-v1": "0.14.0",
-    "@circles-sdk/abi-v2": "0.14.0",
-    "@circles-sdk/data": "0.14.0",
-    "@circles-sdk/profiles": "0.14.0",
-    "@circles-sdk/adapter-ethers": "0.14.0",
+    "@circles-sdk/abi-v1": "0.15.0-preview1",
+    "@circles-sdk/abi-v2": "0.15.0-preview1",
+    "@circles-sdk/data": "0.15.0-preview1",
+    "@circles-sdk/profiles": "0.15.0-preview1",
+    "@circles-sdk/adapter-ethers": "0.15.0-preview1",
     "ethers": "^6.13.2",
     "multihashes": "^4.0.3"
   },

diff --git a/packages/sdk/src/sdk.ts b/packages/sdk/src/sdk.ts
@@ -89,11 +89,12 @@ interface SdkInterface {
   /**
    * Migrates a v1 avatar and all its Circles holdings to v2.
    * [[ Currently only works for human avatars. ]]
+   * @param inviter The address of the avatar that invited the user to v2. Can be 'ZeroAddress' during migration period.
    * @param avatar The avatar's address.
    * @param profile The profile data of the avatar.
    * @trustRelations An optional list of trust relations to migrate.
    */
-  migrateAvatar: (avatar: string, profile: Profile, trustRelations?: string[]) => Promise<void>;
+  migrateAvatar: (inviter: string, avatar: string, profile: Profile, trustRelations?: string[]) => Promise<void>;
 
   /**
    * Creates or updates a user profile.
@@ -359,16 +360,16 @@ export class Sdk implements SdkInterface {
 
   /**
    * Migrates a v1 avatar and all its Circles holdings to v2.
-   * @param avatar The avatar's address.
-   * @param profile The profile data of the avatar.
-   */
-  /**
-   * Migrates a v1 avatar and all its Circles holdings to v2.
+   * @param inviter The address of the avatar that invited the user to v2. Can be 'ZeroAddress' during migration period.
    * @param avatar The avatar's address.
    * @param profile The profile data of the avatar.
    * @param trustRelations An optional list of trust relations to migrate.
    */
-  migrateAvatar = async (avatar: string, profile: Profile, trustRelations?: string[]): Promise<void> => {
+  migrateAvatar = async (
+    inviter: string,
+    avatar: string,
+    profile: Profile,
+    trustRelations?: string[]): Promise<void> => {
     if (!this.v2Hub) {
       throw new Error('V2 hub not available');
     }
@@ -423,7 +424,7 @@ export class Sdk implements SdkInterface {
         const metadataDigest = await this.createProfileIfNecessary(profile);
 
         if (avatarInfo.type === "CrcV1_Signup") {
-          const registerHumanData = this.v2Hub.interface.encodeFunctionData('registerHuman', [ZeroAddress, metadataDigest]);
+          const registerHumanData = this.v2Hub.interface.encodeFunctionData('registerHuman', [inviter, metadataDigest]);
           const registerHumanTx: TransactionRequest = {
             to: this.circlesConfig.v2HubAddress!,
             data: registerHumanData,

diff --git a/packages/utils/package.json b/packages/utils/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@circles-sdk/utils",
-  "version": "0.14.0",
+  "version": "0.15.0-preview1",
   "description": "",
   "type": "module",
   "main": "./dist/index.js",