Merge pull request #55 from dotbitHQ/feat/subaccount-check

web3max · web-flow · commit 8495d5d13b51 · 2023-07-07T12:43:52.000+08:00
feat: add verifyAddrsByAccount method on DotBit
diff --git a/docs/api/dotbit.md b/docs/api/dotbit.md
@@ -25,6 +25,7 @@
 - [dweb(account)](#dwebaccount)
 - [profiles(account, key)](#profilesaccount-key)
 - [avatar(account)](#avataraccount)
+- [verifyAddrsByAccount(address, account, subAccount, verifyType)](#verifyaddrsbyaccountaddress-account-subaccount-verifytype)
 
 ## constructor(config)
 To create a new DotBit instance.
@@ -720,3 +721,36 @@ Get the avatar of a given account.
 - account: `string`
 
 For details, please refer to the documentation of [@dotbit/plugin-avatar](https://github.com/mozwell/dotbit.js/blob/main/packages/plugin-avatar/README.md)
+
+## verifyAddrsByAccount(address, account, subAccount, verifyType)
+Check if the given address has the specified SubDID under the account.
+### Parameters
+- address: `string` Address to be verified.
+- account: `string` Specified .bit account.
+- (Optional)subAccount: `string` Specified SubDID. `subAccount` is an optional field. If subAccount is empty, it will default to checking if the given address has at least one SubDID under any specified account.
+- (Optional)verifyType: `number` The `verifyType` is an optional field with a default value of 0, where 0 represents that the `address` is the owner address of the SubDID, and 1 represents that the `address` is the manager address of the SubDID.
+### Return Value
+Promise\<`boolean`>
+### Example
+```javascript
+// Check if the owner address has the SubDID 'leon.leonx.bit' under the account 'leonx.bit'.
+dotbit.verifyAddrsByAccount(
+  '0xC72B6f66017246d6A7f159F5C2BF358188AD9ECa',
+  'leonx.bit',
+  'leon.leonx.bit',
+)
+
+// The printed result would be like:
+true
+
+// Check if the manager address has any SubDID under the account 'leonx.bit'.
+dotbit.verifyAddrsByAccount(
+  '0xC72B6f66017246d6A7f159F5C2BF358188AD9ECa',
+  'leonx.bit',
+  null,
+  1
+)
+
+// The printed result would be like:
+true
+```
diff --git a/src/DotBit.ts b/src/DotBit.ts
@@ -188,4 +188,15 @@ export class DotBit {
 
     return await bitAccount.avatar()
   }
+
+  /**
+   * Check if the address has the specified SubDID under the designated account.
+   * @param address
+   * @param account
+   * @param subAccount
+   * @param verifyType default 0 === "owner", 1 === "manager"
+   */
+  async verifyAddrsByAccount (address: string, account: string, subAccount?: string, verifyType?: number){
+    return await this.bitIndexer.subAccountVerify(address, account, subAccount, verifyType)
+  }
 }
diff --git a/src/fetchers/BitIndexer.ts b/src/fetchers/BitIndexer.ts
@@ -72,4 +72,21 @@ export class BitIndexer {
     }])
       .then(result => result.account_list.map(item => item.account))
   }
+
+  /**
+   * Check if the address has the specified SubDID under the designated account.
+   * @param address
+   * @param account
+   * @param subAccount
+   * @param verifyType default 0 === "owner", 1 === "manager"
+   */
+  subAccountVerify (address: string, account: string, subAccount?: string, verifyType?: number): Promise<boolean> {
+    return this.request('das_subAccountVerify', [{
+      address,
+      account,
+      sub_account: subAccount,
+      verify_type: verifyType ? 1 : 0,
+    }])
+      .then(result => result.is_subdid)
+  }
 }
diff --git a/tests/DotBit.test.ts b/tests/DotBit.test.ts
@@ -4,6 +4,13 @@ import { CoinType } from '../src/const'
 import { DotBit } from '../src/DotBit'
 import { BitPluginBase } from '../src/types'
 import { dotbitProd } from './common/index'
+import { BitIndexer } from '../src/fetchers/BitIndexer'
+
+const dotbitTest = new DotBit({
+  bitIndexer: new BitIndexer({
+    uri: 'https://test-indexer.did.id',
+  })
+})
 
 describe('serverInfo', function () {
   it('work', async function () {
@@ -193,3 +200,53 @@ describe('addrs', function () {
     expect(addrs.length).toBe(1)
   }, 10000)
 })
+
+describe('verifyAddrsByAccount', function () {
+  it('should work', async function () {
+    const isValid = await dotbitTest.verifyAddrsByAccount(
+      '0xC72B6f66017246d6A7f159F5C2BF358188AD9ECa',
+      'leonx.bit',
+      'leon.leonx.bit',
+    )
+    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',
+      'leonx.bit',
+      'leon123123.leonx.bit',
+    )
+    expect(isValid).toBe(false)
+  })
+  it('should work', async function () {
+    const isValid = await dotbitTest.verifyAddrsByAccount(
+      '0xC72B6f66017246d6A7f159F5C2BF358188AD9ECa',
+      '123.bit',
+      '123.123.bit',
+    )
+    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',
+      'leonx.bit',
+      null,
+      1
+    )
+    expect(isValid).toBe(true)
+  })
+})
