polkamarkets-js 3.1.1 → 3.1.2

package/lib/reality-eth-monorepo/packages/docs/dapp.rst

@@ -0,0 +1,126 @@
+Using the Reality.eth dapp
+============================
+
+Requirements
+------------
+
+You will need the Metamask_ extension for Chrome or Firefox or a a browser with equivalent functionality like Brave_.
+
+To post or answer questions you will need ETH or the equivalent on the network you are on.
+
+If you prefer to try the app without using real money, you can switch Metamask to the Rinkeby or Kovan Testnet. You can get testnet coins at the `Rinkeby Faucet`_ and the `Kovan Faucet`_.
+
+.. _Metamask: http://metamask.io/
+.. _Brave: https://brave.com/
+.. _`Rinkeby Faucet`: https://faucet.rinkeby.io/
+.. _`Kovan Faucet`: https://faucet.kovan.network/
+
+
+Asking a question
+-----------------
+
+Click the "post a question" button and fill in the form you see. Enter a clear, unambiguous question in English. 
+
+Opening Date
+~~~~~~~~~~~~
+
+If you don't want people to be able to answer the question immediately, enter the date you want it to open.
+
+Reward
+~~~~~~~~~~
+Enter the amount you are prepared to pay as an incentive to answer your question. You pay when you post the question, and the money is collected by the person who gave the final accepted answer.
+
+If you intend to supply the answer yourself, and are hoping it will survive challenges so that you can use the question as evidence to send to a smart contract, you do not need to set a bounty, and can instead post a bond when you supply your answer. That way you will get the money back if your answer is accepted.
+
+Question Type
+~~~~~~~~~~~~~
+* Binary (Yes/No): A simple yes or no answer.
+* Number: A positive (unsigned) number. By default questions allow up to 13 decimals. 
+* Single-choice: One answer can be selected from a list. The answer form will display this as a select box.
+* Multiple-choice: Multiple answers can be selected from a list. The answer form will display this as a group of checkboxes.
+* Datetime: A date or date and time. The answer form will display this as a date picker.
+
+See :doc:`contracts` for how these values will be reported to contracts.
+
+
+Arbitrator
+~~~~~~~~~~
+This is the address of a person, organization or DAO that will settle disputes in exchange for a fee. See :doc:`arbitrators` for more details on how they work, and how you can create your own arbitrator.
+
+Timeout
+~~~~~~~
+How long people will have to correct incorrect reponses after they are posted. We normally suggest 24 hours. You may prefer a longer setting if you think your question will need time to come to the attention of people qualified to answer it, or a shorter setting if you think many people will be paying attention within a short timespan. 
+
+Category
+~~~~~~~~
+This is intended to help people find questions of the subject they are interested in.
+
+.. note:: Posting a question will open a MetaMask window which will prompt you to confirm it. 
+          You will have to pay a fee to the network, called "gas". 
+          If you are not in a hurry, you can usually set a much lower gas price than the default suggested by MetaMask.
+
+Answering a question
+--------------------
+
+Click on the question to open the display and entry window.
+
+Your answer
+~~~~~~~~~~~
+
+Enter the answer. 
+
+Your bond
+~~~~~~~~~
+
+This is money that you will get back if your answer is accepted as the final answer, and lose if your answer is not accepted. 
+
+Posting a bond stakes a claim to the answer you are giving: Even if someone else later reposts the same answer, you will get your bond back, and also be paid, as a minimum, an amount equal to the bond you have posted.
+
+.. note:: When you send a transaction to the Ethereum network, it can takes seconds, minutes or even hours to confirm.
+
+          You can go ahead and supply your own answer to a question before it has confirmed. However, other users will not see either the question or your answer until they are confirmed.
+
+
+Correcting an incorrect answer
+------------------------------
+
+If you see a question with an incorrect answer, you can correct it simply by adding a new answer. 
+
+Correcting an answer will entitle you to the bond of the previous user. However, you must submit your own bond, and it must be at least twice as high as the bond submitted by the previous answerer. If you are resubmitting an answer that someone has already given, part of that payment will be deducted and paid to them. See :doc:`fees` for details.
+
+.. note:: Until your answer has been sent to the network and confirmed in a block, it is possible for someone else to submit a competing answer.
+          This will cause your transaction to fail. 
+
+          If the competing answer is also wrong, you may wish to resubmit your answer with an even higher bond.
+          
+Questions include an option for "invalid", for if the question cannot be answered. 
+
+As of version 3, questions may also include an option for "answered too soon". You should select this answer if it was too soon to answer the question at the time the first answer was given, for instance because the question was about an event that had not happened yet.
+
+Requesting arbitration
+----------------------
+
+If you see a question with an incorrect answer and a high bond, you can request arbitration. 
+
+To request arbitration you must pay the arbitrator a fee. The fee may be quite high, and it will not be returned to you even if you are right. However, you will receive the bond posted with the incorrect answer. To make it profitable to request arbitration, you can increase your bond to the point where the person posting the incorrect answer will either give up, making your answer the winner, or post a bond that exceeds the amount you will have to pay the arbitrator.
+
+Once the arbitration fee has been paid the question will be locked, and the participants have to wait for the arbitrator to send their final answer to the contract.
+
+
+See :doc:`arbitrators` for more details on how the arbitration process works.
+
+
+Reopening questions
+-------------------
+
+A question that resolved as "answered too soon" can be reopened. This creates a new version of the question, and the question reward is transferred to the new question.
+
+
+Withdrawing funds
+-----------------
+
+Once a question has been finalized, anyone who submitted the correct answer will be able to withdraw funds.
+
+Once funds are available, a "Claim" button will show up on the "your" tab that appears when you click the user icon in the top-right corner. Clicking the "Claim" button will send the funds to your account.
+
+

