From 28163f20c551d7586075337eb29028c46a91c50b Mon Sep 17 00:00:00 2001 From: louis-md Date: Mon, 21 Oct 2024 17:31:45 +0200 Subject: [PATCH] Format files --- pages/reference-smart-account/_meta.json | 4 ++-- .../owners/addOwnerWithThreshold.mdx | 15 +++++++-------- .../owners/changeThreshold.mdx | 11 +++++------ .../reference-smart-account/owners/getOwners.mdx | 5 ++++- .../owners/getThreshold.mdx | 5 ++++- pages/reference-smart-account/owners/isOwner.mdx | 9 +++++++-- .../owners/removeOwner.mdx | 8 ++++---- .../reference-smart-account/owners/swapOwner.mdx | 12 ++++++++---- 8 files changed, 41 insertions(+), 28 deletions(-) diff --git a/pages/reference-smart-account/_meta.json b/pages/reference-smart-account/_meta.json index a8ba8d3b..5df3e5ec 100644 --- a/pages/reference-smart-account/_meta.json +++ b/pages/reference-smart-account/_meta.json @@ -10,10 +10,10 @@ }, "setup": "Setup", "owners": "Owners", - "modules": "Modules", "transactions": "Transactions", - "fallback": "Fallback Handler", + "modules": "Modules", "guards": "Guards", + "fallback": "Fallback Handler", "signatures": "Signatures", "utilities": "Utilities" } diff --git a/pages/reference-smart-account/owners/addOwnerWithThreshold.mdx b/pages/reference-smart-account/owners/addOwnerWithThreshold.mdx index 01fbc531..8452bb28 100644 --- a/pages/reference-smart-account/owners/addOwnerWithThreshold.mdx +++ b/pages/reference-smart-account/owners/addOwnerWithThreshold.mdx @@ -1,12 +1,10 @@ -import { Tabs, Callout } from "nextra/components" +import { Tabs, Callout } from 'nextra/components' # `addOwnerWithThreshold` Adds the owner `owner` to the Safe and updates the threshold to `_threshold`. - -This can only be done via a Safe transaction. - +This can only be done via a Safe transaction. ## Usage @@ -27,7 +25,8 @@ This can only be done via a Safe transaction. ) } } -``` + +```` @@ -37,7 +36,7 @@ This can only be done via a Safe transaction. ### `owner` -- **Type:** `address` +- **Type:** `address` New owner address. @@ -46,7 +45,7 @@ addOwnerWithThreshold( "0x...", 1 ) -``` +```` ### `_threshold` @@ -70,6 +69,6 @@ event AddedOwner(address owner) ``` -Emitted when an owner is added to the Safe. +Emitted when an owner is added to the Safe. This event is also emitted in the [`swapOwner`](./swapOwner.mdx) function. diff --git a/pages/reference-smart-account/owners/changeThreshold.mdx b/pages/reference-smart-account/owners/changeThreshold.mdx index 252b2ae8..92fe3e0b 100644 --- a/pages/reference-smart-account/owners/changeThreshold.mdx +++ b/pages/reference-smart-account/owners/changeThreshold.mdx @@ -1,12 +1,10 @@ -import { Tabs, Callout } from "nextra/components" +import { Tabs, Callout } from 'nextra/components' # `changeThreshold` Changes the threshold of the Safe to `_threshold`. - -This can only be done via a Safe transaction. - +This can only be done via a Safe transaction. ## Usage @@ -26,7 +24,8 @@ This can only be done via a Safe transaction. ) } } -``` + +```` @@ -43,7 +42,7 @@ New threshold. changeThreshold( 1 ) -``` +```` ## Events diff --git a/pages/reference-smart-account/owners/getOwners.mdx b/pages/reference-smart-account/owners/getOwners.mdx index 639ee258..61ddf6a5 100644 --- a/pages/reference-smart-account/owners/getOwners.mdx +++ b/pages/reference-smart-account/owners/getOwners.mdx @@ -1,8 +1,10 @@ +import { Tabs } from 'nextra/components' + # `getOwners` Returns a list of Safe owners. -## Usage +## Usage {/* */} @@ -21,6 +23,7 @@ Returns a list of Safe owners. ## Returns ### `owners` + - **Type:** `address[]` Array of Safe owners. diff --git a/pages/reference-smart-account/owners/getThreshold.mdx b/pages/reference-smart-account/owners/getThreshold.mdx index afb6cbcd..d2d72a2f 100644 --- a/pages/reference-smart-account/owners/getThreshold.mdx +++ b/pages/reference-smart-account/owners/getThreshold.mdx @@ -1,4 +1,4 @@ -import { Tabs } from "nextra/components" +import { Tabs } from 'nextra/components' # `getThreshold` @@ -7,6 +7,7 @@ Returns the number of required confirmations for a Safe transaction aka the thre ## Usage {/* */} + ```solidity @@ -20,6 +21,7 @@ Returns the number of required confirmations for a Safe transaction aka the thre } } ``` + @@ -28,6 +30,7 @@ Returns the number of required confirmations for a Safe transaction aka the thre ## Returns ### `threshold` + - **Type:** `uint256` Threshold number. diff --git a/pages/reference-smart-account/owners/isOwner.mdx b/pages/reference-smart-account/owners/isOwner.mdx index d941301a..b5b52826 100644 --- a/pages/reference-smart-account/owners/isOwner.mdx +++ b/pages/reference-smart-account/owners/isOwner.mdx @@ -1,4 +1,4 @@ -import { Tabs } from "nextra/components" +import { Tabs } from 'nextra/components' # `isOwner` @@ -21,19 +21,24 @@ Returns if `owner` is an owner of the Safe. } } ``` + {/* */} + ## Returns ### `isOwner` + - **Type:** `bool` Boolean flag indicating if `owner` is an owner of the Safe. ## Parameters + ### `owner` + - **Type:** `address` -Owner address. \ No newline at end of file +Owner address. diff --git a/pages/reference-smart-account/owners/removeOwner.mdx b/pages/reference-smart-account/owners/removeOwner.mdx index 6a398db8..ea8edf04 100644 --- a/pages/reference-smart-account/owners/removeOwner.mdx +++ b/pages/reference-smart-account/owners/removeOwner.mdx @@ -1,4 +1,4 @@ -import { Tabs, Callout } from "nextra/components" +import { Tabs, Callout } from 'nextra/components' # `removeOwner` @@ -6,9 +6,7 @@ import { Tabs, Callout } from "nextra/components" Removes the owner `owner` from the Safe and updates the threshold to `_threshold`. - -This can only be done via a Safe transaction. - +This can only be done via a Safe transaction. ## Usage @@ -31,6 +29,7 @@ This can only be done via a Safe transaction. } } ``` + @@ -39,6 +38,7 @@ This can only be done via a Safe transaction. ## Parameters ### `prevOwner` + - **Type:** `address` Owner that pointed to the owner to be removed in the linked list diff --git a/pages/reference-smart-account/owners/swapOwner.mdx b/pages/reference-smart-account/owners/swapOwner.mdx index bfab7ace..b8976082 100644 --- a/pages/reference-smart-account/owners/swapOwner.mdx +++ b/pages/reference-smart-account/owners/swapOwner.mdx @@ -1,12 +1,10 @@ -import { Tabs, Callout } from "nextra/components" +import { Tabs, Callout } from 'nextra/components' # `swapOwner` Replaces the owner `oldOwner` in the Safe with `newOwner`. - -This can only be done via a Safe transaction. - +This can only be done via a Safe transaction. ## Usage @@ -25,13 +23,16 @@ This can only be done via a Safe transaction. } } ``` + {/* */} ## Parameters + ### `prevOwner` + - **Type:** `address` Owner that pointed to the owner to be replaced in the linked list @@ -45,6 +46,7 @@ swapOwner( ``` ### `oldOwner` + - **Type:** `address` Owner address to be replaced. @@ -58,6 +60,7 @@ swapOwner( ``` ### `newOwner` + - **Type:** `address` New owner address. @@ -73,4 +76,5 @@ swapOwner( ## Events ### [`AddedOwner`](./addOwnerWithThreshold.mdx#addedowner) + ### [`RemovedOwner`](./removeOwner.mdx#removedowner)