Skip to content

Commit 740d082

Browse files
kouksdevops-talus
authored andcommitted
Update docs from nexus-sdk (commit: d5ad555a840b9eadd84f0baec4464f76cbe64e08)
1 parent ea18f98 commit 740d082

File tree

4 files changed

+39
-6
lines changed

4 files changed

+39
-6
lines changed

nexus-sdk/cli.md

Lines changed: 25 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -45,16 +45,16 @@ This command should also check that the URL is accessible by the Leader node. It
4545
**`nexus tool validate --on-chain <ident>`**
4646

4747
{% hint style="warning" %}
48-
The specific design for onchain tools is still in progress and as a result the implementation is not yet implemented. When running the command, it will panic.
48+
The specific design for onchain tools is still in progress and as a result the implementation is not yet present. When running the command, it will panic.
4949
{% endhint %}
5050

5151
---
5252

53-
**`nexus tool register --off-chain <url>`**
53+
**`nexus tool register --off-chain <url> --invocation-cost [mist] --collateral-coin [object_id]`**
5454

55-
Command that makes a request to `GET <url>/meta` to fetch the Tool definition and then submits a TX to our Tool Registry. It also locks the collateral.
55+
Command that makes a request to `GET <url>/meta` to fetch the Tool definition and then submits a TX to our Tool Registry. It also locks the collateral and sets the single invocation cost of the Tool which defaults to 0 MIST.
5656

57-
This returns an OwnerCap object ID that can be used to manage the Tool.
57+
This returns 2 OwnerCap object IDs that can be used to manage the Tool and its Gas settlement methods.
5858

5959
{% hint style="info" %}
6060
This command requires that a wallet is connected to the CLI...
@@ -65,7 +65,7 @@ This command requires that a wallet is connected to the CLI...
6565
**`nexus tool register --on-chain <ident>`**
6666

6767
{% hint style="warning" %}
68-
The specific design for onchain tools is still in progress and as a result the implementation is not yet implemented. When running the command, it will panic.
68+
The specific design for onchain tools is still in progress and as a result the implementation is not yet present. When running the command, it will panic.
6969
{% endhint %}
7070

7171
---
@@ -162,6 +162,22 @@ Inspects a DAG execution process based on the provided `DAGExecution` object ID
162162

163163
---
164164

165+
### `nexus gas`
166+
167+
Set of commands to manage Nexus gas budgets and tickets.
168+
169+
---
170+
171+
**`nexus gas add-budget --coin <object_id>`**
172+
173+
Upload the coin object to the Nexus gas service as budget in the "invoker address" scope. That means that if a DAG execution is started from the address that the coin was uploaded from, the coin can be used to pay for the gas.
174+
175+
{% hint style="info" %}
176+
This command requires that a wallet is connected to the CLI...
177+
{% endhint %}
178+
179+
---
180+
165181
### `nexus network`
166182

167183
Set of commands for managing Nexus networks.
@@ -174,6 +190,10 @@ Create a new Nexus network and assign `count-leader-caps` (default: 5) leader ca
174190

175191
The network object ID is returned.
176192

193+
{% hint style="info" %}
194+
This command requires that a wallet is connected to the CLI...
195+
{% endhint %}
196+
177197
---
178198

179199
### `nexus completion`

nexus-sdk/guides/llm-openai-chat-prep-tool.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,7 @@ enum Output {
6363
```
6464

6565
where:
66+
6667
```rust
6768
/// Represents the type of a message in a chat completion request or response.
6869
#[derive(Debug, Default, PartialEq, Eq, Deserialize, Serialize, JsonSchema, EnumString)]

nexus-sdk/guides/math-branching-with-chat.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -621,5 +621,5 @@ This extended DAG demonstrates how to combine mathematical computation with natu
621621

622622
<!-- List of references -->
623623

624-
[math-branching-entry-guide]: ./math-branching-dag-entry.md
624+
[math-branching-entry-guide]: ./math_branching-dag-entry.md
625625
[llm-openai-chat-prep-tool]: ./llm-openai-chat-prep-tool.md

nexus-sdk/guides/setup.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,18 @@ source .envrc
8787
To automatically load these variables every time you navigate to the project directory, consider using [direnv](https://direnv.net/). After installing it, run `direnv allow` within your project directory.
8888
{% endhint %}
8989

90+
### Upload some gas budget to Nexus
91+
92+
In order to pay for the network transaction fees and the tool invocations, you need to upload some gas budget to Nexus. You can do this by running the following command:
93+
94+
```bash
95+
nexus gas add-budget --coin <object_id>
96+
```
97+
98+
{% hint style="info" %}
99+
Note that this coin can only be used to pay for Nexus and tool invocation fees only if the DAG is executed from the **same address**.
100+
{% endhint %}
101+
90102
### Configure the Sui client
91103

92104
After installing the Sui binaries, configure and activate your Talus `devnet` environment:

0 commit comments

Comments
 (0)