package/lib/reality-eth-monorepo/packages/docs/dapp_links.rst

@@ -0,0 +1,67 @@
+Linking to the Reality.eth dapp
+===============================
+
+Parameters can be set for the reality.eth dapp by adding ``#!`` to the top page, followed by parameters and their values, delimited by ``/``.
+https://reality.eth.link/app/index.html#!/question/0xa09ce5e7943f281a782a0dc021c4029f9088bec4-0x4c6b2691b7f698690168f1fa09c74886cb347d14207ef9a0340a7e53aced9961
+
+Multiple parameters may be added in any order.
+
+Choosing the chain
+------------------
+
+By default the dapp will show you the chain to which the user is already connected using MetaMask etc.
+
+To specify the chain, append ``network``, followed by the chain ID.
+
+For example, for the Rinkeby chain use:
+https://reality.eth.link/app/index.html#!/network/4
+
+If the user does not have this network selected, it will prompt them to switch to it. If the user does not have the chain in question configured in their browser, it will attempt to configure it using data from https://chainlist.org/. This is currently supported by MetaMask but not by Brave.
+
+Choosing the token
+------------------
+
+Append ``token`` and the code for the token. 
+
+For example, to use the ``POLK`` token, use
+https://reality.eth.link/app/index.html#!/token/POLK
+
+If you do not specify a token, the dapp will default to the native token, assuming one is supported.
+
+Specifying the contract
+-----------------------
+
+On some networks, multiple versions of Reality.eth are supported, each with their own contract. 
+
+To specify that only a particular contract version should be used, for both displaying questions and asking new questions, append ``contract`` and the address of the contract.
+
+For example, on Rinkeby the reality.eth 2.0 contract is deployed at ``0x3D00D77ee771405628a4bA4913175EcC095538da``, so you would link to:
+https://reality.eth.link/app/index.html#!/contract/0x3D00D77ee771405628a4bA4913175EcC095538da
+
+Specifying the question
+-----------------------
+
+To link to a specific question, add the ID. Since multiple contracts may be supported on the same network, you should include the contract address. 
+
+For example, for a question on contract ``0x3d00d77ee771405628a4ba4913175ecc095538da`` you would use:
+https://reality.eth.link/app/index.html#!/question/0x3d00d77ee771405628a4ba4913175ecc095538da-0xf9d2c6cd9a1b21d8ec4829dbb1e7b49e951e8171465335907274434b2b762774
+
+This will display your question using the contract to which it was posted, even if you do not otherwise specify the contract that should be displayed by the UI.
+
+Specifying the question creator
+-------------------------------
+
+You can filter to the creator of a question by supplying the ``creator`` parameter and its address. This is often useful when your questions are created by a contract.
+
+Specifying the question creator
+-------------------------------
+
+You can filter to a particular arbitrator by supplying the ``arbitrator`` parameter and its address.
+
+Specifying the question template
+--------------------------------
+
+You can filter to a particular question template by supplying the ``template`` parameter and the numerical ID of the template. You should also specify the ``contract`` parameter above, as a different contract may use the same numerical ID for a different template.
+
+.. note:: Prior to August, 2021, question IDs did not include the contract address. These are still supported, but if the `contract` parameter is not supplied, the dapp may not be able to tell which contract the question lives on.
+

