@ensdomains/ensjs 3.0.0-beta.1 → 3.0.0-beta.3

package/src/functions/public/getAbiRecord.test.ts

@@ -1,174 +0,0 @@
-import { publicClient } from '../../tests/addTestContracts.js'
-import getAbiRecord from './getAbiRecord.js'
-
-const dummyABI = [
-  {
-    type: 'event',
-    anonymous: false,
-    name: 'ABIChanged',
-    inputs: [
-      {
-        type: 'bytes32',
-        indexed: true,
-      },
-      {
-        type: 'uint256',
-        indexed: true,
-      },
-    ],
-  },
-  {
-    type: 'event',
-    anonymous: false,
-    name: 'VersionChanged',
-    inputs: [
-      {
-        type: 'bytes32',
-        indexed: true,
-      },
-      {
-        type: 'uint64',
-      },
-    ],
-  },
-  {
-    type: 'function',
-    name: 'ABI',
-    constant: true,
-    stateMutability: 'view',
-    payable: false,
-    inputs: [
-      {
-        type: 'bytes32',
-      },
-      {
-        type: 'uint256',
-      },
-    ],
-    outputs: [
-      {
-        type: 'uint256',
-      },
-      {
-        type: 'bytes',
-      },
-    ],
-  },
-  {
-    type: 'function',
-    name: 'clearRecords',
-    constant: false,
-    payable: false,
-    inputs: [
-      {
-        type: 'bytes32',
-      },
-    ],
-    outputs: [],
-  },
-  {
-    type: 'function',
-    name: 'recordVersions',
-    constant: true,
-    stateMutability: 'view',
-    payable: false,
-    inputs: [
-      {
-        type: 'bytes32',
-      },
-    ],
-    outputs: [
-      {
-        type: 'uint64',
-      },
-    ],
-  },
-  {
-    type: 'function',
-    name: 'setABI',
-    constant: false,
-    payable: false,
-    inputs: [
-      {
-        type: 'bytes32',
-      },
-      {
-        type: 'uint256',
-      },
-      {
-        type: 'bytes',
-      },
-    ],
-    outputs: [],
-  },
-  {
-    type: 'function',
-    name: 'supportsInterface',
-    constant: true,
-    stateMutability: 'view',
-    payable: false,
-    inputs: [
-      {
-        type: 'bytes4',
-      },
-    ],
-    outputs: [
-      {
-        type: 'bool',
-      },
-    ],
-  },
-]
-
-describe('getAbiRecord()', () => {
-  it('should return object for type 1 abi', async () => {
-    const result = await getAbiRecord(publicClient, {
-      name: 'with-type-1-abi.eth',
-    })
-    expect(result).toBeTruthy()
-    if (result) {
-      expect(result.contentType).toBe(1)
-      expect(result.decoded).toBe(true)
-      expect(result.abi).toMatchObject(dummyABI)
-    }
-  })
-  it('should return object for type 2 ABI', async () => {
-    const result = await getAbiRecord(publicClient, {
-      name: 'with-type-2-abi.eth',
-    })
-    expect(result).toBeTruthy()
-    if (result) {
-      expect(result.contentType).toBe(2)
-      expect(result.decoded).toBe(true)
-      expect(result.abi).toMatchObject(dummyABI)
-    }
-  })
-  it('should return object for type 4 ABI', async () => {
-    const result = await getAbiRecord(publicClient, {
-      name: 'with-type-4-abi.eth',
-    })
-    expect(result).toBeTruthy()
-    if (result) {
-      expect(result.contentType).toBe(4)
-      expect(result.decoded).toBe(true)
-      expect(result.abi).toMatchObject(dummyABI)
-    }
-  })
-  it('should return unresolved URI for type 8 ABI', async () => {
-    const result = await getAbiRecord(publicClient, {
-      name: 'with-type-8-abi.eth',
-    })
-    expect(result).toBeTruthy()
-    if (result) {
-      expect(result.contentType).toBe(8)
-      expect(result.decoded).toBe(true)
-      expect(result.abi).toBe('https://example.com')
-    }
-  })
-  it('should return undefined if unsupported contentType', async () => {
-    const result = await getAbiRecord(publicClient, {
-      name: 'with-type-256-abi.eth',
-    })
-    expect(result).toBeNull()
-  })
-})

