Kleros

https://docs.kleros.io
Admin
Kleros is a decentralized dispute resolution protocol for use on smart contract platforms on...
Tokens:98,177
Snippets:1,120
Trust Score:7.5
Update:3 months ago
Show doc for...
Tokens:
Raw
### Example: Asking a Boolean Question

Source: https://docs.kleros.io/integrations/types-of-integrations/3.-kleros-oracle-integration.md

Example of how to call the askQuestion function to submit a boolean (Yes/No) question with a 0.1 ETH reward.

```solidity
// Ask with a 0.1 ETH reward\nbytes32 questionID = realityETH.askQuestion{value: 0.1 ether}(\n    0, // Boolean template\n    "Did the S&P 500 close above 5000 on April 16, 2025?␟finance␟en",\n    arbitratorAddress,\n    86400, // 24 hour timeout\n    0, // Answerable immediately\n    0 // Default nonce\n);
```

--------------------------------

### Query Documentation with GET Request

Source: https://docs.kleros.io/contribution-guidelines/license-and-code-of-conduct/license.md

Use this GET request to query the documentation dynamically. Include your question in the 'ask' parameter and an optional 'goal' parameter for tailored responses.

```http
GET https://docs.kleros.io/contribution-guidelines/license-and-code-of-conduct/license.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Querying Documentation with GET Request

Source: https://docs.kleros.io/integrations/types-of-integrations/1.-dispute-resolution-integration-plan/use-cases/1.-dispute-resolution-integration-plan/1.-dispute-resolution-integration-plan

Use this GET request to dynamically query the documentation. Include an 'ask' parameter for your specific question and an optional 'goal' parameter to tailor the response.

```http
GET https://docs.kleros.io/integrations/types-of-integrations/1.-dispute-resolution-integration-plan/use-cases/1.-dispute-resolution-integration-plan/1.-dispute-resolution-integration-plan.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Start Susie Bot Command

Source: https://docs.kleros.io/products/retired/moderate/susie/getting-started/start-susie.md

Use the /start command to initiate Susie's community moderation after she has been added as an admin.

```bash
/start: Begins Susie's community moderation
```

--------------------------------

### Query Documentation with GET Request

Source: https://docs.kleros.io/developer/classic.md

Use this GET request to query the documentation dynamically. Include your specific question in the 'ask' parameter and an optional broader goal in the 'goal' parameter for tailored responses.

```http
GET https://docs.kleros.io/developer/classic.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation with GET Request

Source: https://docs.kleros.io/contribution-guidelines/general-dev.-workflow/releases.md

To get information not explicitly on the current page, perform an HTTP GET request to the page URL with `ask` and optional `goal` query parameters.

```http
GET https://docs.kleros.io/contribution-guidelines/general-dev.-workflow/releases.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.kleros.io/products/escrow/new-in-progress-kleros-escrow-tutorial.md

Use this GET request to ask questions about the documentation. Include your specific question in the 'ask' parameter and an optional broader goal in the 'goal' parameter.

```http
GET https://docs.kleros.io/products/escrow/new-in-progress-kleros-escrow-tutorial.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.kleros.io/developer/guide-for-preparing-transactions.md

Use this GET request to ask questions about the documentation. Include your specific question in the 'ask' parameter and an optional broader goal in the 'goal' parameter.

```http
GET https://docs.kleros.io/developer/guide-for-preparing-transactions.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query GitBook Documentation

Source: https://docs.kleros.io/integrations/industry-use-cases.md

Use this HTTP GET request to ask questions about the documentation. Include the 'ask' parameter for your specific question and optionally the 'goal' parameter for broader context.

```http
GET https://docs.kleros.io/integrations/industry-use-cases.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.kleros.io/integrations/types-of-integrations/1.-dispute-resolution-integration-plan/integration-tools.md

Perform an HTTP GET request to query documentation dynamically. Use the `ask` parameter for specific questions and the optional `goal` parameter to tailor the answer.

```http
GET https://docs.kleros.io/integrations/types-of-integrations/1.-dispute-resolution-integration-plan/integration-tools.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.kleros.io/integrations/types-of-integrations/1.-dispute-resolution-integration-plan/use-cases/defi-insurance.md

Perform an HTTP GET request to query the documentation dynamically. Use the `ask` parameter for specific questions and the optional `goal` parameter for broader context.

