genlayer-js 0.9.5 → 0.11.0

package/dist/types/index.d.cts

@@ -1,3 +1,3 @@
 export { Account, Address } from 'viem';
-export { a as CalldataAddress, C as CalldataEncodable, f as ContractMethod, e as ContractMethodBase, c as ContractParamsArraySchemaElement, d as ContractParamsSchema, g as ContractSchema, q as DecodedCallData, D as DecodedDeployData, G as GenLayerClient, b as GenLayerMethod, s as GenLayerRawTransaction, r as GenLayerTransaction, H as Hash, M as MethodDescription, N as Network, S as SnapSource, h as TransactionHash, p as TransactionHashVariant, j as TransactionResult, m as TransactionResultNameToNumber, i as TransactionStatus, o as TransactionType, V as VoteType, l as transactionResultNumberToName, k as transactionsStatusNameToNumber, t as transactionsStatusNumberToName, n as voteTypeNameToNumber, v as voteTypeNumberToName } from '../index-CWYHlYb1.cjs';
+export { a as CalldataAddress, C as CalldataEncodable, f as ContractMethod, e as ContractMethodBase, c as ContractParamsArraySchemaElement, d as ContractParamsSchema, g as ContractSchema, q as DecodedCallData, D as DecodedDeployData, G as GenLayerClient, b as GenLayerMethod, s as GenLayerRawTransaction, r as GenLayerTransaction, H as Hash, M as MethodDescription, N as Network, S as SnapSource, h as TransactionHash, p as TransactionHashVariant, j as TransactionResult, m as TransactionResultNameToNumber, i as TransactionStatus, o as TransactionType, V as VoteType, l as transactionResultNumberToName, k as transactionsStatusNameToNumber, t as transactionsStatusNumberToName, n as voteTypeNameToNumber, v as voteTypeNumberToName } from '../index-BhRfI25e.cjs';
 export { G as GenLayerChain } from '../chains-BYSCF33g.cjs';

package/dist/types/index.d.ts

@@ -1,3 +1,3 @@
 export { Account, Address } from 'viem';
-export { a as CalldataAddress, C as CalldataEncodable, f as ContractMethod, e as ContractMethodBase, c as ContractParamsArraySchemaElement, d as ContractParamsSchema, g as ContractSchema, q as DecodedCallData, D as DecodedDeployData, G as GenLayerClient, b as GenLayerMethod, s as GenLayerRawTransaction, r as GenLayerTransaction, H as Hash, M as MethodDescription, N as Network, S as SnapSource, h as TransactionHash, p as TransactionHashVariant, j as TransactionResult, m as TransactionResultNameToNumber, i as TransactionStatus, o as TransactionType, V as VoteType, l as transactionResultNumberToName, k as transactionsStatusNameToNumber, t as transactionsStatusNumberToName, n as voteTypeNameToNumber, v as voteTypeNumberToName } from '../index-CjM-U5oN.js';
+export { a as CalldataAddress, C as CalldataEncodable, f as ContractMethod, e as ContractMethodBase, c as ContractParamsArraySchemaElement, d as ContractParamsSchema, g as ContractSchema, q as DecodedCallData, D as DecodedDeployData, G as GenLayerClient, b as GenLayerMethod, s as GenLayerRawTransaction, r as GenLayerTransaction, H as Hash, M as MethodDescription, N as Network, S as SnapSource, h as TransactionHash, p as TransactionHashVariant, j as TransactionResult, m as TransactionResultNameToNumber, i as TransactionStatus, o as TransactionType, V as VoteType, l as transactionResultNumberToName, k as transactionsStatusNameToNumber, t as transactionsStatusNumberToName, n as voteTypeNameToNumber, v as voteTypeNumberToName } from '../index-dnt5ldCd.js';
 export { G as GenLayerChain } from '../chains-BYSCF33g.js';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "genlayer-js",
   "type": "module",
-  "version": "0.9.5",
+  "version": "0.11.0",
   "description": "GenLayer JavaScript SDK",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/chains/index.ts

@@ -1,3 +1,4 @@
 // src/chains/index.ts
 export {localnet} from "./localnet";
+export {studionet} from "./studionet";
 export {testnetAsimov} from "./testnetAsimov";

package/src/contracts/actions.ts

@@ -137,13 +137,19 @@ export const contractActions = (client: GenLayerClient<GenLayerChain>, publicCli
       } = args;
       const data = [calldata.encode(makeCalldataObject(functionName, callArgs, kwargs)), leaderOnly];
       const serializedData = serialize(data);
