zapper-fi / studio

Zapper App Integrations

Twitter • Discord

Description

Zapper Studio is a platform which enables developers in our community to integrate Web3 applications into Zapper. Integrations can support fetching tokens and contract positions, retrieving a wallet's balances, calculating TVL, and more to come in the future. These adapters enrich the Zapper API, and all of its consumers, including our own mobile and web apps.

Requirements

Ensure the following have been installed on your system:

• Node v18.16.1 or above
• pnpm 8

Getting Started

You can get started building immediately!

OpenAPI docs for studio is available on localhost:5001/docs. Which will give you a rough overview of all exposed endpoints you can test out.

If you wish to know how to integrate your application, please check out Zapper Studio docs for more details.

Installation

$ pnpm install

Running the app

$ pnpm dev

Creating a new app

pnpm studio create-app

Generating code templates

pnpm studio create-token-fetcher [app-id]
pnpm studio create-contract-position-fetcher [app-id]

Clearing the cache

Clears the file-system cache that persists app tokens, contract positions and any other app related data. Useful when you are doing modification to an app and it keeps on returning stale data.

pnpm studio clear-cache

Setting custom network providers

If default network providers are too slow or are failing, you can use customize your setup.

pnpm studio set-network-provider

Generating a typescript contract from an ABI

ABIs that are contained within the contracts/abis folder of your application can be leveraged to quickly spin up a typescript library for interacting with a given smart contract.

You can quickly spin up a typescript library for using an ABI by running the following command:

pnpm studio generate:contract-factory [app-id]

Enabling environment specific configuration

Simply copy .env.sample to .env and edit the configuration file.

ENABLED_APPS

Control which app to enable on startup. Particularly useful to keep local build times snappy. When developing your own app, it's recommended to add its identifier (aka: the folder name) and its dependant apps (also their respective folder name) into this configuration key. See the .env file for further details.

Contributing

Read our Contribution Guide

Contributing new commands

You can generate a new cli command by running the hidden command:

pnpm studio new:command [my-command-name]

Need help?

Join our community on Discord

License

This repository is under the Business Source License 1.1

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Justin D'Errico 💻 💬 🚧	immasandwich 💻 💬 🚧	William Poulin 💻 💬 🚧	Xavier Drdak 💻 💬 🚧	0xMaxim 📖 💬	YYY 🐛	Jabun 🐛
brightiron 💻	wrap-that-potassium 💻	piersss 💻	Roman Kolpakov 💻	mehdi-loup 💻 💬 🚧	Dylan 💻	Kyle 💻 🐛
Mélen 💻	Papa Sougou Wele 💻 💬 🚧	Alexandre Sobolevski 💻 💬 🚧	Farhaan 💻	tonzgao 💻	leifu 💻	Dominik Prediger 💻 🐛
Kakashi 💻	Andrew Leonard 💻	Michael 💻	liuyepiaoxiang 💻	Apoorv Singal 💻	The Ol' Dirty Bubble 💻	Connor Mulhall 💻
Kosiso 💻	kinesis-labs 💻	marcomariscal 💻	CronosLabsDev 💻	BastionProvider 💻	David Esposto 💻	Weston Nelson 💻
coslendteam 💻	liz 💻	oo-00 💻	takao-aurigami 💻	Sébastien Audet 💻 💬 🚧	BlueBit Finance 💻	Clonescody 💻
Emerald 💻	EvLorne 💻	Kratos 💻	reganwrench 💻	scruffy-dev 💻	Émile Filteau-Tessier 💻 💬 🚧	Sam | Zapper 📖 💬
Single Finance Lab 💻	FiboApe 💻	David 💻 🐛	0xAlunara 💻	Eugene Lepeico 💻	FredCoen 💻	VaporwaveFinance 💻
peezebit 💻	p7m 💻	0xoats 🐛	croc12344 💻	peteris 💻	Mike Shultz 💻 🐛	Benjamin Hughes 💻 🐛
0xButterfield 💻	Mark 💻	yuval-weiss 🐛	volt62 💻	0xNeo 💻	0xR 💻	DINNGO Dev 💻
rekt0x 💻	Mickey 💻 🐛	crypslato 💻	Msordet 💻 💬 🚧	0x A.K. 💻	Julien THOMAS 💻	koffeebot 💻
Justin Greenberg 💻	Maxime Bedard 💻 💬 🚧	Steven Enamakel 💻	gauloiseth 💻	Eugene 💻	Rob 💻	Vedant Dalvi 💻
ibeandyy 💻	0xdapper 💻	Oleh Vovnianko 💻	akashiceth 💻