package/lib/reality-eth-monorepo/packages/docs/fees.rst

@@ -0,0 +1,89 @@
+Fees and payments
+=================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+
+All fees are set by participants.
+
+=============== ================= =================== ============ ========================================
+Fee             Set by            Paid by             Deductions   Paid to
+=============== ================= =================== ============ ========================================
+Question fee    Arbitrator        Asker                            Arbitrator                      
+Question reward Asker             Asker                            Highest-bonded correct answerer [1]
+Answer bond     Answerer          Answerer            Takeover fee Answerer, or Next correct answerer 
+Takeover fee    [= previous bond] Subsequent answerer              Previous answerer
+Arbitration fee Arbitration       Anyone                           Arbitrator 
+Claim fee       [2.5%]            Claimer                          [Burned]
+=============== ================= =================== ============ ========================================
+
+[1] Except when settled by arbitration. See below for details.
+
+Question fee
+------------
+
+A fee set (optionally) by the arbitrator for asking a question. 
+
+This fee is intended to be used as an anti-spam measure if the network fees are insufficient.
+
+Set by the arbitrator.
+
+Paid by the question asker.
+
+Paid to the arbitrator.
+
+Question reward
+---------------
+
+A reward for answering the question.
+
+Set by the question asker.
+
+Paid by the question asker.
+
+Paid to whoever last gives the final answer. If the answer is decided by the arbitrator, the arbitrator specifies who should get paid. If they decide the final answer given was incorrect, they should direct that it be paid to whoever paid for arbitration.
+
+Answer bond
+-----------
+
+A bond paid by someone who gives an answer to back their claim that the answer is correct.
+
+Set by the question answerer. However, if there is an earlier answer, it must be least twice the level of the bond given with that answer.
+
+Paid by the question answerer.
+
+If the answer is correct (ie matches the final answer) this is returned. The same amount may be received as an Answer Takeover Fee (see below).
+
+If the answer is incorrect, this is paid to the next answerer to supply the correct answer.
+
+Answer takeover fee
+-------------------
+
+A fee for taking over a correct answer given by someone else.
+
+Set to equal the bond supplied by the last person to give that answer.
+
+Paid to the last person to give that answer.
+
+Paid by deducting it from payments that would otherwise by awarded for giving the correct answer.
+
+Arbitration fee
+---------------
+
+A fee paid to the arbitrator when requesting that they intervene and provide arbitration for a question.
+
+Set by the arbitrator.
+
+Paid to the arbitrator.
+
+Paid by the user requesting arbitration. Usually this will be an answerer whoses answer has been replaced by another answerer supplying a higher bond. They would normally not request arbitration until bonds have reached a level where the amount they stand to gain exceeds the arbitration fee.
+
+Claim fee
+---------------
+
+From version 2.1 onwards, when you claim a bond other than the final bond, 2.5% is burned (left in contract balance).
+
+
+

