tge-spreadsheet-etl

README

TGE Spreadsheet ETL

It's an application which loads members Sweetcoin contribution and stores them as a Direct Buy records into the Postgresql database.

This is a limited usage tool to be used only for a certain set of contributions, verified and managed by the TGE & Compliance Teams for the early TGE stages.

Please refer for to ./cmd/tge-direct-buy-report/README.md for more information.

Data flow

Diagram: tge-contributions-flow.pdf.

Amounts

The spreadsheet defines two amounts:

• amountIn - this is the amount user sent in a given currency (as specified in the currency column).
• amountOut - amount of tokens we are giving to the user.

Both values (amountIn and amountOut) have to have the same sign. If the amount is negative, than it means that we are making a refund to the user. Since we can't rollback an SWC transaction, we can't refund a distributed tranche. So, every user has to have non-negative total balance of amountIn and amountOut in each tranche. This is checked in the reporting tool, not the loader.

Status

We support following statuses:

• "on hold" -- order acknowledged but not scheduled for distribution
• "pending" -- scheduled for the TGE distribution
• "done" -- distribution is done.

The direct buy operator can update status between on hold and pending (in any way). But once status is set to done it can't be changed.

The Direct Buy records can be updated. However not fields are overwritten:

• we keep old timestamp values
• we don't allow to set a lower status then the one recorded in DB. The status is always the maximum of the status in DB and the status in the spreadsheet.