package/src/functions/public/getAddressRecord.test.ts

@@ -1,83 +0,0 @@
-import { createPublicClient, http } from 'viem'
-import { mainnet } from 'viem/chains'
-import { addEnsContracts } from '../../contracts/addEnsContracts.js'
-import { publicClient } from '../../tests/addTestContracts.js'
-import getAddressRecord from './getAddressRecord.js'
-
-const mainnetPublicClient = createPublicClient({
-  chain: addEnsContracts(mainnet),
-  transport: http('https://web3.ens.domains/v1/mainnet'),
-})
-
-describe('getAddressRecord()', () => {
-  it('returns the ETH record when no coin is provided', async () => {
-    const result = await getAddressRecord(publicClient, {
-      name: 'with-profile.eth',
-    })
-    expect(result).toMatchInlineSnapshot(`
-      {
-        "id": 60,
-        "name": "ETH",
-        "value": "0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC",
-      }
-    `)
-  })
-  it('should return the correct address based on a coin ID input as a number', async () => {
-    const result = await getAddressRecord(publicClient, {
-      name: 'with-profile.eth',
-      coin: 61,
-    })
-    expect(result).toMatchInlineSnapshot(`
-      {
-        "id": 61,
-        "name": "ETC_LEGACY",
-        "value": "0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC",
-      }
-    `)
-  })
-  it('should return the correct address based on a coin ID input as a string', async () => {
-    const result = await getAddressRecord(publicClient, {
-      name: 'with-profile.eth',
-      coin: '61',
-    })
-    expect(result).toMatchInlineSnapshot(`
-      {
-        "id": 61,
-        "name": "ETC_LEGACY",
-        "value": "0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC",
-      }
-    `)
-  })
-  it('should return the correct address based on a coin name', async () => {
-    const result = await getAddressRecord(publicClient, {
-      name: 'with-profile.eth',
-      coin: 'ETC_LEGACY',
-    })
-    expect(result).toMatchInlineSnapshot(`
-      {
-        "id": 61,
-        "name": "ETC_LEGACY",
-        "value": "0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC",
-      }
-    `)
-  })
-  it('should return null for a non-existent coin', async () => {
-    const result = await getAddressRecord(publicClient, {
-      name: 'with-profile.eth',
-      coin: 'BNB',
-    })
-    expect(result).toBeNull()
-  })
-  it('should return value for label > 255 bytes', async () => {
-    const result = await getAddressRecord(mainnetPublicClient, {
-      name: `696969696969696969696969696969696969696969696969696969696969696969696969696969696969696969696969696969696969696969696969696969696969696969696969696969696969696969696969696969696969696969696969696969696969696969696969696969696969696969696969696969696969696969696969696969696969696969696969696969696969696969696969696969696969696969696969696969696969696969696969696969696969696969696969696969696969696969696969696969696969.eth`,
-    })
-    expect(result).toMatchInlineSnapshot(`
-      {
-        "id": 60,
-        "name": "ETH",
-        "value": "0xde9ba5F62D6047C4a9cCF24455AA733cCC5B8F41",
-      }
-    `)
-  })
-})

package/src/functions/public/getAvailable.test.ts

@@ -1,17 +0,0 @@
-import { publicClient } from '../../tests/addTestContracts.js'
-import getAvailable from './getAvailable.js'
-
-describe('getAvailable', () => {
-  it('should return false for a name that is unavailable', async () => {
-    const result = await getAvailable(publicClient, { name: 'test123.eth' })
-    expect(typeof result).toBe('boolean')
-    expect(result).toBe(false)
-  })
-  it('should return true for a name that is available', async () => {
-    const result = await getAvailable(publicClient, {
-      name: 'available-name.eth',
-    })
-    expect(typeof result).toBe('boolean')
-    expect(result).toBe(true)
-  })
-})

package/src/functions/public/getContentHashRecord.test.ts

