wallet-adapters,wallet-standard: support chain and account transactio…

…n parameters (MystenLabs#8496) * allow dapps/wallet-kit specify the chain and account for a transaction part of APPS-281
nitingujarathi · Feb 24, 2023 · c718dee · c718dee
1 parent c8ea6a1
commit c718dee
Show file tree

Hide file tree

Showing 30 changed files with 338 additions and 280 deletions.
diff --git a/.changeset/strange-fireants-burn.md b/.changeset/strange-fireants-burn.md
@@ -0,0 +1,14 @@
+---
+"@mysten/wallet-adapter-wallet-standard": minor
+"@mysten/wallet-adapter-unsafe-burner": minor
+"@mysten/wallet-adapter-base": minor
+"@mysten/wallet-kit-core": minor
+"@mysten/wallet-standard": minor
+"@mysten/wallet-kit": minor
+---
+
+wallet-standard: changes sui:signAndExecuteTransaction and sui:signTransaction features to support account and chain options
+wallet-adapter-wallet-standard: change signAndExecuteTransaction and signTransaction signatures to support account and chain options
+wallet-adapter-wallet-standard: ensure version compatibility for of the wallet signAndExecuteTransaction and signTransaction features before using them (same major version)
+wallet-kit-core/wallet-kit: expose accounts as ReadonlyWalletAccount instead of only the address
+wallet-kit-core: signTransaction and signAndExecuteTransaction methods mirror the ones in standard adapter
diff --git a/apps/explorer/src/components/module/module-functions-interaction/ModuleFunction.tsx b/apps/explorer/src/components/module/module-functions-interaction/ModuleFunction.tsx
@@ -69,14 +69,16 @@ export function ModuleFunction({
     const execute = useMutation({
         mutationFn: async ({ params, types }: TypeOf<typeof argsSchema>) => {
             const result = await signAndExecuteTransaction({
-                kind: 'moveCall',
-                data: {
-                    packageObjectId: packageId,
-                    module: moduleName,
-                    function: functionName,
-                    arguments: params || [],
-                    typeArguments: types || [],
-                    gasBudget: 2000,
+                transaction: {
+                    kind: 'moveCall',
+                    data: {
+                        packageObjectId: packageId,
+                        module: moduleName,
+                        function: functionName,
+                        arguments: params || [],
+                        typeArguments: types || [],
+                        gasBudget: 2000,
+                    },
                 },
             });
             if (getExecutionStatusType(result) === 'failure') {

diff --git a/apps/wallet/src/dapp-interface/WalletStandardInterface.ts b/apps/wallet/src/dapp-interface/WalletStandardInterface.ts
@@ -110,11 +110,11 @@ export class SuiWallet implements Wallet {
                 on: this.#on,
             },
             'sui:signTransaction': {
-                version: '1.0.0',
+                version: '2.0.0',
                 signTransaction: this.#signTransaction,
             },
             'sui:signAndExecuteTransaction': {
-                version: '1.1.0',
+                version: '2.0.0',
                 signAndExecuteTransaction: this.#signAndExecuteTransaction,
             },
             'suiWallet:stake': {

diff --git a/dapps/frenemies/src/components/Validators/actions/AddDelegation.tsx b/dapps/frenemies/src/components/Validators/actions/AddDelegation.tsx
@@ -44,7 +44,10 @@ export function AddDelegation({ validator, amount }: Props) {
       throw new Error("No coins found.");
     }
 
-    const totalBalance = coins.reduce((acc, coin) => (acc += BigInt(coin.balance)), 0n);
+    const totalBalance = coins.reduce(
+      (acc, coin) => (acc += BigInt(coin.balance)),
+      0n
+    );
 
     const mistAmount = toMist(amount);
 
@@ -62,8 +65,8 @@ export function AddDelegation({ validator, amount }: Props) {
 
     const stakeCoin = await manageCoins(coins, mistAmount, gasRequired);
 
-    await signAndExecuteTransaction(
-      {
+    await signAndExecuteTransaction({
+      transaction: {
         kind: "moveCall",
         data: {
           packageObjectId: SUI_FRAMEWORK_ADDRESS,
@@ -79,10 +82,10 @@ export function AddDelegation({ validator, amount }: Props) {
           ],
         },
       },
-      {
-        // requestType: "WaitForEffectsCert",
-      }
-    );
+      // options: {
+      // requestType: "WaitForEffectsCert",
+      // },
+    });
   });
 
   return (

diff --git a/dapps/frenemies/src/components/Validators/actions/CancelDelegation.tsx b/dapps/frenemies/src/components/Validators/actions/CancelDelegation.tsx
@@ -23,8 +23,8 @@ export function CancelDelegation({ stake }: Props) {
   const { signAndExecuteTransaction } = useWalletKit();
 
   const withdrawDelegation = useMutation(["unstake-validator"], async () => {
-    await signAndExecuteTransaction(
-      {
+    await signAndExecuteTransaction({
+      transaction: {
         kind: "moveCall",
         data: {
           packageObjectId: SUI_FRAMEWORK_ADDRESS,
@@ -38,10 +38,10 @@ export function CancelDelegation({ stake }: Props) {
           ],
         },
       },
-      {
-        // requestType: "WaitForEffectsCert",
-      }
-    );
+      // options: {
+      // requestType: "WaitForEffectsCert",
+      // },
+    });
   });
 
   return (

diff --git a/dapps/frenemies/src/components/Validators/actions/WithdrawDelegation.tsx b/dapps/frenemies/src/components/Validators/actions/WithdrawDelegation.tsx
@@ -24,8 +24,8 @@ export function WithdrawDelegation({ stake, delegation }: Props) {
   const { currentAccount, signAndExecuteTransaction } = useWalletKit();
 
   const withdrawDelegation = useMutation(["unstake-validator"], async () => {
-    await signAndExecuteTransaction(
-      {
+    await signAndExecuteTransaction({
+      transaction: {
         kind: "moveCall",
         data: {
           packageObjectId: SUI_FRAMEWORK_ADDRESS,
@@ -40,10 +40,10 @@ export function WithdrawDelegation({ stake, delegation }: Props) {
           ],
         },
       },
-      {
-        // requestType: "WaitForEffectsCert",
-      }
-    );
+      // options: {
+      // requestType: "WaitForEffectsCert",
+      // },
+    });
   });
 
   return (

diff --git a/dapps/frenemies/src/network/queries/coin.ts b/dapps/frenemies/src/network/queries/coin.ts
@@ -11,10 +11,10 @@ const DEC = 9;
 export function useBalance() {
   const { currentAccount } = useWalletKit();
   return useQuery(
-    ["account-balance", currentAccount],
+    ["account-balance", currentAccount?.address],
     async () => {
       const { totalBalance } = await provider.getBalance(
-        currentAccount!,
+        currentAccount?.address!,
         SUI_TYPE_ARG
       );
 
@@ -24,7 +24,7 @@ export function useBalance() {
       };
     },
     {
-      enabled: !!currentAccount,
+      enabled: !!currentAccount?.address,
       refetchInterval: 60 * 1000,
       staleTime: 2000,
     }

diff --git a/dapps/frenemies/src/network/queries/scorecard.ts b/dapps/frenemies/src/network/queries/scorecard.ts
@@ -48,18 +48,20 @@ export function useRefreshScorecard() {
     if (!leaderboard) throw new Error("Missing leaderboard");
 
     await signAndExecuteTransaction({
-      kind: "moveCall",
-      data: {
-        packageObjectId: config.VITE_PKG,
-        module: "frenemies",
-        function: "update",
-        typeArguments: [],
-        gasBudget: Number(GAS_BUDGET),
-        arguments: [
-          normalizeSuiAddress(scorecard.reference.objectId),
-          SUI_SYSTEM_ID,
-          normalizeSuiAddress(leaderboard.reference.objectId),
-        ],
+      transaction: {
+        kind: "moveCall",
+        data: {
+          packageObjectId: config.VITE_PKG,
+          module: "frenemies",
+          function: "update",
+          typeArguments: [],
+          gasBudget: Number(GAS_BUDGET),
+          arguments: [
+            normalizeSuiAddress(scorecard.reference.objectId),
+            SUI_SYSTEM_ID,
+            normalizeSuiAddress(leaderboard.reference.objectId),
+          ],
+        },
       },
     });
   });

diff --git a/dapps/frenemies/src/network/queries/use-raw.ts b/dapps/frenemies/src/network/queries/use-raw.ts
@@ -25,10 +25,10 @@ export function useRawObject<T>(objectId: string, bcsType: string) {
 function useObjectsOwnedByAddress() {
   const { currentAccount } = useWalletKit();
   return useQuery(
-    ["owned", currentAccount],
-    async () => provider.getObjectsOwnedByAddress(currentAccount!),
+    ["owned", currentAccount?.address],
+    async () => provider.getObjectsOwnedByAddress(currentAccount?.address!),
     {
-      enabled: !!currentAccount,
+      enabled: !!currentAccount?.address,
       refetchInterval: 2 * 60 * 1000,
     }
   );

diff --git a/dapps/frenemies/src/routes/Claim.tsx b/dapps/frenemies/src/routes/Claim.tsx
@@ -88,6 +88,9 @@ function Connected() {
   const submitWinner = useMutation(
     ["submit-winner"],
     async (values: z.infer<typeof Schema>) => {
+      if (!currentAccount) {
+        throw new Error("Missing account");
+      }
       const res = await fetch(
         import.meta.env.DEV
           ? "http://127.0.0.1:3003/frenemies"
@@ -98,7 +101,7 @@ function Connected() {
             "content-type": "application/json",
           },
           body: JSON.stringify({
-            address: currentAccount!,
+            address: currentAccount.address,
             name: values.name,
             email: values.email,
           }),
@@ -112,14 +115,16 @@ function Connected() {
       const data = await res.json();
 
       await signAndExecuteTransaction({
-        kind: "moveCall",
-        data: {
-          packageObjectId: config.VITE_NOOP,
-          module: "noop",
-          function: "noop_w_metadata",
-          typeArguments: [],
-          gasBudget: Number(GAS_BUDGET),
-          arguments: [data.bytes],
+        transaction: {
+          kind: "moveCall",
+          data: {
+            packageObjectId: config.VITE_NOOP,
+            module: "noop",
+            function: "noop_w_metadata",
+            typeArguments: [],
+            gasBudget: Number(GAS_BUDGET),
+            arguments: [data.bytes],
+          },
         },
       });
     }

diff --git a/dapps/frenemies/src/routes/Migrate.tsx b/dapps/frenemies/src/routes/Migrate.tsx
@@ -44,17 +44,19 @@ export function Migrate() {
     ["migrate-scorecard"],
     async () => {
       await signAndExecuteTransaction({
-        kind: "moveCall",
-        data: {
-          packageObjectId: config.VITE_PKG,
-          module: "frenemies",
-          function: "migrate",
-          typeArguments: [],
-          arguments: [
-            legacyScorecard.data!.reference.objectId,
-            config.VITE_MIGRATION,
-          ],
-          gasBudget: GAS_BUDGET,
+        transaction: {
+          kind: "moveCall",
+          data: {
+            packageObjectId: config.VITE_PKG,
+            module: "frenemies",
+            function: "migrate",
+            typeArguments: [],
+            arguments: [
+              legacyScorecard.data!.reference.objectId,
+              config.VITE_MIGRATION,
+            ],
+            gasBudget: GAS_BUDGET,
+          },
         },
       });
     },

diff --git a/dapps/frenemies/src/routes/Setup.tsx b/dapps/frenemies/src/routes/Setup.tsx
@@ -71,7 +71,7 @@ export function Setup() {
           { pkg: config.VITE_PKG, registry: config.VITE_REGISTRY },
         ].map(({ pkg, registry }) =>
           provider.devInspectTransaction(
-            currentAccount,
+            currentAccount.address,
             {
               kind: "moveCall",
               data: {
@@ -114,21 +114,23 @@ export function Setup() {
       });
 
       await signAndExecuteTransaction({
-        kind: "moveCall",
-        data: {
-          packageObjectId: config.VITE_PKG,
-          module: "frenemies",
-          function: "register",
-          arguments: [
-            username,
-            config.VITE_REGISTRY,
-            config.VITE_OLD_REGISTRY,
-            SUI_SYSTEM_ID,
-          ],
-          typeArguments: [],
+        transaction: {
+          kind: "moveCall",
+          data: {
+            packageObjectId: config.VITE_PKG,
+            module: "frenemies",
+            function: "register",
+            arguments: [
+              username,
+              config.VITE_REGISTRY,
+              config.VITE_OLD_REGISTRY,
+              SUI_SYSTEM_ID,
+            ],
+            typeArguments: [],
 
-          // TODO: Fix in sui.js - add option to use bigint...
-          gasBudget: Number(GAS_BUDGET),
+            // TODO: Fix in sui.js - add option to use bigint...
+            gasBudget: Number(GAS_BUDGET),
+          },
         },
       });
     },

diff --git a/dapps/frenemies/src/utils/coins.ts b/dapps/frenemies/src/utils/coins.ts
@@ -14,7 +14,7 @@ export function useGetLatestCoins() {
   return async () => {
     if (!currentAccount) throw new Error("Wallet not connected");
     const { data } = await provider.getCoins(
-      currentAccount,
+      currentAccount.address,
       SUI_TYPE_ARG,
       undefined,
       1000
@@ -59,13 +59,15 @@ export function useManageCoin() {
     const inputCoins = getCoins(coins, totalAmount);
 
     const result = await signAndExecuteTransaction({
-      kind: "paySui",
-      data: {
-        inputCoins: inputCoins.map((coin) => coin.coinObjectId),
-        recipients: [currentAccount, currentAccount],
-        // TODO: Update SDK to accept bigint
-        amounts: [Number(amount), Number(gasFee)],
-        gasBudget: computeGasBudgetForPay(inputCoins.length),
+      transaction: {
+        kind: "paySui",
+        data: {
+          inputCoins: inputCoins.map((coin) => coin.coinObjectId),
+          recipients: [currentAccount.address, currentAccount.address],
+          // TODO: Update SDK to accept bigint
+          amounts: [Number(amount), Number(gasFee)],
+          gasBudget: computeGasBudgetForPay(inputCoins.length),
+        },
       },
     });