SyncDB¶
Description¶
SyncDB
is used by the SyncManager to store information about current synchronization statuses.
API¶
Methods¶
getCommitmentContracts¶
async function getCommitmentContracts(): Promise<string[]>
Description¶
Gets the list of commitment contracts the client is currently watching.
Returns¶
Promise<string[]>
: List of commitment contract addresses to synchronize with.
getDepositContracts¶
async function getDepositContracts(
commitmentContract: string
): Promise<string[]>
Description¶
Gets the list of deposit contracts that are connected to a given commitment contract.
Parameters¶
commitmentContract
-string
: Address of the commitment contract to get deposit contracts for.
Returns¶
Promise<string[]>
: List of deposit contract addresses connected to a given commitment contract.
addDepositContract¶
async function addDepositContract(
commitmentContract: string,
depositContract: string
): Promise<void>
Description¶
Connects a deposit contract to a commitment contract.
Parameters¶
commitmentContract
-string
: Address of the commitment contract to connect to.depositContract
-string
: Address of the deposit contract to connect.
Returns¶
Promise<void>
: Promise that resolves once the contracts have been connected.
removeDepositContract¶
async function removeDepositContract(
commitmentContract: string,
depositContract: string
): Promise<void>
Description¶
Removes a connection between a deposit contract and a commitment contract.
Parameters¶
commitmentContract
-string
: Commitment contract to remove the connection from.depositContract
-string
: Deposit contract to remove.
Returns¶
Promise<void>
: Promise that resolves once the contracts have been disconnected.
putLastSyncedBlock¶
async function putLastSyncedBlock(
plasmaContract: string,
block: number
): Promise<void>
Description¶
Sets the last block up to which the client has synchronized with a given plasma contract.
Parameters¶
plasmaContract
-string
: ID of the plasma chain to set last block for.block
-number
: Last block up to which the client has synchronized.
Returns¶
Promise<void>
: Promise that resolves once the block has been set.
getLastSyncedBlock¶
async function getLastSyncedBlock(plasmaContract: string): Promise<number>
Description¶
Gets the last block up to which the client has synchronized with a given plasma contract.
Parameters¶
plasmaContract
-string
: Contract to query the last synced block for.
Returns¶
Promise<number>
: Block up to which the client has synchronized.
addSyncQuery¶
async function addSyncQuery(
plasmaContract: string,
stateQuery: StateQuery
): Promise<void>
Description¶
Adds a StateQuery to the list of queries to execute for a given plasma contract.
Parameters¶
plasmaContract
-string
: Contract to add a query for.stateQuery
-StateQuery
: Query to add for the contract.
Returns¶
Promise<void>
: Promise that resolves once the query has been added.
removeSyncQuery¶
async function removeSyncQuery(
plasmaContract: string,
stateQuery: StateQuery
): Promise<void>
Description¶
Removes a StateQuery from the list of queries to execute for a given plasma contract.
Parameters¶
plasmaContract
-string
: Contract to remove a query for.stateQuery
-StateQuery
: Query to remove for the contract.
Returns¶
Promise<void>
: Promise that resolves once the query has been removed.
getSyncQueries¶
async function getSyncQueries(
plasmaContract: string
): Promise<StateQuery[]>
Description¶
Returns the StateQuery objects to execute for a given plasma contract.
Parameters¶
plasmaContract
-string
: Contract to get sync queries for.
Returns¶
Promise<StateQuery[]>
: List of queries to execute for a given contract.