```HTTP
GET https://docs.kleros.io/integrations/types-of-integrations/1.-dispute-resolution-integration-plan/use-cases/defi-insurance.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.kleros.io/developer/arbitration-by-example/rental.sol

Perform an HTTP GET request to query documentation dynamically. Use the `ask` parameter for specific questions and the optional `goal` parameter for broader objectives.

```HTTP
GET https://docs.kleros.io/developer/arbitration-by-example/rental.sol.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.kleros.io/developer/arbitration-development.md

Use this GET request to query the documentation when information is not directly available on the page. The `ask` parameter is for your specific question, and `goal` is optional for tailoring the answer.

```http
GET https://docs.kleros.io/developer/arbitration-development.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Humanity Recovery Process Example

Source: https://docs.kleros.io/products/proof-of-humanity/proof-of-humanity-2.0-integration-guide

Illustrates the state transitions of a humanity ID during wallet recovery. This sequence shows the owner address changing while the humanity status is maintained.

```solidity
// 1. Human loses access to wallet
humanity.owner == lostAddress
isHuman(lostAddress) == true

// 2. Human requests removal of lost address
humanity.owner == address(0)
isHuman(lostAddress) == false

// 3. Human registers with new wallet address
humanity.owner == newAddress
isHuman(newAddress) == true
```

--------------------------------

### Query Kleros Documentation Dynamically

Source: https://docs.kleros.io/developer/arbitration-development/arbitrable-proxy.md

Use this HTTP GET request to query the documentation. Include your specific question in the 'ask' parameter and an optional broader goal in the 'goal' parameter.

```http
GET https://docs.kleros.io/developer/arbitration-development/arbitrable-proxy.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Deployment Addresses Documentation

Source: https://docs.kleros.io/developer/deployment-addresses.md

Perform an HTTP GET request to query the documentation dynamically. Use the 'ask' parameter for your specific question and optionally the 'goal' parameter to specify your broader objective.

```bash
GET https://docs.kleros.io/developer/deployment-addresses.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation with Ask and Goal Parameters

Source: https://docs.kleros.io/contribution-guidelines/general-dev.-workflow.md

Use this HTTP GET request to query the documentation dynamically. The 'ask' parameter specifies the question, and the optional 'goal' parameter helps tailor the answer to a broader objective.

```HTTP
GET https://docs.kleros.io/contribution-guidelines/general-dev.-workflow.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Install Kleros GTCR SDK

Source: https://docs.kleros.io/developer/classic.md

Install the Kleros GTCR SDK using npm. This is the first step for integrating Kleros functionalities into your project.

```shell
npm add @kleros/gtcr-sdk
```

--------------------------------

### Install file-to-ipfs Package

Source: https://docs.kleros.io/developer/guide-for-preparing-transactions.md

Install the file-to-ipfs package using yarn or npm. This package is used for pinning policy JSON files to IPFS.

```shell
mkdir policy
cd policy
yarn init -y
npm i @kleros/file-to-ipfs
```

--------------------------------

### Querying Documentation with Parameters

Source: https://docs.kleros.io/contribution-guidelines/smart-contract-workflow.md

Use this HTTP GET request to query the documentation dynamically. Include your specific question in the 'ask' parameter and an optional broader goal in the 'goal' parameter.

```HTTP
GET https://docs.kleros.io/contribution-guidelines/smart-contract-workflow.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### ERC-1497 Evidence Example for 'Yes' Answer

Source: https://docs.kleros.io/integrations/types-of-integrations/3.-kleros-oracle-integration

Provide a specific JSON example for evidence supporting a 'Yes' answer in a dispute, detailing the S&P 500 closing price.

```JSON
{
  "fileURI": "/ipfs/QmScreenshotHash",
  "fileHash": "QmScreenshotHash",
  "name": "Evidence Supporting Yes",
  "description": "Proof that the S&P 500 closed above 5000 on April 16, 2025 - Official S&P website showing closing price of 5,127.43",
  "fileTypeExtension": "png"
}
```

--------------------------------

### ERC-1497 Evidence Example for 'No' Answer

Source: https://docs.kleros.io/integrations/types-of-integrations/3.-kleros-oracle-integration

Provide a specific JSON example for evidence supporting a 'No' answer in a dispute, detailing an alternative S&P 500 closing price.

```JSON
{
  "fileURI": "/ipfs/QmCounterScreenshotHash", 
  "fileHash": "QmCounterScreenshotHash",
  "name": "Evidence Supporting No",
  "description": "Proof that the S&P 500 did NOT close above 5000 on April 16, 2025 - Official S&P website showing closing price of 4,987.22",
  "fileTypeExtension": "png"
}
```

--------------------------------

### Get Transaction Count

Source: https://docs.kleros.io/developer/arbitration-by-example/multiplearbitrabletokentransaction.sol

Retrieves the total number of transactions recorded in the contract.

```APIDOC
## GET /getCountTransactions

