Skip to content

Commit

Permalink
Implement erc20 checks in typescript (#480)
Browse files Browse the repository at this point in the history
  • Loading branch information
@clemire
clemire authored Jul 30, 2024
1 parent ad82c01 commit ef406c0
Show file tree
Hide file tree
Showing 2 changed files with 235 additions and 13 deletions.
47 changes: 43 additions & 4 deletions packages/web3/src/entitlement.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -448,8 +448,16 @@ async function evaluateCheckOperation(
}
case CheckOperationType.ISENTITLED:
throw new Error(`CheckOperationType.ISENTITLED not implemented`)
case CheckOperationType.ERC20:
throw new Error('CheckOperationType.ERC20 not implemented')
case CheckOperationType.ERC20: {
await Promise.all(providers.map((p) => p.ready))
const provider = findProviderFromChainId(providers, operation.chainId)

if (!provider) {
controller.abort()
return zeroAddress
}
return evaluateERC20Operation(operation, controller, provider, linkedWallets)
}
case CheckOperationType.ERC721: {
await Promise.all(providers.map((p) => p.ready))
const provider = findProviderFromChainId(providers, operation.chainId)
Expand Down Expand Up @@ -653,8 +661,39 @@ async function evaluateERC721Operation(
provider: ethers.providers.StaticJsonRpcProvider,
linkedWallets: string[],
): Promise<EntitledWalletOrZeroAddress> {
const contract = new ethers.Contract(
return evaluateContractBalanceAcrossWallets(
operation.contractAddress,
operation.threshold,
controller,
provider,
linkedWallets,
)
}

async function evaluateERC20Operation(
operation: CheckOperation,
controller: AbortController,
provider: ethers.providers.StaticJsonRpcProvider,
linkedWallets: string[],
): Promise<EntitledWalletOrZeroAddress> {
return evaluateContractBalanceAcrossWallets(
operation.contractAddress,
operation.threshold,
controller,
provider,
linkedWallets,
)
}

async function evaluateContractBalanceAcrossWallets(
contractAddress: `0x${string}`,
threshold: bigint,
controller: AbortController,
provider: ethers.providers.StaticJsonRpcProvider,
linkedWallets: string[],
): Promise<EntitledWalletOrZeroAddress> {
const contract = new ethers.Contract(
contractAddress,
['function balanceOf(address) view returns (uint)'],
provider,
)
Expand Down Expand Up @@ -690,7 +729,7 @@ async function evaluateERC721Operation(
ethers.BigNumber.from(0),
)

if (walletsWithAsset.length > 0 && accumulatedBalance.gte(operation.threshold)) {
if (walletsWithAsset.length > 0 && accumulatedBalance.gte(threshold)) {
return walletsWithAsset[0].wallet
} else {
controller.abort()
Expand Down
201 changes: 192 additions & 9 deletions packages/web3/tests/entitlement.test.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ import {
} from '../src/entitlement'
import { MOCK_ADDRESS } from '../src/Utils'
import { zeroAddress } from 'viem'
import { Address } from '../src/ContractTypes'

function makeRandomOperation(depth: number): Operation {
const rand = Math.random()
Expand Down Expand Up @@ -53,8 +54,8 @@ test('random', async () => {
expect(result).toBeDefined()
})

function generateRandomEthAddress(): `0x${string}` {
let address: `0x${string}` = '0x'
function generateRandomEthAddress(): Address {
let address: Address = '0x'
const characters = '0123456789abcdef'
for (let i = 0; i < 40; i++) {
address += characters.charAt(Math.floor(Math.random() * characters.length))
Expand Down Expand Up @@ -102,31 +103,34 @@ const slowTrueCheck: CheckOperation = {
// reproduce the same unit tests here to ensure parity between evaluation in xchain and the
// client.
// Contract addresses for the test NFT contracts.
const SepoliaTestNftContract: `0x${string}` = '0xb088b3f2b35511A611bF2aaC13fE605d491D6C19'
const SepoliaTestNftWallet_1Token: `0x${string}` = '0x1FDBA84c2153568bc22686B88B617CF64cdb0637'
const SepoliaTestNftWallet_3Tokens: `0x${string}` = '0xB79Af997239A334355F60DBeD75bEDf30AcD37bD'
const SepoliaTestNftWallet_2Tokens: `0x${string}` = '0x8cECcB1e5537040Fc63A06C88b4c1dE61880dA4d'
const SepoliaTestNftContract: Address = '0xb088b3f2b35511A611bF2aaC13fE605d491D6C19'
const SepoliaTestNftWallet_1Token: Address = '0x1FDBA84c2153568bc22686B88B617CF64cdb0637'
const SepoliaTestNftWallet_3Tokens: Address = '0xB79Af997239A334355F60DBeD75bEDf30AcD37bD'
const SepoliaTestNftWallet_2Tokens: Address = '0x8cECcB1e5537040Fc63A06C88b4c1dE61880dA4d'

const ethereumSepoliaChainId = 11155111n
const baseSepoliaChainId = 84532n

const nftCheckEthereumSepolia: CheckOperation = {
opType: OperationType.CHECK,
checkType: CheckOperationType.ERC721,
chainId: 11155111n,
chainId: ethereumSepoliaChainId,
contractAddress: SepoliaTestNftContract,
threshold: 1n,
} as const

const nftMultiCheckEthereumSepolia: CheckOperation = {
opType: OperationType.CHECK,
checkType: CheckOperationType.ERC721,
chainId: 11155111n,
chainId: ethereumSepoliaChainId,
contractAddress: SepoliaTestNftContract,
threshold: 6n,
} as const

const nftMultiCheckHighThresholdEthereumSepolia: CheckOperation = {
opType: OperationType.CHECK,
checkType: CheckOperationType.ERC721,
chainId: 11155111n,
chainId: ethereumSepoliaChainId,
contractAddress: SepoliaTestNftContract,
threshold: 100n,
} as const
Expand Down Expand Up @@ -261,6 +265,185 @@ test.each(nftCases)('erc721Check - $desc', async (props) => {
}
})

// These are the addresses of the chain link test contract on base sepolia and ethereum sepolia.
const baseSepoliaChainLinkContract: Address = '0xE4aB69C077896252FAFBD49EFD26B5D171A32410'
const ethSepoliaChainLinkContract: Address = '0x779877A7B0D9E8603169DdbD7836e478b4624789'

// The following are the addresses of the wallets that hold the chain link tokens for testing.
// Some wallet addresses are duplicated for the sake of self-documenting variable names.
const sepoliaChainLinkWallet_50Link: Address = '0x4BCfC6962Ab0297aF801da21216014F53B46E991'
const sepoliaChainLinkWallet_25Link: Address = '0xa4D440AeA5F555feEB5AEa0ddcED6e1B9FaD6A9C'
const baseSepoliaChainLinkWallet_50Link: Address = '0x4BCfC6962Ab0297aF801da21216014F53B46E991'
const baseSepoliaChainLinkWallet_25Link: Address = '0xa4D440AeA5F555feEB5AEa0ddcED6e1B9FaD6A9C'
const testEmptyAccount: Address = '0xb227905F186095083869928BAb49cA9CE9546817'

const chainlinkExp = BigInt(10) ** BigInt(18)

const erc20ChainLinkCheckBaseSepolia_20Tokens: CheckOperation = {
opType: OperationType.CHECK,
checkType: CheckOperationType.ERC20,
chainId: 84532n,
contractAddress: baseSepoliaChainLinkContract,
threshold: 20n * chainlinkExp,
}

const erc20ChainLinkCheckBaseSepolia_30Tokens: CheckOperation = {
...erc20ChainLinkCheckBaseSepolia_20Tokens,
threshold: 30n * chainlinkExp,
}

const erc20ChainLinkCheckBaseSepolia_75Tokens: CheckOperation = {
...erc20ChainLinkCheckBaseSepolia_20Tokens,
threshold: 75n * chainlinkExp,
}

const erc20ChainLinkCheckBaseSepolia_90Tokens: CheckOperation = {
...erc20ChainLinkCheckBaseSepolia_20Tokens,
threshold: 90n * chainlinkExp,
}

const erc20ChainLinkEthereumSepolia_20Tokens: CheckOperation = {
opType: OperationType.CHECK,
checkType: CheckOperationType.ERC20,
chainId: ethereumSepoliaChainId,
contractAddress: ethSepoliaChainLinkContract,
threshold: 20n * chainlinkExp,
}

const erc20ChainLinkCheckEthereumSepolia_30Tokens: CheckOperation = {
...erc20ChainLinkEthereumSepolia_20Tokens,
threshold: 30n * chainlinkExp,
}

const erc20ChainLinkCheckEthereumSepolia_75Tokens: CheckOperation = {
...erc20ChainLinkEthereumSepolia_20Tokens,
threshold: 75n * chainlinkExp,
}

const erc20ChainLinkCheckEthereumSepolia_90Tokens: CheckOperation = {
...erc20ChainLinkEthereumSepolia_20Tokens,
threshold: 90n * chainlinkExp,
}

const erc20Cases = [
{
desc: 'base sepolia (empty wallet, false)',
check: erc20ChainLinkCheckBaseSepolia_20Tokens,
wallets: [testEmptyAccount],
provider: baseSepoliaProvider,
expectedResult: false,
},
{
desc: 'base sepolia (single wallet)',
check: erc20ChainLinkCheckBaseSepolia_20Tokens,
wallets: [baseSepoliaChainLinkWallet_25Link],
provider: baseSepoliaProvider,
expectedResult: true,
},
{
desc: 'base sepolia (two wallets)',
check: erc20ChainLinkCheckBaseSepolia_20Tokens,
wallets: [baseSepoliaChainLinkWallet_25Link, testEmptyAccount],
provider: baseSepoliaProvider,
expectedResult: true,
},
{
desc: 'base sepolia (false)',
check: erc20ChainLinkCheckBaseSepolia_30Tokens,
wallets: [baseSepoliaChainLinkWallet_25Link],
provider: baseSepoliaProvider,
expectedResult: false,
},
{
desc: 'base sepolia (two wallets, false)',
check: erc20ChainLinkCheckBaseSepolia_30Tokens,
wallets: [baseSepoliaChainLinkWallet_25Link, testEmptyAccount],
provider: baseSepoliaProvider,
expectedResult: false,
},
{
desc: 'base sepolia (two nonempty wallets, true)',
check: erc20ChainLinkCheckBaseSepolia_30Tokens,
wallets: [baseSepoliaChainLinkWallet_25Link, baseSepoliaChainLinkWallet_50Link],
provider: baseSepoliaProvider,
expectedResult: true,
},
{
desc: 'base sepolia (two nonempty wallets, exact balance - true)',
check: erc20ChainLinkCheckBaseSepolia_75Tokens,
wallets: [baseSepoliaChainLinkWallet_25Link, baseSepoliaChainLinkWallet_50Link],
provider: baseSepoliaProvider,
expectedResult: true,
},
{
desc: 'base sepolia (two nonempty wallets, false)',
check: erc20ChainLinkCheckBaseSepolia_90Tokens,
wallets: [baseSepoliaChainLinkWallet_25Link, baseSepoliaChainLinkWallet_50Link],
provider: baseSepoliaProvider,
expectedResult: false,
},
{
desc: 'eth sepolia (empty wallet, false)',
check: erc20ChainLinkCheckEthereumSepolia_30Tokens,
wallets: [testEmptyAccount],
provider: ethSepoliaProvider,
expectedResult: false,
},
{
desc: 'eth sepolia (single wallet)',
check: erc20ChainLinkCheckBaseSepolia_20Tokens,
wallets: [sepoliaChainLinkWallet_25Link],
provider: ethSepoliaProvider,
expectedResult: true,
},
{
desc: 'eth sepolia (two wallets)',
check: erc20ChainLinkCheckBaseSepolia_20Tokens,
wallets: [sepoliaChainLinkWallet_25Link, testEmptyAccount],
provider: ethSepoliaProvider,
expectedResult: true,
},
{
desc: 'eth sepolia (false)',
check: erc20ChainLinkCheckBaseSepolia_30Tokens,
wallets: [sepoliaChainLinkWallet_25Link],
provider: ethSepoliaProvider,
expectedResult: false,
},
{
desc: 'eth sepolia (two wallets, false)',
check: erc20ChainLinkCheckBaseSepolia_30Tokens,
wallets: [sepoliaChainLinkWallet_25Link, testEmptyAccount],
provider: ethSepoliaProvider,
expectedResult: false,
},
{
desc: 'eth sepolia (two nonempty wallets, exact balance - true)',
check: erc20ChainLinkCheckEthereumSepolia_75Tokens,
wallets: [sepoliaChainLinkWallet_25Link, sepoliaChainLinkWallet_50Link],
provider: ethSepoliaProvider,
expectedResult: true,
},
{
desc: 'eth sepolia (two nonempty wallets, false)',
check: erc20ChainLinkCheckEthereumSepolia_90Tokens,
wallets: [sepoliaChainLinkWallet_25Link, sepoliaChainLinkWallet_50Link],
provider: ethSepoliaProvider,
expectedResult: false,
},
]

test.each(erc20Cases)('erc20Check - $desc', async (props) => {
const { check, wallets, provider, expectedResult } = props
const controller = new AbortController()
const result = await evaluateTree(controller, wallets, [provider], check)
if (expectedResult) {
expect(result).toBeTruthy()
} else {
expect(result).toEqual(zeroAddress)
}
})

/*
["andOperation", trueCheck, trueCheck, true],
["andOperation", falseCheck, falseCheck, false],
Expand Down

0 comments on commit ef406c0

Please sign in to comment.