Skip to content

Commit

Permalink
IBC TypeScript Library
Browse files Browse the repository at this point in the history
  • Loading branch information
mchosc committed Aug 2, 2023
1 parent af88845 commit fa5d6ae
Showing 1 changed file with 90 additions and 0 deletions.
90 changes: 90 additions & 0 deletions applications/ibc-typescript-library.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
# EOS Network Foundation Grant Proposal

- **Project Name:** IBC TypeScript Library
- **Team Name:** Animus Labs LTD (representing Boid.com)
- **EOS Payment Address:** animus.inc
- **[Level](https://github.com/eosnetworkfoundation/grant-framework#grant-levels):** 2
- **Pomelo Grant(s):** https://pomelo.io/grants/eosioibc
- **Project is Open-Source:** Yes
- **Project was part of Token sale:** No
- **Repository where Project resides:** <https://github.com/animuslabs>

## Contact

- **Contact Name:** John Heeter
- **Contact Email:** [email protected]
- **Website:** <https://www.animus.is>

## Project Overview
We're creating a TypeScript library for the Antelope IBC, to be distributed as an npm package. It will feature a user-friendly API, strong type safety, high performance, and comprehensive documentation.

### Overview

- **Name:** IBC TypeScript Library
- **Brief Description:** Lower the barrier to entry for projects that want to implement IBC.
- **Relationship to EOSIO:** Part of core functionality.
- **Reason for Interest:** We had a huge issue with implementing the JavaScript code.

### Project Details
The primary objective of this project is to perform a comprehensive rewrite of the existing JavaScript code base that underpins the Cryptomechanics-developed Antelope Inter-Blockchain Communication (IBC) system. Our focus is to enhance the developer experience and simplify the process of building complex applications that utilize IBC. This library, which can be employed in both frontend and backend development, will be using Wharf SDK, funded by the Antelope coalition, replacing the use of the eosjs library. By streamlining the codebase, we aim to remove barriers to entry for developers, fostering an environment of greater innovation and collaboration. Ultimately, our goal is to propel broader adoption and usage of the Antelope IBC system.

### Ecosystem Fit
This library will become a cornerstone tool in the Antelope ecosystem. By lowering the barrier of entry to the Antelope IBC, we aim to attract more developers and foster innovation within the Antelope ecosystem.


## Team
### Team members

- **Team Leader:** John Heeter - Founder @ Boid.com
- John Heeter - Technical Lead / Development
- Seth Choscilowicz - Development / DevOps

### Legal Structure
- **Registered Legal Entity:** Animus Labs LTD
- **Registered Address:** Hunkins Waterfront Plaza, Main Street, Charlestown, Nevis

### Team Experience

John Heeter - 8 years of developement experience (5 years blockchain experience eosio) / full stack dev; technical artist 3 years; technical director 3 years
Seth Choscilowicz - blockchain dev ops 4 years eosio / systems engineer 14 years

### Team Org Repos

- <https://github.com/boid-com>
- <https://github.com/animuslabs>

### Team Member Repos

- <https://github.com/jdheeter>
- <https://github.com/mchosc>

### Team LinkedIn Profiles

- <https://www.linkedin.com/in/johnheeter>
- <https://www.linkedin.com/in/mchosc>

## Development Status
In developement


## Development Roadmap
Creation of NPM Antelope IBC package
Documentation

### Milestone — Implementation of the NPM package

- **Estimated duration:** 3 month
- **FTE:** 2
- **Costs:** 30,000 USD

Design, development, and implementation of the TypeScript library as an npm package. Our team will build a robust and user-friendly API for Antelope IBC, ensuring the code is clear, maintainable, and efficient. We will also write comprehensive documentation to make it easy for other developers to use the library.

## Future Plans

Upon the successful completion of this project, we plan to continue refining and expanding the library based on user feedback and changes in the Antelope IBC system. Our aim is to establish the library as a staple in the Antelope development toolkit. Furthermore, we hope to use this project as a stepping stone to create more tools and libraries that enhance the accessibility and usability of blockchain technologies.

## Additional Information

**How did you hear about the Grants Program?** Twitter

So far, we have been implementing the project with our own funds, we do not want to go beyond the EOSIO/Antelope environment with the idea. We submit the application for funding only to the EOS Network Foundation.

0 comments on commit fa5d6ae

Please sign in to comment.