[Persistence] Consolidate common behaviour between Pool and Account into a shared interface (Issue #102)

[h5law]

Description

This PR addresses issue #102. It consolidates Account and Pool to use a shared interface ProtocolAccountSchema that generalises the functions that both actors use.

The ProtocolAccountSchema interface is implemented by the baseProtocolAccountSchema struct - following the same pattern laid out by the ProtocolActorSchema and baseProtocolActorSchema. Two new types are then created - Account and Pool these are instances of the baseProtocolAccountSchema struct and are initiated with their relevant SQL table names, height constraints and column names.

The functions in the PersistenceRWContext for both Account and Pool utilities are now generalised to use shared logic dramatically reducing the code footprint.

In addition to this all relevant unit tests have been updated and usages of these functions are working correctly. Also regarding issue #149 address []bytes has been removed from InsertPool.

Issue

Fixes #102

Type of change

Please mark the relevant option(s):

• New feature, functionality or library
• Bug fix
• Code health or cleanup
• Major breaking change
• Documentation
• Other

List of changes

• Create ProtocolAccountSchema interface and baseProtocolAccountSchema struct that implements this interface
• Create Account and Pool types that share the common functionality of baseProtocolAccountSchema
• Generalise all Account and Pool functions to use shared logic
• Remove address []byte from InsertPool()
• Seperate shared_sql.go and types/shared_sql.go into account_shared_sql.go and actor_shared_sql.go as well as types/account_shared_sql.go and types/actor_shared_sql.go respectively

Testing

• make develop_test
• LocalNet w/ all of the steps outlined in the README

Required Checklist

• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have tested my changes using the available tooling
• I have updated the corresponding CHANGELOG

If Applicable Checklist

• I have updated the corresponding README(s); local and/or global
• I have added tests that prove my fix is effective or that my feature works
• I have added, or updated, mermaid.js diagrams in the corresponding README(s)
• I have added, or updated, documentation and mermaid.js diagrams in shared/docs/* if I updated shared/*README(s)

[h5law]

@Olshansk I have also addressed the discussion comment in the persistence/account.go file and included the code for the relevant change if desired - commented out though. The current functionality is identical to how it was prior - only using shared logic instead. As the GetAccountAmount() and GetPoolAmount() will both by default return "0" (as before) this change seemed useful to include if desired I can uncomment or remove it.

[Olshansk]

@h5law LGTM!

Just a couple things regarding review:

1. Make sure to re-request review when you need me to take another look
2. Don't hesitate to resolve the comments yourself if your confident you addressed the comment
3. Just double checking that LocalNet works fine? If so, go ahead and squash-and-merge!

[h5law]

@Olshansk

1. Make sure to re-request review when you need me to take another look
2. Don't hesitate to resolve the comments yourself if your confident you addressed the comment

I thought I did these but will make sure going forward 🫡

3. Just double checking that LocalNet works fine? If so, go ahead and squash-and-merge!

All good - will update CHANGELOGs and merge after that