Merge pull request #651 from hhatto/add-interface-for-stoken-owner-of

Add interface of stoken ownerOf

Author: aggre

lib/ethereum/s-tokens/index.spec.ts

@@ -2,12 +2,14 @@ import { ethers } from 'ethers'
 import { createSTokensContract, STokensContract } from '.'
 import { sTokensAbi } from './abi'
 import { createPositionsCaller } from './positions'
+import { createOwnerOfCaller } from './ownerOf'
 import { createRewardsCaller } from './rewards'
 import { createTokenURICaller } from './tokenURI'
 import { createPositionsOfPropertyCaller } from './positionsOfProperty'
 import { createPositionsOfOwnerCaller } from './positionsOfOwner'
 
 jest.mock('./positions')
+jest.mock('./ownerOf')
 jest.mock('./rewards')
 jest.mock('./tokenURI')
 jest.mock('./positionsOfProperty')
@@ -39,6 +41,7 @@ describe('s-tokens/index.ts', () => {
 				const contract = new ethers.Contract(address, [...sTokensAbi], provider)
 				return {
 					positions: createPositionsCaller(contract),
+					ownerOf: createOwnerOfCaller(contract),
 					rewards: createRewardsCaller(contract),
 					tokenURI: createTokenURICaller(contract),
 					positionsOfProperty: createPositionsOfPropertyCaller(contract),

lib/ethereum/s-tokens/index.ts

@@ -3,13 +3,15 @@ import { Provider } from '@ethersproject/abstract-provider'
 import { Signer } from '@ethersproject/abstract-signer'
 import { sTokensAbi } from './abi'
 import { createPositionsCaller, Positions } from './positions'
+import { createOwnerOfCaller } from './ownerOf'
 import { createRewardsCaller, Rewards } from './rewards'
 import { createTokenURICaller, TokenURI } from './tokenURI'
 import { createPositionsOfPropertyCaller } from './positionsOfProperty'
 import { createPositionsOfOwnerCaller } from './positionsOfOwner'
 
 export type STokensContract = {
 	readonly positions: (tokenId: number) => Promise<Positions>
+	readonly ownerOf: (tokenId: number) => Promise<string>
 	readonly rewards: (tokenId: number) => Promise<Rewards>
 	readonly tokenURI: (tokenId: number) => Promise<TokenURI>
 	readonly positionsOfProperty: (
@@ -32,6 +34,7 @@ export const createSTokensContract =
 
 		return {
 			positions: createPositionsCaller(contractClient),
+			ownerOf: createOwnerOfCaller(contractClient),
 			rewards: createRewardsCaller(contractClient),
 			tokenURI: createTokenURICaller(contractClient),
 			positionsOfProperty: createPositionsOfPropertyCaller(contractClient),

lib/ethereum/s-tokens/ownerOf.spec.ts

@@ -0,0 +1,41 @@
+import { createOwnerOfCaller } from './ownerOf'
+
+describe('ownerOf.spec.ts', () => {
+	describe('createOwnerOfCaller', () => {
+		it('call success', async () => {
+			const value = '0x00'
+
+			const contract = {
+				ownerOf: jest
+					.fn()
+					.mockImplementation(async () => Promise.resolve(value)),
+			}
+
+			const expected = '0x00'
+
+			// eslint-disable-next-line @typescript-eslint/no-explicit-any
+			const caller = createOwnerOfCaller(contract as any)
+
+			const result = await caller(1)
+
+			expect(result).toEqual(expected)
+		})
+
+		it('call failure', async () => {
+			const error = 'error'
+
+			const contract = {
+				ownerOf: jest
+					.fn()
+					.mockImplementation(async () => Promise.reject(error)),
+			}
+
+			// eslint-disable-next-line @typescript-eslint/no-explicit-any
+			const caller = createOwnerOfCaller(contract as any)
+
+			const result = await caller(1).catch((err) => err)
+
+			expect(result).toEqual(error)
+		})
+	})
+})

lib/ethereum/s-tokens/ownerOf.ts

@@ -0,0 +1,16 @@
+/* eslint-disable @typescript-eslint/prefer-readonly-parameter-types */
+import { ethers } from 'ethers'
+import { execute, QueryOption } from '../../common/utils/execute'
+
+export type CreateOwnerOfCaller = (
+	contract: ethers.Contract
+) => (tokenId: number) => Promise<string>
+
+export const createOwnerOfCaller: CreateOwnerOfCaller =
+	(contract: ethers.Contract) => async (tokenId: number) =>
+		execute<QueryOption, string>({
+			contract,
+			method: 'ownerOf',
+			args: [String(tokenId)],
+			mutation: false,
+		})