Skip to content

GIB馃拵WORK Bounty - Pull Request Made To ramm-evm-sdk #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
calmwelder wants to merge 2 commits into
base: main
Choose a base branch
from
Open

GIB馃拵WORK Bounty - Pull Request Made To ramm-evm-sdk #4

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8ce64fa
Update README.md
calmwelder Jan 12, 2024
3b94bd5
Merge pull request #1 from calmwelder/calmwelder-BOUNTY-#34
calmwelder Jan 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 50 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,51 @@
# ramm-sdk
# **RAMM-SDK**

# Overview

The RAMM (Risk Adjusted Money Market) Pool SDK is a sophisticated TypeScript library designed for seamless integration with RAMM pools on Ethereum/EVM blockchains. As a crucial element in the decentralized finance (DeFi) ecosystem, this SDK facilitates dynamic liquidity and asset management, making it possible for developers to build advanced DeFi solutions.

## Repository Structure
- `abi/`: Contains Application Binary Interfaces (ABIs) for smart contracts, essential for Ethereum/EVM blockchain interactions.
- `src/:`
- `constants/:` Houses configuration files and network-related constants.
- `interface/:` TypeScript interfaces and types for safety and clarity.
- `math/:` Utility functions for complex mathematical operations.
- `transactions/:` Dedicated functions for handling and executing transactions.
- `RAMMPool.ts:` The core class responsible for facilitating interactions with RAMM pools.
- `tests/:` A comprehensive test suite to validate application reliability.
- `index.ts:` The primary entry point of the application.
- `env.example:` Requires Infura API KEY details.

## Getting Started
- Clone this repository to your local environment.
- Run `yarn install` to install all required dependencies.
- Duplicate **.env.example** into **.env** and populate it with your environment variables.
- Compile using `tsc` command.

## Usage Guidelines
To utilize the SDK, import the `RAMMPool` class from `src/RAMMPool.ts`. use this class to begin interaction with the RAMM pool.

## Testing Framework
Use `yarn test` to run tests.

## Contribution Protocol
We highly encourage community contributions. To contribute, please fork the repository, make your changes, and submit a pull request. For significant changes or enhancements, kindly open an issue first to discuss your ideas.

## Licensing
This project is licensed under the MIT License - see the LICENSE file for details.

## Disclaimer
The RAMM Pool SDK is provided "as is" without any warranty. The authors and contributors are not liable for any damages or liabilities arising from the use of this SDK. Users are responsible for compliance with regulations in their respective jurisdictions.