@@ -1,28 +0,0 @@
-import { publicClient } from '../../tests/addTestContracts.js'
-import getContentHashRecord from './getContentHashRecord.js'
-
-describe('getContentHashRecord', () => {
-  it('should return null for a non-existent name', async () => {
-    const result = await getContentHashRecord(publicClient, {
-      name: 'test123123cool.eth',
-    })
-    expect(result).toBeNull()
-  })
-  it('should return null for a name with no contenthash record', async () => {
-    const result = await getContentHashRecord(publicClient, {
-      name: 'with-profile.eth',
-    })
-    expect(result).toBeNull()
-  })
-  it('should return the contenthash for a name with the record set', async () => {
-    const result = await getContentHashRecord(publicClient, {
-      name: 'with-contenthash.eth',
-    })
-    expect(result).toMatchInlineSnapshot(`
-      {
-        "decoded": "bafybeico3uuyj3vphxpvbowchdwjlrlrh62awxscrnii7w7flu5z6fk77y",
-        "protocolType": "ipfs",
-      }
-    `)
-  })
-})

package/src/functions/public/getExpiry.test.ts

@@ -1,48 +0,0 @@
-import { publicClient } from '../../tests/addTestContracts.js'
-import getExpiry from './getExpiry.js'
-
-describe('getExpiry', () => {
-  it('should get the expiry for a .eth name with no other args', async () => {
-    const result = await getExpiry(publicClient, { name: 'with-profile.eth' })
-    expect(result).toBeTruthy()
-    if (result) {
-      const { expiry, gracePeriod, status } = result
-      expect(expiry.date).toBeInstanceOf(Date)
-      expect(typeof expiry.value).toBe('bigint')
-      expect(gracePeriod).toBe(7776000)
-      expect(status).toBe('active')
-    }
-  })
-  it('should get the expiry for a wrapped name', async () => {
-    const result = await getExpiry(publicClient, {
-      name: 'wrapped.eth',
-      contract: 'nameWrapper',
-    })
-
-    expect(result).toBeTruthy()
-    if (result) {
-      const { expiry, gracePeriod, status } = result
-      expect(expiry.date).toBeInstanceOf(Date)
-      expect(typeof expiry.value).toBe('bigint')
-      expect(gracePeriod).toBe(0)
-      expect(status).toBe('active')
-    }
-  })
-  it('should return null for a non .eth name if not wrapped', async () => {
-    const result = await getExpiry(publicClient, {
-      name: 'sub.with-profile.eth',
-    })
-    expect(result).toBeNull()
-  })
-  it('should throw an error for a non .eth name if registrar is specified', async () => {
-    try {
-      await getExpiry(publicClient, {
-        name: 'sub.with-profile.eth',
-        contract: 'registrar',
-      })
-      expect(false).toBeTruthy()
-    } catch {
-      expect(true).toBeTruthy()
-    }
-  })
-})

package/src/functions/public/getName.test.ts

@@ -1,66 +0,0 @@
-import type { Address, Hex } from 'viem'
-import {
-  deploymentAddresses,
-  publicClient,
-  testClient,
-  waitForTransaction,
-  walletClient,
-} from '../../tests/addTestContracts.js'
-import setPrimaryName from '../wallet/setPrimaryName.js'
-import getName from './getName.js'
-
-let snapshot: Hex
-let accounts: Address[]
-
-beforeAll(async () => {
-  accounts = await walletClient.getAddresses()
-})
-
-beforeEach(async () => {
-  snapshot = await testClient.snapshot()
-})
-
-afterEach(async () => {
-  await testClient.revert({ id: snapshot })
-})
-
-describe('getName', () => {
-  it('should get a primary name from an address', async () => {
-    const result = await getName(publicClient, {
-      address: '0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC',
-    })
-    expect(result).toMatchInlineSnapshot(`
-      {
-        "match": true,
-        "name": "with-profile.eth",
-        "resolverAddress": "${deploymentAddresses.LegacyPublicResolver}",
-        "reverseResolverAddress": "${deploymentAddresses.PublicResolver}",
-      }
-    `)
-  })
-  it('should return null for an address with no primary name', async () => {
-    const result = await getName(publicClient, {
-      address: '0x8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0',
-    })
-    expect(result).toBeNull()
-  })
-  it('should return with a false match for a name with no forward resolution', async () => {
-    const tx = await setPrimaryName(walletClient, {
-      name: 'with-profile.eth',
-      account: accounts[0],
-    })
-    await waitForTransaction(tx)
-
-    const result = await getName(publicClient, {
-      address: accounts[0],
-    })
-    expect(result).toMatchInlineSnapshot(`
-      {
-        "match": false,
-        "name": "with-profile.eth",
-        "resolverAddress": "${deploymentAddresses.LegacyPublicResolver}",
-        "reverseResolverAddress": "${deploymentAddresses.PublicResolver}",
-      }
-    `)
-  })
-})

