Skip to content

Commit

Permalink
language for return value precision
Browse files Browse the repository at this point in the history
  • Loading branch information
forrestnorwood committed Jul 11, 2023
1 parent 5237a5f commit c24c28b
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 9 deletions.
6 changes: 3 additions & 3 deletions pages/protocol/rubicon-market/contract-overview.en.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,7 @@ function getOfferCount(ERC20 sell_gem, ERC20 buy_gem)

Returns the number of offers in the order book for a specified pair.

### getFeeBPS()
### protocolFee()

```solidity copy
function protocolFee()
Expand All @@ -229,7 +229,7 @@ Returns the number of offers in the order book for a specified pair.
returns (uint256)
```

Returns the current protocol fee.
Returns the current protocol fee. Return value is an integer at this precision (1 / 100,000 or 0.001%).

### makerFee()

Expand All @@ -240,7 +240,7 @@ function makerFee()
returns (uint256)
```

Returns the current maker fee.
Returns the current maker fee. Return value is an integer at this precision (1 / 100,000 or 0.001%).

## Events

Expand Down
6 changes: 4 additions & 2 deletions pages/protocol/rubicon-market/contract-overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -259,14 +259,16 @@ function getOfferCount(ERC20 sell_gem, ERC20 buy_gem)

Returns the number of offers in the order book for a specified pair.

### protocolFee()

```solidity copy
function protocolFee()
public
view
returns (uint256)
```

Returns the current protocol fee.
Returns the current protocol fee. Return value is an integer at this precision (1 / 100,000 or 0.001%).

### makerFee()

Expand All @@ -277,7 +279,7 @@ function makerFee()
returns (uint256)
```

Returns the current maker fee.
Returns the current maker fee. Return value is an integer at this precision (1 / 100,000 or 0.001%).

## Key Events

Expand Down
4 changes: 2 additions & 2 deletions pages/protocol/rubicon-market/fees.en.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Use these view functions to query the fee values.
returns (uint256)
```

Returns the current protocol fee.
Returns the current protocol fee. Return value is an integer at this precision (1 / 100,000 or 0.001%).

```solidity copy
function makerFee()
Expand All @@ -44,7 +44,7 @@ function makerFee()
returns (uint256)
```

Returns the current maker fee.
Returns the current maker fee. Return value is an integer at this precision (1 / 100,000 or 0.001%).

### Calculating Fees for a Trade

Expand Down
4 changes: 2 additions & 2 deletions pages/protocol/rubicon-market/fees.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Use these view functions to query the fee values.
returns (uint256)
```

Returns the current protocol fee.
Returns the current protocol fee. Return value is an integer at this precision (1 / 100,000 or 0.001%).

```solidity copy
function makerFee()
Expand All @@ -44,7 +44,7 @@ function makerFee()
returns (uint256)
```

Returns the current maker fee.
Returns the current maker fee. Return value is an integer at this precision (1 / 100,000 or 0.001%).

### Calculating Fees for a Trade

Expand Down

0 comments on commit c24c28b

Please sign in to comment.