studio's Issues

sETH is double counted because it shows both under the Synthetix app and wallet as a base token

Cream

my Sand Saving on Cream is not showing up?

https://zapper.canny.io/admin/board/report-bugs/p/cream

Support Vesta GMX Trove and Stability Pool

Add sOHM to Pool together

https://app.pooltogether.com/pools/mainnet/sOHM

From canny: https://features.zapper.fi/protocol-requests/p/pooltogether-1

Illuvium V2 Staking

RocketPool ETH Staking

[StakeDAO] sdFXS gauge

from canny.io - https://features.zapper.fi/protocol-requests/p/stakedao-sdfxs-gauge

StakeDAO sdFXS

Address: 0x402F878BDd1f5C66FdAF0fabaBcF74741B68ac36
Symbol: sdFXS
Description: Basically locked FXS on StakeDAO
FXS price : https://www.coingecko.com/en/coins/frax-share
sdFXS price: Basically 1-to-1 with FXS. True price is on Curve https://curve.fi/factory/100
StakeDAO sdFXS Gauge

Address: 0xF3C6e8fbB946260e8c2a55d48a5e01C82fD63106
Symbol: sdFXS-gauge
Description: Deposited sdFXS. Earns FXS and SDT rewards
https://lockers.stakedao.org/
Underlying token (sdFXS): 0x402F878BDd1f5C66FdAF0fabaBcF74741B68ac36
sdFXS Gauge price: Basically 1-to-1 with FXS. True price is on Curve https://curve.fi/factory/100
Price info:
FXS: https://www.coingecko.com/en/coins/frax-share
SDT: https://www.coingecko.com/en/coins/stake-dao
Deposited Balance
call balanceOf(<USER ADDRESS) on 0xF3C6e8fbB946260e8c2a55d48a5e01C82fD63106
Rewards
FXS: call claimable_reward(<USER ADDRESS, 0x3432B6A60D23Ca0dFCa7761B7ab56459D9C964D0) on 0xF3C6e8fbB946260e8c2a55d48a5e01C82fD63106
SDT: call claimable_reward(<USER ADDRESS, 0x73968b9a57c6E53d41345FD57a6E6ae27d6CDB2F) on 0xF3C6e8fbB946260e8c2a55d48a5e01C82fD63106
Thank you

xLQDR dolar value incorrect

Right now zapper use the amount of xLQDR and the price of LQDR in dollar to calculate the balance.
This is incorrect. It should instead use the amount of LQDR locked and the price of LQDR in dollar to calculate the balance.

Canny: https://features.zapper.fi/cointoken-request/p/xlqdr-dolar-value-incorrect

See Tokemak Token Reward in Zapper

See Tokemak Token Reward ($TOKE) in Zapper in the farm section

https://zapper.canny.io/admin/board/protocol-requests/p/see-tokemak-token-reward-in-zapper

mGNO

Solidex

Add missing Maple pools

https://etherscan.io/address/0x1A066b0109545455BC771E49e6EDef6303cb0A93

Venus Finance missing XVS and VAI vaults

https://venus.finance/app

Missing XVS and Vai

https://features.zapper.fi/protocol-requests/p/httpsvenusfinanceapp

DeFi Saver mStable supply not showing up

