hckyu13 / ambient-ts-app

Introduction

Welcome to the Ambient Finance platform! Please click here to launch the web app.

Table of Contents

1. Instructions for Use
2. Contributions
3. Version Notes
4. Contact

Instructions for Use

Dev Mode

Clone the repo and use yarn start to run the Ambient UI in development mode.

Open http://localhost:3000 to view it in a browser.

Note: Node v16+ is required

Environmental Variables

Configure your build environment by adding a dotfile (e.g. .env.local) with variable definitions to the top level directory before starting the server. Please reference .gitignore in the root directory for dotfile naming conventions.

Chain IDs

This allows the app to interface with different networks as defined in the SDK (not all deployments support all networks).

Format: REACT_APP_CHAIN_IDS=0x1,0x82750,0x5

Notes:

• 0x1 → Ethereum Mainnet
• 0x82750 → Scroll (Ethereum L2 ZK Rollup)
• 0x5 → Görli Testnet

Infura

This is a key for the Infura API which is used to pull metadata from on-chain.

Format: REACT_APP_INFURA_KEY=*********************

Notes:

• Please use your own Infura key for development purposes.

Back to Top

Contributions

Contributions are always welcome! Feel free to open a GitHub Issue or Pull Request.

Please see the docs for our coding style guide: https://github.com/CrocSwap/ambient-ts-app/tree/develop/docs

Back to Top

Version Notes

Release notes for app versions.

Quick Links: 1.7 (Current) | 1.6 | 1.5

version 1.7

Summary:

• Added automatic gas cost estimate updates and estimate displays in the trade modules on Scroll
• Fixed value calculations for non-default (ETH/USDC) tokens
• Fixed display of ENS name resolutions in trade tables
• Fixed missing chart in transaction details on mobile devices

Code changes are viewable on GitHub Link

version 1.6

Summary:

• Added the ability to switch to the Scroll network and a test network (Görli) using the network selector in the page header
• Added an external link to Canto in the network selector
• Updated the pool initialization form to enable additionally minting of an initial liquidity position
• Fixed a bug preventing approvals of certain tokens (thanks busimus!)
• Added the ability to annotate the price charts with trend lines and horizontal rays
• Added USD $ value estimation calculations to the token selectors in the swap/limit/pool modules based on CoinGecko

Code changes are viewable on GitHub Link

version 1.5

Summary:

• Refactored styling for easier future updates to add customizability.

Code changes are viewable on GitHub Link

Back to Top

Contact

Social Media

• Twitter
• Discord
• Medium
• Corporate Site

People

• Doug Colkitt is the Founder & CEO of Crocodile Labs
• Ben Wolski manages the CI/CD pipeline and production releases
• Vee is our Community Manager and handles external communications
• Emily is the primary caretaker of this document

Back to Top