chore: docstring

Consensys · Nov 21, 2024 · bfe1070 · bfe1070
1 parent 7a4fd30
commit bfe1070
Show file tree

Hide file tree

Showing 7 changed files with 16 additions and 13 deletions.
diff --git a/packages/starknet-snap/src/rpcs/sign-declare-transaction.test.ts b/packages/starknet-snap/src/rpcs/sign-declare-transaction.test.ts
@@ -79,7 +79,7 @@ describe('signDeclareTransaction', () => {
       senderAddress: address,
       chainId,
       networkName: STARKNET_SEPOLIA_TESTNET_NETWORK.name,
-      details: request.details,
+      declareTransactions: request.details,
     });
   });
 

diff --git a/packages/starknet-snap/src/rpcs/sign-declare-transaction.ts b/packages/starknet-snap/src/rpcs/sign-declare-transaction.ts
@@ -84,7 +84,7 @@ export class SignDeclareTransactionRpc extends AccountRpcController<
         senderAddress: details.senderAddress,
         networkName: this.network.name,
         chainId: this.network.chainId,
-        details,
+        declareTransactions: details,
       }))
     ) {
       throw new UserRejectedOpError() as unknown as Error;

diff --git a/packages/starknet-snap/src/rpcs/sign-transaction.test.ts b/packages/starknet-snap/src/rpcs/sign-transaction.test.ts
@@ -76,7 +76,7 @@ describe('signTransaction', () => {
       senderAddress: address,
       chainId,
       networkName: STARKNET_SEPOLIA_TESTNET_NETWORK.name,
-      details: request.transactions,
+      transactions: request.transactions,
     });
   });
 

diff --git a/packages/starknet-snap/src/rpcs/sign-transaction.ts b/packages/starknet-snap/src/rpcs/sign-transaction.ts
@@ -85,7 +85,7 @@ export class SignTransactionRpc extends AccountRpcController<
         senderAddress: address,
         networkName: this.network.name,
         chainId: this.network.chainId,
-        details: transactions,
+        transactions,
       }))
     ) {
       throw new UserRejectedOpError() as unknown as Error;

diff --git a/packages/starknet-snap/src/ui/components/SignDeclareTransactionUI.tsx b/packages/starknet-snap/src/ui/components/SignDeclareTransactionUI.tsx
@@ -9,7 +9,7 @@ export type SignDeclareTransactionUIProps = {
   senderAddress: string;
   networkName: string;
   chainId: string;
-  details: Infer<typeof DeclareSignDetailsStruct>;
+  declareTransactions: Infer<typeof DeclareSignDetailsStruct>;
 };
 
 /**
@@ -19,19 +19,22 @@ export type SignDeclareTransactionUIProps = {
  * @param options.senderAddress - The address of the sender initiating the transaction.
  * @param options.networkName - The name of the blockchain network where the transaction will occur.
  * @param options.chainId - The chain ID of the blockchain network.
- * @param options.details - The details of the Declare transaction, conforming to the `DeclareSignDetailsStruct` structure.
+ * @param options.declareTransactions - The details of the Declare transaction.
  * @returns A JSX component for the user to review and confirm the Declare transaction signing.
  */
 export const SignDeclareTransactionUI: SnapComponent<
   SignDeclareTransactionUIProps
-> = ({ senderAddress, networkName, chainId, details }) => {
+> = ({ senderAddress, networkName, chainId, declareTransactions }) => {
   return (
     <Box>
       <Heading>Do you want to sign this transaction?</Heading>
       <Section>
         <AddressUI label="Signer" address={senderAddress} chainId={chainId} />
         <NetworkUI networkName={networkName} />
-        <JsonDataUI label={'Declare Transaction Details'} data={details} />
+        <JsonDataUI
+          label={'Declare Transaction Details'}
+          data={declareTransactions}
+        />
       </Section>
     </Box>
   );

diff --git a/packages/starknet-snap/src/ui/components/SignMessageUI.tsx b/packages/starknet-snap/src/ui/components/SignMessageUI.tsx
@@ -17,7 +17,7 @@ export type SignMessageUIProps = {
  * @param options - The options to configure the component.
  * @param options.address - The address of the signer.
  * @param options.chainId - The chain ID of the blockchain network.
- * @param options.typedDataMessage - The typed data message to be signed, conforming to the `TypeDataStruct` structure.
+ * @param options.typedDataMessage - The typed data message to be signed.
  * @returns A JSX component for the user to review and confirm the message signing.
  */
 export const SignMessageUI: SnapComponent<SignMessageUIProps> = ({

diff --git a/packages/starknet-snap/src/ui/components/SignTransactionUI.tsx b/packages/starknet-snap/src/ui/components/SignTransactionUI.tsx
@@ -9,7 +9,7 @@ export type SignTransactionUIProps = {
   senderAddress: string;
   networkName: string;
   chainId: string;
-  details: Infer<typeof CallDataStruct>[];
+  transactions: Infer<typeof CallDataStruct>[];
 };
 
 /**
@@ -19,22 +19,22 @@ export type SignTransactionUIProps = {
  * @param options.senderAddress - The address of the sender initiating the transaction.
  * @param options.networkName - The name of the blockchain network where the transaction will occur.
  * @param options.chainId - The chain ID of the blockchain network.
- * @param options.details - An array of transaction details conforming to the `CallDataStruct` structure.
+ * @param options.transactions - An array of transactions Call.
  * @returns A JSX component for the user to review and confirm the transaction signing.
  */
 export const SignTransactionUI: SnapComponent<SignTransactionUIProps> = ({
   senderAddress,
   networkName,
   chainId,
-  details,
+  transactions,
 }) => {
   return (
     <Box>
       <Heading>Do you want to sign this transaction?</Heading>
       <Section>
         <AddressUI label="Signer" address={senderAddress} chainId={chainId} />
         <NetworkUI networkName={networkName} />
-        <JsonDataUI label={'Transactions'} data={details} />
+        <JsonDataUI label={'Transactions'} data={transactions} />
       </Section>
     </Box>
   );