Skip to content

Commit

Permalink
GitBook: [master] 24 pages and 6 assets modified
Browse files Browse the repository at this point in the history
  • Loading branch information
Nader authored and gitbook-bot committed Apr 9, 2021
1 parent 9715438 commit 63796b0
Show file tree
Hide file tree
Showing 30 changed files with 2,226 additions and 51 deletions.
Binary file removed .gitbook/assets/built-on-black.png
Binary file not shown.
Binary file removed .gitbook/assets/built-on-gray.png
Binary file not shown.
Binary file removed .gitbook/assets/built-on-purple.png
Binary file not shown.
Binary file added .gitbook/assets/data_api.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/making_defi_easy.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/zapper_api_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
31 changes: 16 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,33 @@
# Introduction

## [Zapper](https://www.zapper.fi/dashboard) is the ultimate hub for DeFi. Our mission is to make DeFi accessible and easy to use.
![](.gitbook/assets/making_defi_easy.png)

## **Features**

1. \*\*\*\*[**Dashboard**](invest/dashboard.md)\*\*\*\*
1. \*\*\*\*[**Zapper API**](zapper-api/api-getting-started.md) ****DeFi Data and Transactions builder
2. \*\*\*\*[**Smart Contracts**](zapper-smart-contracts/smart-contracts.md) ****View a list of all the Zapper smart contracts
3. **Learn Zapper**

Get a snapshot of all your DeFi assets & liabilities.
Find out how to use the Zapper user interface to its fullest

2. \*\*\*\*[**Exchange**](invest/exchange.md)\*\*\*\*
* [**Dashboard**](learn-zapper/dashboard.md)\*\*\*\*

Swap assets with our exchange aggregator
Get a snapshot of all your DeFi assets & liabilities.

3. [**Pool**](invest/pooling/)
* [**Exchange**](learn-zapper/exchange.md)\*\*\*\*

