add specific exceptions when performing contract transactions

sinzii · sinzii · commit 1a6dde0eb70c · 2025-01-07T10:40:35.000+07:00
diff --git a/examples/demo-subconnect/.eslintrc.cjs b/examples/demo-subconnect/.eslintrc.cjs
@@ -14,5 +14,6 @@ module.exports = {
       'warn',
       { allowConstantExport: true },
     ],
+    "@typescript-eslint/no-explicit-any": "off"
   },
 }
diff --git a/examples/demo-subconnect/src/components/GreeterBoard.tsx b/examples/demo-subconnect/src/components/GreeterBoard.tsx
@@ -5,22 +5,13 @@ import PendingText from '@/components/shared/PendingText.tsx';
 import { shortenAddress } from '@/utils/string.ts';
 import { ContractId } from 'contracts/deployments';
 import { GreeterContractApi } from 'contracts/types/greeter';
-import {
-  useBalance,
-  useContract,
-  useContractTx,
-  useTypink,
-  useWatchContractEvent,
-  useWatchContractQuery,
-} from 'typink';
+import { useContract, useContractTx, useWatchContractEvent, useWatchContractQuery } from 'typink';
 import { txToaster } from '@/utils/txToaster.tsx';
 
 export default function GreetBoard() {
-  const { connectedAccount } = useTypink();
   const { contract } = useContract<GreeterContractApi>(ContractId.GREETER);
   const [message, setMessage] = useState('');
   const setMessageTx = useContractTx(contract, 'setMessage');
-  const balance = useBalance(connectedAccount?.address);
 
   const { data: greet, isLoading } = useWatchContractQuery({
     contract,
@@ -30,16 +21,6 @@ export default function GreetBoard() {
   const handleUpdateGreeting = async () => {
     if (!contract || !message) return;
 
-    if (!connectedAccount) {
-      toast.info('Please connect to your wallet');
-      return;
-    }
-
-    if (balance?.free === 0n) {
-      toast.error('Balance insufficient to make transaction.');
-      return;
-    }
-
     const toaster = txToaster('Signing transaction...');
 
     try {
diff --git a/examples/demo/.eslintrc.cjs b/examples/demo/.eslintrc.cjs
@@ -14,5 +14,6 @@ module.exports = {
       'warn',
       { allowConstantExport: true },
     ],
+    "@typescript-eslint/no-explicit-any": "off"
   },
 }
diff --git a/examples/demo/src/components/GreeterBoard.tsx b/examples/demo/src/components/GreeterBoard.tsx
@@ -5,22 +5,13 @@ import PendingText from '@/components/shared/PendingText.tsx';
 import { shortenAddress } from '@/utils/string.ts';
 import { ContractId } from 'contracts/deployments';
 import { GreeterContractApi } from 'contracts/types/greeter';
-import {
-  useBalance,
-  useContract,
-  useContractTx,
-  useTypink,
-  useWatchContractEvent,
-  useWatchContractQuery,
-} from 'typink';
+import { useContract, useContractTx, useWatchContractEvent, useWatchContractQuery } from 'typink';
 import { txToaster } from '@/utils/txToaster.tsx';
 
 export default function GreetBoard() {
-  const { connectedAccount } = useTypink();
   const { contract } = useContract<GreeterContractApi>(ContractId.GREETER);
   const [message, setMessage] = useState('');
   const setMessageTx = useContractTx(contract, 'setMessage');
-  const balance = useBalance(connectedAccount?.address);
 
   const { data: greet, isLoading } = useWatchContractQuery({
     contract,
@@ -30,16 +21,6 @@ export default function GreetBoard() {
   const handleUpdateGreeting = async () => {
     if (!contract || !message) return;
 
-    if (!connectedAccount) {
-      toast.info('Please connect to your wallet');
-      return;
-    }
-
-    if (balance?.free === 0n) {
-      toast.error('Balance insufficient to make transaction.');
-      return;
-    }
-
     const toaster = txToaster('Signing transaction...');
 
     try {
diff --git a/examples/demo/src/components/Psp22Board.tsx b/examples/demo/src/components/Psp22Board.tsx
@@ -11,7 +11,7 @@ import { txToaster } from '@/utils/txToaster.tsx';
 export default function Psp22Board() {
   const { contract } = useContract<Psp22ContractApi>(ContractId.PSP22);
   const { connectedAccount } = useTypink();
-  const mintTx = useContractTx(contract, 'psp22MintableMint');
+  const mintTx = useContractTx(contract, 'psp22Transfer');
   const inputAddressRef = useRef<HTMLInputElement>(null);
   const [address, setAddress] = useState('');
   const [watch, setWatch] = useState(false);
@@ -64,7 +64,7 @@ export default function Psp22Board() {
     const toaster = txToaster('Signing transaction...');
     try {
       await mintTx.signAndSend({
-        args: [BigInt(100 * Math.pow(10, tokenDecimal))],
+        args: ['5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY', BigInt(10000000000000000 * Math.pow(10, tokenDecimal)), '0x'],
         callback: ({ status }) => {
           console.log(status);
 
diff --git a/examples/demo/src/utils/txToaster.tsx b/examples/demo/src/utils/txToaster.tsx
@@ -50,9 +50,7 @@ export function txToaster(initialMessage: string = 'Signing transaction...'): Tx
   const onError = (e: Error) => {
     toast.update(toastId, {
       render: (
-        <p>
-          Tx Error: <b>{e.message}</b>
-        </p>
+        <p>{e.message}</p>
       ),
       type: 'error',
       isLoading: false,
diff --git a/packages/typink/src/hooks/useContractTx.ts b/packages/typink/src/hooks/useContractTx.ts
@@ -10,8 +10,9 @@ import {
 } from 'dedot/contracts';
 import { ISubmittableResult } from 'dedot/types';
 import { assert, deferred } from 'dedot/utils';
-import { TypinkError } from '../utils/index.js';
+import { BalanceInsufficientError, ContractMessageError } from '../utils/index.js';
 import { useDeepDeps } from './internal/index.js';
+import { ISubstrateClient } from 'dedot';
 
 type UseContractTx<A extends GenericContractApi = GenericContractApi> = OmitNever<{
   [K in keyof A['tx']]: K extends string ? (K extends `${infer Literal}` ? Literal : never) : never;
@@ -63,8 +64,8 @@ export function useContractTx<
   const signAndSend = useMemo(
     () => {
       return async (o: Parameters<UseContractTxReturnType<T>['signAndSend']>[0]) => {
-        assert(contract, 'Contract Not Found');
-        assert(connectedAccount, 'Connected Account Not Found');
+        assert(contract, 'Contract not found');
+        assert(connectedAccount, 'No connected account. Please connect your wallet.');
 
         setInProgress(true);
         setInBestBlockProgress(true);
@@ -122,18 +123,15 @@ export async function contractTx<
     callback?: (result: ISubmittableResult) => void;
   } & Args<Pop<Parameters<T['tx'][M]>>>,
 ): Promise<void> {
-  // TODO assertions
-  // TODO check if balance is sufficient
-
   const defer = deferred<void>();
 
   const signAndSend = async () => {
     const { contract, fn, args = [], caller, txOptions = {}, callback } = parameters;
 
+    await checkBalanceSufficient(contract.client, caller);
+
     try {
-      // TODO dry running
       const dryRunOptions: ContractCallOptions = { caller };
-
       const dryRun = await contract.query[fn](...args, dryRunOptions);
       console.log('Dry run result:', dryRun);
 
@@ -143,8 +141,7 @@ export async function contractTx<
       } = dryRun;
 
       if (data && data['isErr'] && data['err']) {
-        // TODO Add a specific contract level error
-        throw new TypinkError(JSON.stringify(data['err']));
+        throw new ContractMessageError(data['err']);
       }
 
       const actualTxOptions: ContractTxOptions = {
@@ -179,3 +176,14 @@ export async function contractTx<
 
   return defer.promise;
 }
+
+const checkBalanceSufficient = async <T extends GenericContractApi = GenericContractApi>(
+  client: ISubstrateClient<T['types']['ChainApi']>,
+  caller: string,
+): Promise<void> => {
+  const balance = await client.query.system.account(caller);
+  // TODO better calculate reducible balance
+  if (balance.data.free <= 0n) {
+    throw new BalanceInsufficientError(caller);
+  }
+};
diff --git a/packages/typink/src/utils/errors.ts b/packages/typink/src/utils/errors.ts
@@ -3,4 +3,26 @@ import { DedotError } from 'dedot/utils';
 /**
  * Typink-related errors
  */
-export class TypinkError extends DedotError {}
+export class TypinkError extends DedotError {}
+
+export class ContractMessageError<T extends any> extends TypinkError {
+    constructor(public error: T, message?: string) {
+        super(message || `Contract Message Error: ${extractErrorType(error)}`);
+    }
+}
+
+export class BalanceInsufficientError extends TypinkError {
+    constructor(public caller: string, message?: string) {
+        super(message || 'Insufficient balance to perform this transaction');
+    }
+}
+
+const extractErrorType = (error: any): string => {
+    if (typeof error === 'object' && error?.hasOwnProperty('type')) {
+        return error['type'];
+    } else if (typeof error === 'string') {
+        return error;
+    }
+
+    return JSON.stringify(error)
+}

Original file line number	Diff line number	Diff line change
`@@ -14,5 +14,6 @@ module.exports = {`
`14`	`14`	`'warn',`
`15`	`15`	`{ allowConstantExport: true },`
`16`	`16`	`],`
	`17`	`+ "@typescript-eslint/no-explicit-any": "off"`
`17`	`18`	`},`
`18`	`19`	`}`