Skip to content

Commit

Permalink
Format files
Browse files Browse the repository at this point in the history
  • Loading branch information
louis-md committed Oct 21, 2024
1 parent a81b921 commit 28163f2
Show file tree
Hide file tree
Showing 8 changed files with 41 additions and 28 deletions.
4 changes: 2 additions & 2 deletions pages/reference-smart-account/_meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
15 changes: 7 additions & 8 deletions pages/reference-smart-account/owners/addOwnerWithThreshold.mdx
Original file line number Diff line number Diff line change
@@ -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`.

<Callout type="warning">
This can only be done via a Safe transaction.
</Callout>
<Callout type='warning'>This can only be done via a Safe transaction.</Callout>

## Usage

Expand All @@ -27,7 +25,8 @@ This can only be done via a Safe transaction.
)
}
}
```
````
</Tabs.Tab>
</Tabs>
Expand All @@ -37,7 +36,7 @@ This can only be done via a Safe transaction.
### `owner`
- **Type:** `address`
- **Type:** `address`
New owner address.
Expand All @@ -46,7 +45,7 @@ addOwnerWithThreshold(
"0x...",
1
)
```
````
### `_threshold`
Expand All @@ -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.
11 changes: 5 additions & 6 deletions pages/reference-smart-account/owners/changeThreshold.mdx
Original file line number Diff line number Diff line change
@@ -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`.

<Callout type="warning">
This can only be done via a Safe transaction.
</Callout>
<Callout type='warning'>This can only be done via a Safe transaction.</Callout>

## Usage

Expand All @@ -26,7 +24,8 @@ This can only be done via a Safe transaction.
)
}
}
```
````
</Tabs.Tab>
</Tabs>
Expand All @@ -43,7 +42,7 @@ New threshold.
changeThreshold(
1
)
```
````
## Events
Expand Down
5 changes: 4 additions & 1 deletion pages/reference-smart-account/owners/getOwners.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
import { Tabs } from 'nextra/components'

# `getOwners`

Returns a list of Safe owners.

## Usage
## Usage

{/* <!-- vale off --> */}

Expand All @@ -21,6 +23,7 @@ Returns a list of Safe owners.
## Returns

### `owners`

- **Type:** `address[]`

Array of Safe owners.
5 changes: 4 additions & 1 deletion pages/reference-smart-account/owners/getThreshold.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { Tabs } from "nextra/components"
import { Tabs } from 'nextra/components'

# `getThreshold`

Expand All @@ -7,6 +7,7 @@ Returns the number of required confirmations for a Safe transaction aka the thre
## Usage

{/* <!-- vale off --> */}

<Tabs items={['example.sol']}>
<Tabs.Tab>
```solidity
Expand All @@ -20,6 +21,7 @@ Returns the number of required confirmations for a Safe transaction aka the thre
}
}
```

</Tabs.Tab>
</Tabs>

Expand All @@ -28,6 +30,7 @@ Returns the number of required confirmations for a Safe transaction aka the thre
## Returns

### `threshold`

- **Type:** `uint256`

Threshold number.
9 changes: 7 additions & 2 deletions pages/reference-smart-account/owners/isOwner.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { Tabs } from "nextra/components"
import { Tabs } from 'nextra/components'

# `isOwner`

Expand All @@ -21,19 +21,24 @@ Returns if `owner` is an owner of the Safe.
}
}
```

</Tabs.Tab>
</Tabs>

{/* <!-- vale on --> */}

## Returns

### `isOwner`

- **Type:** `bool`

Boolean flag indicating if `owner` is an owner of the Safe.

## Parameters

### `owner`

- **Type:** `address`

Owner address.
Owner address.
8 changes: 4 additions & 4 deletions pages/reference-smart-account/owners/removeOwner.mdx
Original file line number Diff line number Diff line change
@@ -1,14 +1,12 @@
import { Tabs, Callout } from "nextra/components"
import { Tabs, Callout } from 'nextra/components'

# `removeOwner`

## Overview

Removes the owner `owner` from the Safe and updates the threshold to `_threshold`.

<Callout type="warning">
This can only be done via a Safe transaction.
</Callout>
<Callout type='warning'>This can only be done via a Safe transaction.</Callout>

## Usage

Expand All @@ -31,6 +29,7 @@ This can only be done via a Safe transaction.
}
}
```

</Tabs.Tab>
</Tabs>

Expand All @@ -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
Expand Down
12 changes: 8 additions & 4 deletions pages/reference-smart-account/owners/swapOwner.mdx
Original file line number Diff line number Diff line change
@@ -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`.

<Callout type="warning">
This can only be done via a Safe transaction.
</Callout>
<Callout type='warning'>This can only be done via a Safe transaction.</Callout>

## Usage

Expand All @@ -25,13 +23,16 @@ This can only be done via a Safe transaction.
}
}
```

</Tabs.Tab>
</Tabs>

{/* <!-- vale on --> */}

## Parameters

### `prevOwner`

- **Type:** `address`

Owner that pointed to the owner to be replaced in the linked list
Expand All @@ -45,6 +46,7 @@ swapOwner(
```

### `oldOwner`

- **Type:** `address`

Owner address to be replaced.
Expand All @@ -58,6 +60,7 @@ swapOwner(
```

### `newOwner`

- **Type:** `address`

New owner address.
Expand All @@ -73,4 +76,5 @@ swapOwner(
## Events

### [`AddedOwner`](./addOwnerWithThreshold.mdx#addedowner)

### [`RemovedOwner`](./removeOwner.mdx#removedowner)

0 comments on commit 28163f2

Please sign in to comment.