package/src/functions/public/getOwner.test.ts

@@ -1,87 +0,0 @@
-import {
-  deploymentAddresses,
-  publicClient,
-} from '../../tests/addTestContracts.js'
-import getOwner from './getOwner.js'
-
-describe('getOwner', () => {
-  it('should return correct ownership level and values for a wrapped .eth name', async () => {
-    const result = await getOwner(publicClient, { name: 'wrapped.eth' })
-    expect(result).toMatchInlineSnapshot(`
-      {
-        "owner": "0x70997970C51812dc3A010C7d01b50e0d17dc79C8",
-        "ownershipLevel": "nameWrapper",
-      }
-    `)
-  })
-  it('should return correct ownership level and values for an expired wrapped .eth name', async () => {
-    const result = await getOwner(publicClient, { name: 'expired-wrapped.eth' })
-    expect(result).toMatchInlineSnapshot(`
-      {
-        "owner": "${deploymentAddresses.NameWrapper}",
-        "ownershipLevel": "registrar",
-        "registrant": null,
-      }
-    `)
-    // expect(result).toEqual({
-    //   ownershipLevel: 'nameWrapper',
-    //   owner: '0x0000000000000000000000000000000000000000',
-    //   expired: true,
-    // })
-  })
-  it('should return correct ownership level and values for an unwrapped .eth name', async () => {
-    const result = await getOwner(publicClient, { name: 'test123.eth' })
-    expect(result).toMatchInlineSnapshot(`
-      {
-        "owner": "0x70997970C51812dc3A010C7d01b50e0d17dc79C8",
-        "ownershipLevel": "registrar",
-        "registrant": "0x70997970C51812dc3A010C7d01b50e0d17dc79C8",
-      }
-    `)
-  })
-  it('should return correct ownership level and values for an expired unwrapped .eth name', async () => {
-    const result = await getOwner(publicClient, { name: 'expired.eth' })
-    expect(result).toMatchInlineSnapshot(`
-      {
-        "owner": "0x70997970C51812dc3A010C7d01b50e0d17dc79C8",
-        "ownershipLevel": "registrar",
-        "registrant": null,
-      }
-    `)
-  })
-  describe('subname', () => {
-    it('should return correct ownership level and values for a unwrapped name', async () => {
-      const result = await getOwner(publicClient, {
-        name: 'test.with-subnames.eth',
-      })
-      expect(result).toMatchInlineSnapshot(`
-        {
-          "owner": "0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC",
-          "ownershipLevel": "registry",
-        }
-      `)
-    })
-    it('should return correct ownership level and values for a wrapped name', async () => {
-      const result = await getOwner(publicClient, {
-        name: 'test.wrapped-with-subnames.eth',
-      })
-      expect(result).toMatchInlineSnapshot(`
-        {
-          "owner": "0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC",
-          "ownershipLevel": "nameWrapper",
-        }
-      `)
-    })
-    it('should return correct ownership level and values for an expired wrapped name', async () => {
-      const result = await getOwner(publicClient, {
-        name: 'test.expired-wrapped.eth',
-      })
-      expect(result).toMatchInlineSnapshot(`
-        {
-          "owner": "0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC",
-          "ownershipLevel": "nameWrapper",
-        }
-      `)
-    })
-  })
-})

