polkamarkets-js 1.0.1 → 3.1.0

package/CONTRIBUTING.md

@@ -0,0 +1,36 @@
+# Contributor's Guide
+
+Welcome; we appreciate you and would like to thank you for contributing to our project. This document aims to facilitate the process and share with you some structure that hopefully will remove any roadblock.
+
+### Guidelines:
+
+1. Each reported issue shall have a name and description.
+2. It should also have a detailed description of the requested feature.
+3. It should also contain a label with the bounty price
+4. It should include the expected solution.
+5. It should also contain who is requesting the feature.
+6. The issue shall be reviewed and approved by one of the collaborators in the projects before any contributor starts working on it.
+7. Once the issue is approved, it shall be assigned to the contributor.
+
+---
+
+### Discussion
+1.  The issue discussion shall include the basics principles of communication.
+2. It should be clear, and if a solution is proposed, it should include pros and cons.
+3. If a question is asked, it should tag at least one of the project collaborators who will provide some guidance around the issue and/or the solution
+
+---
+
+### Solution
+1. Each PR shall include the [**Ethereum Address**][1] for the bounty payment.
+2. The PR shall include a clear description of the proposed solution
+3. If there is any additional information or link, it shall be included in the description.
+4. The PR shall be cleaned up with [Prettier][2]
+5. (Optional) The contributor has the option to include the Twitter handle.
+
+---
+
+If you have any comment or ideas in terms of making this process better, please let us know or submit a PR.
+
+[1]: [https://prettier.io/]
+[2]: [https://coinmarketcap.com/currencies/polkamarkets/]

package/README.md

@@ -1,48 +1,44 @@
-![alt tag](https://uploads-ssl.webflow.com/6001b8a9fb88852f468bf865/600f55bddbe2354c1e36e200_Dark.svg)
+# ![alt tag](https://uploads-ssl.webflow.com/6001b8a9fb88852f468bf865/600f55bddbe2354c1e36e200_Dark.svg)
 
 ## Introductions
 
-`polkamarkets-js` is the Polkamarkets Javascript SDK to integrate Prediction Markets into any dapp.
+`polkamarkets-js` is the Polkamarkets' Javascript SDK to integrate Prediction Markets into any dapp.
 
 ## Installation
 
 Using [npm](https://www.npmjs.com/):
 
 ```bash
-npm install "polkamarkets-js" --save
+npm install "https://github.com/Polkamarkets/polkamarkets-js" --save
 ```
 
 Using [yarn](https://yarnpkg.com/):
 
 ```bash
-yarn add polkamarkets-js
+yarn add https://github.com/Polkamarkets/polkamarkets-js
 ```
 
 ## Usage
 
 ### Initializing App
 
-Polkamarkets uses [`bepro-js`](https://github.com/bepronetwork/bepro-js/tree/feature/prediction-markets) for the web3 EVM integration.
+`polkamarkets-js` library initialization is performed in [`Application.js`](https://github.com/Polkamarkets/polkamarkets-js/blob/main/src/Application.js).
 
 You'll need to provide a web3 RPC provider (e.g., Infura for Ethereum dapps)
 
 ```javascript
-import Polkamarkets from 'polkamarkets-js';
+import * as polkamarketsjs from 'polkamarkets-js';
 
 // Moonriver RPC
 const web3Provider = 'https://rpc.moonriver.moonbeam.network';
 
+const polkamarkets = new polkamarketsjs.Application({ web3Provider });
+
 // Starting application
-const polkamarkets = new Polkamarkets(web3Provider);
+polkamarkets.start();
 
 // Connecting wallet
 await polkamarkets.login();
-
-// Fetching connected address
-const balance = await polkamarkets.getAddress();
-
-// Fetching address balance
-const balance = await polkamarkets.getBalance();
 ```
 
 ### Prediction Markets
@@ -51,37 +47,40 @@ Once the library is initialized, it's ready to interact with prediction markets
 
 ```javascript
 const contractAddress = '0xDcBe79f74c98368141798eA0b7b979B9bA54b026';
-polkamarkets.getPredictionMarketContract(contractAddress);
+const contract = polkamarkets.getPredictionMarketContract({ contractAddress });
 ```
 
 Once initialized, you'll be able to interact with the smart contract.
 
-- Prediction Market Smart Contract: [PredictionMarket.sol](https://github.com/bepronetwork/bepro-js/blob/feature/prediction-markets/contracts/PredictionMarket.sol)
-- Prediction Market JS Integration: [PredictionMarketContract.js](https://github.com/bepronetwork/bepro-js/blob/feature/prediction-markets/src/models/PredictionMarketContract.js)
+- Prediction Market Smart Contract: [PredictionMarket.sol](https://github.com/Polkamarkets/polkamarkets-js/blob/main/contracts/PredictionMarket.sol)
+- Prediction Market JS Integration: [PredictionMarketContract.js](https://github.com/Polkamarkets/polkamarkets-js/blob/main/src/models/PredictionMarketContract.js)
 
 Here's a few call examples
 
 ```javascript
 const marketId = 1;
-const outcomeId = 0;
+const outcomeId = 2;
 const ethAmount = 0.1;
 
+// Fetching all Market Ids
+await contract.getMarkets();
+
 // Fetching Market Details
-await polkamarkets.getMarketData(marketId);
+await contract.getMarketData({ marketId });
 
 // Buying Outcome Shares
-const mintOutcomeSharesToBuy = await polkamarkets.calcBuyAmount(marketId, outcomeId, ethAmount)
-await polkamarkets.buy(marketId, outcomeId, ethAmount, minOutcomeSharesToBuy);
+const mintOutcomeSharesToBuy = await contract.calcBuyAmount({ marketId, outcomeId, ethAmount })
+await contract.buy({ marketId, outcomeId, ethAmount, minOutcomeSharesToBuy });
 
 // Selling Outcome Shares
-const maxOutcomeSharesToSell = await polkamarkets.calcSellAmount(marketId, outcomeId, ethAmount)
-await polkamarkets.buy(marketId, outcomeId, ethAmount, maxOutcomeSharesToSell);
+const maxOutcomeSharesToSell = await contract.calcSellAmount({ marketId, outcomeId, ethAmount })
+await contract.buy({ marketId, outcomeId, ethAmount, maxOutcomeSharesToSell });
 
 // Claiming Winnings
-await polkamarkets.claimWinnings(marketId);
+await contract.claimWinnings({ marketId });
 
 // Fetching portfolio data
-await polkamarkets.getPortfolio();
+await contract.getMyPortfolio();
 ```
 
 ## Contribution
@@ -96,4 +95,4 @@ Contributions are welcomed but we ask to red existing code guidelines, specially
 
 The usage of ETH in all methods or params means using the native currency of that blockchain, example BSC in Binance Chain would still be nominated as ETH
 
-[1]: https://github.com/bepronetwork/bepro-js/blob/master/CONTRIBUTING.md
+[1]: https://github.com/Polkamarkets/polkamarkets-js/blob/main/CONTRIBUTING.md