# MoCSettlement

View Source: [contracts/MoCSettlement.sol](https://github.com/money-on-chain/main-RBTC-contract/blob/master-gitbook/contracts/MoCSettlement.sol)

**↗ Extends:** [**MoCSettlementEvents**](https://github.com/money-on-chain/main-RBTC-contract/blob/master-gitbook/docs/abis/MoCSettlementEvents.md)**,** [**MoCBase**](https://github.com/money-on-chain/main-RBTC-contract/blob/master-gitbook/docs/abis/MoCBase.md)**,** [**PartialExecution**](https://github.com/money-on-chain/main-RBTC-contract/blob/master-gitbook/docs/abis/PartialExecution.md)**,** [**Governed**](/main-rbtc-contract/smart-contracts/abis-documentation/governed.md)**,** [**IMoCSettlement**](https://github.com/money-on-chain/main-RBTC-contract/blob/master-gitbook/docs/abis/IMoCSettlement.md) **↘ Derived Contracts:** [**MoCSettlementMock**](/main-rbtc-contract/smart-contracts/abis-documentation/mocsettlementmock.md)

**MoCSettlement** - version: 0.1.12

## Structs

### RedeemRequest

```js
struct RedeemRequest {
 address payable who,
 uint256 amount
}
```

### UserRedeemRequest

```js
struct UserRedeemRequest {
 uint256 index,
 bool activeRedeemer
}
```

### SettlementInfo

```js
struct SettlementInfo {
 uint256 btcPrice,
 uint256 btcxPrice,
 uint256 docRedeemCount,
 uint256 deleveragingCount,
 uint256 bproxAmount,
 uint256 partialCommissionAmount,
 uint256 finalCommissionAmount,
 uint256 leverage,
 uint256 startBlockNumber,
 bool isProtectedMode
}
```

## Contract Members

**Constants & Variables**

```js
bytes32 public constant DOC_REDEMPTION_TASK;
```

***

```js
bytes32 public constant DELEVERAGING_TASK;
```

***

```js
bytes32 public constant SETTLEMENT_TASK;
```

***

```js
contract IMoCState internal mocState;
```

***

```js
contract IMoCExchange internal mocExchange;
```

***

```js
contract DocToken internal docToken;
```

***

```js
contract MoCBProxManager internal bproxManager;
```

***

```js
uint256 internal lastProcessedBlock;
```

***

```js
uint256 internal blockSpan;
```

***

```js
struct MoCSettlement.SettlementInfo internal settlementInfo;
```

***

```js
struct MoCSettlement.RedeemRequest[] private redeemQueue;
```

***

```js
uint256 private redeemQueueLength;
```

***

```js
mapping(address => struct MoCSettlement.UserRedeemRequest) private redeemMapping;
```

***

```js
uint256[50] private upgradeGap;
```

***

## RedeemRequestAlter

**Parameters**

| Name       | Type    | Description |
| ---------- | ------- | ----------- |
| redeemer   | address |             |
| isAddition | bool    |             |
| delta      | uint256 |             |

## RedeemRequestProcessed

**Parameters**

| Name       | Type    | Description |
| ---------- | ------- | ----------- |
| redeemer   | address |             |
| commission | uint256 |             |
| amount     | uint256 |             |

## SettlementRedeemStableToken

**Parameters**

| Name             | Type    | Description |
| ---------------- | ------- | ----------- |
| queueSize        | uint256 |             |
| accumCommissions | uint256 |             |
| reservePrice     | uint256 |             |

## SettlementDeleveraging

**Parameters**

| Name             | Type    | Description |
| ---------------- | ------- | ----------- |
| leverage         | uint256 |             |
| riskProxPrice    | uint256 |             |
| reservePrice     | uint256 |             |
| startBlockNumber | uint256 |             |

## SettlementStarted

**Parameters**

| Name                   | Type    | Description |
| ---------------------- | ------- | ----------- |
| stableTokenRedeemCount | uint256 |             |
| deleveragingCount      | uint256 |             |
| riskProxPrice          | uint256 |             |
| reservePrice           | uint256 |             |

## SettlementCompleted

**Parameters**

| Name             | Type    | Description |
| ---------------- | ------- | ----------- |
| commissionsPayed | uint256 |             |

## Modifiers

* [withinBoundaries](#withinboundaries)
* [isTime](#istime)

### withinBoundaries

Verify that the index is smaller than the length of the redeem request queue

```js
modifier withinBoundaries(uint256 _index) internal
```

**Arguments**

| Name    | Type    | Description           |
| ------- | ------- | --------------------- |
| \_index | uint256 | queue position to get |

### isTime

```js
modifier isTime() internal
```

**Arguments**

## Functions

* [initialize(address connectorAddress, address \_governor, uint256 \_blockSpan)](#initialize)
* [setBlockSpan(uint256 bSpan)](#setblockspan)
* [setSettlementToStall()](#setsettlementtostall)
* [restartSettlementState()](#restartsettlementstate)
* [getRedeemRequestAt(uint256 \_index)](#getredeemrequestat)
* [getBlockSpan()](#getblockspan)
* [redeemQueueSize()](#redeemqueuesize)
* [isSettlementEnabled()](#issettlementenabled)
* [isSettlementRunning()](#issettlementrunning)
* [isSettlementReady()](#issettlementready)
* [nextSettlementBlock()](#nextsettlementblock)
* [docAmountToRedeem(address \_who)](#docamounttoredeem)
* [addRedeemRequest(uint256 amount, address payable redeemer)](#addredeemrequest)
* [clear()](#clear)
* [alterRedeemRequestAmount(bool isAddition, uint256 delta, address redeemer)](#alterredeemrequestamount)
* [runSettlement(uint256 steps)](#runsettlement)
* [fixTasksPointer()](#fixtaskspointer)
* [initializeContracts()](#initializecontracts)
* [initializeValues(address \_governor, uint256 \_blockSpan)](#initializevalues)
* [deleveragingStepCount()](#deleveragingstepcount)
* [docRedemptionStepCount()](#docredemptionstepcount)
* [initializeSettlement()](#initializesettlement)
* [finishSettlement()](#finishsettlement)
* [finishDeleveraging()](#finishdeleveraging)
* [finishDocRedemption()](#finishdocredemption)
* [deleveragingStep(uint256 )](#deleveragingstep)
* [docRedemptionStep(uint256 index)](#docredemptionstep)
* [initializeTasks()](#initializetasks)

### initialize

Initializes the contract

```js
function initialize(address connectorAddress, address _governor, uint256 _blockSpan) public nonpayable initializer 
```

**Arguments**

| Name             | Type    | Description                                     |
| ---------------- | ------- | ----------------------------------------------- |
| connectorAddress | address | MoCConnector contract address                   |
| \_governor       | address | Governor contract address                       |
| \_blockSpan      | uint256 | Blockspan configuration blockspan of settlement |

### setBlockSpan

⤿ Overridden Implementation(s): [MoCSettlementMock.setBlockSpan](/main-rbtc-contract/smart-contracts/abis-documentation/mocsettlementmock.md#setblockspan)

Set the blockspan configuration blockspan of settlement

```js
function setBlockSpan(uint256 bSpan) public nonpayable onlyAuthorizedChanger 
```

**Arguments**

| Name  | Type    | Description |
| ----- | ------- | ----------- |
| bSpan | uint256 |             |

### setSettlementToStall

Set Settlement to be kept in finnished state after all execution is completed.

```js
function setSettlementToStall() public nonpayable onlyAuthorizedChanger 
```

**Arguments**

### restartSettlementState

Set Settlement state to Ready

```js
function restartSettlementState() public nonpayable onlyAuthorizedChanger 
```

**Arguments**

### getRedeemRequestAt

⤾ overrides IMoCSettlement.getRedeemRequestAt

Gets the RedeemRequest at the queue index position

```js
function getRedeemRequestAt(uint256 _index) public view withinBoundaries 
returns(address payable, uint256)
```

**Returns**

redeemer's address and amount he submitted

**Arguments**

| Name    | Type    | Description           |
| ------- | ------- | --------------------- |
| \_index | uint256 | queue position to get |

### getBlockSpan

Gets the number of blocks the settlemnet will be allowed to run

```js
function getBlockSpan() public view
returns(uint256)
```

**Arguments**

### redeemQueueSize

⤾ overrides IMoCSettlement.redeemQueueSize

Returns the current redeem request queue's length

```js
function redeemQueueSize() public view
returns(uint256)
```

**Arguments**

### isSettlementEnabled

⤾ overrides IMoCSettlement.isSettlementEnabled

Returns true if blockSpan number of blocks has pass since last execution

```js
function isSettlementEnabled() public view
returns(bool)
```

**Arguments**

### isSettlementRunning

Returns true if the settlment is running

```js
function isSettlementRunning() public view
returns(bool)
```

**Arguments**

### isSettlementReady

⤾ overrides IMoCSettlement.isSettlementReady

Returns true if the settlment is ready

```js
function isSettlementReady() public view
returns(bool)
```

**Arguments**

### nextSettlementBlock

⤾ overrides IMoCSettlement.nextSettlementBlock

Returns the next block from which settlement is possible

```js
function nextSettlementBlock() public view
returns(uint256)
```

**Arguments**

### docAmountToRedeem

⤾ overrides IMoCSettlement.docAmountToRedeem

returns the total amount of Docs in the redeem queue for \_who

```js
function docAmountToRedeem(address _who) public view
returns(uint256)
```

**Returns**

total amount of Docs in the redeem queue for \_who \[using mocPrecision]

**Arguments**

| Name  | Type    | Description                     |
| ----- | ------- | ------------------------------- |
| \_who | address | address for which ^ is computed |

### addRedeemRequest

⤾ overrides IMoCSettlement.addRedeemRequest

push a new redeem request to the queue for the sender or updates the amount if the user has a redeem request

```js
function addRedeemRequest(uint256 amount, address payable redeemer) public nonpayable onlyWhitelisted 
```

**Arguments**

| Name     | Type            | Description                                          |
| -------- | --------------- | ---------------------------------------------------- |
| amount   | uint256         | amount he is willing to redeem \[using mocPrecision] |
| redeemer | address payable | redeemer address                                     |

### clear

empty the queue

```js
function clear() public nonpayable onlyWhitelisted 
```

**Arguments**

### alterRedeemRequestAmount

⤾ overrides IMoCSettlement.alterRedeemRequestAmount

Alters the redeem amount position for the redeemer

```js
function alterRedeemRequestAmount(bool isAddition, uint256 delta, address redeemer) public nonpayable onlyWhitelisted 
```

**Returns**

the filled amount \[using mocPrecision]

**Arguments**

| Name       | Type    | Description                                                           |
| ---------- | ------- | --------------------------------------------------------------------- |
| isAddition | bool    | true if adding amount to redeem, false to substract.                  |
| delta      | uint256 | the amount to add/substract to current position \[using mocPrecision] |
| redeemer   | address | address to alter amount for                                           |

### runSettlement

⤾ overrides IMoCSettlement.runSettlement

Runs settlement process in steps

```js
function runSettlement(uint256 steps) public nonpayable onlyWhitelisted isTime 
returns(uint256)
```

**Returns**

The commissions collected in the executed steps

**Arguments**

| Name  | Type    | Description            |
| ----- | ------- | ---------------------- |
| steps | uint256 | Amount of steps to run |

### fixTasksPointer

Create Task structures for Settlement execution

```js
function fixTasksPointer() public nonpayable
```

**Arguments**

### initializeContracts

```js
function initializeContracts() internal nonpayable
```

**Arguments**

### initializeValues

```js
function initializeValues(address _governor, uint256 _blockSpan) internal nonpayable
```

**Arguments**

| Name        | Type    | Description |
| ----------- | ------- | ----------- |
| \_governor  | address |             |
| \_blockSpan | uint256 |             |

### deleveragingStepCount

Returns the amount of steps for the Deleveraging task which is the amount of active BProx addresses

```js
function deleveragingStepCount() internal view
returns(uint256)
```

**Arguments**

### docRedemptionStepCount

Returns the amount of steps for the Doc Redemption task which is the amount of redeem requests in the queue

```js
function docRedemptionStepCount() internal view
returns(uint256)
```

**Arguments**

### initializeSettlement

Freezes state for Settlement execution

```js
function initializeSettlement() internal nonpayable
```

**Arguments**

### finishSettlement

Execute final step of Settlement task group

```js
function finishSettlement() internal nonpayable
```

**Arguments**

### finishDeleveraging

Execute final step of Deleveraging task

```js
function finishDeleveraging() internal nonpayable
```

**Arguments**

### finishDocRedemption

Execute final step of DocRedemption task

```js
function finishDocRedemption() internal nonpayable
```

**Arguments**

### deleveragingStep

Individual Deleveraging step to be executed in partial execution uint256 parameter needed for PartialExecution

```js
function deleveragingStep(uint256 ) internal nonpayable
```

**Arguments**

| Name | Type    | Description |
| ---- | ------- | ----------- |
|      | uint256 |             |

### docRedemptionStep

Individual DocRedemption step to be executed in partial execution

```js
function docRedemptionStep(uint256 index) internal nonpayable
```

**Arguments**

| Name  | Type    | Description                        |
| ----- | ------- | ---------------------------------- |
| index | uint256 | Step number currently in execution |

### initializeTasks

Create Task structures for Settlement execution

```js
function initializeTasks() internal nonpayable
```

**Arguments**


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.moneyonchain.com/main-rbtc-contract/smart-contracts/abis-documentation/mocsettlement.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.