Skip to content

Commit a1c7782

Browse files
b00fb00f
authored
update API docs (#98)
1 parent 4a24820 commit a1c7782

2 files changed

Lines changed: 12 additions & 144 deletions

File tree

‎content/api/grpc.md‎

Lines changed: 6 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -175,10 +175,6 @@ For seamless integration with Pactus, you can use these client libraries:
175175
<a href="#pactus.Wallet.GetWalletInfo">
176176
<span class="rpc-badge"></span> GetWalletInfo</a>
177177
</li>
178-
<li>
179-
<a href="#pactus.Wallet.IsWalletLoaded">
180-
<span class="rpc-badge"></span> IsWalletLoaded</a>
181-
</li>
182178
<li>
183179
<a href="#pactus.Wallet.UpdatePassword">
184180
<span class="rpc-badge"></span> UpdatePassword</a>
@@ -3241,12 +3237,6 @@ maximum number of messages to queue before dropping older ones.
32413237
Message has no fields.
32423238
<h4>PingResponse <span class="badge text-bg-warning fs-6 align-top">Response</span></h4>
32433239

3244-
<table class="table table-bordered table-responsive table-sm">
3245-
<thead>
3246-
<tr><td>Field</td><td>Type</td><td>Description</td></tr>
3247-
</thead>
3248-
<tbody class="table-group-divider">
3249-
</tbody>
32503240
</table>
32513241

32523242
### Utils Service
@@ -3538,7 +3528,8 @@ signing, verification, and other cryptographic operations.</p>
35383528

35393529
#### LoadWallet <span id="pactus.Wallet.LoadWallet" class="rpc-badge"></span>
35403530

3541-
<p>LoadWallet loads an existing wallet with the given name.</p>
3531+
<p>LoadWallet loads an existing wallet with the given name.
3532+
deprecated: It will be removed in a future version.</p>
35423533

35433534
<h4>LoadWalletRequest <span class="badge text-bg-info fs-6 align-top">Request</span></h4>
35443535

@@ -3575,7 +3566,8 @@ signing, verification, and other cryptographic operations.</p>
35753566

35763567
#### UnloadWallet <span id="pactus.Wallet.UnloadWallet" class="rpc-badge"></span>
35773568

3578-
<p>UnloadWallet unloads a currently loaded wallet with the specified name.</p>
3569+
<p>UnloadWallet unloads a currently loaded wallet with the specified name.
3570+
deprecated: It will be removed in a future version.</p>
35793571

35803572
<h4>UnloadWalletRequest <span class="badge text-bg-info fs-6 align-top">Request</span></h4>
35813573

@@ -3612,25 +3604,11 @@ signing, verification, and other cryptographic operations.</p>
36123604

36133605
#### ListWallets <span id="pactus.Wallet.ListWallets" class="rpc-badge"></span>
36143606

3615-
<p>ListWallets returns a list of all available wallets.
3616-
If `include_unloaded` is set, it returns both loaded and unloaded wallets.</p>
3607+
<p>ListWallets returns a list of all available wallets.</p>
36173608

36183609
<h4>ListWalletsRequest <span class="badge text-bg-info fs-6 align-top">Request</span></h4>
36193610

3620-
<table class="table table-bordered table-responsive table-sm">
3621-
<thead>
3622-
<tr><td>Field</td><td>Type</td><td>Description</td></tr>
3623-
</thead>
3624-
<tbody class="table-group-divider">
3625-
<tr>
3626-
<td class="fw-bold">include_unloaded</td>
3627-
<td> bool</td>
3628-
<td>
3629-
Whether to include wallets that exist on disk but are not currently loaded.
3630-
</td>
3631-
</tr>
3632-
</tbody>
3633-
</table>
3611+
Message has no fields.
36343612
<h4>ListWalletsResponse <span class="badge text-bg-warning fs-6 align-top">Response</span></h4>
36353613

36363614
<table class="table table-bordered table-responsive table-sm">
@@ -3741,50 +3719,6 @@ If `include_unloaded` is set, it returns both loaded and unloaded wallets.</p>
37413719
</tbody>
37423720
</table>
37433721

3744-
#### IsWalletLoaded <span id="pactus.Wallet.IsWalletLoaded" class="rpc-badge"></span>
3745-
3746-
<p>IsWalletLoaded checks whether the specified wallet is currently loaded.</p>
3747-
3748-
<h4>IsWalletLoadedRequest <span class="badge text-bg-info fs-6 align-top">Request</span></h4>
3749-
3750-
<table class="table table-bordered table-responsive table-sm">
3751-
<thead>
3752-
<tr><td>Field</td><td>Type</td><td>Description</td></tr>
3753-
</thead>
3754-
<tbody class="table-group-divider">
3755-
<tr>
3756-
<td class="fw-bold">wallet_name</td>
3757-
<td> string</td>
3758-
<td>
3759-
Name of the wallet to check.
3760-
</td>
3761-
</tr>
3762-
</tbody>
3763-
</table>
3764-
<h4>IsWalletLoadedResponse <span class="badge text-bg-warning fs-6 align-top">Response</span></h4>
3765-
3766-
<table class="table table-bordered table-responsive table-sm">
3767-
<thead>
3768-
<tr><td>Field</td><td>Type</td><td>Description</td></tr>
3769-
</thead>
3770-
<tbody class="table-group-divider">
3771-
<tr>
3772-
<td class="fw-bold">wallet_name</td>
3773-
<td> string</td>
3774-
<td>
3775-
Name of the wallet.
3776-
</td>
3777-
</tr>
3778-
<tr>
3779-
<td class="fw-bold">loaded</td>
3780-
<td> bool</td>
3781-
<td>
3782-
True if the wallet is currently loaded.
3783-
</td>
3784-
</tr>
3785-
</tbody>
3786-
</table>
3787-
37883722
#### UpdatePassword <span id="pactus.Wallet.UpdatePassword" class="rpc-badge"></span>
37893723

37903724
<p>UpdatePassword updates the password of an existing wallet.</p>

‎content/api/json-rpc.md‎

Lines changed: 6 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -225,10 +225,6 @@ curl --location 'http://localhost:8545/' \
225225
<a href="#pactus.wallet.get_wallet_info">
226226
<span class="rpc-badge"></span> pactus.wallet.get_wallet_info</a>
227227
</li>
228-
<li>
229-
<a href="#pactus.wallet.is_wallet_loaded">
230-
<span class="rpc-badge"></span> pactus.wallet.is_wallet_loaded</a>
231-
</li>
232228
<li>
233229
<a href="#pactus.wallet.update_password">
234230
<span class="rpc-badge"></span> pactus.wallet.update_password</a>
@@ -3291,12 +3287,6 @@ maximum number of messages to queue before dropping older ones.
32913287
Parameters has no fields.
32923288
<h4>Result</h4>
32933289

3294-
<table class="table table-bordered table-responsive table-sm">
3295-
<thead>
3296-
<tr><td>Field</td><td>Type</td><td>Description</td></tr>
3297-
</thead>
3298-
<tbody class="table-group-divider">
3299-
</tbody>
33003290
</table>
33013291

33023292
### Utils Service
@@ -3588,7 +3578,8 @@ signing, verification, and other cryptographic operations.</p>
35883578

35893579
#### pactus.wallet.load_wallet <span id="pactus.wallet.load_wallet" class="rpc-badge"></span>
35903580

3591-
<p>LoadWallet loads an existing wallet with the given name.</p>
3581+
<p>LoadWallet loads an existing wallet with the given name.
3582+
deprecated: It will be removed in a future version.</p>
35923583

35933584
<h4>Parameters</h4>
35943585

@@ -3625,7 +3616,8 @@ signing, verification, and other cryptographic operations.</p>
36253616

36263617
#### pactus.wallet.unload_wallet <span id="pactus.wallet.unload_wallet" class="rpc-badge"></span>
36273618

3628-
<p>UnloadWallet unloads a currently loaded wallet with the specified name.</p>
3619+
<p>UnloadWallet unloads a currently loaded wallet with the specified name.
3620+
deprecated: It will be removed in a future version.</p>
36293621

36303622
<h4>Parameters</h4>
36313623

@@ -3662,25 +3654,11 @@ signing, verification, and other cryptographic operations.</p>
36623654

36633655
#### pactus.wallet.list_wallets <span id="pactus.wallet.list_wallets" class="rpc-badge"></span>
36643656

3665-
<p>ListWallets returns a list of all available wallets.
3666-
If `include_unloaded` is set, it returns both loaded and unloaded wallets.</p>
3657+
<p>ListWallets returns a list of all available wallets.</p>
36673658

36683659
<h4>Parameters</h4>
36693660

3670-
<table class="table table-bordered table-responsive table-sm">
3671-
<thead>
3672-
<tr><td>Field</td><td>Type</td><td>Description</td></tr>
3673-
</thead>
3674-
<tbody class="table-group-divider">
3675-
<tr>
3676-
<td class="fw-bold">include_unloaded</td>
3677-
<td> boolean</td>
3678-
<td>
3679-
Whether to include wallets that exist on disk but are not currently loaded.
3680-
</td>
3681-
</tr>
3682-
</tbody>
3683-
</table>
3661+
Parameters has no fields.
36843662
<h4>Result</h4>
36853663

36863664
<table class="table table-bordered table-responsive table-sm">
@@ -3791,50 +3769,6 @@ If `include_unloaded` is set, it returns both loaded and unloaded wallets.</p>
37913769
</tbody>
37923770
</table>
37933771

3794-
#### pactus.wallet.is_wallet_loaded <span id="pactus.wallet.is_wallet_loaded" class="rpc-badge"></span>
3795-
3796-
<p>IsWalletLoaded checks whether the specified wallet is currently loaded.</p>
3797-
3798-
<h4>Parameters</h4>
3799-
3800-
<table class="table table-bordered table-responsive table-sm">
3801-
<thead>
3802-
<tr><td>Field</td><td>Type</td><td>Description</td></tr>
3803-
</thead>
3804-
<tbody class="table-group-divider">
3805-
<tr>
3806-
<td class="fw-bold">wallet_name</td>
3807-
<td> string</td>
3808-
<td>
3809-
Name of the wallet to check.
3810-
</td>
3811-
</tr>
3812-
</tbody>
3813-
</table>
3814-
<h4>Result</h4>
3815-
3816-
<table class="table table-bordered table-responsive table-sm">
3817-
<thead>
3818-
<tr><td>Field</td><td>Type</td><td>Description</td></tr>
3819-
</thead>
3820-
<tbody class="table-group-divider">
3821-
<tr>
3822-
<td class="fw-bold">wallet_name</td>
3823-
<td> string</td>
3824-
<td>
3825-
Name of the wallet.
3826-
</td>
3827-
</tr>
3828-
<tr>
3829-
<td class="fw-bold">loaded</td>
3830-
<td> boolean</td>
3831-
<td>
3832-
True if the wallet is currently loaded.
3833-
</td>
3834-
</tr>
3835-
</tbody>
3836-
</table>
3837-
38383772
#### pactus.wallet.update_password <span id="pactus.wallet.update_password" class="rpc-badge"></span>
38393773

38403774
<p>UpdatePassword updates the password of an existing wallet.</p>

0 commit comments

Comments
 (0)