-      return _sendTransaction({
+      const senderAccount = account || client.account;
+      const encodedData = _encodeAddTransactionData({
         client,
-        publicClient,
+        senderAccount,
         recipient: address,
         data: serializedData,
-        senderAccount: account || client.account,
         consensusMaxRotations,
+      });
+      return _sendTransaction({
+        client,
+        publicClient,
+        encodedData,
+        senderAccount,
         value,
       });
     },
@@ -169,68 +175,118 @@ export const contractActions = (client: GenLayerClient<GenLayerChain>, publicCli
         leaderOnly,
       ];
       const serializedData = serialize(data);
-      return _sendTransaction({
+      const senderAccount = account || client.account;
+      const encodedData = _encodeAddTransactionData({
         client,
-        publicClient: publicClient,
+        senderAccount,
         recipient: zeroAddress,
         data: serializedData,
-        senderAccount: account || client.account,
         consensusMaxRotations,
       });
+      return _sendTransaction({
+        client,
+        publicClient,
+        encodedData,
+        senderAccount,
+      });
+    },
+    appealTransaction: async (args: {
+      account?: Account;
+      txId: `0x${string}`;
+    }) => {
+      const {account, txId} = args;
+      const senderAccount = account || client.account;
+      const encodedData = _encodeSubmitAppealData({client, txId});
+      return _sendTransaction({
+        client,
+        publicClient,
+        encodedData,
+        senderAccount,
+      });
     },
   };
 };
 
-const _sendTransaction = async ({
+const validateAccount = (Account?: Account): Account => {
+  if (!Account) {
+    throw new Error(
+      "No account set. Configure the client with an account or pass an account to this function.",
+    );
+  }
+  return Account;
+};
+
+const _encodeAddTransactionData = ({
   client,
-  publicClient,
+  senderAccount,
   recipient,
   data,
-  senderAccount,
-  consensusMaxRotations,
-  value,
+  consensusMaxRotations = client.chain.defaultConsensusMaxRotations,
 }: {
   client: GenLayerClient<GenLayerChain>;
-  publicClient: PublicClient;
-  recipient: `0x${string}`;
-  data: `0x${string}`;
   senderAccount?: Account;
+  recipient?: `0x${string}`;
+  data?: `0x${string}`;
   consensusMaxRotations?: number;
-  value?: bigint;
-}) => {
-  if (!senderAccount) {
-    throw new Error(
-      "No account set. Configure the client with an account or pass an account to this function.",
-    );
-  }
-
-  if (!client.chain.consensusMainContract?.address) {
-    throw new Error("Consensus main contract not initialized. Please ensure client is properly initialized.");
-  }
-
-  const encodedData = encodeFunctionData({
+}): `0x${string}` => {
+  const validatedSenderAccount = validateAccount(senderAccount);
+  return encodeFunctionData({
     abi: client.chain.consensusMainContract?.abi as any,
     functionName: "addTransaction",
     args: [
-      senderAccount.address,
+      validatedSenderAccount.address,
       recipient,
       client.chain.defaultNumberOfInitialValidators,
       consensusMaxRotations,
       data,
     ],
   });
+};
+
+const _encodeSubmitAppealData = ({
+  client,
+  txId,
+}: {
+  client: GenLayerClient<GenLayerChain>;
+  txId: `0x${string}`;
+}): `0x${string}` => {
+  return encodeFunctionData({
+    abi: client.chain.consensusMainContract?.abi as any,
+    functionName: "submitAppeal",
+    args: [txId],
+  });
+};
+
+const _sendTransaction = async ({
+  client,
+  publicClient,
+  encodedData,
+  senderAccount,
+  value = 0n,
+}: {
+  client: GenLayerClient<GenLayerChain>;
+  publicClient: PublicClient;
+  encodedData: `0x${string}`;
+  senderAccount?: Account;
+  value?: bigint;
+}) => {
+  if (!client.chain.consensusMainContract?.address) {
+    throw new Error("Consensus main contract not initialized. Please ensure client is properly initialized.");
+  }
+
+  const validatedSenderAccount = validateAccount(senderAccount);
 
-  const nonce = await client.getCurrentNonce({address: senderAccount.address});
+  const nonce = await client.getCurrentNonce({address: validatedSenderAccount.address});
   const transactionRequest = await client.prepareTransactionRequest({
-    account: senderAccount,
+    account: validatedSenderAccount,
     to: client.chain.consensusMainContract?.address as Address,
     data: encodedData,
     type: "legacy",
     nonce: Number(nonce),
-    value: value ?? 0n,
+    value: value,
   });
 
-  if (senderAccount?.type !== "local") {
+  if (validatedSenderAccount?.type !== "local") {
     const formattedRequest = {
       from: transactionRequest.from,
       to: transactionRequest.to,
@@ -244,11 +300,11 @@ const _sendTransaction = async ({
     });
   }
 
-  if (!senderAccount?.signTransaction) {
+  if (!validatedSenderAccount?.signTransaction) {
     throw new Error("Account does not support signTransaction");
   }
 
-  const serializedTransaction = await senderAccount.signTransaction(transactionRequest);
+  const serializedTransaction = await validatedSenderAccount.signTransaction(transactionRequest);
 
   const txHash = await client.sendRawTransaction({serializedTransaction: serializedTransaction});
 

package/src/types/clients.ts

@@ -79,4 +79,8 @@ export type GenLayerClient<TGenLayerChain extends GenLayerChain> = Omit<
     initializeConsensusSmartContract: (forceReset?: boolean) => Promise<void>;
     connect: (network?: Network, snapSource?: SnapSource) => Promise<void>;
     metamaskClient: (snapSource?: SnapSource) => Promise<MetaMaskClientResult>;
+    appealTransaction: (args: {
+      account?: Account;
+      txId: `0x${string}`;
+    }) => Promise<any>;
   };