Create base interoperability store

[ishantiw]

Description

Interoperability Store will take getStore(modID, store_prefix) => KVStore and InteroperableModules as arguments in the constructor and will provide all the. BaseInteroperabilityStore abstract class should be created under /framework/src/modules.

export abstract class BaseInteroperabilityStore {
	private _interopModules: Map<number, InteroperableModule>;
	private _getStore: (modID, store_prefix) => KVStore;

	constructor(getStore, interoperableModules) {
		this._interopModules = interoperableModules;
		this._getStore = getStore;
	}
	public abstract apply(ccu, ccm) {}
	public abstract forward(ccu, ccm) {} // only used in mainchain
	public abstract bounce(ccu, ccm) {} // only used in mainchain
	public abstract sendInternal(sendInternalContext) {} // same as the API
	public abstract appendToInboxTree(chainID, appendData) {}
	public abstract appendToOutboxTree(chainID, appendData) {}
	public abstract addToOutbox(chainID, ccm) {}
	public abstract addToInbox(chainID, ccm) {}
	public abstract isLive(chainID) {} // different in mainchain and sidechain
	public abstract terminateChainInternal(chainID) {}
	public abstract terminatedStateAccount(chainID) {}
	public abstract createTerminatedOutboxAccount(chainID, outboxRoot, outboxSize, partnerChainInboxSize) {}
	public abstract getInboxRoot(chainID): Buffer {}
	public abstract getOutboxRoot(chainID): Buffer {}
	public abstract getChainAccount(chainID): PartnerChainData {}
	public abstract getChannel(chainID): ChannelData {}
}

validateFormat() func can be added to utils.ts as it doesn't require subStore

Usage

Usage of Interoperability in other classes is by creating a file store.ts with a class extending the BaseInteroperabilityStore and implements the functions required to enable interoperability.

Acceptance Criteria

• BaseInteroperabilityStore abstract class should exist under /framework/src/modules