package/lib/reality-eth-monorepo/packages/docs/index.rst

@@ -0,0 +1,26 @@
+.. Reality.eth documentation master file, created by
+   sphinx-quickstart on Thu Sep 28 14:43:50 2017.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Reality.eth
+=========================================
+
+Reality.eth is a crowd-sourced on-chain smart contract oracle system by Reality Keys.
+
+Reality.eth can be used either from our web application or by calling our contracts directly.
+
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   dapp
+   contracts
+   javascript
+   arbitrators
+   fees
+   whitepaper 
+   contract_explanation
+   dapp_links
+   audit

package/lib/reality-eth-monorepo/packages/docs/javascript.rst

@@ -0,0 +1,142 @@
+Using Reality.eth from JavaScript
+=====================================
+
+Contract deployments
+--------------------
+
+You can find the reality.eth contract addresses under https://github.com/RealityETH/reality-eth-monorepo/tree/main/packages/contracts/chains/deployments .
+
+For instance, the reality.eth v3 contract for mainnet (chain ID `1`) is shown in the file
+
+https://github.com/RealityETH/reality-eth-monorepo/blob/main/packages/contracts/chains/deployments/1/ETH/RealityETH-3.0.json
+
+These are also stored in the `@reality.eth/contracts` library. You can install them with 
+
+.. code-block:: javascript
+
+   npm install --save @reality.eth/contracts
+
+You can load this library with 
+
+.. code-block:: javascript
+
+   const reality_eth_contracts = require('@reality.eth/contracts');
+
+
+
+
+Loading the contracts for your network / token
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+You can check if a given `chain_id` is supported by calling
+
+.. code-block:: javascript
+
+   reality_eth_contracts.isChainSupported(chain_id);
+
+We normally deploy a reality.eth contract for the native token on the chain (the token you pay gas with), and some chains may have additional contracts supporting different ERC20 tokens. You can get the name of the native token by calling `reality_eth_contracts.defaultTokenForChain(chain_id)`. On the Ethereum mainnet this will be `ETH`.
+
+.. code-block:: javascript
+
+   const token_ticker = reality_eth_contracts.defaultTokenForChain(chain_id);
+
+The token may have multiple reality.eth contracts for different versions. You can read these with 
+
+.. code-block:: javascript
+
+   const my_configs = reality_eth_contracts.realityETHConfigs(chain_id, token_ticker);
+
+If you know which version you want, you can pass this to get a single config, eg 
+
+.. code-block:: javascript
+
+   const my_config = reality_eth_contracts.realityETHConfig(chain_id, token_ticker, '3.0');
+
+To get an instance of the contract with the ABI populated, you can call 
+
+.. code-block:: javascript
+
+   const my_instance = reality_eth_contracts.realityETHInstance(my_config);
+
+You can then create an instance in `ethers.js`, using a provider, with something like 
+
+.. code-block:: javascript
+
+   const my_instance = new ethers.Contract(my_instance.address, my_instance.abi, provider);
+
+
+Using reality-eth-lib
+---------------------
+
+We provide a library to help with formatting questions and parsing the answers.
+
+Although it is possible to format questions and handle the answers without using this library, we recommend that you use it where possible to ensure that your code matches what users will see if they interact with your questions on the reality.eth dapp or in other UI code.
+
+You can install this library with
+
+.. code-block:: javascript
+
+   npm install --save @reality.eth/reality-eth-lib
+
+You can then import libraries for handling questions and templates.
+
+.. code-block:: javascript
+
+   const reality_eth_question = require('@reality.eth/reality-eth-lib').question;
+   const reality_eth_template = require('@reality.eth/reality-eth-lib').template;
+
+This library will help you handle the encoding and decoding of questions using templates. See :doc:`contracts` to understand how the template system works.
+
+
+Interpreting a question
+^^^^^^^^^^^^^^^^^^^^^^^
+
+A question stored on the blockchain consists of a template ID, with the body of the template in the logs for that template, and some encoded text. 
+
+The template ID and question text are passed in as the first arguments of the `askQuestion()` function which creates questions. 
+
+This data can be fetched from event logs: The question text is logged in the `question` field of the `LogNewQuestion` event, and the template ID in the `template_id` field. The text of the template can be found by looking up the `LogNewTemplate` event for the `template_id`, where it is found in the `question_text` field. 
+
+It can also be fetched by querying our subgraph, for example
+https://thegraph.com/hosted-service/subgraph/realityeth/realityeth
+
+.. code-block:: javascript
+
+    {
+      questions(first: 5) {        
+        data
+        template {
+          questionText
+        }
+      }
+    }
+
+
+Having populated the `tmpl` and `qtext` variables, the following will parse the text and populate a an object with the question `title`, `type` and any other fields it may have such as `category`.
+
+.. code-block:: javascript
+
+   const q = reality_eth_question.populatedJSONForTemplate(tmpl, qtext);
+
+
+Creating a question
+^^^^^^^^^^^^^^^^^^^
+
+Questions are created by calling the `askQuestion` method of the reality.eth contract. This requires a template ID and some parameters, stored in a string of text. The questions are formatted using an unusual delimiter character, "␟". See :doc:`contracts` for more details on formatting. The `encodeText` function will handle formatting text for inclusion into a template.
+
+The supported types are `bool`, `uint`, `single-select`, `multiple-select`, `datetime`.
+
+Our built-in templates expect a type, the question title, a list of outcomes (for select types only), a category and a language. If your template expects the same parameters in the same order, you can use the following methods to format the text:
+
+
+.. code-block:: javascript
+
+   const qtext = reality_eth_question.encodeText('bool', 'my title', null, 'my-category', 'en_US');
+
+   const qtext = reality_eth_question.encodeText('multiple-select', 'my title', ["option1", "option2"], 'my-category');
+   const qtext = reality_eth_question.encodeText('single-select', 'my title', ["option1", "option2"], 'my-category');
+
+If your template uses different parameters or parameters in a different order, you can pass them as an object with the keys appropriately ordered to `encodeCustomText`.
+
+
+

