reverting

cryptol0g1c · Oct 2, 2018 · 1a2fc2a · 1a2fc2a
1 parent 5077776
commit 1a2fc2a
Showing 1 changed file with 39 additions and 39 deletions.
diff --git a/docs/api.md b/docs/api.md
@@ -1,9 +1,9 @@
-# Status Endpoints
-## [Get Bitsign Status [GET /status]](https://bitsign.docs.apiary.io/#reference/0/get-bitsign-status/get-bitsign-status)
+## Status Endpoints
+### [Get Bitsign Status [GET /status]](https://bitsign.docs.apiary.io/#reference/0/get-bitsign-status/get-bitsign-status)
 This endpoint returns Bitsign blockchain status, latestblock, bootnodes, etc.
 
-# User Endpoints
-## [User Info [GET /api/v2/user?email={email}&password={password}]](https://bitsign.docs.apiary.io/#reference/0/user-endpoints/user-info)
+## User Endpoints
+### [User Info [GET /api/v2/user?email={email}&password={password}]](https://bitsign.docs.apiary.io/#reference/0/user-endpoints/user-info)
 This endpoint retrieves token and Ethereum keys needed to interact with the rest of the endpoints.
 **Email** and **password** parameters must be provided.
 
@@ -12,7 +12,7 @@ This endpoint retrieves token and Ethereum keys needed to interact with the rest
     + email: alice@crypto.com (string) - Unique email address.
     + password: some_crafty_password (string) - User password.
 
-## [New User [POST /api/v2/user]](https://bitsign.docs.apiary.io/#reference/0/user-endpoints/new-user)
+### [New User [POST /api/v2/user]](https://bitsign.docs.apiary.io/#reference/0/user-endpoints/new-user)
 Create new user trough our API to get token access and pre-configured Ethereum keys.
 With the token you can query all other endpoints and interact with all blockchains and the Smart Contracts.
 
@@ -29,7 +29,7 @@ With the token you can query all other endpoints and interact with all blockchai
             "username": ""
         }
 
-## [Change Password [PUT /api/v2/user]](https://bitsign.docs.apiary.io/#reference/0/user-endpoints/change-password)
+### [Change Password [PUT /api/v2/user]](https://bitsign.docs.apiary.io/#reference/0/user-endpoints/change-password)
 This endpoint allows the user to changes their password. You must send the old password and the new one that must respect our security policies.
 
 + Request (application/json)
@@ -40,8 +40,8 @@ This endpoint allows the user to changes their password. You must send the old p
             "newPassword": "new_crafty_password"
         }
 
-# Transaction Endpoints
-## [Notarization TX [POST /eth/notarizetx]](https://bitsign.docs.apiary.io/#reference/0/transaction-endpoints/notarization-tx)
+## Transaction Endpoints
+### [Notarization TX [POST /eth/notarizetx]](https://bitsign.docs.apiary.io/#reference/0/transaction-endpoints/notarization-tx)
 This endpoints uses data field input to create a **notary transaction** and include it in a new block.
 Transactions from this endpoints will be executed **from Bitsign's main node** to facilitate its creation.
 If you want to create your own transaction and send it from your account please use **sendRawTX endpoint instead**.
@@ -55,16 +55,16 @@ If you want to create your own transaction and send it from your account please
             "password": "<your_password>"
         }
 
-## [Get transactions by user [GET /api/v2/transactions?token={token}&hash={hash}]](https://bitsign.docs.apiary.io/#reference/0/transaction-endpoints/get-transactions-by-user)
+### [Get transactions by user [GET /api/v2/transactions?token={token}&hash={hash}]](https://bitsign.docs.apiary.io/#reference/0/transaction-endpoints/get-transactions-by-user)
 This endpoint returns the transactions executed by the user. JWT token is a required parameter, but the tx hash is an optional parameter.
 
 + Parameters
 
     + token: <user_token> - User token.
     + hash: <hash> (optional) - Transaction hash.
 
-# Raw Transactions Endpoints
-## [SendRawTransaction [POST /eth/signedRawTx]](https://bitsign.docs.apiary.io/#reference/0/raw-transactions-endpoints/sendrawtransaction)
+## Raw Transactions Endpoints
+### [SendRawTransaction [POST /eth/signedRawTx]](https://bitsign.docs.apiary.io/#reference/0/raw-transactions-endpoints/sendrawtransaction)
 If you don't trust or don't want to use the **keypair provided by Bitsign**, you can always call this endpoint that will publish your **offline
 signed** raw [transaction](https://web3js.readthedocs.io/en/1.0/web3-eth.html#sendsignedtransaction). Bitsign node will only handle gas cost and transaction publication,
 but you have to **craft the entire transaction** on your end.
@@ -79,29 +79,29 @@ We will be releasing Bitsign tx library to facilitate this process soon.
             "tx": ""
         }
 
