diff --git a/BSC/README.md b/BSC/README.md new file mode 100644 index 0000000000000000000000000000000000000000..524491ecdffeabe4565b1c9b417ef7b454495387 --- /dev/null +++ b/BSC/README.md @@ -0,0 +1,14 @@ +# Binance Smart Chain + +This document provides information about Offshift's ETH<>BSC [bridge](https://open.offshift.io/offshiftXFT/protocol-main/-/tree/master/BSC/bridge) and PancakeSwap [farm](https://open.offshift.io/offshiftXFT/protocol-main/-/tree/master/BSC/farm). This directory contains backend contracts and frontend UIs that support bridging XFT between Ethereum and Binance Smart Chain and staking PancakeSwap LP tokens: + +* Bridge - The bridge directory contains the following resources: + * Backend + * bridge.sol - The Offshift bridge contract. + * Frontend + * index.html - User interface for interacting with the Offshift bridge contract. +* Farm - The farm directory contains the following resources: + * Backend + * farm.sol - The Offshift PancakeSwap farm contract. + * Frontend + * index.html - User interface for interacting with the Offshift PancakeSwap farm contract. diff --git a/BSC/bridge/README.md b/BSC/bridge/README.md index 18d5869243c9b45a88992e04fe062dbbf53df74d..4ea9a353ea1e1494baa929c787aa275eeea6ee58 100644 --- a/BSC/bridge/README.md +++ b/BSC/bridge/README.md @@ -1 +1,3 @@ -# Offshift BSC-ETHEREUM bridge \ No newline at end of file +### Offshift ETH<>BSC Bridge + +Our [bridge guide](https://offshift.io/public/blog/2021-05-27-offshift-eth-bsc-bridge-goes-live-on-mainnet/) on the Offshift Blog provides instructions for setting up MetaMask to connect to Binance Smart Chain and instructions for interacting with the Offshift bridge UI. \ No newline at end of file diff --git a/BSC/farm/README.md b/BSC/farm/README.md index a4de190e425adf370551c407157f20ffe27f49a4..49bb3ba6c962dfd7631c8dc246fb9effb73f96a6 100644 --- a/BSC/farm/README.md +++ b/BSC/farm/README.md @@ -1,2 +1,5 @@ -# Offshift pancakeswap farm +### Offshift PancakeSwap Farm +Before using the staking resources in this repository, obtain PancakeSwap Liquidity Pool tokens (Cake-LP) by providing liquidity in the [PancakeSwap XFT-BNB market](https://exchange.pancakeswap.finance/#/add/0xbb4cdb9cbd36b01bd1cbaebf2de08d9173bc095c/0xe138c66982fd5c890c60b94fdba1747faf092c20). You will use the staking dashboard provided here to stake the Cake-LP. + +Our [staking guide](https://offshift.io/public/blog/2021-07-15-offshift-lists-xft-on-pancakeswap-launches-pancake-lp-rewards-bolsters-lp-rewards-on-sushiswap/) on the Offshift Blog provides additional details about obtaining Cake-LP and using the staking dashboard. \ No newline at end of file diff --git a/README.md b/README.md index 15e5b973711848bc48f22782a06f19d93465ec3d..56f6bf36165747e2879347924d6fc3946d92531d 100644 --- a/README.md +++ b/README.md @@ -9,24 +9,26 @@ Read The Offshift Yellowpaper [here](https://offshift.io/content/Yellowpaper.pdf Offshift provides a private derivatives platform that supports the following functions: * [Shifting](#Shifting) - Convert XFT to zkAssets, which are the confidential tokens that enable anonymous transactions. -* [Staking](#Staking) - Provide liquidity to the XFT/ETH pool on SushiSwap and earn rewards on your tokens. +* [Staking](#Staking) - Provide XFT liquidity on SushiSwap and/or PancakeSwap and earn rewards on your tokens. +* [Bridging](#Bridging) - Move XFT between Ethereum (ERC-20) and Binance Smart Chain (BEP-20). ## Benefits -Our shifting and staking functions can lead to the following benefits for your users: +Our shifting, staking and bridging functions can lead to the following benefits for users: * Anonymity - Anonymous transactions on multiple blockchains. * Zero Knowledge Assets - Private derivatives with prices pegged to any asset with a market and a price feed. -* Rewards - Rewards paid in XFT and SUSHI for providing liquidity to the pool. +* Rewards - Rewards paid in XFT and SUSHI on SushiSwap, and rewards paid in XFT on PancakeSwap, for providing liquidity to the pool. ## Implementation -We currently support staking on the Ethereum blockchain and shifting on both the Ethereum and Moonbase Alpha blockchains. +We currently support staking LP tokens on Ethereum and Binance Smart Chain, and shifting on both the Ethereum and Moonbeam Testnets. This repo includes the following resources: -* [Ethereum](./Ethereum)- Backend scripts and a frontend UI for shifting and staking on the Ethereum blockchain. -* [Moonbase](./Moonbase)- Backend scripts and a frontend UI for shifting on the Moonbase Alpha testnet. +* [Ethereum](./Ethereum)- Backend scripts and a frontend UI for shifting on Ethereum's Rinkeby Testnet, and backend scripts and a frontend UI for staking SushiSwap LP tokens on the Ethereum mainnet. +* [Moonbeam](./Moonbeam)- Backend scripts and a frontend UI for shifting on the Moonbase Alpha testnet. +* [BSC](./BSC) - Backend contracts and a frontend UI for staking PancakeSwap LP tokens on Binance Smart Chain. * [Confidential Tokens](./Confidential_Tokens) - Detailed analysis of our approach to confidential contracts. See the README file for the specific component you are implementing for installation and configuration details. @@ -37,7 +39,7 @@ For support, contact us on [Telegram](https://t.me/OffshiftXFT) or [Discord](htt ## Additional Resources -We provide our own front ends for obtaining test assets, shifting, and staking: +We provide our own front ends for obtaining test assets, shifting, staking and bridging: * [Ethereum xftT Faucet](https://offshift.io/xftT-faucet.html#) - Obtain test XFT that you can use to develop your Ethereum-based application. * [Ethereum Shifting UI](https://offshift.io/xftT-shift.html#) - Burn XFT to create zkAssets with the price pegged to one of several existing underlying assets. @@ -45,15 +47,19 @@ We provide our own front ends for obtaining test assets, shifting, and staking: * [Moonbeam xftT Faucet](https://offshift.io/moonbeam-faucet.html#) - Obtain test XFT that you can use to develop applications on Moonbeam, which supports interoperability between the Polkadot and Ethereum blockchains. * [Moonbeam Shifting UI](https://offshift.io/moonbeam-shift.html#) - Shift between XFT and zkAssets that can be transferred on Polkadot and Ethereum. * [Moonbeam Shifting CLI scripts](https://open.offshift.io/offshiftXFT/protocol-main/-/tree/master/Moonbeam/Shifting/frontend/scripts) - Use the Offshift dapp in the CLI without the need of a web browser. -* [Offshift Staking Dashboard](https://dashboard.offshift.io/stake-now) - Supply liquidity for XFT on Sushi to earn XFT and SUSHI tokens. +* [Offshift SushiSwap Staking Dashboard](https://dashboard.offshift.io/stake-now) - Supply liquidity for XFT on SushiSwap to earn XFT and SUSHI tokens. +* [Offshift ETH<>BSC Bridge Dashboard](https://offshift.io/bridge/) - Move XFT tokens between Ethereum and Binance Smart Chain. +* [Offshift PancakeSwap Staking Dashboard](https://offshift.io/stake/) - Supply liquidity for XFT on PancakeSwap to earn XFT tokens. -See our articles on the Offshift Blog for detailed, step-by-step descriptions of shifting and staking using our dashboards with MetaMask: +See our articles on the Offshift Blog for detailed, step-by-step descriptions of shifting, staking and bridging using our dashboards with MetaMask: -* [Shifting on Ethereum](https://offshift.io/public/blog/2020-09-30-offshift-testnet-guide-phase-two/) -* [Shifting on Moonbase Alpha](https://offshift.io/public/blog/2021-01-04-offshift-testnet-guide-moonbase-alpha/) -* [Staking using SushiSwap](https://offshift.io/public/blog/2021-03-19-offshift-sushiswap-dual-liquidity-mining-goes-live/) +* [Shifting on Ethereum Testnet](https://offshift.io/public/blog/2020-09-30-offshift-testnet-guide-phase-two/) +* [Shifting on Moonbeam Testnet](https://offshift.io/public/blog/2021-01-04-offshift-testnet-guide-moonbase-alpha/) +* [Staking LP tokens on SushiSwap](https://offshift.io/public/blog/2021-03-19-offshift-sushiswap-dual-liquidity-mining-goes-live/) +* [Staking LP tokens PancakeSwap](https://offshift.io/public/blog/2021-07-15-offshift-lists-xft-on-pancakeswap-launches-pancake-lp-rewards-bolsters-lp-rewards-on-sushiswap/) +* [Bridging between ETH and BSC](https://offshift.io/public/blog/2021-05-27-offshift-eth-bsc-bridge-goes-live-on-mainnet/) -The sections below provide an overview of how to use our [shifting](#shifting) and [staking](#staking) tools. By using the code in this repository, you can add the functionality described below to your own application. +The sections below provide an overview of how to use our [shifting](#shifting), [staking](#staking) and [bridging](#bridging) tools. By using the code in this repository, you can add the functionality described below to your own application. ## Shifting @@ -83,11 +89,13 @@ The steps below provide an overview of how to use our shifting resources with th ## Staking -Staking provides a way for people holding XFT and ETH to earn rewards for providing liquidity to the network. +Staking provides a way for users holding XFT to earn rewards for providing liquidity on either SushiSwap or PancakeSwap. -Before staking, you must have equal amounts in USD of XFT and ETH in your wallet. You cannot use test coins for staking. +#### Staking on SushiSwap -The steps below provide an overview of how to use our staking resources in your project. The README file in the [Ethereum](./Ethereum) directory provides more details about installing and running the scripts: +Before staking, you must have equal amounts (in USD) of XFT and ETH in your wallet. + +The steps below provide an overview of how to use our staking resources. The README file in the [Ethereum](./Ethereum) directory provides more details about installing and running the scripts: 1. Use the [SushiSwap Add Liquidity XFT-ETH page](https://app.sushi.com/add/0xabe580e7ee158da464b51ee1a83ac0289622e6be/ETH) to exchange XFT and ETH for SushiSwap Liquidity Pool (SLP) tokens. 2. Clone this repository and add the files to your project. @@ -95,4 +103,20 @@ The steps below provide an overview of how to use our staking resources in your 4. Start the server. 5. Open [`http://localhost:4200/`](http://localhost:4200/) in your web browser to launch the staking dashboard. 6. Follow the onscreen prompts or see the [staking] information at the root of this repository to connect to your MetaMask wallet and stake the SLP you obtained in step 1. -7. Rewards accrue every block and are paid in XFT and SLP. Claim your rewards in the Rewards tab in the staking dashboard. +7. Rewards accrue every block and are paid in XFT and SUSHI. Claim your rewards in the Rewards tab on the staking dashboard. + +#### Staking on PancakeSwap + +Before staking, you must have equal amounts (in USD) of (BEP-20) XFT and BNB in your wallet. + +To bridge ERC-20 XFT on Ethereum to BEP-20 XFT on Binance Smart Chain, see [Bridging](#Bridging). + +The steps below provide an overview of how to use our staking resources. The README file in the [BSC](./BSC) directory provides more details. + +1. Use the [PancakeSwap Add Liquidity XFT-BNB page](https://exchange.pancakeswap.finance/#/add/0xbb4cdb9cbd36b01bd1cbaebf2de08d9173bc095c/0xe138c66982fd5c890c60b94fdba1747faf092c20) to exchange XFT and BNB for PancakeSwap Liquidity tokens (Cake-LP). +2. Open the [PancakeSwap Staking Dashboard](https://offshift.io/stake/) to stake and unstake your Cake-LP. +3. Rewards accrue every block and are paid in XFT. Claim your rewards in the Rewards tab on the staking dashboard. + +## Bridging + +XFT can be moved between Ethereum (ERC-20) and Binance Smart Chain (BEP-20) using the [Offshift ETH<>BSC Bridge](https://offshift.io/bridge/). Step-by-step [bridging instructions](https://offshift.io/public/blog/2021-05-27-offshift-eth-bsc-bridge-goes-live-on-mainnet/) can be found on the Offshift Blog.