Merge pull request #57 from dotbitHQ/feat/validDotbitAliasAddresses

web3max · web-flow · commit d7cb128e21b1 · 2023-08-26T13:31:12.000+08:00
feat: add validDotbitAliasAddresses.
diff --git a/docs/api/dotbit.md b/docs/api/dotbit.md
@@ -26,6 +26,7 @@
 - [profiles(account, key)](#profilesaccount-key)
 - [avatar(account)](#avataraccount)
 - [verifyAddrsByAccount(address, account, subAccount, verifyType)](#verifyaddrsbyaccountaddress-account-subaccount-verifytype)
+- [validDotbitAliasAddresses(account)](#validdotbitaliasaddresses-account)
 
 ## constructor(config)
 To create a new DotBit instance.
@@ -754,3 +755,25 @@ dotbit.verifyAddrsByAccount(
 // The printed result would be like:
 true
 ```
+
+## validDotbitAliasAddresses (account)
+Query the valid alias address using the .bit alias.
+### Parameters
+- account: `string`. a .bit alias.
+### Return Value
+Promise\<`BitKeyInfo[]`>
+### Example
+```javascript
+dotbit.validDotbitAliasAddresses('imac.bit').then(console.log)
+
+// The printed result would be like:
+[
+  {
+    "type":"blockchain",
+    "key_info":{
+      "coin_type":"60",
+      "key":"0x15a33588908cf8edb27d1abe3852bf287abd3891"
+    }
+  }
+]
+```
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "dotbit",
-  "version": "0.4.22",
+  "version": "0.4.23",
   "description": "A complete .bit SDK and utilities in TypeScript",
   "author": "Jeff Jing <https://github.com/zgayjjf>",
   "license": "MIT",
diff --git a/src/DotBit.ts b/src/DotBit.ts
@@ -196,7 +196,15 @@ export class DotBit {
    * @param subAccount
    * @param verifyType default 0 === "owner", 1 === "manager"
    */
-  async verifyAddrsByAccount (address: string, mainAccount: string, subAccount?: string, verifyType?: number){
+  async verifyAddrsByAccount (address: string, mainAccount: string, subAccount?: string, verifyType?: number) {
     return await this.bitIndexer.subAccountVerify(address, mainAccount, subAccount, verifyType)
   }
+
+  /**
+   * Query the valid alias address using the .bit alias.
+   * @param account
+   */
+  async validDotbitAliasAddresses (account: string) {
+    return await this.bitIndexer.validDotbitAliasAddresses(account)
+  }
 }
diff --git a/src/fetchers/BitIndexer.ts b/src/fetchers/BitIndexer.ts
@@ -3,6 +3,7 @@ import {
   BitAccountInfo,
   BitAccountList,
   BitAccountRecord,
+  BitKeyInfo,
   DasAccountRecords,
   DasServerInfo,
   KeyInfo,
@@ -89,4 +90,13 @@ export class BitIndexer {
     }])
       .then(result => result.is_subdid)
   }
+
+  /**
+   * Query the valid alias address using the .bit alias.
+   * @param account
+   */
+  validDotbitAliasAddresses (account: string): Promise<BitKeyInfo[]> {
+    return this.request('das_accountReverseAddress', [{ account }])
+      .then(result => result.list)
+  }
 }
diff --git a/tests/DotBit.test.ts b/tests/DotBit.test.ts
@@ -210,13 +210,15 @@ describe('verifyAddrsByAccount', function () {
     )
     expect(isValid).toBe(true)
   })
+
   it('should work', async function () {
     const isValid = await dotbitTest.verifyAddrsByAccount(
       '0xC72B6f66017246d6A7f159F5C2BF358188AD9ECa',
       'leonx.bit',
     )
     expect(isValid).toBe(true)
   })
+
   it('should work', async function () {
     const isValid = await dotbitTest.verifyAddrsByAccount(
       '0xC72B6f66017246d6A7f159F5C2BF358188AD9ECa',
@@ -225,6 +227,7 @@ describe('verifyAddrsByAccount', function () {
     )
     expect(isValid).toBe(false)
   })
+
   it('should work', async function () {
     const isValid = await dotbitTest.verifyAddrsByAccount(
       '0xC72B6f66017246d6A7f159F5C2BF358188AD9ECa',
@@ -233,13 +236,15 @@ describe('verifyAddrsByAccount', function () {
     )
     expect(isValid).toBe(false)
   })
+
   it('should work', async function () {
     const isValid = await dotbitTest.verifyAddrsByAccount(
       '0xC72B6f66017246d6A7f159F5C2BF358188AD9ECa',
       '123.bit',
     )
     expect(isValid).toBe(false)
   })
+
   it('should work', async function () {
     const isValid = await dotbitTest.verifyAddrsByAccount(
       '0xC72B6f66017246d6A7f159F5C2BF358188AD9ECa',
@@ -250,3 +255,11 @@ describe('verifyAddrsByAccount', function () {
     expect(isValid).toBe(true)
   })
 })
+
+describe('validDotbitAliasAddresses', function () {
+  it('should work', async function () {
+    const addresses = await dotbitProd.validDotbitAliasAddresses('imac.bit')
+    expect(addresses).toBeInstanceOf(Array)
+    expect(addresses.length).toBe(0)
+  })
+})

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "dotbit",`
`3`		`- "version": "0.4.22",`
	`3`	`+ "version": "0.4.23",`
`4`	`4`	`"description": "A complete .bit SDK and utilities in TypeScript",`
`5`	`5`	`"author": "Jeff Jing <https://github.com/zgayjjf>",`
`6`	`6`	`"license": "MIT",`