-# Smart Contract Endpoints
-## [Deploy new Smart Contract [PUT /eth/contract]](https://bitsign.docs.apiary.io/#reference/0/smart-contract-endpoints/deploy-new-smart-contract)
+## Smart Contract Endpoints
+### [Deploy new Smart Contract [PUT /eth/contract]](https://bitsign.docs.apiary.io/#reference/0/smart-contract-endpoints/deploy-new-smart-contract)
 This endpoint allows the user to deploy a new smart contract. The available smart contracts are:
 
-#### Notarize
+##### Notarize
 This smart contract allows the user to notarize documents.
-##### Constructor
+###### Constructor
 In order to initialize Notarize contract the user must send an address, that will be set as the owner of the contract. The owner will be the only one that is able to notarize.
-##### Methods
+###### Methods
 * notarize: This method receive as a parameter a bytes32 that will be the evidence to be notarized. The owner of the contract will be the only one that is capable of execute this method. If the sender is not the owner, the tx will be reverted. After the evidence is notarized the Notary event will be raised with two parameters: the evidence and the address.
 
-#### Escrow
+##### Escrow
 This smart contract allows the user to deposit funds in the smart contract and define a buyer and a seller. Each actor can release the funds to the other part based on pre established conditions. Also there is BSG arbiter which act as an impartial third party that can release the payment to one party in case the other part breaks the initial conditions.
-##### Constructor
+###### Constructor
 In order to initialize Escrow contract the user must send _seller (address), _buyer (address) and _endTime (uint). The sender of the transaction will be the arbiter of the contract. The arbiter act as an impartial third party. Also the value should be passed in order to set funds on the contract.
-##### Methods
+###### Methods
 * pay: This method can be executed by the buyer or the arbiter. This method will transfer the balance of the contract to the seller address. After that, it will raise the Payout event with two parameters: balance and seller address.
 * refund: This method can be executed by the seller or the arbiter. This method will transfer the balance of the contract to the buyer address. After that, it will raise the Refund event with two parameters: balance and buyer address.
 * getBalance: This method will return the balance of the contract. It can be executed by any member of the contract.
 * kill: This method can be executed by the arbiter only. It will destruct the contract and send the balance of the contract to its address.
 
-####  NotarizeTX
-##### Constructor
+#####  NotarizeTX
+###### Constructor
 In order to initialize NotarizeTx contract the user must send the following values:
 - buyer (address)
 - seller (address)
@@ -111,7 +111,7 @@ In order to initialize NotarizeTx contract the user must send the following valu
 - hash (bytes32)
 - status (string)
 - shipping (string)
-##### Methods
+###### Methods
 * updateStatus: This method can be executed by the buyer or the BSG node. Also it checks that the id passed is the same as one that user sent when deployed. The parameters of this method are status (string), hash (bytes32) and id (bytes32). The main purpose of this method is to update the tx status. After the method notarize the new tx, it raise the NotaryEvt event with the parameters: hash (bytes32) and id (bytes32).
 * updateShipping: This method can be executed by the buyer or the BSG node. Also it checks that the id passed is the same as one that user sent when deployed. The parameters of this method are status (string), hash (bytes32) and id (bytes32). The main purpose of this method is to update the tx shipping. After the method notarize the new tx, it raise the NotaryEvt event with the parameters: hash (bytes32) and id (bytes32).
 
@@ -130,15 +130,15 @@ In order to initialize NotarizeTx contract the user must send the following valu
             "password": "<your_password>"
         }
 
-## [Contract Usage [GET /eth/contract/doc?token={token}&type={type}]](https://bitsign.docs.apiary.io/#reference/0/smart-contract-endpoints/contract-usage)
+### [Contract Usage [GET /eth/contract/doc?token={token}&type={type}]](https://bitsign.docs.apiary.io/#reference/0/smart-contract-endpoints/contract-usage)
 This endpoint returns smart contract's ABI and functions to use its functionality.
 
 + Parameters
 
     + token: <user_token> (string) - User token.
     + type: <contract_name> (string) - Smart Contract type.
 
-## [Call Contract Method [POST /eth/contract]](https://bitsign.docs.apiary.io/#reference/0/smart-contract-endpoints/call-contract-method)
+### [Call Contract Method [POST /eth/contract]](https://bitsign.docs.apiary.io/#reference/0/smart-contract-endpoints/call-contract-method)
 
 This endpoint allows the user to read the state from the blockchain using contract methods.
 This endpoint will not alter blockchain state and therefore wont cost gas.
