Merge pull request #777 from dev-protocol/get_balances

getBalances in Property.sol

Author: Akira-Taniguchi

lib/l2/property/getBalances.spec.ts

@@ -0,0 +1,50 @@
+import { BigNumber } from 'ethers'
+import { createGetBalancesCaller } from './getBalances'
+
+describe('GetBalances.spec.ts', () => {
+	describe('createGetBalancesCaller', () => {
+		it('call success', async () => {
+			const value = [
+				{ account: '0x0', balance: BigNumber.from(1) },
+				{ account: '0x1', balance: BigNumber.from(2) },
+				{ account: '0x2', balance: BigNumber.from(3) },
+			]
+
+			const propertyContract = {
+				getBalances: jest
+					.fn()
+					.mockImplementation(async () => Promise.resolve(value)),
+			}
+
+			const expected = [
+				{ account: '0x0', balance: '1' },
+				{ account: '0x1', balance: '2' },
+				{ account: '0x2', balance: '3' },
+			]
+
+			// eslint-disable-next-line @typescript-eslint/no-explicit-any
+			const caller = createGetBalancesCaller(propertyContract as any)
+
+			const result = await caller()
+
+			expect(result).toEqual(expected)
+		})
+
+		it('call failure', async () => {
+			const error = 'error'
+
+			const propertyContract = {
+				getBalances: jest
+					.fn()
+					.mockImplementation(async () => Promise.reject(error)),
+			}
+
+			// eslint-disable-next-line @typescript-eslint/no-explicit-any
+			const caller = createGetBalancesCaller(propertyContract as any)
+
+			const result = await caller().catch((err) => err)
+
+			expect(result).toEqual(error)
+		})
+	})
+})

lib/l2/property/getBalances.ts

@@ -0,0 +1,22 @@
+import { ethers } from 'ethers'
+import { always } from 'ramda'
+import { execute, QueryOption } from '../../common/utils/execute'
+
+export type PropertyBalance = Readonly<{
+	readonly account: string
+	readonly balance: string
+}>
+
+export type CreateGetBalancesCaller = (
+	contract: ethers.Contract
+) => () => Promise<readonly PropertyBalance[]>
+
+export const createGetBalancesCaller: CreateGetBalancesCaller =
+	(contract: ethers.Contract) =>
+		always(
+			execute<QueryOption, readonly PropertyBalance[]>({
+				contract,
+				method: 'getBalances',
+				mutation: false,
+			})
+		)

lib/l2/property/index.spec.ts

@@ -13,6 +13,7 @@ import { createTransferFromCaller } from '../../common/erc20/transferFrom'
 import { createBalanceOfCaller } from './../../common/erc20/balanceOf'
 import { createApproveCaller } from './../../common/erc20/approve'
 import { createAllowanceCaller } from './../../common/erc20/allowance'
+import { createGetBalancesCaller } from './getBalances'
 
 jest.mock('./../../ethereum/property/author')
 jest.mock('./../../ethereum/property/changeName')
@@ -26,6 +27,7 @@ jest.mock('../../common/erc20/transferFrom')
 jest.mock('./../../common/erc20/balanceOf')
 jest.mock('./../../common/erc20/approve')
 jest.mock('./../../common/erc20/allowance')
+jest.mock('./getBalances')
 
 describe('property/index.ts', () => {
 	;(createAuthorCaller as jest.Mock).mockImplementation((contract) => contract)
@@ -56,6 +58,7 @@ describe('property/index.ts', () => {
 	;(createAllowanceCaller as jest.Mock).mockImplementation(
 		(contract) => contract
 	)
+	;(createGetBalancesCaller as jest.Mock).mockImplementation((contract) => contract)
 	describe('createPropertyContract', () => {
 		it('check return object', () => {
 			const host = 'localhost'
@@ -83,6 +86,7 @@ describe('property/index.ts', () => {
 					author: createAuthorCaller(contract),
 					changeName: createChangeNameCaller(contract),
 					changeSymbol: createChangeSymbolCaller(contract),
+					getBalances: createGetBalancesCaller(contract),
 					contract: () => contract,
 				}
 			}

lib/l2/property/index.ts

@@ -5,6 +5,10 @@ import { propertyAbi } from './abi'
 import { createAuthorCaller } from './../../ethereum/property/author'
 import { createChangeNameCaller } from './../../ethereum/property/changeName'
 import { createChangeSymbolCaller } from './../../ethereum/property/changeSymbol'
+import {
+	createGetBalancesCaller,
+	PropertyBalance,
+} from './getBalances'
 import { createTransferCaller } from './../../common/erc20/transfer'
 import { createNameCaller } from './../../common/erc20/name'
 import { createSymbolCaller } from './../../common/erc20/symbol'
@@ -50,6 +54,7 @@ export type PropertyContract = {
 		nextSymbol: string,
 		overrides?: FallbackableOverrides
 	) => Promise<TransactionResponse>
+	readonly getBalances: () => Promise<readonly PropertyBalance[]>
 	readonly contract: () => ethers.Contract
 }
 
@@ -75,6 +80,7 @@ export const createPropertyContract: CreatePropertyContract =
 			author: createAuthorCaller(contract),
 			changeName: createChangeNameCaller(contract),
 			changeSymbol: createChangeSymbolCaller(contract),
+			getBalances: createGetBalancesCaller(contract),
 			contract: always(contract),
 		}
 	}