panteo92 / studio

Zapper App Integrations

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Twitter β€’ Discord

All Contributors

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 v16.14.2 or above
  • pnpm

Getting Started

You can get started building immediately!
See Zapper Studio docs for more details

Installation

$ pnpm install

Running the app

$ pnpm dev

Creating a new app

pnpm studio create-app

Generating code template

pnpm studio codegen-app [app-id]

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 it's 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

πŸ’»

About

Zapper App Integrations

License:Other


Languages

Language:TypeScript 99.8%Language:JavaScript 0.2%Language:Shell 0.0%