### Description
Returns the total count of transactions managed by the contract.

### Method
GET

### Endpoint
`/getCountTransactions`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

### Response
#### Success Response (200)
- **countTransactions** (uint) - The total number of transactions.

#### Response Example
```json
{
  "countTransactions": 10
}
```
```

--------------------------------

### Query Documentation Index via HTTP GET

Source: https://docs.kleros.io/llms.txt

Use this method to ask specific questions about the documentation. Include your question in the 'ask' parameter and optionally specify a broader 'goal' to tailor the response. The response will contain direct answers and relevant excerpts.

```http
GET https://docs.kleros.io/kleros-faq.md?ask=<question>&goal=<end_goal>
```

--------------------------------

### Get Transaction Count

Source: https://docs.kleros.io/developer/arbitration-by-example/multiplearbitrabletransaction.sol.md

Returns the total number of arbitrable transactions currently managed by the contract.

```Solidity
/** @dev Getter to know the count of transactions. 
 *  @return countTransactions The count of transactions. 
 */
function getCountTransactions() public view returns (uint countTransactions) {
    return transactions.length;
}
```

--------------------------------

### Get transaction count in MultipleArbitrableTransaction.sol

Source: https://docs.kleros.io/developer/arbitration-by-example/multiplearbitrabletransaction.sol

Returns the total number of arbitrable transactions managed by the contract.

```Solidity
function getCountTransactions() public view returns (uint countTransactions) {
        return transactions.length;
    }
```

--------------------------------

### Get Transaction Count

Source: https://docs.kleros.io/developer/arbitration-by-example/multiplearbitrabletokentransaction.sol.md

A public view function to retrieve the total number of transactions recorded in the contract.

```Solidity
/** @dev Getter to know the count of transactions. 
     *  @return countTransactions The count of transactions. 
     */
    function getCountTransactions() public view returns (uint countTransactions) {
        return transactions.length;
    }
```

--------------------------------

### MyArbitrable Contract Example

Source: https://docs.kleros.io/developer/arbitration-development/arbitrable-proxy.md

This snippet demonstrates how to interact with the ArbitrableProxy from your own contract. It includes creating a dispute and fetching its ruling.

```Solidity
contract MyArbitrable {
    IArbitrableProxy arbitrableProxy = IArbitrableProxy(<ARBITRATOR_ADDRESS>);
    function foo( 
        bytes calldata extraData, 
        string memory evidenceURI, 
        uint256 rulingOptions
        ) {
        uint256 disputeID = arbitrableProxy.createDispute{value: msg.value}( 
            extraData, 
            evidenceURI, 
            rulingOptions
            );
            
        // do something with disputeID
    }
    
    function fetchRuling(uint256 disputeID) {
        (, bool isRuled, uint256 ruling) = arbitrableProxy.disputes(disputeID)
        
        // do something with ruling if isRuled
    }
}
```

--------------------------------

### Query Documentation with GET Request

Source: https://docs.kleros.io/products/proof-of-humanity/proof-of-humanity-tutorial.md

Use this method to ask questions about the documentation when the answer is not explicitly present. The 'ask' parameter specifies the question, and the optional 'goal' parameter defines the broader objective.

```bash
GET https://docs.kleros.io/products/proof-of-humanity/proof-of-humanity-tutorial.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Querying GitBook Documentation

Source: https://docs.kleros.io/developer/arbitration-by-example/arbitrabledeposit.sol

Use this HTTP GET request to ask questions about the documentation. The `ask` parameter specifies the question, and the optional `goal` parameter provides context for the desired outcome.

```http
GET https://docs.kleros.io/developer/arbitration-by-example/arbitrabledeposit.sol.md?ask=<question>&goal=<endgoal>
```
Tokens:
Raw