package/src/functions/public/getPrice.test.ts

@@ -1,45 +0,0 @@
-import { publicClient } from '../../tests/addTestContracts.js'
-import getPrice from './getPrice.js'
-
-const yearCost = BigInt('8561643835626')
-
-describe('getPrice', () => {
-  it('should return a base and premium price for a name', async () => {
-    const result = await getPrice(publicClient, {
-      nameOrNames: 'test123.eth',
-      duration: 86400,
-    })
-    expect(result).toBeTruthy()
-    if (result) {
-      const { base, premium } = result
-      expect(base).toBe(yearCost)
-      expect(premium).toBe(0n)
-    }
-  })
-
-  it('should return a base and premium price for an array of names', async () => {
-    const result = await getPrice(publicClient, {
-      nameOrNames: ['test123.eth', 'to-be-renewed.eth'],
-      duration: 86400,
-    })
-    expect(result).toBeTruthy()
-    if (result) {
-      const { base, premium } = result
-      expect(base).toBe(yearCost * 2n)
-      expect(premium).toBe(0n)
-    }
-  })
-
-  it('should allow labels as inputs', async () => {
-    const result = await getPrice(publicClient, {
-      nameOrNames: 'test123',
-      duration: 86400,
-    })
-    expect(result).toBeTruthy()
-    if (result) {
-      const { base, premium } = result
-      expect(base).toBe(yearCost)
-      expect(premium).toBe(0n)
-    }
-  })
-})

package/src/functions/public/getRecords.test.ts

@@ -1,49 +0,0 @@
-import {
-  deploymentAddresses,
-  publicClient,
-} from '../../tests/addTestContracts.js'
-import getRecords from './getRecords.js'
-
-describe('getRecords()', () => {
-  it('works', async () => {
-    const result = await getRecords(publicClient, {
-      name: 'with-profile.eth',
-      records: {
-        texts: ['description', 'url'],
-        coins: ['60', 'ETC_LEGACY', '0'],
-      },
-    })
-    expect(result).toMatchInlineSnapshot(`
-      {
-        "coins": [
-          {
-            "id": 60,
-            "name": "ETH",
-            "value": "0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC",
-          },
-          {
-            "id": 61,
-            "name": "ETC_LEGACY",
-            "value": "0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC",
-          },
-          {
-            "id": 0,
-            "name": "BTC",
-            "value": "bc1qjqg9slurvjukfl92wp58y94480fvh4uc2pwa6n",
-          },
-        ],
-        "resolverAddress": "${deploymentAddresses.LegacyPublicResolver}",
-        "texts": [
-          {
-            "key": "description",
-            "value": "Hello2",
-          },
-          {
-            "key": "url",
-            "value": "twitter.com",
-          },
-        ],
-      }
-    `)
-  })
-})

package/src/functions/public/getResolver.test.ts

@@ -1,12 +0,0 @@
-import {
-  deploymentAddresses,
-  publicClient,
-} from '../../tests/addTestContracts.js'
-import getResolver from './getResolver.js'
-
-describe('getResolver', () => {
-  it('should find the resolver for a name with a resolver', async () => {
-    const result = await getResolver(publicClient, { name: 'with-profile.eth' })
-    expect(result).toBe(deploymentAddresses.LegacyPublicResolver)
-  })
-})

package/src/functions/public/getTextRecord.test.ts

@@ -1,20 +0,0 @@
-import { publicClient } from '../../tests/addTestContracts.js'
-import getTextRecord from './getTextRecord.js'
-
-describe('getTextRecord()', () => {
-  it('should return a record from a key', async () => {
-    const result = await getTextRecord(publicClient, {
-      name: 'with-profile.eth',
-      key: 'description',
-    })
-    expect(result).toBe('Hello2')
-  })
-
-  it('should return null for a non-existent key', async () => {
-    const result = await getTextRecord(publicClient, {
-      name: 'with-profile.eth',
-      key: 'thiskeydoesntexist',
-    })
-    expect(result).toBeNull()
-  })
-})