chore: add state management base class and shared lock

stanleyyconsensys commented 1 month ago

This PR is to add state management base class SnapStateManager

it provides the functionally of update, get, set, withTransaction, commit, rollback

get and set is the simple method to get the state and set the state.
update is an method combine with get, then set, but also compatible with transaction mode.
withTransaction is a method to init a transaction by getting the state, and do the callback, if anything happen, it will rollback to the state that we get previously, it can combine withupdate to use.
commit is a method to force commit in a transaction before it auto commit.
rollback is a internal method to rollback the state.

example use:

export type SnapState = {
  walletIds: string[];
  wallets: Wallets;
};

class MyState extends SnapStateManager<SnapState> {
      constructor() {
        super(true);
      }

     async updateWallet(wallet) {
         await this.update(async (state: SnapState) => {
                 const { id, address } = wallet.account;
                 if (
                    this.isAccountExist(state, id) ||
                    this.getAccountByAddress(state, address)
                  ) {
                    throw new Error(`Account address ${address} already exists`);
                  }
              state.wallets[id] = wallet;
        })
     }
}

// Test rollback
async function testRollback() {
    const mgt = new MyState()
    await mgt.withTransaction(async () => {
        await mgt.addWallet({
          account: keyringAccount,
        });
        // if this line fail, it will not update the state
        await this.#emitEvent(KeyringEvent.AccountCreated, {
          account: keyringAccount,
          accountNameSuggestion: this.getKeyringAccountNameSuggestion(options),
        });
    });
}