User: I have an mStable position. I put the DSproxy wallet address as a watched wallet in Zapper but that mStable position doesn’t show. Possible to DM you my wallet address? It shows it on Etherscan

dopex.io new SSOV-c rDPX contract

dopex.io SSOV-c rDPX has a new contract and no longer shows on zapper. can the contract be updated please.

https://zapper.canny.io/admin/board/protocol-requests/p/dopexio-1

`yarn studio generate:contract-factory` has issues when having ABI files with upper case

If my ABI is named Something.json it won't generate much of the code.
If it's named something.json is working though.

Bondly token address update post-hack

Bondly was hacked last year and they replaced their old token with new token. Could you please remove pricing for old token like the other portfolio mangers have done already.

New QiDao MAI+3Pool3CRV-f pool

https://app.mai.finance/farm
There is a new MAI+3Pool3CRV-f farming pool on QiDao. The old one isn't good anymore.

https://zapper.canny.io/admin/board/protocol-requests/p/qidao-mai3pool3crv-f-pool

Tonic doesn't show up on dashboard

Regarding balance fetcher

endpoint: http://localhost:5001/apps/tectonic/balances?addresses[]=<ADDRESS>&network=cronos

getClaimableBalances() in tectonic.balance-fetcher.ts, there is TONIC token with balance

[
  {
    type: 'contract-position',
    address: '0xb3831584acb95ed9ccb0c11f677b5ad01deaeec0',
    appId: 'tectonic',
    groupId: 'claimable',
    network: 'cronos',
    dataProps: {},
    displayProps: {
      label: 'Claimable TONIC',
      secondaryLabel: [Object],
      images: [Array],
      statsItems: []
    },
    tokens: [ [Object] ],
    balanceUSD: 0.0001389300468845742
  }
]

But the return value of presentBalanceFetcherResponse (from '~app-toolkit/helpers/presentation/balance-fetcher-response.present') function somehow filters out the claimableProduct and therefore TONIC doesn't show up on endpoint and dashboard. Any suggestion to fix it plz 🙏

Hide or Delete old contract Token Floki Inu

In my wallet I still see the old Floki token contract, I don't own any more Floki tokens, but I still see the old contract in my wallet with a different price, because the old contract is now at 0.
Contract : 0x2B3F34e9D4b127797CE6244Ea341a83733ddd6E4

https://zapper.canny.io/admin/board/feature-requests/p/hide-or-delete-old-contract-token-floki-inu

Old KNC token shown still

Delete old KNC token (circled in red). Only maintain KNCv2

https://features.zapper.fi/cointoken-request/p/knc

Remove rugged CREAM assets

From Canny:

after CREAM got rugged, the assets used as collaterals and the debt stopped appearing on my wallet, which was the right thing. Today it suddenly reappeared though, which is very confusing because these assets are still lost - illiquid and useless

Add gALCX - ALCX Wrapper

Please add gALCX, 0x93dede06ae3b5590af1d4c111bc54c3f717e4b35.
gALCX is a liquid ALCX wrapper for single-sided staking.
https://app.alchemix.fi/farms

inSpirit price reported as incorrect

Right now zapper use the amount of inSPIRIT and the price of SPIRIT in dollar to calculate the balance.
This is incorrect. It should instead use the amount of SPIRIT locked and the price of SPIRIT in dollar to calculate the balance.

From canny: https://features.zapper.fi/cointoken-request/p/inspirit-dolar-value-incorrect

Bent Finance Staked LPs

Convex Fixed Forex LPs stopped showing

Fixed Forex pools on Convex were showing up under Convex but now do not. As an example, my fixed forex GBP LP does not show. This worked fine until recently.

From canny - https://features.zapper.fi/report-bugs/p/convex-fixed-forex-lps-stopped-showing

Show staked $GEIST on geist.finance

While desposited assets (as collateral) are showing, staked $GEIST is not showing.

https://zapper.canny.io/admin/board/protocol-requests/p/show-staked-geist-on-geistfinance