Invest in unique opportunities available across the always expanding list of available [DeFi platforms](https://zapper.fi/protocols)
Swap assets with our exchange aggregator

4. [**Farm**](invest/farming.md) ****Generate yield with your assets
5. [**Bridge**](invest/bridge.md)\*\*\*\*
* \*\*\*\*[**Pool** ](learn-zapper/pooling/)\*\*\*\*

Migrate funds from Ethereum to L2s and sidechains
Invest in unique opportunities available across the expanding list of available [DeFi platforms](https://zapper.fi/protocols)

6. \*\*\*\*[**Zapper API**](build/zapper-api.md) ****DeFi Data and Transactions builder
* [**Farm**](learn-zapper/farming.md) ****Generate yield with your assets
* [**Bridge**](learn-zapper/bridge.md)\*\*\*\*

\*\*\*\*
Migrate funds from Ethereum to L2s and sidechains


****

\*\*\*\*

If you have questions or would like to learn more to about Zapper feel free to join our [Discord](https://discord.com/invite/5C4wxPr)

59 changes: 30 additions & 29 deletions SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,39 +2,40 @@

* [Introduction](README.md)

## BUILD

* [Zapper API](build/zapper-api.md)
* [Smart Contracts](build/smart-contracts.md)
* [Guides](build/guides/README.md)
* [Get User Token Balances](build/guides/get-user-token-balances.md)
* [Get Supported Tokens and Prices](build/guides/get-supported-tokens-and-prices.md)
* [Get Gas Price](build/guides/get-gas-price.md)
* [Get Curve User Balances](build/guides/curve-user-balances.md)
* [Get Yearn User Balances](build/guides/yearn-user-balances.md)
* [Get Sushiswap Pool Stats](build/guides/sushiswap-pool-stats.md)
* [Get Yearn Vault Stats](build/guides/yearn-vault-stats.md)
* [Create a Zap In \(Yearn\)](build/guides/yearn-zap-in.md)
* [Create a Zap Out \(Sushiswap\)](build/guides/create-uniswapv2-zap-out.md)

## INVEST

* [Dashboard](invest/dashboard.md)
* [Exchange](invest/exchange.md)
* [Pool](invest/pooling/README.md)
* [Uniswap](invest/pooling/uniswap.md)
* [Balancer](invest/pooling/balancer.md)
* [Curve](invest/pooling/curve.md)
* [Yearn Vaults](invest/pooling/yearn-vaults.md)
* [Bridge](invest/bridge.md)
* [Farm](invest/farming.md)
## Zapper API

* [Getting Started](zapper-api/api-getting-started.md)
* [Endpoints](zapper-api/endpoints.md)
* [API Guides](zapper-api/api-guides/README.md)
* [Token Balances](zapper-api/api-guides/token-balances.md)
* [Supported Tokens and Prices](zapper-api/api-guides/supported-tokens-and-prices.md)
* [Gas Price](zapper-api/api-guides/gas-price.md)
* [Protocol Balances](zapper-api/api-guides/curve-balances.md)
* [Pool Stats](zapper-api/api-guides/pool-stats.md)
* [Vault Stats](zapper-api/api-guides/vault-stats.md)
* [Zap In](zapper-api/api-guides/zap-in.md)
* [Zap Out](zapper-api/api-guides/zap-out.md)

## Zapper Smart Contracts

* [Smart Contracts](zapper-smart-contracts/smart-contracts.md)

## Learn Zapper

* [Dashboard](learn-zapper/dashboard.md)
* [Exchange](learn-zapper/exchange.md)
* [Pool](learn-zapper/pooling/README.md)
* [Uniswap](learn-zapper/pooling/uniswap.md)
* [Balancer](learn-zapper/pooling/balancer.md)
* [Curve](learn-zapper/pooling/curve.md)
* [Yearn Vaults](learn-zapper/pooling/yearn-vaults.md)
* [Bridge](learn-zapper/bridge.md)
* [Farm](learn-zapper/farming.md)

## ADDITIONAL RESOURCES

* [Ecosystem Partners](additional-resources/our-partners.md)
* [Brand Assets](additional-resources/brand-assets.md)
* [Join Our Discord](https://discordapp.com/invite/h6CGbuN)
* [Tutorials & FAQs](https://zapper.crunch.help/)
* [Feature Requests](https://features.zapper.fi/)
* [Blog](https://medium.com/zapper-protocol)
* [Join Our Community](https://discordapp.com/invite/h6CGbuN)

16 changes: 9 additions & 7 deletions additional-resources/brand-assets.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,18 @@
# Brand Assets

![Zapper Official Logo](../.gitbook/assets/group-24-5-.png)
## Download

![API integration logo - Gray](../.gitbook/assets/power-zap-gray.svg)
Get the all of the Zapper assets as svgs at the download below.

![API integration logo - Purple](../.gitbook/assets/power-zap-purple.svg)
{% file src="../.gitbook/assets/zapper\_brand\_assets \(1\).zip" caption="Zapper Brand Assets" %}

![API integration logo - Black](../.gitbook/assets/power-zap-black.svg)
### Brand Examples

## Download
![Zapper Official Logo](../.gitbook/assets/group-24-5-.png)

Get the all of the Zapper assets as svgs at the download below.
![API integration logo - Gray](../.gitbook/assets/power-zap-gray.svg)

{% file src="../.gitbook/assets/zapper\_brand\_assets \(1\).zip" caption="Zapper Brand Assets" %}
![API integration logo - Black](../.gitbook/assets/power-zap-black.svg)

![API integration logo - Purple](../.gitbook/assets/power-zap-purple.svg)

41 changes: 41 additions & 0 deletions learn-zapper/bridge.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Bridge

{% embed url="https://www.youtube.com/watch?v=VSSaQTMZfIM" caption="Defi Class on how to use the Zapper Bridge" %}

## What is the Purpose of a Bridge?

A bridge is an easy way of porting assets from Ethereum to layer 2s and sidechains. By being able to port their assets over, you gain access to lower fees when interacting with different defi protocols. Zapper currently only supports a one way bridge, but there are plans to make it a two way bridge in the near future.

![](../.gitbook/assets/one-way-bridge.png)

**Currently Supporting:**

* **Polygon**
* **Binance Smart Chain**
* **Optimism** - Coming Soon
* **xdai** - Coming Soon

### Connecting to a Network - Polygon \(Matic\)

You will need to first set up a custom RPC to connect your wallet to the Matic Mainnet. Then click on the network options in Metamask on the top and select Custom RPC in the dropdown.

![Custom RPC Option](../.gitbook/assets/mm-custom.png)

Then enter in the information below to create a custom RPC for Polygon \(Matic\).

**Network Name:** Matic Mainnet

**New RPC URL:** [https://rpc-mainnet.matic.network](https://rpc-mainnet.matic.network/)

**Chain ID:** 137

**Symbol:** MATIC

**Block Explorer URL**: [https://explorer.matic.network/](https://explorer.matic.network/)



## Chainlist

A list of different chain information can be found [here](https://chainlist.org/).

24 changes: 24 additions & 0 deletions learn-zapper/dashboard.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
description: An overview of your DeFi assets and liabilities
---

# Dashboard

## **Supported Platforms**

At Zapper, the team is always working on adding on new protocols. Check out our updated list of [supported platforms](https://zapper.fi/protocols) to see the latest additions. If you would like to suggest an addition, or you are building a protocol and would like to see it on Zapper, you can make [requests here](https://features.zapper.fi/).

**Enter an address or connect a wallet to see your own dashboard at** [**Zapper**](https://zapper.fi)\*\*\*\*

![Account Dashboard](../.gitbook/assets/image%20%2815%29.png)

{% hint style="info" %}
The dashboard updates dynamically in real time reflecting current market conditions. Check out the [live demo](https://zapper.fi/dashboard?address=0x43a5c1331375f1f34bd774ecaee51501e9ca2db5)
{% endhint %}

## Supported Wallets

Zapper supports a wide range of wallets to enable anyone to access DeFi. If your favorite wallet is not listed here, feel free to [make a request](https://features.zapper.fi/feature-requests).

![Supported Wallets](../.gitbook/assets/image%20%2829%29.png)

29 changes: 29 additions & 0 deletions learn-zapper/exchange.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
description: Zapper DEX Aggregator
---

# Exchange

## The best swaps in DeFi.

Zapper is a [decentralized exchange](https://zapper.fi/exchange) that does not require you to deposit tokens like centralized exchanges \(e.g. Coinbase\). Signups are not required to use the exchange and all trades are executed trustlessly in a peer-to-peer manner.

In order to source and execute the best available swaps in DeFi, the exchange sources deep liquidity among all of the top exchanges at once, intelligently routing and executing swaps for any of the hundreds of tokens supported by Zapper.

### [Zapper Exchange](https://zapper.fi/exchange)

* Search over 18 exchanges at once, selecting the best swap to minimize slippage and gas fees.
* Intelligently route your swap, splitting the input among multiple exchanges and tapping into PMMs if necessary in order to optimize the trade.



![](../.gitbook/assets/image%20%2830%29.png)

## Video Walkthrough

{% embed url="https://youtu.be/Jl6uLLO62j8?t=1205" %}





28 changes: 28 additions & 0 deletions learn-zapper/farming.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Farm

## **What does 'Yield Farming' mean?**

**Utilizing your assets to generate governance tokens.**

{% embed url="https://youtu.be/SUoaaqQCs6g" caption="How to get Started Yield Farming" %}

## How does Farming work?

Let's say that there is a new token called Bleep Token \(BLP\) and they are hoping to gain liquidity on different decentralized exchanges. Ideally, as a new token it is important to have liquid markets because it allows for larger trades without slippage.

![More liquidity makes it easier to trade a token](../.gitbook/assets/farm-ex1.png)

In this example, a way for the Bleep Token \(BLP\) creators to get liquidity on Uniswap could be incentivize it through a rewards program where anyone that locks up ETH/BLP Uniswap Liquidity provider tokens in a rewards contract will reward Bleep Token \(BLP\) over time until they remove their liquidity provider tokens.

![Locking up liquidity provider tokens earns governance token rewards](../.gitbook/assets/farm-ex2-1-.png)

## Farming on Zapper

You can add assets to different liquidity pools under the pool tab. The example below shows how you can invest into the WBTC/ETH pool on Sushiswap.

![Pool Tab](../.gitbook/assets/pools.png)

Once you has invested into a pool, you can then take your liquidity provider tokens and lock them into a rewards contract. In this example, the SUSHI liquidity provider tokens can be locked into the reward contracts to earn SUSHI as a reward for providing liquidity to Sushiswap.

![Farm Tab](../.gitbook/assets/farms.png)

52 changes: 52 additions & 0 deletions learn-zapper/pooling/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# Pool

{% embed url="https://youtu.be/kbGhu1dxRhM" caption="How to Become a Liquidity Provider" %}

## What does "Pooling" mean

> **Providing liquidity to** [_**constant function market makers**_](https://medium.com/bollinger-investment-group/constant-function-market-makers-defis-zero-to-one-innovation-968f77022159) _**& earning proportional exchange fees in return.**_
>
> ### Traditional Finance:
>
> * Most exchanges _**maintain an order book**_ and facilitate matches between buyers and sellers.
> * For each successful match, traders are charged _**exchange fees**_ which go directly to exchange operators.
>
> ### The DeFi Difference:
>
> * _**Smart contracts hold liquidity**_ reserves of various tokens, and trades are executed directly against these reserves.
> * _**Prices are set automatically**_ using the constant product market maker mechanism, which keeps overall reserves in relative equilibrium.
> * Reserves are pooled between a network of liquidity providers who supply the system with tokens and receive a _**proportional share of transaction fees**_ accrued.
> * **IMPORTANT NOTE:** With fluctuating prices, liquidity providers may incur [**“impermanent loss”**](https://medium.com/@pintail/understanding-uniswap-returns-cc593f3499ef)**.**
## Adding Liquidity

In the example below a user is supplying ETH and DAI to a Uniswap pool. After adding their assets, they receive Uniswap liquidity provider tokens which represent a share of the underlying assets in the smart contract. When supplying liquidity to Uniswap, the assets need to be provided in 50/50 proportions. For example, if adding $1000 in liquidity to the ETH-DAI pool, $500 worth of DAI and $500 worth of ETH must be added.

![Adding liquidity to the Uniswap ETH-DAI pool](../../.gitbook/assets/adding-liquidity.png)

## Zapper allows for access to the best pooling opportunities with a single click

Zapper allows you to add liquidity in a single transaction. For example, if you only has ETH, but would like to to supply to the ETH-DAI Uniswap pair with Zapper you don't have to worry about manually converting half the ETH into DAI and then submit another transaction to add the liquidity.

![Part 1: Zapper contract swaps half of supplied for the needed asset](../../.gitbook/assets/zap1.png)

Instead the Zapper contracts will handle this under the hood and will swap to exactly half the amount of ETH into DAI and will then add both assets to the Uniswap pool. Lastly, the contract will pass the liquidity provider tokens back to your address at the end of the transaction, both steps done in one transactions.

![Part 2: Both assets are supplied and the LP tokens are forwarded to the user's address](../../.gitbook/assets/zap2.png)

## Impermanent Loss TLDR

Impermanent loss sounds like a scary term, but can be broken down into a simple balance between the amount of fees collected by a pool vs the amount of price shift between the supplied assets. Pairs that earn large amounts of fees tend to be the ones that have the most price divergence between the underlying assets.

![Uniswap LP Tokens are like a 50/50 weighted index](../../.gitbook/assets/50-50.png)

In simple terms, when supplying liquidity it is easiest to think that when entering a pool that the liquidity provider tokens are a weighted index of the pool you are in. So when you zaps in your ETH into the ETH-DAI Uniswap pool they now hold an LP token that is somewhat like a 50/50 weighted index between ETH and DAI. This pool tends to earn lots of fees due to people frequently trading between the assets. However, as a liquidity provider, you no longer has full price exposure to ETH.

## Explore Different Pooling Opportunities

{% page-ref page="uniswap.md" %}

{% page-ref page="curve.md" %}

{% page-ref page="balancer.md" %}

Loading

0 comments on commit 63796b0

Please sign in to comment.