@@ -153,7 +153,7 @@ This endpoint will not alter blockchain state and therefore wont cost gas.
             "args": {}
         }
 
-## [Execute Contract Method[PATCH /eth/contract]](https://bitsign.docs.apiary.io/#reference/0/smart-contract-endpoints/execute-contract-method)
+### [Execute Contract Method[PATCH /eth/contract]](https://bitsign.docs.apiary.io/#reference/0/smart-contract-endpoints/execute-contract-method)
 
 This endpoint allows the user to send a transaction to the node and therefore modify the blockchain state.
 Although this method will generally cost gas, there is no limitation about it when using BSG Chain and gas cost will be handled internally.
@@ -172,16 +172,16 @@ Although this method will generally cost gas, there is no limitation about it wh
             "password": "<your_password>"
         }
 
-## [Get deployed contracts by user [GET /api/v2/contracts?token={token}]](https://bitsign.docs.apiary.io/#reference/0/smart-contract-endpoints/get-deployed-contracts-by-user)
+### [Get deployed contracts by user [GET /api/v2/contracts?token={token}]](https://bitsign.docs.apiary.io/#reference/0/smart-contract-endpoints/get-deployed-contracts-by-user)
 This endpoint returns the contracts deployed by the user.
 
 + Parameters
 
     + token: <user_token> (string) - User token.
 
-# Crowdsale 
+## Crowdsale 
 
-## Deploy new ERC20 Token Crowdsale Smart Contract **[PUT /erc20]**
+### Deploy new ERC20 Token Crowdsale Smart Contract **[PUT /erc20]**
 
 This endpoint allows to create a new erc20 crowdsale. By this, user will deploy at same time:
 
@@ -191,7 +191,7 @@ This endpoint allows to create a new erc20 crowdsale. By this, user will deploy
     - Capped: Adds a cap to your crowdsale, invalidating any purchases that would exceed that cap.
     - Timed: Adds an openingTime and closingTime to user crowdsale.
 
-#### Required values
+##### Required values
 
 To perform a deploy user must send following values:
 
@@ -235,10 +235,10 @@ _Request example (application/json):&nbsp;_
 }
 ```
 
-## View contract methods
+### View contract methods
 This section explains how the user to read the state from the blockchain using erc20 contract methods. These will not alter blockchain state and therefore wont cost gas.
 
-#### Required values
+##### Required values
 
 There are 2 possible endpoints, one for call token contract, and the another for crowdsale contract. To perform a view method user must send following values:
 
@@ -250,7 +250,7 @@ There are 2 possible endpoints, one for call token contract, and the another for
 
 - _args (object):&nbsp;_ The arguments required by the function.
 
-### Generic Token Crowdsale Methods **[POST /erc20/genericTokenCrowdsale]**
+#### Generic Token Crowdsale Methods **[POST /erc20/genericTokenCrowdsale]**
 
 A list of possible methods to call is provided down.
 
@@ -277,7 +277,7 @@ _Request example (application/json):&nbsp;_
 }
 ``` 
 
-### Generic Token Methods **[POST /erc20/genericToken]**:
+#### Generic Token Methods **[POST /erc20/genericToken]**:
 
 There are several methods to call with this endpoint, listed down.
 
@@ -301,10 +301,10 @@ _Request example (application/json):&nbsp;_
 }
 ```
 
-## Write methods **[PATCH /erc20]**
+### Write methods **[PATCH /erc20]**
 Endpoint for execute a write method over an ERC20 crowdsale. These methods change the state of blockchain, so requires gas usage by sender address. Elsewere, transaction will fail. 
 
-#### Required values
+##### Required values
 
 To perform a write method user must provide following values:
 
@@ -314,7 +314,7 @@ To perform a write method user must provide following values:
 - _args (object):&nbsp;_      The arguments required by the function.
 - _value (uint):&nbsp;_        The value in ethers. Mostly used when the user want to buy tokens.
 
-### Available methods
+#### Available methods
 
 A list of possible methods to call is provided down.
 
@@ -341,16 +341,16 @@ _Request example (application/json):&nbsp;_
 }
 ``` 
 
-## retrieve deployed ERC20 **[GET /erc20]**
+### retrieve deployed ERC20 **[GET /erc20]**
 This endpoint allows user to retrieve a list of deployed contrats by user, as well as information about a specific contract instance
 
-#### Required value
+##### Required value
 
 To perform a write method user must provide following values:
 
 - **email (string):&nbsp;** The user email.
 
-#### Optional value
+##### Optional value
 
 If this value is sent, response will show information about a specific contract instance.