Skip to content

Commit 349f26f

Browse files
web3maxweb3max
committed
fix: API Url.
1 parent 1303bad commit 349f26f

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

65 files changed

+2761
-7336
lines changed

‎README.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
<p align="center">
2-
<a href="https://did.id/">
2+
<a href="https://d.id/">
33
<img width="1000" src="/docs/dotbit-banner.png">
44
</a>
55
</p>
66
<h1 align="center">Dotbit.js</h2>
7-
<p align="center">The Official <a href="https://did.id/">.bit</a> JavaScript SDK provided by .bit team.</p>
7+
<p align="center">The Official <a href="https://d.id/">.bit</a> JavaScript SDK provided by .bit team.</p>
88
<div align="center">
99

1010
![NPM](https://img.shields.io/npm/l/dotbit) ![npm](https://img.shields.io/npm/v/dotbit)
@@ -26,11 +26,11 @@
2626
## Features
2727
- Query .bit account info (e.g. **owner, manager, status**, etc.)
2828
- Query .bit account records (e.g. **addresses, profiles, dwebs and custom data**.)
29-
- Enable .bit [SubDID](https://www.did.id/subdid) for a specific account.
30-
- **Mint a SubDID** of a .bit main account.
31-
- Query all the SubDIDs of a .bit main account.
32-
- Manage the **ownership** of a .bit account(SubDID included).
33-
- Manage the **records** of a .bit account(SubDID included).
29+
- Enable .bit [Second-level DID](https://d.id/did-as-a-service) for a specific account.
30+
- **Mint a Second-level DID** of a .bit main account.
31+
- Query all the Second-level DIDs of a .bit main account.
32+
- Manage the **ownership** of a .bit account(Second-level DID included).
33+
- Manage the **records** of a .bit account(Second-level DID included).
3434
- **Register a .bit account** with CKB.
3535

3636
## Getting Started
@@ -66,16 +66,15 @@ A sample result would be like:
6666
```javascript
6767
{
6868
account: 'imac.bit',
69-
account_alias: 'imac.bit',
7069
account_id_hex: '0x5728088435fb8788472a9ca601fbc0b9cbea8be3',
7170
next_account_id_hex: '0x57280ab92f213d74c7a185e9b9d26d0a795108de',
7271
create_at_unix: 1671164348,
7372
expired_at_unix: 1702700348,
7473
status: 0,
7574
das_lock_arg_hex: '0x05b2be2887a26f44555835eeacc47d65b88b6b42c205b2be2887a26f44555835eeacc47d65b88b6b42c2',
76-
owner_algorithm_id: 5,
75+
owner_algorithm_id: 17000,
7776
owner_key: '0xb2be2887a26f44555835eeacc47d65b88b6b42c2',
78-
manager_algorithm_id: 5,
77+
manager_algorithm_id: 17000,
7978
manager_key: '0xb2be2887a26f44555835eeacc47d65b88b6b42c2',
8079
enable_sub_account: 0
8180
}

‎docs/api/bit-account.md

Lines changed: 34 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@
66
- [bitBuilder](#bitbuilder)
77
- [signer](#signer)
88
- [status](#status)
9-
- [enableSubAccount()](#enablesubaccount)
109
- [subAccounts(params)](#subaccountsparams)
1110
- [checkSubAccounts(subAccounts)](#checksubaccountssubaccounts)
1211
- [mintSubAccounts(params)](#mintsubaccountsparams)
@@ -125,15 +124,14 @@ N/A
125124
`BitSigner`
126125
### Example
127126
```javascript
128-
const { EthersSigner } = require('../../lib/index')
129-
const { ethers, Wallet } = require('ethers')
130-
const { createInstance } = require('dotbit')
127+
const { Wallet, QuickNodeProvider } = require('ethers')
128+
const { createInstance, EvmSigner } = require('dotbit')
131129

132130
const privateKey = "INPUT_YOUR_PRIVATE_KEY_HERE";
133131

134-
const provider = new ethers.providers.InfuraProvider()
132+
const provider = new QuickNodeProvider()
135133
const wallet = new Wallet(privateKey, provider)
136-
const signer = new EthersSigner(wallet)
134+
const signer = new EvmSigner(wallet)
137135
const dotbit = createInstance({
138136
signer: signer
139137
})
@@ -166,36 +164,6 @@ console.log(account.status)
166164
6 // AccountStatus
167165
```
168166

169-
## enableSubAccount()
170-
To enable sub-accounts of a main account.
171-
> Note: This is a write API, which means you need to set up a signer before calling it. See example below for how to set up a signer.
172-
### Parameters
173-
N/A
174-
### Return Value
175-
Promise<{ hash?: `string`, hash_list: `string[]` }>
176-
### Example
177-
```javascript
178-
const { EthersSigner } = require('../../lib/index')
179-
const { ethers, Wallet } = require('ethers')
180-
181-
const privateKey = "INPUT_YOUR_PRIVATE_KEY_HERE";
182-
183-
const provider = new ethers.providers.InfuraProvider()
184-
const wallet = new Wallet(privateKey, provider)
185-
const signer = new EthersSigner(wallet)
186-
187-
const account = new BitAccount({account: 'imac.bit', signer});
188-
// To enable sub-accounts of 'imac.bit'.
189-
const result = await account.enableSubAccount()
190-
console.log(result)
191-
192-
// ...
193-
// The printed result would be like:
194-
{
195-
hash: '0xadc19c5a8bd9ce963cbfc876e55a9f11b0518073114ceb967d521e695d8b41a4'
196-
}
197-
```
198-
199167
## subAccounts(params)
200168
List the sub accounts of a main account, with pagination and filter.
201169
### Parameters
@@ -280,7 +248,7 @@ const result = await account.checkSubAccounts(subAccounts)
280248
## mintSubAccounts(params)
281249
To mint multiple sub-accounts for a BitAccount instance.
282250
> Note: This is a write API, which means you need to set up a signer before calling it. See example below for how to set up a signer.
283-
> Note: Currently, SubDID is fully available in testnet, and need whitelist on mainnet. If you would like to distribute SubDIDs on mainnet, please email [email protected] with a brief description of your project.
251+
> Note: Currently, Second-level DID is fully available in testnet, and need whitelist on mainnet. If you would like to distribute Second-level DIDs on mainnet, please email [email protected] with a brief description of your project.
284252
### Parameters
285253
- params: `SubAccountParams[]`
286254
- account: `string`,
@@ -291,15 +259,14 @@ To mint multiple sub-accounts for a BitAccount instance.
291259
Promise<{ hash?: `string`, hash_list: `string[]` }>
292260
### Example
293261
```javascript
294-
const { EthersSigner } = require('../../lib/index')
295-
const { ethers, Wallet } = require('ethers')
296-
const { createInstance } = require('dotbit')
262+
const { Wallet, QuickNodeProvider } = require('ethers')
263+
const { createInstance, EvmSigner } = require('dotbit')
297264

298265
const privateKey = "INPUT_YOUR_PRIVATE_KEY_HERE";
299266

300-
const provider = new ethers.providers.InfuraProvider()
267+
const provider = new QuickNodeProvider()
301268
const wallet = new Wallet(privateKey, provider)
302-
const signer = new EthersSigner(wallet)
269+
const signer = new EvmSigner(wallet)
303270
const dotbit = createInstance({
304271
signer: signer
305272
})
@@ -336,7 +303,7 @@ console.log(result);
336303
## mintSubAccount(params)
337304
To mint a sub-account for a BitAccount instance.
338305
> Note: This is a write API, which means you need to set up a signer before calling it. See example below for how to set up a signer.
339-
> Note: Currently, SubDID is fully available in testnet, and need whitelist on mainnet. If you would like to distribute SubDIDs on mainnet, please email [email protected] with a brief description of your project.
306+
> Note: Currently, Second-level DID is fully available in testnet, and need whitelist on mainnet. If you would like to distribute Second-level DIDs on mainnet, please email [email protected] with a brief description of your project.
340307
### Parameters
341308
- params: `SubAccountParams`
342309
- account: `string`,
@@ -347,15 +314,14 @@ To mint a sub-account for a BitAccount instance.
347314
Promise<{ hash?: `string`, hash_list: `string[]` }>
348315
### Example
349316
```javascript
350-
const { EthersSigner } = require('../../lib/index')
351-
const { ethers, Wallet } = require('ethers')
352-
const { createInstance } = require('dotbit')
317+
const { Wallet, QuickNodeProvider } = require('ethers')
318+
const { createInstance, EvmSigner } = require('dotbit')
353319

354320
const privateKey = "INPUT_YOUR_PRIVATE_KEY_HERE";
355321

356-
const provider = new ethers.providers.InfuraProvider()
322+
const provider = new QuickNodeProvider()
357323
const wallet = new Wallet(privateKey, provider)
358-
const signer = new EthersSigner(wallet)
324+
const signer = new EvmSigner(wallet)
359325
const dotbit = createInstance({
360326
signer: signer
361327
})
@@ -390,15 +356,14 @@ To change the owner of a BitAccount instance.
390356
Promise<{ hash?: `string`, hash_list: `string[]` }>
391357
### Example
392358
```javascript
393-
const { EthersSigner } = require('../../lib/index')
394-
const { ethers, Wallet } = require('ethers')
395-
const { createInstance } = require('dotbit')
359+
const { Wallet, QuickNodeProvider } = require('ethers')
360+
const { createInstance, EvmSigner } = require('dotbit')
396361

397362
const privateKey = "INPUT_YOUR_PRIVATE_KEY_HERE";
398363

399-
const provider = new ethers.providers.InfuraProvider()
364+
const provider = new QuickNodeProvider()
400365
const wallet = new Wallet(privateKey, provider)
401-
const signer = new EthersSigner(wallet)
366+
const signer = new EvmSigner(wallet)
402367

403368
const dotbit = createInstance({
404369
signer: signer
@@ -428,15 +393,14 @@ To change the manager of a BitAccount instance.
428393
Promise<{ hash?: `string`, hash_list: `string[]` }>
429394
### Example
430395
```javascript
431-
const { EthersSigner } = require('../../lib/index')
432-
const { ethers, Wallet } = require('ethers')
433-
const { createInstance } = require('dotbit')
396+
const { Wallet, QuickNodeProvider } = require('ethers')
397+
const { createInstance, EvmSigner } = require('dotbit')
434398

435399
const privateKey = "INPUT_YOUR_PRIVATE_KEY_HERE";
436400

437-
const provider = new ethers.providers.InfuraProvider()
401+
const provider = new QuickNodeProvider()
438402
const wallet = new Wallet(privateKey, provider)
439-
const signer = new EthersSigner(wallet)
403+
const signer = new EvmSigner(wallet)
440404
const dotbit = createInstance({
441405
signer: signer
442406
})
@@ -468,15 +432,14 @@ To update all records of a BitAccount instance.
468432
Promise<{ hash?: `string`, hash_list: `string[]` }>
469433
### Example
470434
```javascript
471-
const { EthersSigner } = require('../../lib/index')
472-
const { ethers, Wallet } = require('ethers')
473-
const { createInstance } = require('dotbit')
435+
const { Wallet, QuickNodeProvider } = require('ethers')
436+
const { createInstance, EvmSigner } = require('dotbit')
474437

475438
const privateKey = "INPUT_YOUR_PRIVATE_KEY_HERE";
476439

477-
const provider = new ethers.providers.InfuraProvider()
440+
const provider = new QuickNodeProvider()
478441
const wallet = new Wallet(privateKey, provider)
479-
const signer = new EthersSigner(wallet)
442+
const signer = new EvmSigner(wallet)
480443
const dotbit = createInstance({
481444
signer: signer
482445
})
@@ -505,15 +468,14 @@ N/A
505468
### Return Value
506469
`RecordsEditor`
507470
```javascript
508-
const { EthersSigner } = require('../../lib/index')
509-
const { ethers, Wallet } = require('ethers')
510-
const { createInstance } = require('dotbit')
471+
const { Wallet, QuickNodeProvider } = require('ethers')
472+
const { createInstance, EvmSigner } = require('dotbit')
511473

512474
const privateKey = "INPUT_YOUR_PRIVATE_KEY_HERE";
513475

514-
const provider = new ethers.providers.InfuraProvider()
476+
const provider = new QuickNodeProvider()
515477
const wallet = new Wallet(privateKey, provider)
516-
const signer = new EthersSigner(wallet)
478+
const signer = new EvmSigner(wallet)
517479

518480
const dotbit = createInstance({
519481
signer: signer,
@@ -548,7 +510,6 @@ N/A
548510
### Return Value
549511
Promise\<AccountInfo>
550512
- account: `string`,
551-
- account_alias: `string`,
552513
- account_id_hex: `string`,
553514
- next_account_id_hex: `string`,
554515
- create_at_unix: `number`,
@@ -572,16 +533,15 @@ account.info().then(console.log)
572533
// The printed result would be like:
573534
{
574535
account: 'imac.bit',
575-
account_alias: 'imac.bit',
576536
account_id_hex: '0x5728088435fb8788472a9ca601fbc0b9cbea8be3',
577537
next_account_id_hex: '0x57280ab92f213d74c7a185e9b9d26d0a795108de',
578538
create_at_unix: 1671164348,
579539
expired_at_unix: 1702700348,
580540
status: 0,
581541
das_lock_arg_hex: '0x05b2be2887a26f44555835eeacc47d65b88b6b42c205b2be2887a26f44555835eeacc47d65b88b6b42c2',
582-
owner_algorithm_id: 5,
542+
owner_algorithm_id: 17000,
583543
owner_key: '0xb2be2887a26f44555835eeacc47d65b88b6b42c2',
584-
manager_algorithm_id: 5,
544+
manager_algorithm_id: 17000,
585545
manager_key: '0xb2be2887a26f44555835eeacc47d65b88b6b42c2',
586546
enable_sub_account: 0
587547
}
@@ -609,7 +569,7 @@ account.owner().then(console.log)
609569
{
610570
key: '0xb2be2887a26f44555835eeacc47d65b88b6b42c2',
611571
coin_type: '60',
612-
algorithm_id: 5
572+
algorithm_id: 17000
613573
}
614574
```
615575

@@ -635,7 +595,7 @@ account.manager().then(console.log)
635595
{
636596
key: '0xb2be2887a26f44555835eeacc47d65b88b6b42c2',
637597
coin_type: '60',
638-
algorithm_id: 5
598+
algorithm_id: 17000
639599
}
640600
```
641601

‎docs/api/bit-subaccount.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ BitSubAccount {
3737
```
3838

3939
## mainAccount
40-
To get the main account of a SubDID.
40+
To get the main account of a Second-level DID.
4141
### Parameters
4242
N/A
4343
### Return Value
@@ -54,7 +54,7 @@ makeafriend.bit
5454
```
5555

5656
## changeOwner(keyInfo)
57-
To change the owner of a SubDID.
57+
To change the owner of a Second-level DID.
5858
> Note: This is a write API, which means you need to set up a signer before calling it. See example below for how to set up a signer.
5959
### Parameters
6060
- keyInfo: `KeyInfo`
@@ -64,14 +64,14 @@ To change the owner of a SubDID.
6464
Promise<{ hash?: `string`, hash_list: `string[]` }>
6565
### Example
6666
```javascript
67-
const { EthersSigner } = require('../../lib/index')
68-
const { ethers, Wallet } = require('ethers')
67+
const { Wallet, QuickNodeProvider } = require('ethers')
68+
const { EvmSigner } = require('dotbit')
6969

7070
const privateKey = "INPUT_YOUR_PRIVATE_KEY_HERE";
7171

72-
const provider = new ethers.providers.InfuraProvider()
72+
const provider = new QuickNodeProvider()
7373
const wallet = new Wallet(privateKey, provider)
74-
const signer = new EthersSigner(wallet)
74+
const signer = new EvmSigner(wallet)
7575

7676
const subAccount = new BitSubAccount({account: 'jeff.makeafriend.bit', signer});
7777
const result = await subAccount.changeOwner({
@@ -88,7 +88,7 @@ console.log(result);
8888
```
8989

9090
## changeManager(keyInfo)
91-
To change the manager of a SubDID.
91+
To change the manager of a Second-level DID.
9292
> Note: This is a write API, which means you need to set up a signer before calling it. See example below for how to set up a signer.
9393
### Parameters
9494
- keyInfo: `KeyInfo`
@@ -98,14 +98,14 @@ To change the manager of a SubDID.
9898
Promise<{ hash?: `string`, hash_list: `string[]` }>
9999
### Example
100100
```javascript
101-
const { EthersSigner } = require('../../lib/index')
102-
const { ethers, Wallet } = require('ethers')
101+
const { EvmSigner } = require('dotbit')
102+
const { Wallet, QuickNodeProvider } = require('ethers')
103103

104104
const privateKey = "INPUT_YOUR_PRIVATE_KEY_HERE";
105105

106-
const provider = new ethers.providers.InfuraProvider()
106+
const provider = new QuickNodeProvider()
107107
const wallet = new Wallet(privateKey, provider)
108-
const signer = new EthersSigner(wallet)
108+
const signer = new EvmSigner(wallet)
109109

110110
const subAccount = new BitSubAccount({account: 'jeff.makeafriend.bit', signer});
111111
const result = await subAccount.changeManager({
@@ -122,7 +122,7 @@ console.log(result);
122122
```
123123

124124
## updateRecords(records)
125-
To update all records of a SubDID.
125+
To update all records of a Second-level DID.
126126
> Note: This is a write API, which means you need to set up a signer before calling it. See example below for how to set up a signer.
127127
> Note: The existing records will be erased.
128128
### Parameters
@@ -135,14 +135,14 @@ To update all records of a SubDID.
135135
Promise<{ hash?: `string`, hash_list: `string[]` }>
136136
### Example
137137
```javascript
138-
const { EthersSigner } = require('../../lib/index')
139-
const { ethers, Wallet } = require('ethers')
138+
const { EvmSigner } = require('dotbit')
139+
const { Wallet, QuickNodeProvider } = require('ethers')
140140

141141
const privateKey = "INPUT_YOUR_PRIVATE_KEY_HERE";
142142

143-
const provider = new ethers.providers.InfuraProvider()
143+
const provider = new QuickNodeProvider()
144144
const wallet = new Wallet(privateKey, provider)
145-
const signer = new EthersSigner(wallet)
145+
const signer = new EvmSigner(wallet)
146146

147147
const subAccount = new BitSubAccount({account: 'jeff.makeafriend.bit', signer});
148148
const result = await subAccount.updateRecords([{

0 commit comments

Comments
 (0)