algorand-error-handling

Algorand Error Handling Git Bounty Proposal

Ritchel Cousar Jr. - https://github.com/overhead525




Table of Contents

Abstract
Work Plan
Questions I Have For You
About Me
Discussion and PRs


Abstract

 The sandbox at https://github.com/algorand/sandbox is used to create a development environment for users who want to test applications that make use of Algorand. The purpose of their application isn’t really important here. But what is important, is their ability to update parts of the development environment or lack thereof, currently.

 Upon closer inspection of the code, I understand the sandbox to basically be a shell script that spins up three docker containers on the user’s local machine using docker-compose, along with various options and commands. I won’t lie, I had a lot of fun exploring the code. Excellent architecture.


Algorand Sandbox Diagram

Work Plan

There are three requirements for this bounty:

  1. Update algod/indexer during ./sandbox up
  2. Force rebuild after cleaning
  3. Improve error handling

Here’s how I plan to work on them:

About Me

My Local Setup: Windows running WSL2 (Ubuntu 18.04 LTS)

 I understand that you want the solution tested on Ubuntu 20.04 and MacOSX as well, so I’ll spin up a couple of docker instances to test those operating systems.

Questions I Have For You

Question 1: In the bounty description, you mentioned that the README.md file in the algorand/sandbox repository needed to be update. That’s cool. But you also mentioned the phrase other user-facing documentation. Is this documentation in another repository? I could use some help identifying where I need to change things. It would save some time.

Discussions and PRs