"Contribution Guide" link in readme leads to a 404

Should it lead to: https://github.com/Zapper-fi/studio/blob/main/CONTRIBUTING.md ? 🤓

[Barnbridge] SMART alpha

Please add Barnbridge SMART alpha wETH/USD-1wk:
BarnBridge WETH-USD-1w junior token: 0xcD89c90ce3D565F51587033604591BA292BA1866
BarnBridge WETH-USD-1w senior token: 0xb138dd4a00f9afa14c7feaacd710f37a22fe4f12

https://zapper.canny.io/admin/board/protocol-requests/p/barnbridge-smart-alpha

Badger Vote Locked CVX

From Canny -- https://features.zapper.fi/cointoken-request/p/badger-vote-locked-cvx

https://app.badger.com/setts/convex-vote-locked-cvx
https://docs.badger.com/badger-finance/sett-user-guides/blcvx-locked-convex
https://www.convexfinance.com/lock-cvx
https://etherscan.io/address/0x4e3FBD56CD56c3e72c1403e103b45Db9da5B9D2B

Add claimable amount for SNX on Optimism

Lyra Pools

Wrong price for rocket pool eth on Arbitrum

https://zapper.fi/token/arbitrum/0xec70dcb4a1efa46b8f2d97c310c9c4790ba5ffa8/rETH

the price information for Rocket Pool ETH on arbitrum seem to point to the wrong coingecko page resulting wrong price information on zapper (etherscan one is correct).
rETH contract on arbitrum: 0xec70dcb4a1efa46b8f2d97c310c9c4790ba5ffa8

add the staked linkLPLA token on Linkpool

From user:

It'd be great to add the staked linkLPLA token 0x0aA3d1c7838e20790A196d56899fE0Bc8B23700F , since 98.8% of LPL is staked currently. When you use the dapp (https://app.linkpool.io/pools/linkpool-owners/stake) you convert LPL to linkLPLA, which does not show on zapper. Thanks again!

https://features.zapper.fi/cointoken-request/p/please-add-linkpool-erc20-token-asset-price-ticker-lpl

RDPX/ETH LP is missing

thanks guys!

https://zapper.canny.io/admin/board/protocol-requests/p/rdpxeth-lp-is-missing

Curve on Optimism

