Skip to content

Commit

Permalink
I update docs to be more simple.
Browse files Browse the repository at this point in the history
  • Loading branch information
sweetmantech committed Apr 16, 2022
1 parent e273007 commit 820e286
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 8 deletions.
12 changes: 5 additions & 7 deletions pages/flow-of-funds.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,19 +16,17 @@ Splits may receive funds via two paths:

1. Simply send funds to the Split's address via `send`, `transfer`, or `call`.
These funds will be flushed to `SplitMain` the next time
`distributeETH(address, accounts, percentAllocations, distributorFee, distributorAddress)`
is called.
[`distributeETH`](/smartcontracts/overview#distributeethaddress) is called.
1. If the Split is itself a Recipient of another Split, it will receive funds
when
`distributeETH(address, accounts, percentAllocations, distributorFee, distributorAddress)`
is called on the upstream Split.
when [`distributeETH`](/smartcontracts/overview#distributeethaddress) is
called on the upstream Split.

### Distributing Funds

Once funds have arrived at `SplitMain`, funds may be distributed by any third
party willing to pay the gas to call
`distributeETH(address, accounts, percentAllocations, distributorFee, distributorAddress)`.
This function only needs to be called once in order for all Recipients to
[`distributeETH`](/smartcontracts/overview#distributeethaddress). This function
only needs to be called once in order for all Recipients to
[withdraw](/core-concepts#withdraw) their share of the
[balance](/core-concepts#balance). The party who calls this function will
receive the [Distributor Fee](/core-concepts#distributor-fee) as compensation
Expand Down
2 changes: 1 addition & 1 deletion pages/smartcontracts/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ can read their audit report

Create a new [`SplitProxy`](#splitproxy)

### `distributeETH(address, accounts, percentAllocations, distributorFee, distributorAddress)`
### `distributeETH`

Split ETH for Split `address` which allows Recipients to withdraw

Expand Down

0 comments on commit 820e286

Please sign in to comment.