package/lib/reality-eth-monorepo/packages/docs/make.bat

@@ -0,0 +1,36 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=python -msphinx
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+set SPHINXPROJ=RealityCheck
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The Sphinx module was not found. Make sure you have Sphinx installed,
+	echo.then set the SPHINXBUILD environment variable to point to the full
+	echo.path of the 'sphinx-build' executable. Alternatively you may add the
+	echo.Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd

package/lib/reality-eth-monorepo/packages/docs/requirements.txt

@@ -0,0 +1,24 @@
+alabaster==0.7.12
+Babel==2.9.1
+certifi==2020.12.5
+chardet==4.0.0
+docutils==0.16
+idna==2.10
+imagesize==1.2.0
+Jinja2==3.0.1
+MarkupSafe==2.0.1
+packaging==20.9
+Pygments==2.9.0
+pyparsing==2.4.7
+pytz==2021.1
+requests==2.25.1
+snowballstemmer==2.1.0
+Sphinx==3.5.4
+sphinx-rtd-theme==0.5.2
+sphinxcontrib-applehelp==1.0.2
+sphinxcontrib-devhelp==1.0.2
+sphinxcontrib-htmlhelp==2.0.0
+sphinxcontrib-jsmath==1.0.1
+sphinxcontrib-qthelp==1.0.3
+sphinxcontrib-serializinghtml==1.1.5
+urllib3==1.26.4