Deposits in to Curve gauges do not show (rewards aren't live yet, but were just voted in).

https://optimism.curve.fi/

https://zapper.canny.io/admin/board/protocol-requests/p/curve-on-optimism

Add B.AMM LUSD-ETH (LUSDETH)

https://etherscan.io/address/0x00ff66ab8699aafa050ee5ef5041d1503aa0849a[](https://zapper.canny.io/admin/feedback/cointoken-request/p/bamm-lusd-eth-lusdeth?boards=cointoken-request)

test address not showing the value: https://zapper.fi/account/0x2794714e909661d1e84ba58c3284276d60d8e4c7

LooksRare Compounder

icETH for Coop

Adding token the team Set / COOP-- icETH

[NAOS] Updating NAOS for staking, BSC, pools

ETH Staking Pool Address:
0x99E4eA9eF6bf396C49B35FF9478EbB8890aEF581
PoolId 0: NAOS Token
PoolId 1: NAOS/ETH Uni LP Token
PoolId 3: nUSD3CRV LP Token
BSC NAOS Staking Pool Address:
0x3Dcd32Dd2b225749Aa830Ca3B4F2411BFEB03DB4
BSC Staking Pool Address:
0x6EbC2C41c1e29A5506B86b758B6c16DD5bbCF7d1
PoolId 0: NAOS/BNB Pancake LP Token

Wonderland Farm wMEMO broken

Wonderland recently launched their revenue sharing farm. The staked wMEMO tokens no longer show up on Zapper.
https://app.wonderland.money/#/farm

https://zapper.canny.io/admin/board/protocol-requests/p/wonderland-farm

Llama Airforce Claimables

Use Merkle JSON from https://github.com/0xAlunara/Llama-Airforce-Airdrops/tree/master/ucrv

Kwenta

Alchemix V2 DAI vault APY is off by a multiple of 10000

Tokens on Cronos seem not display correctly

Expect other Cronos tokens (e.g. VVS, TONIC) to display like CRO
Any advice on it please, thank you 🙏

https://www.dhedge.org/

dHEDGE V2 has released on Polygon. dHEDGE V1 is currently tracked on Zapper. Would be great to track V2 as well. About 1M TVL within the first week of launch

https://zapper.canny.io/admin/board/protocol-requests/p/httpswwwdhedgeorg

Add Squeeth vaults on opyn

https://features.zapper.fi/protocol-requests/p/httpssqueethopynco

LICENSE

Business Source License 1.1

License text copyright (c) 2017 MariaDB Corporation Ab, All Rights Reserved.
"Business Source License" is a trademark of MariaDB Corporation Ab.

---

Parameters

Licensor: Zapper Inc.

Licensed Work: Zapper-fi / studio
The Licensed Work is (c) 2022 Zapper Inc.

Additional Use Grant: none

Change Date: The earlier of 2024-04-20 or a date specified at studio-license-date.zapper.eth

Change License: The MIT License (aka. "Expat License")

---

Terms

The Licensor hereby grants you the right to copy, modify, create derivative
works, redistribute, and make non-production use of the Licensed Work. The
Licensor may make an Additional Use Grant, above, permitting limited
production use.

Effective on the Change Date, or the fourth anniversary of the first publicly
available distribution of a specific version of the Licensed Work under this
License, whichever comes first, the Licensor hereby grants you rights under
the terms of the Change License, and the rights granted in the paragraph
above terminate.

If your use of the Licensed Work does not comply with the requirements
currently in effect as described in this License, you must purchase a
commercial license from the Licensor, its affiliated entities, or authorized
resellers, or you must refrain from using the Licensed Work.

All copies of the original and modified Licensed Work, and derivative works
of the Licensed Work, are subject to this License. This License applies
separately for each version of the Licensed Work and the Change Date may vary
for each version of the Licensed Work released by Licensor.

You must conspicuously display this License on each original or modified copy
of the Licensed Work. If you receive the Licensed Work in original or
modified form from a third party, the terms and conditions set forth in this
License apply to your use of that work.

Any use of the Licensed Work in violation of this License will automatically
terminate your rights under this License for the current and all other
versions of the Licensed Work.

This License does not grant you any right in any trademark or logo of
Licensor or its affiliates (provided that you may use a trademark or logo of
Licensor as expressly required by this License).

TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE LICENSED WORK IS PROVIDED ON
AN "AS IS" BASIS. LICENSOR HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS OR IMPLIED, INCLUDING (WITHOUT LIMITATION) WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND
TITLE.

MariaDB hereby grants you permission to use this License’s text to license
your works, and to refer to it using the trademark "Business Source License",
as long as you comply with the Covenants of Licensor below.

---

Covenants of Licensor

In consideration of the right to use this License’s text and the "Business
Source License" name and trademark, Licensor covenants to MariaDB, and to all
other recipients of the licensed work to be provided by Licensor:

1. To specify as the Change License the GPL Version 2.0 or any later version,
   or a license that is compatible with GPL Version 2.0 or a later version,
   where "compatible" means that software provided under the Change License can
   be included in a program with software provided under GPL Version 2.0 or a
   later version. Licensor may specify additional Change Licenses without
   limitation.

2. To either: (a) specify an additional grant of rights to use that does not
   impose any additional restriction on the right granted in this License, as
   the Additional Use Grant; or (b) insert the text "None".

3. To specify a Change Date.

4. Not to modify this License in any other way.

---

Notice

The Business Source License (this document, or the "License") is not an Open
Source license. However, the Licensed Work will eventually be made available
under an Open Source License, as stated in this License.

Hop Pools (support other networks)

Enzyme Finance