Skip to content

Commit

Permalink
feat: add useNetworks and useNetworksRelationship hooks (#1297)
Browse files Browse the repository at this point in the history
  • Loading branch information
@chrstph-dvx
chrstph-dvx authored Dec 7, 2023
1 parent 69c6302 commit 755c989
Show file tree
Hide file tree
Showing 8 changed files with 1,049 additions and 117 deletions.
5 changes: 4 additions & 1 deletion packages/arb-token-bridge-ui/jest.config.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,10 @@ const transformNodeModules = [
// The following are dependencies for query-string (https://github.com/sindresorhus/query-string/blob/main/package.json)
'decode-uri-component',
'split-on-first',
'filter-obj'
'filter-obj',
// wagmi
'@wagmi',
'wagmi'
]

module.exports = async function () {
Expand Down
296 changes: 180 additions & 116 deletions packages/arb-token-bridge-ui/src/hooks/__tests__/useArbQueryParams.test.ts
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
/**
* @jest-environment jsdom
*/
import { AmountQueryParam } from '../useArbQueryParams'
import { ChainId, customChainLocalStorageKey } from '../../util/networks'
import { AmountQueryParam, ChainParam } from '../useArbQueryParams'

describe('AmountQueryParam custom encoder and decoder', () => {
describe('encode input field value to query param', () => {
Expand All @@ -11,155 +12,218 @@ describe('AmountQueryParam custom encoder and decoder', () => {
const getEncodeResult = (value: string) => AmountQueryParam.encode(value)

it('should return input field value after encoding', () => {
expect(getEncodeResult('10234')).toBe('10234')
expect(getEncodeResult('12')).toBe('12')

expect(getEncodeResult('1.0234')).toBe('1.0234')
expect(getEncodeResult('0.0234')).toBe('0.0234')
expect(getEncodeResult('0.0')).toBe('0.0')
expect(getEncodeResult('0')).toBe('0')
expect(getEncodeResult('0.000')).toBe('0.000')

expect(getEncodeResult('1,0234')).toBe('1.0234')
expect(getEncodeResult('0,0234')).toBe('0.0234')
expect(getEncodeResult('0,0')).toBe('0.0')
expect(getEncodeResult('0,000')).toBe('0.000')

expect(getEncodeResult('1e1')).toBe('1e1')
expect(getEncodeResult('1.0234e4')).toBe('1.0234e4')
expect(getEncodeResult('1.0234e-4')).toBe('1.0234e-4')
expect(getEncodeResult('1,0234e4')).toBe('1.0234e4')
expect(getEncodeResult('1,0234e-4')).toBe('1.0234e-4')

expect(getEncodeResult('max')).toBe('max')
expect(getEncodeResult('mAx')).toBe('max')
expect(getEncodeResult('MAX')).toBe('max')
expect(getEncodeResult('MAx')).toBe('max')
expect(getEncodeResult('10234')).toEqual('10234')
expect(getEncodeResult('12')).toEqual('12')

expect(getEncodeResult('1.0234')).toEqual('1.0234')
expect(getEncodeResult('0.0234')).toEqual('0.0234')
expect(getEncodeResult('0.0')).toEqual('0.0')
expect(getEncodeResult('0')).toEqual('0')
expect(getEncodeResult('0.000')).toEqual('0.000')

expect(getEncodeResult('1,0234')).toEqual('1.0234')
expect(getEncodeResult('0,0234')).toEqual('0.0234')
expect(getEncodeResult('0,0')).toEqual('0.0')
expect(getEncodeResult('0,000')).toEqual('0.000')

expect(getEncodeResult('1e1')).toEqual('1e1')
expect(getEncodeResult('1.0234e4')).toEqual('1.0234e4')
expect(getEncodeResult('1.0234e-4')).toEqual('1.0234e-4')
expect(getEncodeResult('1,0234e4')).toEqual('1.0234e4')
expect(getEncodeResult('1,0234e-4')).toEqual('1.0234e-4')

expect(getEncodeResult('max')).toEqual('max')
expect(getEncodeResult('mAx')).toEqual('max')
expect(getEncodeResult('MAX')).toEqual('max')
expect(getEncodeResult('MAx')).toEqual('max')
})

it('should return the absolute positive value after encoding', () => {
expect(getEncodeResult('-0.234')).toBe('0.234')
expect(getEncodeResult('-0,234')).toBe('0.234')
expect(getEncodeResult('-0')).toBe('0')
expect(getEncodeResult('-0.123123')).toBe('0.123123')
expect(getEncodeResult('-0,123123')).toBe('0.123123')
expect(getEncodeResult('-1')).toBe('1')
expect(getEncodeResult('-10')).toBe('10')
expect(getEncodeResult('-0.234')).toEqual('0.234')
expect(getEncodeResult('-0,234')).toEqual('0.234')
expect(getEncodeResult('-0')).toEqual('0')
expect(getEncodeResult('-0.123123')).toEqual('0.123123')
expect(getEncodeResult('-0,123123')).toEqual('0.123123')
expect(getEncodeResult('-1')).toEqual('1')
expect(getEncodeResult('-10')).toEqual('10')
})

it('should return an empty string after encoding', () => {
// these should never come into encode from the input[type=number]
// but the tests are here in case we change the input type in the future
expect(getEncodeResult('random')).toBe('')
expect(getEncodeResult('null')).toBe('')
expect(getEncodeResult('1dfk')).toBe('')
expect(getEncodeResult('da24')).toBe('')
expect(getEncodeResult('random')).toEqual('')
expect(getEncodeResult('null')).toEqual('')
expect(getEncodeResult('1dfk')).toEqual('')
expect(getEncodeResult('da24')).toEqual('')

// these should never come into encode from the input[type=number]
// but the tests are here in case we change the input type in the future
expect(getEncodeResult('1.23.0')).toBe('')
expect(getEncodeResult('1,23,0')).toBe('')
expect(getEncodeResult('0,null,123')).toBe('')
expect(getEncodeResult('some, text')).toBe('')
expect(getEncodeResult('1.23.0')).toEqual('')
expect(getEncodeResult('1,23,0')).toEqual('')
expect(getEncodeResult('0,null,123')).toEqual('')
expect(getEncodeResult('some, text')).toEqual('')

// it's a quirk of the number field that these won't trigger a value change
// although the function handles these, if these were input,
// the value of the input will instantly become an empty string, at least it does on Chrome on Mac
expect(getEncodeResult('12--32123-32')).toBe('')
expect(getEncodeResult('--10.23')).toBe('')
expect(getEncodeResult('')).toBe('')
expect(getEncodeResult('12--32123-32')).toEqual('')
expect(getEncodeResult('--10.23')).toEqual('')
expect(getEncodeResult('')).toEqual('')
})

it('should return formatted value after encoding', () => {
expect(getEncodeResult('00.001')).toBe('0.001')
expect(getEncodeResult('0000')).toBe('0')
expect(getEncodeResult('00.000')).toBe('0.000')
expect(getEncodeResult('.1')).toBe('0.1')
expect(getEncodeResult('00002.123')).toBe('2.123')
expect(getEncodeResult('.0234')).toBe('0.0234')
expect(getEncodeResult('123.123000')).toBe('123.123000')

expect(getEncodeResult('00,001')).toBe('0.001')
expect(getEncodeResult('00,000')).toBe('0.000')
expect(getEncodeResult(',1')).toBe('0.1')
expect(getEncodeResult('00002,123')).toBe('2.123')
expect(getEncodeResult(',0234')).toBe('0.0234')
expect(getEncodeResult('123,123000')).toBe('123.123000')
expect(getEncodeResult('00.001')).toEqual('0.001')
expect(getEncodeResult('0000')).toEqual('0')
expect(getEncodeResult('00.000')).toEqual('0.000')
expect(getEncodeResult('.1')).toEqual('0.1')
expect(getEncodeResult('00002.123')).toEqual('2.123')
expect(getEncodeResult('.0234')).toEqual('0.0234')
expect(getEncodeResult('123.123000')).toEqual('123.123000')

expect(getEncodeResult('00,001')).toEqual('0.001')
expect(getEncodeResult('00,000')).toEqual('0.000')
expect(getEncodeResult(',1')).toEqual('0.1')
expect(getEncodeResult('00002,123')).toEqual('2.123')
expect(getEncodeResult(',0234')).toEqual('0.0234')
expect(getEncodeResult('123,123000')).toEqual('123.123000')
})
})

describe('decode query param to input field value', () => {
const getDecodeResult = (value: string) => AmountQueryParam.decode(value)

it('should return the original value after decoding', () => {
expect(getDecodeResult('10234')).toBe('10234')
expect(getDecodeResult('12')).toBe('12')

expect(getDecodeResult('1.0234')).toBe('1.0234')
expect(getDecodeResult('0.0234')).toBe('0.0234')
expect(getDecodeResult('0.0')).toBe('0.0')
expect(getDecodeResult('0')).toBe('0')
expect(getDecodeResult('0.000')).toBe('0.000')

expect(getDecodeResult('1,0234')).toBe('1.0234')
expect(getDecodeResult('0,0234')).toBe('0.0234')
expect(getDecodeResult('0,0')).toBe('0.0')
expect(getDecodeResult('0,000')).toBe('0.000')

expect(getDecodeResult('1e1')).toBe('1e1')
expect(getDecodeResult('1.0234e4')).toBe('1.0234e4')
expect(getDecodeResult('1.0234e-4')).toBe('1.0234e-4')
expect(getDecodeResult('1,0234e4')).toBe('1.0234e4')
expect(getDecodeResult('1,0234e-4')).toBe('1.0234e-4')

expect(getDecodeResult('max')).toBe('max')
expect(getDecodeResult('mAx')).toBe('max')
expect(getDecodeResult('MAX')).toBe('max')
expect(getDecodeResult('MAx')).toBe('max')
expect(getDecodeResult('10234')).toEqual('10234')
expect(getDecodeResult('12')).toEqual('12')

expect(getDecodeResult('1.0234')).toEqual('1.0234')
expect(getDecodeResult('0.0234')).toEqual('0.0234')
expect(getDecodeResult('0.0')).toEqual('0.0')
expect(getDecodeResult('0')).toEqual('0')
expect(getDecodeResult('0.000')).toEqual('0.000')

expect(getDecodeResult('1,0234')).toEqual('1.0234')
expect(getDecodeResult('0,0234')).toEqual('0.0234')
expect(getDecodeResult('0,0')).toEqual('0.0')
expect(getDecodeResult('0,000')).toEqual('0.000')

expect(getDecodeResult('1e1')).toEqual('1e1')
expect(getDecodeResult('1.0234e4')).toEqual('1.0234e4')
expect(getDecodeResult('1.0234e-4')).toEqual('1.0234e-4')
expect(getDecodeResult('1,0234e4')).toEqual('1.0234e4')
expect(getDecodeResult('1,0234e-4')).toEqual('1.0234e-4')

expect(getDecodeResult('max')).toEqual('max')
expect(getDecodeResult('mAx')).toEqual('max')
expect(getDecodeResult('MAX')).toEqual('max')
expect(getDecodeResult('MAx')).toEqual('max')
})

it('should return the absolute positive value after decoding', () => {
expect(getDecodeResult('-0.234')).toBe('0.234')
expect(getDecodeResult('-0')).toBe('0')
expect(getDecodeResult('-0.123123')).toBe('0.123123')
expect(getDecodeResult('-1')).toBe('1')
expect(getDecodeResult('-10')).toBe('10')

expect(getDecodeResult('-0,234')).toBe('0.234')
expect(getDecodeResult('-0,123123')).toBe('0.123123')
expect(getDecodeResult('-0.234')).toEqual('0.234')
expect(getDecodeResult('-0')).toEqual('0')
expect(getDecodeResult('-0.123123')).toEqual('0.123123')
expect(getDecodeResult('-1')).toEqual('1')
expect(getDecodeResult('-10')).toEqual('10')

expect(getDecodeResult('-0,234')).toEqual('0.234')
expect(getDecodeResult('-0,123123')).toEqual('0.123123')
})

it('should return an empty string after decoding', () => {
expect(getDecodeResult('random')).toBe('')
expect(getDecodeResult('null')).toBe('')
expect(getDecodeResult('1dfk')).toBe('')
expect(getDecodeResult('da24')).toBe('')

expect(getDecodeResult('1,23,0')).toBe('')
expect(getDecodeResult('1.23.0')).toBe('')
expect(getDecodeResult('0,null,123')).toBe('')
expect(getDecodeResult('some, text')).toBe('')

expect(getDecodeResult('12--32123-32')).toBe('')
expect(getDecodeResult('--10.23')).toBe('')
expect(getDecodeResult('')).toBe('')
expect(getDecodeResult('random')).toEqual('')
expect(getDecodeResult('null')).toEqual('')
expect(getDecodeResult('1dfk')).toEqual('')
expect(getDecodeResult('da24')).toEqual('')

expect(getDecodeResult('1,23,0')).toEqual('')
expect(getDecodeResult('1.23.0')).toEqual('')
expect(getDecodeResult('0,null,123')).toEqual('')
expect(getDecodeResult('some, text')).toEqual('')

expect(getDecodeResult('12--32123-32')).toEqual('')
expect(getDecodeResult('--10.23')).toEqual('')
expect(getDecodeResult('')).toEqual('')
})

it('should return formatted value after encoding', () => {
expect(getDecodeResult('00.001')).toBe('0.001')
expect(getDecodeResult('0000')).toBe('0')
expect(getDecodeResult('00.000')).toBe('0.000')
expect(getDecodeResult('.1')).toBe('0.1')
expect(getDecodeResult('00002.123')).toBe('2.123')
expect(getDecodeResult('.0234')).toBe('0.0234')
expect(getDecodeResult('123.123000')).toBe('123.123000')

expect(getDecodeResult('00,001')).toBe('0.001')
expect(getDecodeResult('00,000')).toBe('0.000')
expect(getDecodeResult(',1')).toBe('0.1')
expect(getDecodeResult('00002,123')).toBe('2.123')
expect(getDecodeResult(',0234')).toBe('0.0234')
expect(getDecodeResult('123,123000')).toBe('123.123000')
expect(getDecodeResult('00.001')).toEqual('0.001')
expect(getDecodeResult('0000')).toEqual('0')
expect(getDecodeResult('00.000')).toEqual('0.000')
expect(getDecodeResult('.1')).toEqual('0.1')
expect(getDecodeResult('00002.123')).toEqual('2.123')
expect(getDecodeResult('.0234')).toEqual('0.0234')
expect(getDecodeResult('123.123000')).toEqual('123.123000')

expect(getDecodeResult('00,001')).toEqual('0.001')
expect(getDecodeResult('00,000')).toEqual('0.000')
expect(getDecodeResult(',1')).toEqual('0.1')
expect(getDecodeResult('00002,123')).toEqual('2.123')
expect(getDecodeResult(',0234')).toEqual('0.0234')
expect(getDecodeResult('123,123000')).toEqual('123.123000')
})
})
})

describe('ChainParam custom encoder and decoder', () => {
describe('encode chainId to chainId/ChainQueryParam', () => {
it('should return undefined if value is null or undefined', () => {
expect(ChainParam.encode(null)).toBeUndefined()
expect(ChainParam.encode(undefined)).toBeUndefined()
})

it('should return ChainQueryParam if value is a valid chainId', () => {
expect(ChainParam.encode(ChainId.Ethereum)).toEqual('ethereum')
expect(ChainParam.encode(ChainId.ArbitrumOne)).toEqual('arbitrum-one')
expect(ChainParam.encode(ChainId.Goerli)).toEqual('goerli')
expect(ChainParam.encode(ChainId.ArbitrumGoerli)).toEqual(
'arbitrum-goerli'
)
expect(ChainParam.encode(1234567890)).toBeUndefined()
localStorage.setItem(
customChainLocalStorageKey,
JSON.stringify([
{ chainID: '1111111111', name: 'custom 1111111111 chain' }
])
)
expect(ChainParam.encode(1111111111)).toEqual('1111111111')
localStorage.clear()
})
})

describe('decode chainId/ChainQueryParam to chainId', () => {
it('should return undefined if value is null or undefined', () => {
expect(ChainParam.decode(null)).toBeUndefined()
expect(ChainParam.decode(undefined)).toBeUndefined()
})

it('should decode to ChainId if value is a valid ChainQueryParam', () => {
expect(ChainParam.decode('ethereum')).toEqual(ChainId.Ethereum)
expect(ChainParam.decode('arbitrum-one')).toEqual(ChainId.ArbitrumOne)
expect(ChainParam.decode('goerli')).toEqual(ChainId.Goerli)
expect(ChainParam.decode('arbitrum-goerli')).toEqual(
ChainId.ArbitrumGoerli
)
expect(ChainParam.decode('aaa123')).toBeUndefined()
})

it('should decode to ChainId if value is a valid chainId', () => {
function decodeChainId(value: ChainId) {
return ChainParam.decode(value.toString())
}
expect(decodeChainId(ChainId.Ethereum)).toEqual(ChainId.Ethereum)
expect(decodeChainId(ChainId.ArbitrumOne)).toEqual(ChainId.ArbitrumOne)
expect(decodeChainId(ChainId.Goerli)).toEqual(ChainId.Goerli)
expect(decodeChainId(ChainId.ArbitrumGoerli)).toEqual(
ChainId.ArbitrumGoerli
)
expect(ChainParam.decode('1234567890')).toBeUndefined()
localStorage.setItem(
customChainLocalStorageKey,
JSON.stringify([{ chainID: '222222', name: 'custom 222222 chain' }])
)
expect(ChainParam.decode('222222')).toEqual(222222)
localStorage.clear()
})
})
})
Loading

1 comment on commit 755c989

@vercel
Copy link

@vercel vercel bot commented on 755c989 Dec 7, 2023

Choose a reason for hiding this comment

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

Successfully deployed to the following URLs:

arbitrum-token-bridge – ./

arb-token-bridge.vercel.app
arbitrum-token-bridge-offchain-labs.vercel.app
arbitrum-token-bridge-git-master-offchain-labs.vercel.app
bridge.arbitrum.io

Please sign in to comment.