Skip to content

update API docs #98

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
b00f merged 1 commit into from
Jan 22, 2026
Merged

update API docs #98

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
78 changes: 6 additions & 72 deletions content/api/grpc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,10 +175,6 @@ For seamless integration with Pactus, you can use these client libraries:
<a href="#pactus.Wallet.GetWalletInfo">
<span class="rpc-badge"></span> GetWalletInfo</a>
</li>
<li>
<a href="#pactus.Wallet.IsWalletLoaded">
<span class="rpc-badge"></span> IsWalletLoaded</a>
</li>
<li>
<a href="#pactus.Wallet.UpdatePassword">
<span class="rpc-badge"></span> UpdatePassword</a>
Expand Down Expand Up @@ -3241,12 +3237,6 @@ maximum number of messages to queue before dropping older ones.
Message has no fields.
<h4>PingResponse <span class="badge text-bg-warning fs-6 align-top">Response</span></h4>

<table class="table table-bordered table-responsive table-sm">
<thead>
<tr><td>Field</td><td>Type</td><td>Description</td></tr>
</thead>
<tbody class="table-group-divider">
</tbody>
</table>

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

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

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

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

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

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

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

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

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

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

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

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

<table class="table table-bordered table-responsive table-sm">
<thead>
<tr><td>Field</td><td>Type</td><td>Description</td></tr>
</thead>
<tbody class="table-group-divider">
<tr>
<td class="fw-bold">include_unloaded</td>
<td> bool</td>
<td>
Whether to include wallets that exist on disk but are not currently loaded.
</td>
</tr>
</tbody>
</table>
Message has no fields.
<h4>ListWalletsResponse <span class="badge text-bg-warning fs-6 align-top">Response</span></h4>

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

#### IsWalletLoaded <span id="pactus.Wallet.IsWalletLoaded" class="rpc-badge"></span>

<p>IsWalletLoaded checks whether the specified wallet is currently loaded.</p>

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

<table class="table table-bordered table-responsive table-sm">
<thead>
<tr><td>Field</td><td>Type</td><td>Description</td></tr>
</thead>
<tbody class="table-group-divider">
<tr>
<td class="fw-bold">wallet_name</td>
<td> string</td>
<td>
Name of the wallet to check.
</td>
</tr>
</tbody>
</table>
<h4>IsWalletLoadedResponse <span class="badge text-bg-warning fs-6 align-top">Response</span></h4>

<table class="table table-bordered table-responsive table-sm">
<thead>
<tr><td>Field</td><td>Type</td><td>Description</td></tr>
</thead>
<tbody class="table-group-divider">
<tr>
<td class="fw-bold">wallet_name</td>
<td> string</td>
<td>
Name of the wallet.
</td>
</tr>
<tr>
<td class="fw-bold">loaded</td>
<td> bool</td>
<td>
True if the wallet is currently loaded.
</td>
</tr>
</tbody>
</table>

#### UpdatePassword <span id="pactus.Wallet.UpdatePassword" class="rpc-badge"></span>

<p>UpdatePassword updates the password of an existing wallet.</p>
Expand Down
78 changes: 6 additions & 72 deletions content/api/json-rpc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,10 +225,6 @@ curl --location 'http://localhost:8545/' \
<a href="#pactus.wallet.get_wallet_info">
<span class="rpc-badge"></span> pactus.wallet.get_wallet_info</a>
</li>
<li>
<a href="#pactus.wallet.is_wallet_loaded">
<span class="rpc-badge"></span> pactus.wallet.is_wallet_loaded</a>
</li>
<li>
<a href="#pactus.wallet.update_password">
<span class="rpc-badge"></span> pactus.wallet.update_password</a>
Expand Down Expand Up @@ -3291,12 +3287,6 @@ maximum number of messages to queue before dropping older ones.
Parameters has no fields.
<h4>Result</h4>

<table class="table table-bordered table-responsive table-sm">
<thead>
<tr><td>Field</td><td>Type</td><td>Description</td></tr>
</thead>
<tbody class="table-group-divider">
</tbody>
</table>

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

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

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

<h4>Parameters</h4>

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

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

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

<h4>Parameters</h4>

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

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

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

<h4>Parameters</h4>

<table class="table table-bordered table-responsive table-sm">
<thead>
<tr><td>Field</td><td>Type</td><td>Description</td></tr>
</thead>
<tbody class="table-group-divider">
<tr>
<td class="fw-bold">include_unloaded</td>
<td> boolean</td>
<td>
Whether to include wallets that exist on disk but are not currently loaded.
</td>
</tr>
</tbody>
</table>
Parameters has no fields.
<h4>Result</h4>

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

#### pactus.wallet.is_wallet_loaded <span id="pactus.wallet.is_wallet_loaded" class="rpc-badge"></span>

<p>IsWalletLoaded checks whether the specified wallet is currently loaded.</p>

<h4>Parameters</h4>

<table class="table table-bordered table-responsive table-sm">
<thead>
<tr><td>Field</td><td>Type</td><td>Description</td></tr>
</thead>
<tbody class="table-group-divider">
<tr>
<td class="fw-bold">wallet_name</td>
<td> string</td>
<td>
Name of the wallet to check.
</td>
</tr>
</tbody>
</table>
<h4>Result</h4>

<table class="table table-bordered table-responsive table-sm">
<thead>
<tr><td>Field</td><td>Type</td><td>Description</td></tr>
</thead>
<tbody class="table-group-divider">
<tr>
<td class="fw-bold">wallet_name</td>
<td> string</td>
<td>
Name of the wallet.
</td>
</tr>
<tr>
<td class="fw-bold">loaded</td>
<td> boolean</td>
<td>
True if the wallet is currently loaded.
</td>
</tr>
</tbody>
</table>

#### pactus.wallet.update_password <span id="pactus.wallet.update_password" class="rpc-badge"></span>

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