Skip to content
This repository has been archived by the owner on May 30, 2022. It is now read-only.

Commit

Permalink
Merge pull request #79 from wibsonorg/df-naming-conventions
Browse files Browse the repository at this point in the history 
Contracts constants now use UPPER_CASE_WITH_UNDERSCORES style
  • Loading branch information
@danielfx90
danielfx90 authored May 16, 2019
2 parents 1f154a7 + 36c495a commit 1dceac8
Show file tree
Hide file tree
Showing 9 changed files with 46 additions and 46 deletions.
10 changes: 5 additions & 5 deletions contracts/Accounts.sol
View file
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ contract Accounts is Data {
function bulkRegister(uint256 bulkSize, bytes32 rootHash) public {
require(bulkSize > 0, "Bulk size can't be zero");
require(bulkSize < params.maxBulk, "Cannot register this number of ids simultaneously");
require(SafeMath.add(accounts.length, bulkSize) <= maxAccountId, "Cannot register: ran out of ids");
require(SafeMath.add(accounts.length, bulkSize) <= MAX_ACCOUNT_ID, "Cannot register: ran out of ids");
require(rootHash > 0, "Root hash can't be zero");

emit BulkRegister(bulkSize, accounts.length, bulkRegistrations.length);
Expand Down Expand Up @@ -97,7 +97,7 @@ contract Accounts is Data {
* @return the id of the new account
*/
function register() public returns (uint32 ret) {
require(accounts.length < maxAccountId, "no more accounts left");
require(accounts.length < MAX_ACCOUNT_ID, "no more accounts left");
ret = (uint32)(accounts.length);
accounts.push(Account(msg.sender, 0, 0));
emit AccountRegistered(ret, msg.sender);
Expand Down Expand Up @@ -127,15 +127,15 @@ contract Accounts is Data {
* @dev Deposit tokens into the BatchPayment contract to enable scalable payments
* @param amount Amount of tokens to deposit on `accountId`. User should have
* enough balance and issue an `approve()` method prior to calling this.
* @param accountId The id of the user account. In case `newAccountFlag` is used,
* @param accountId The id of the user account. In case `NEW_ACCOUNT_FLAG` is used,
* a new account will be registered and the requested amount will be
* deposited in a single operation.
*/
function deposit(uint64 amount, uint256 accountId) external {
require(accountId < accounts.length || accountId == newAccountFlag, "invalid accountId");
require(accountId < accounts.length || accountId == NEW_ACCOUNT_FLAG, "invalid accountId");
require(amount > 0, "amount should be positive");

if (accountId == newAccountFlag) {
if (accountId == NEW_ACCOUNT_FLAG) {
// new account
uint newId = register();
accounts[newId].balance = amount;
Expand Down
6 changes: 3 additions & 3 deletions contracts/Data.sol
View file
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,8 @@ contract Data {
Config public params;
address public owner;

uint public constant maxAccountId = 2**32-1; // Maximum account id (32-bits)
uint public constant newAccountFlag = 2**256-1; // Request registration of new account
uint public constant instantSlot = 32768;
uint public constant MAX_ACCOUNT_ID = 2**32-1; // Maximum account id (32-bits)
uint public constant NEW_ACCOUNT_FLAG = 2**256-1; // Request registration of new account
uint public constant INSTANT_SLOT = 32768;

}
4 changes: 2 additions & 2 deletions contracts/Payments.sol
View file
Original file line number Diff line number Diff line change
Expand Up @@ -236,7 +236,7 @@ contract Payments is Accounts {
uint64 needed = params.collectStake;

// check if this is an instant collect
if (slotId >= instantSlot) {
if (slotId >= INSTANT_SLOT) {
uint64 declaredAmountLessFee = SafeMath.sub64(declaredAmount, fee);
sl.delegateAmount = declaredAmount;
needed = SafeMath.add64(needed, declaredAmountLessFee);
Expand All @@ -260,7 +260,7 @@ contract Payments is Accounts {
balanceSub(delegate, needed);

// Proceed if the user is withdrawing its balance
if (destination != address(0) && slotId >= instantSlot) {
if (destination != address(0) && slotId >= INSTANT_SLOT) {
uint64 toWithdraw = accounts[toAccountId].balance;
accounts[toAccountId].balance = 0;
require(token.transfer(destination, toWithdraw), "transfer failed");
Expand Down
6 changes: 3 additions & 3 deletions lib/bat.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ var abi = require('ethereumjs-abi')

const bytesPerId = 4

var newAccountFlag = new BigNumber(2).pow(256).minus(1)
var NEW_ACCOUNT_FLAG = new BigNumber(2).pow(256).minus(1)

const prefs = {
default: {
Expand Down Expand Up @@ -147,7 +147,7 @@ class BP {
this.unlockBlocks = params[6].toNumber()
this.maxCollectAmount = params[13].toNumber()

this.instantSlot = (await this.bp.instantSlot.call()).toNumber()
this.INSTANT_SLOT = (await this.bp.INSTANT_SLOT.call()).toNumber()
}

async register (addr) {
Expand Down Expand Up @@ -389,7 +389,7 @@ class BP {
}

module.exports = {
newAccountFlag,
NEW_ACCOUNT_FLAG,
BP,
findEvent,
getChallengeData,
Expand Down
2 changes: 1 addition & 1 deletion src/benchmarks.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ async function collect () {
let t3 = await b.collect(id, 2, id2, 2, 3, 100, 2, acc[0])
addStat('collect-empty-withdraw', t3.receipt.gasUsed)

let t7 = await b.collect(id, b.instantSlot, id2, 3, 4, 100, 2, acc[0])
let t7 = await b.collect(id, b.INSTANT_SLOT, id2, 3, 4, 100, 2, acc[0])
addStat('collect-empty-instant-withdraw', t7.receipt.gasUsed)

await utils.skipBlocks(b.challengeBlocks)
Expand Down
4 changes: 2 additions & 2 deletions src/demo.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -156,15 +156,15 @@ async function doStuff () {
let amount = await b.getCollectAmount(i, c, max)
if (i == 3) amount = amount + 100

await b.collect(0, i + b.instantSlot, i, c, max, amount, 1, addr)
await b.collect(0, i + b.INSTANT_SLOT, i, c, max, amount, 1, addr)
}

await b.showBalance()

await skipBlocks(b.challengeBlocks)
console.log('Freeing collect slots')
for (let i = 1; i <= 5; i++) {
await b.freeSlot(0, i + b.instantSlot)
await b.freeSlot(0, i + b.INSTANT_SLOT)
}
await b.showBalance()
} catch (e) {
Expand Down
34 changes: 17 additions & 17 deletions test/test_accounts.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ contract('Accounts', (addr) => {
let a1 = addr[1]

let bp, tAddress, st
const newAccountFlag = new BigNumber(2).pow(256).minus(1)
const NEW_ACCOUNT_FLAG = new BigNumber(2).pow(256).minus(1)

before(async () => {
await utils.skipBlocks(1)
Expand All @@ -35,18 +35,18 @@ contract('Accounts', (addr) => {
it('Should fail on not enough approval', async () => {
const amount = 100
await st.approve(bp.address, amount - 1)
await catchRevert(bp.deposit(amount, newAccountFlag))
await catchRevert(bp.deposit(amount, NEW_ACCOUNT_FLAG))

await st.approve(bp.address, 0)
await catchRevert(bp.deposit(amount, newAccountFlag))
await catchRevert(bp.deposit(amount, NEW_ACCOUNT_FLAG))
})

it('Should accept deposits for new accounts', async () => {
const initial = await st.balanceOf.call(a0)
const amount = 100

let r0 = await st.approve(bp.address, amount)
let r1 = await bp.deposit(amount, newAccountFlag)
let r1 = await bp.deposit(amount, NEW_ACCOUNT_FLAG)

let v0 = await st.balanceOf.call(a0)
let v1 = await st.balanceOf.call(bp.address)
Expand All @@ -60,7 +60,7 @@ contract('Accounts', (addr) => {
const amount = 100

let r0 = await st.approve(bp.address, 2 * amount)
let r1 = await bp.deposit(amount, newAccountFlag)
let r1 = await bp.deposit(amount, NEW_ACCOUNT_FLAG)

let v0 = await bp.balanceOf.call(0)
await bp.deposit(amount, 0)
Expand All @@ -71,7 +71,7 @@ contract('Accounts', (addr) => {
})

it('Should reject 0-token deposits', async () => {
await assertRequire(bp.deposit(0, newAccountFlag), 'amount should be positive')
await assertRequire(bp.deposit(0, NEW_ACCOUNT_FLAG), 'amount should be positive')
})
})

Expand All @@ -80,7 +80,7 @@ contract('Accounts', (addr) => {
const amount = 100

await st.approve(bp.address, amount)
await bp.deposit(amount, newAccountFlag)
await bp.deposit(amount, NEW_ACCOUNT_FLAG)
let id = await bp.getAccountsLength.call()
id = id.toNumber() - 1

Expand All @@ -105,7 +105,7 @@ contract('Accounts', (addr) => {
const amount = 100

await st.approve(bp.address, amount)
await bp.deposit(amount, newAccountFlag)
await bp.deposit(amount, NEW_ACCOUNT_FLAG)
let id = await bp.getAccountsLength.call()
id = id.toNumber() - 1

Expand All @@ -116,10 +116,10 @@ contract('Accounts', (addr) => {
const amount = 100

await st.approve(bp.address, amount)
await bp.deposit(amount, newAccountFlag)
await bp.deposit(amount, NEW_ACCOUNT_FLAG)

let id = await bp.getAccountsLength.call()
id = id.toNumber() - 1 // this is a dangerous way to obtain the ID of the newAccountFlag, as many accounts c
id = id.toNumber() - 1 // this is a dangerous way to obtain the ID of the NEW_ACCOUNT_FLAG, as many accounts c

await bp.withdraw(1, id) // make sure we can actually do a withdraw using a valid id
await catchRevert(bp.withdraw(amount / 2, id + 1)) // try with invalid id
Expand All @@ -129,7 +129,7 @@ contract('Accounts', (addr) => {
const amount = 100

await st.approve(bp.address, amount)
await bp.deposit(amount, newAccountFlag)
await bp.deposit(amount, NEW_ACCOUNT_FLAG)

let id = await bp.getAccountsLength.call()
id = id.toNumber() - 1
Expand All @@ -144,7 +144,7 @@ contract('Accounts', (addr) => {
// const amount = 100;
//
// await st.approve(bp.address, amount);
// await bp.deposit(amount, newAccountFlag);
// await bp.deposit(amount, NEW_ACCOUNT_FLAG);
//
// let id = await bp.getAccountsLength.call();
// id = id.toNumber()-1;
Expand All @@ -166,7 +166,7 @@ contract('Accounts', (addr) => {
const amount = 100

await st.approve(bp.address, amount)
await bp.deposit(amount, newAccountFlag)
await bp.deposit(amount, NEW_ACCOUNT_FLAG)

let id = await bp.getAccountsLength.call()
id = id.toNumber() - 1
Expand All @@ -186,9 +186,9 @@ contract('Accounts', (addr) => {
const amount = 100

await st.approve(bp.address, amount)
let tx1 = await bp.deposit(1, newAccountFlag)
let tx1 = await bp.deposit(1, NEW_ACCOUNT_FLAG)
const v1 = await bp.getAccountsLength.call()
let tx2 = await bp.deposit(1, newAccountFlag)
let tx2 = await bp.deposit(1, NEW_ACCOUNT_FLAG)
const v2 = await bp.getAccountsLength.call()

eventEmitted(tx1, 'AccountRegistered')
Expand Down Expand Up @@ -236,7 +236,7 @@ contract('Accounts', (addr) => {
})

// TODO: check case we run out of ids:
// require(accounts.length + n <= maxAccountId, "Cannot register: ran out of ids");
// require(accounts.length + n <= MAX_ACCOUNT_ID, "Cannot register: ran out of ids");

it('Bulk registration should fail for n == 0', async () => {
let v0 = await bp.getBulkLength.call()
Expand Down Expand Up @@ -272,7 +272,7 @@ contract('Accounts', (addr) => {
})

// TODO: check case we registered a lot of accounts
// accounts.length < maxAccountId, "no more accounts left");
// accounts.length < MAX_ACCOUNT_ID, "no more accounts left");
})

describe('claim', () => {
Expand Down
4 changes: 2 additions & 2 deletions test/test_batpay.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ contract('BatPay', (addr) => {
let a1 = addr[1]

let batPay, tAddress, st
const newAccountFlag = new BigNumber(2).pow(256).minus(1)
const NEW_ACCOUNT_FLAG = new BigNumber(2).pow(256).minus(1)

before(async () => {
let ret = await utils.newInstances()
Expand All @@ -64,7 +64,7 @@ contract('BatPay', (addr) => {
unlockBlocks = params[7].toNumber()
challengeBlocks = params[3].toNumber()
challengeStepBlocks = params[4].toNumber()
instantSlot = (await batPay.instantSlot.call()).toNumber()
INSTANT_SLOT = (await batPay.INSTANT_SLOT.call()).toNumber()
})

it('cannot obtain the balance for invalid id', async () => {
Expand Down
22 changes: 11 additions & 11 deletions test/test_payments.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ contract('Payments', (accounts) => {
let a1 = accounts[1]

let bp, tAddress, st
const newAccountFlag = new BigNumber(2).pow(256).minus(1)
const NEW_ACCOUNT_FLAG = new BigNumber(2).pow(256).minus(1)

before(async function () {
await utils.skipBlocks(1)
Expand Down Expand Up @@ -56,7 +56,7 @@ contract('Payments', (accounts) => {

// put enough funds to transfer and bulk register ids
await st.approve(bp.address, total_amount * 2)
t0 = await bp.deposit(total_amount * 2, newAccountFlag)
t0 = await bp.deposit(total_amount * 2, NEW_ACCOUNT_FLAG)
from_id = await bp.getAccountsLength.call() - 1
v0 = await bp.bulkRegister(list.length, rootHash)

Expand Down Expand Up @@ -181,7 +181,7 @@ contract('Payments', (accounts) => {
it('should reject registerPayment if there are too many payees', async () => {
// NOTE: there are 2 checks that depend on newCount:
// 1. (payData.length-2) / bytesPerId + newCount < maxTransfer = 100000
// 2. accounts.length + newCount < maxAccountId = 2 ** 32
// 2. accounts.length + newCount < MAX_ACCOUNT_ID = 2 ** 32
//
// because 100000 < 2 ** 32 we can only trigger the first condition
let toobig_count = 100000 // this should actually be bp.maxTransfer, however it crashes
Expand Down Expand Up @@ -292,7 +292,7 @@ contract('Payments', (accounts) => {
let mid = userid[1]
let amount = await b.getCollectAmount(mid, 0, maxPayIndex + 1)
let b0 = (await b.balanceOf(mid)).toNumber()
await b.collect(id, b.instantSlot, mid, 0, maxPayIndex + 1, amount, 0, 0)
await b.collect(id, b.INSTANT_SLOT, mid, 0, maxPayIndex + 1, amount, 0, 0)
let b1 = (await b.balanceOf(mid)).toNumber()

assert.equal(b0 + amount, b1)
Expand All @@ -317,7 +317,7 @@ contract('Payments', (accounts) => {

it('should pay fee on instant-collect', async () => {
let mid = userid[3]
let slot = b.instantSlot + 1
let slot = b.INSTANT_SLOT + 1
let amount = await b.getCollectAmount(mid, 0, maxPayIndex + 1)
let fee = Math.floor(amount / 3)
let b0 = (await b.balanceOf(mid)).toNumber()
Expand Down Expand Up @@ -375,7 +375,7 @@ contract('Payments', (accounts) => {

it('should withdraw if requested instant', async () => {
let mid = userid[6]
let slot = b.instantSlot + 2
let slot = b.INSTANT_SLOT + 2
let amount = await b.getCollectAmount(mid, 0, maxPayIndex + 1)
let fee = Math.floor(amount / 3)
let b0 = (await b.balanceOf(mid)).toNumber()
Expand All @@ -398,7 +398,7 @@ contract('Payments', (accounts) => {

it('should reject if payIndex is less or equal to last collected payment ID', async () => {
let collectorAccountId = userid[6]
let slot = b.instantSlot
let slot = b.INSTANT_SLOT
let amount = await b.getCollectAmount(collectorAccountId, 0, maxPayIndex + 1)
let [, , lastCollectedPaymentId] = await b.getAccount(collectorAccountId)

Expand All @@ -407,7 +407,7 @@ contract('Payments', (accounts) => {

it('should reject if payIndex is invalid', async () => {
let collectorId = userid[6]
let slot = b.instantSlot + 2
let slot = b.INSTANT_SLOT + 2
let amount = await b.getCollectAmount(collectorId, 0, maxPayIndex + 1)
let [, , lastCollectedPaymentId] = await b.getAccount(collectorId)
const tooHighPayIndex = (await b.getPaymentsLength()) + 1
Expand All @@ -428,7 +428,7 @@ contract('Payments', (accounts) => {

it('should reject if invalid toAccountId', async () => {
let mid = userid[6]
let slot = b.instantSlot + 2
let slot = b.INSTANT_SLOT + 2
let amount = await b.getCollectAmount(mid, 0, maxPayIndex + 1)
const invalidCollectorId = 123454321
// We need a valid address to sign the collect transaction.
Expand All @@ -442,7 +442,7 @@ contract('Payments', (accounts) => {

it('should reject wrong fromPayIndex / Invalid Signature', async () => {
let collectorId = userid[7]
let slot = b.instantSlot + 2
let slot = b.INSTANT_SLOT + 2
let amount = await b.getCollectAmount(collectorId, 0, maxPayIndex + 1)
const invalidFromPayIndex = 123454321

Expand All @@ -468,7 +468,7 @@ contract('Payments', (accounts) => {
utils.skipBlocks(b.unlockBlocks)

let b0 = (await b.balanceOf(id)).toNumber()
await b.collect(id, b.instantSlot, id, 0, pid+1, stake, 0, 0)
await b.collect(id, b.INSTANT_SLOT, id, 0, pid+1, stake, 0, 0)
let b1 = (await b.balanceOf(id)).toNumber()

assert.isBelow(b1, b0)
Expand Down

0 comments on commit 1dceac8

Please sign in to comment.