Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Mock ingest transactions & produce blocks #325

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
"lint": "wsrun -p $(yarn --silent run pkgparse) --parallel --exclude-missing lint",
"fix": "wsrun -p $(yarn --silent run pkgparse) --fast-exit --parallel --exclude-missing fix",
"clean": "wsrun -p $(yarn --silent run pkgparse) -r --fast-exit --parallel --exclude-missing clean",
"test": "wsrun -p $(yarn --silent run pkgparse) --fast-exit --parallel --no-prefix --exclude-missing test",
"test": "wsrun -p $(yarn --silent run pkgparse) --fast-exit --parallel --no-prefix --exclude-missing --timeout 5000 test",
"build": "lerna link && wsrun -p $(yarn --silent run pkgparse) -r --fast-exit --stages --exclude-missing build",
"release": "yarn run build && lerna publish --force-publish --exact -m \"chore(@plasma-group) publish %s release\"",
"release:rc": "yarn run build && lerna publish --npm-tag=rc -m \"chore(@plasma-group) publish %s release\"",
Expand Down
9 changes: 7 additions & 2 deletions packages/contracts/test/Deposit.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -46,14 +46,19 @@ async function depositErc20(
}

describe('Deposit Contract with Ownership', () => {
const provider = createMockProvider()
const [wallet, walletTo] = getWallets(provider)
let provider
let wallet
let walletTo
let token
let depositContract
let commitmentContract
let ownershipPredicate

beforeEach(async () => {
provider = createMockProvider()
const wallets = getWallets(provider)
wallet = wallets[0]
walletTo = wallets[1]
token = await deployContract(wallet, BasicTokenMock, [wallet.address, 1000])
commitmentContract = await deployContract(wallet, Commitment, [])
depositContract = await deployContract(wallet, Deposit, [
Expand Down
1 change: 1 addition & 0 deletions packages/core/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
},
"dependencies": {
"abstract-leveldown": "^6.0.3",
"async-mutex": "^0.1.3",
"axios": "^0.19.0",
"bn.js": "^4.11.8",
"body-parser": "^1.19.0",
Expand Down
63 changes: 63 additions & 0 deletions packages/core/src/app/aggregator/aggregator.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
import BigNum = require('bn.js')

import { Aggregator } from '../../types/aggregator'
import { StateManager } from '../../types/ovm'
import {
BlockTransaction,
BlockTransactionCommitment,
Transaction,
TransactionResult,
} from '../../types/serialization'
import { doRangesSpanRange, sign } from '../utils'
import { BlockManager } from '../../types/block-production'

export class DefaultAggregator implements Aggregator {
private readonly publicKey: string =
'TODO: figure out public key storage and access'
private readonly privateKey: string =
'TODO: figure out private key storage and access'

public constructor(
private readonly stateManager: StateManager,
private readonly blockManager: BlockManager
) {}

public async ingestTransaction(
transaction: Transaction
): Promise<BlockTransactionCommitment> {
const blockNumber: BigNum = await this.blockManager.getNextBlockNumber()

const {
stateUpdate,
validRanges,
}: TransactionResult = await this.stateManager.executeTransaction(
transaction,
blockNumber,
'' // Note: This function call will change, so just using '' so it compiles
)

if (!doRangesSpanRange(validRanges, transaction.range)) {
throw Error(
`Cannot ingest Transaction that is not valid across its entire range.
Valid Ranges: ${JSON.stringify(validRanges)}.
Transaction: ${JSON.stringify(transaction)}.`
)
}

await this.blockManager.addPendingStateUpdate(stateUpdate)

const blockTransaction: BlockTransaction = {
blockNumber,
transaction,
}

return {
blockTransaction,
witness: sign(this.privateKey, blockTransaction),
}
}

public async getPublicKey(): Promise<any> {
return this.publicKey
}
}
1 change: 1 addition & 0 deletions packages/core/src/app/aggregator/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
export * from './aggregator'
151 changes: 151 additions & 0 deletions packages/core/src/app/block-production/block-db.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,151 @@
/* External Imports */
import BigNum = require('bn.js')
import { Mutex } from 'async-mutex'

import { BaseKey, BaseRangeBucket } from '../db'
import { BlockDB } from '../../types/block-production'
import { KeyValueStore, RangeStore } from '../../types/db'
import { StateUpdate } from '../../types/serialization'
import { MAX_BIG_NUM, ONE, ZERO } from '../utils'
import { GenericMerkleIntervalTree } from './merkle-interval-tree'
import { deserializeStateUpdate, serializeStateUpdate } from '../serialization'

const KEYS = {
NEXT_BLOCK: Buffer.from('nextblock'),
BLOCK: new BaseKey('b', ['buffer']),
}

/**
* Simple BlockDB implementation.
*/
export class DefaultBlockDB implements BlockDB {
private readonly blockMutex: Mutex

/**
* Initializes the database wrapper.
* @param vars the KeyValueStore to store variables in
* @param blocks the KeyValueStore to store Blocks in
*/
constructor(
private readonly vars: KeyValueStore,
private readonly blocks: KeyValueStore
) {
this.blockMutex = new Mutex()
}

/**
* @returns the next plasma block number.
*/
public async getNextBlockNumber(): Promise<BigNum> {
// TODO: Cache this when it makes sense
const buf = await this.vars.get(KEYS.NEXT_BLOCK)
return !buf ? ONE : new BigNum(buf, 'be')
}

/**
* Adds a state update to the list of updates to be published in the next
* plasma block.
* @param stateUpdate State update to publish in the next block.
* @returns a promise that resolves once the update has been added.
*/
public async addPendingStateUpdate(stateUpdate: StateUpdate): Promise<void> {
await this.blockMutex.runExclusive(async () => {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice mutex!

const block = await this.getNextBlockStore()
const start = stateUpdate.range.start
const end = stateUpdate.range.end

if (await block.hasDataInRange(start, end)) {
throw new Error(
'Block already contains a state update over that range.'
)
}

const value = Buffer.from(serializeStateUpdate(stateUpdate))
await block.put(start, end, value)
})
}

/**
* @returns the list of state updates waiting to be published in the next
* plasma block.
*/
public async getPendingStateUpdates(): Promise<StateUpdate[]> {
const blockNumber = await this.getNextBlockNumber()
return this.getStateUpdates(blockNumber)
}

/**
* Computes the Merkle Interval Tree root of a given block.
* @param blockNumber Block to compute a root for.
* @returns the root of the block.
*/
public async getMerkleRoot(blockNumber: BigNum): Promise<Buffer> {
const stateUpdates = await this.getStateUpdates(blockNumber)

const leaves = stateUpdates.map((stateUpdate) => {
// TODO: Actually encode this.
const encodedStateUpdate = serializeStateUpdate(stateUpdate)
return {
start: stateUpdate.range.start,
end: stateUpdate.range.end,
data: encodedStateUpdate,
}
})
const tree = new GenericMerkleIntervalTree(leaves)
return tree.root().hash
}

/**
* Finalizes the next plasma block so that it can be published.
*
* Note: The execution of this function is serialized internally,
* but to be of use, the caller will most likely want to serialize
* their calls to it as well.
*/
public async finalizeNextBlock(): Promise<void> {
await this.blockMutex.runExclusive(async () => {
const prevBlockNumber: BigNum = await this.getNextBlockNumber()
const nextBlockNumber: Buffer = prevBlockNumber.add(ONE).toBuffer('be')

await this.vars.put(KEYS.NEXT_BLOCK, nextBlockNumber)
})
}

/**
* Opens the RangeDB for a specific block.
* @param blockNumber Block to open the RangeDB for.
* @returns the RangeDB instance for the given block.
*/
private async getBlockStore(blockNumber: BigNum): Promise<RangeStore> {
const key = KEYS.BLOCK.encode([blockNumber.toBuffer('be')])
const bucket = this.blocks.bucket(key)
return new BaseRangeBucket(bucket.db, bucket.prefix)
}

/**
* @returns the RangeDB instance for the next block to be published.
*
* IMPORTANT: This function itself is safe from concurrency issues, but
* if the caller is modifying the returned RangeStore or needs to
* guarantee the returned next RangeStore is not stale, both the call
* to this function AND any subsequent reads / writes should be run with
* the blockMutex lock held to guarantee the expected behavior.
*/
private async getNextBlockStore(): Promise<RangeStore> {
const blockNumber = await this.getNextBlockNumber()
return this.getBlockStore(blockNumber)
}

/**
* Queries all of the state updates within a given block.
* @param blockNumber Block to query state updates for.
* @returns the list of state updates for that block.
*/
private async getStateUpdates(blockNumber: BigNum): Promise<StateUpdate[]> {
const block = await this.getBlockStore(blockNumber)
const values = await block.get(ZERO, MAX_BIG_NUM)
return values.map((value) => {
return deserializeStateUpdate(value.value.toString())
})
}
}
69 changes: 69 additions & 0 deletions packages/core/src/app/block-production/block-manager.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
import BigNum = require('bn.js')
import { Mutex } from 'async-mutex'

import {
BlockDB,
BlockManager,
CommitmentContract,
} from '../../types/block-production'
import { StateUpdate } from '../../types/serialization'

/**
* Simple BlockManager implementation.
*/
export class DefaultBlockManager implements BlockManager {
private readonly blockSubmissionMutex: Mutex

/**
* Initializes the manager.
* @param blockdb BlockDB instance to store/query data from.
* @param commitmentContract Contract wrapper used to publish block roots.
*/
constructor(
private blockdb: BlockDB,
private commitmentContract: CommitmentContract
) {
this.blockSubmissionMutex = new Mutex()
}

/**
* @returns the next plasma block number.
*/
public async getNextBlockNumber(): Promise<BigNum> {
return this.blockdb.getNextBlockNumber()
}

/**
* Adds a state update to the list of updates to be published in the next
* plasma block.
* @param stateUpdate State update to add to the next block.
* @returns a promise that resolves once the update has been added.
*/
public async addPendingStateUpdate(stateUpdate: StateUpdate): Promise<void> {
await this.blockdb.addPendingStateUpdate(stateUpdate)
}

/**
* @returns the state updates to be published in the next block.
*/
public async getPendingStateUpdates(): Promise<StateUpdate[]> {
return this.blockdb.getPendingStateUpdates()
}

/**
* Finalizes the next block and submits the block root to Ethereum.
* @returns a promise that resolves once the block has been published.
*/
public async submitNextBlock(): Promise<void> {
await this.blockSubmissionMutex.runExclusive(async () => {
// Don't submit the block if there are no StateUpdates
if ((await this.getPendingStateUpdates()).length === 0) {
return
}
const blockNumber = await this.getNextBlockNumber()
await this.blockdb.finalizeNextBlock()
const root = await this.blockdb.getMerkleRoot(blockNumber)
await this.commitmentContract.submitBlock(root)
})
}
}
2 changes: 2 additions & 0 deletions packages/core/src/app/block-production/index.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
export * from './block-db'
export * from './block-manager'
export * from './merkle-interval-tree'
export * from './state-interval-tree'
export * from './plasma-block-tree'
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ export class PlasmaBlock extends GenericMerkleIntervalTree

/**
* Returns a double inclusion proof which demonstrates the existence of a state update within the plasma block.
* @param stateUpdatePosition index of the state udpate in the state subtree of the block.
* @param stateUpdatePosition index of the state update in the state subtree of the block.
* @param assetIdPosition index of the assetId in the top-level asset id of the block
*/
public getStateUpdateInclusionProof(
Expand Down
14 changes: 12 additions & 2 deletions packages/core/src/app/db/db.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,11 @@
*/

/* External Imports */
import { AbstractOpenOptions, AbstractLevelDOWN } from 'abstract-leveldown'
import {
AbstractOpenOptions,
AbstractLevelDOWN,
AbstractChainedBatch,
} from 'abstract-leveldown'

/* Internal Imports */
import {
Expand All @@ -16,12 +20,18 @@ import {
Iterator,
Bucket,
RangeBucket,
KeyValueStore,
PutBatch,
PUT_BATCH_TYPE,
DEL_BATCH_TYPE,
} from '../../types'
import { BaseIterator } from './iterator'
import { BaseBucket } from './bucket'
import { BaseRangeBucket } from './range-bucket'
import { bufferUtils } from '../../app'

export const DEFAULT_PREFIX_LENGTH = 3

/**
* Checks if an error is a NotFoundError.
* @param err Error to check.
Expand All @@ -45,7 +55,7 @@ const isNotFound = (err: any): boolean => {
export class BaseDB implements DB {
constructor(
readonly db: AbstractLevelDOWN,
readonly prefixLength: number = 3
readonly prefixLength: number = DEFAULT_PREFIX_LENGTH
) {}

/**
Expand Down
Loading