> For the complete documentation index, see [llms.txt](https://docs.talus.network/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.talus.network/talus-docs-v2.1.0/reference/move/nexus_workflow/invocation_adapter.md).

# nexus\_workflow::invocation\_adapter

* [Struct `InvocationLockedEvent`](#struct-invocationlockedevent)
* [Struct `InvocationSettledEvent`](#struct-invocationsettledevent)
* [Constants](#constants)
* [Function `new_request`](#function-new_request)
* [Function `lock_and_request`](#function-lock_and_request)
* [Function `settle`](#function-settle)
* [Function `is_locked`](#function-is_locked)
* [Function `abort_expired`](#function-abort_expired)

### Struct `InvocationLockedEvent`

Records one exact Invocation admitted for a runtime vertex.

```move
public struct InvocationLockedEvent has copy, drop
```

<details>

<summary>Fields</summary>

[`execution`](/talus-docs-v2.1.0/reference/move/nexus_workflow/execution.md#nexus_workflow_execution)`: sui::object::IDvertex:` [`nexus_interface::graph::RuntimeVertex`](/talus-docs-v2.1.0/reference/move/nexus_interface/graph.md#nexus_interface_graph_RuntimeVertex)`tool: sui::object::IDtool_fqn: std::ascii::Stringcashier: sui::object::IDinvocation: sui::object::IDbeneficiary:` [`nexus_interface::payment::PaymentSourceKind`](/talus-docs-v2.1.0/reference/move/nexus_interface/payment.md#nexus_interface_payment_PaymentSourceKind)`policy: std::type_name::TypeNamesources: vector<sui::object::ID>amount: u64`

</details>

#### Struct `InvocationSettledEvent`

Records the terminal accounting outcome for one exact \[Invocation].

```move
public struct InvocationSettledEvent has copy, drop
```

<details>

<summary>Fields</summary>

[`execution`](/talus-docs-v2.1.0/reference/move/nexus_workflow/execution.md#nexus_workflow_execution)`: sui::object::IDvertex:` [`nexus_interface::graph::RuntimeVertex`](/talus-docs-v2.1.0/reference/move/nexus_interface/graph.md#nexus_interface_graph_RuntimeVertex)`tool: sui::object::IDtool_fqn: std::ascii::Stringcashier: sui::object::IDinvocation: sui::object::IDbeneficiary:` [`nexus_interface::payment::PaymentSourceKind`](/talus-docs-v2.1.0/reference/move/nexus_interface/payment.md#nexus_interface_payment_PaymentSourceKind)`policy: std::type_name::TypeNamesources: vector<sui::object::ID>amount: u64was_refunded: bool`

</details>

#### Constants

```move
#[error]
const EExecutionFinished: vector<u8> = b"Finished execution cannot authorize an Invocation";
```

```move
#[error]
const EInvalidToolCashier: vector<u8> = b"Tool cashier does not match the DAG vertex";
```

```move
#[error]
const EInvocationMismatch: vector<u8> = b"Invocation does not match the workflow vertex";
```

```move
#[error]
const ERequestNotCreated: vector<u8> = b"Invocation authorization must create executable Tool work";
```

```move
#[error]
const EVertexNotExpired: vector<u8> = b"Invocation vertex has not expired";
```

```move
#[error]
const EVertexNotInvoked: vector<u8> = b"Runtime vertex is not active for this execution";
```

#### Function `new_request`

Creates the canonical policy request for one active runtime vertex.

The cashier is borrowed immutably and is not part of the conflict domain.

```move
public fun new_request(cashier: &nexus_tool::tool_cashier::ToolCashier, dag: &nexus_interface::dag::DAG, execution: &nexus_workflow::execution::DAGExecution, vertex: nexus_interface::graph::RuntimeVertex, clock: &sui::clock::Clock): nexus_interface::payment::InvocationRequest
```

#### Function `lock_and_request`

Locks one exact \[Invocation], reimburses submission gas, and emits its executable walk request.

The lock and \[RequestWalkExecutionEvent] are created in one transaction, so an executor cannot observe executable work without its accounting authority.

```move
public fun lock_and_request<R>(_permit: &nexus_kernel::runtime_authority::RuntimePermit<R>, dag: &nexus_interface::dag::DAG, execution: &mut nexus_workflow::execution::DAGExecution, leader_registry: &nexus_registry::leader::LeaderRegistry, leader_cap: &nexus_primitives::owner_cap::CloneableOwnerCap<nexus_registry::leader_cap::OverNetwork>, walk_index: u64, vertex: nexus_interface::graph::RuntimeVertex, authorized: nexus_tool::invocation::Invocation, submission_gas_charge: u64, clock: &sui::clock::Clock, ctx: &mut sui::tx_context::TxContext)
```

#### Function `settle`

Applies the pending outcome for one exact \[Invocation].

If the workflow has no terminal outcome, the \[Receiving] value is dropped and the Invocation remains locked under its execution.

```move
public fun settle<R>(_permit: &nexus_kernel::runtime_authority::RuntimePermit<R>, dag: &nexus_interface::dag::DAG, execution: &mut nexus_workflow::execution::DAGExecution, vertex: nexus_interface::graph::RuntimeVertex, receiving: sui::transfer::Receiving<nexus_tool::invocation::Invocation>)
```

#### Function `is_locked`

Returns whether the execution payment holds the exact runtime vertex lock.

```move
public fun is_locked(execution: &nexus_workflow::execution::DAGExecution, vertex: nexus_interface::graph::RuntimeVertex, tool_fqn: std::ascii::String): bool
```

#### Function `abort_expired`

Refunds one locked expired Invocation and applies workflow timeout handling.

The supplied \[Receiving] proves the exact Invocation is owned by the execution. No user, policy, or cashier participation is required.

```move
public fun abort_expired<R>(_permit: &nexus_kernel::runtime_authority::RuntimePermit<R>, dag: &nexus_interface::dag::DAG, execution: &mut nexus_workflow::execution::DAGExecution, vertex: nexus_interface::graph::RuntimeVertex, receiving: sui::transfer::Receiving<nexus_tool::invocation::Invocation>, clock: &sui::clock::Clock, ctx: &mut sui::tx_context::TxContext)
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.talus.network/talus-docs-v2.1.0/reference/move/nexus_workflow/invocation_adapter.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `build a script that syncs our docs to a CMS` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.