anchor_gen

https://docs.rs/anchor-gen/0.4.1/
Admin
A Rust library that generates a crate for cross-program invocations (CPI) to an Anchor program,...
Tokens:1,615
Snippets:16
Trust Score:9.7
Update:1 year ago
Show doc for...
Tokens:
Raw
### Rust Example: Using `generate_cpi_crate` Macro

Source: https://docs.rs/anchor-gen/0.4.1/anchor_gen/macro.generate_cpi_crate

An example demonstrating how to invoke the `generate_cpi_crate` macro in Rust. It shows the macro being called with a relative path to an IDL JSON file, followed by a simple struct definition for context.

```Rust
anchor_generate_cpi_crate::generate_cpi_crate!("../../examples/govern-cpi/idl.json");
let _my_governor = GovernanceParameters {
    quorum_votes: 0,
    timelock_delay_seconds: 0,
    voting_period: 0,
    voting_delay: 0,
};
```

--------------------------------

### Example Usage of `generate_cpi_interface` Macro

Source: https://docs.rs/anchor-gen/0.4.1/anchor_gen/macro.generate_cpi_interface

This example demonstrates how to use the `generate_cpi_interface` macro to generate an Anchor CPI crate from a specified JSON IDL file. It also shows a subsequent struct initialization, likely related to the generated code.

```Rust
anchor_generate_cpi_interface::generate_cpi_interface!(idl_path = "../../examples/govern-cpi/idl.json");
let _my_governor = GovernanceParameters {
    quorum_votes: 0,
    timelock_delay_seconds: 0,
    voting_period: 0,
    voting_delay: 0,
};
```

--------------------------------

### APIDOC: `generate_cpi_interface` Macro Reference

Source: https://docs.rs/anchor-gen/0.4.1/anchor_gen/macro.generate_cpi_interface

Detailed documentation for the `generate_cpi_interface` procedural macro, including its purpose and arguments.

```APIDOC
Macro: generate_cpi_interface
  Description: Generates an Anchor CPI crate from a JSON file.
  Arguments:
    idl_path: Path to a JSON IDL relative to the crate’s the Cargo.toml.
```

--------------------------------

### Generate Anchor CPI Client in Rust

Source: https://docs.rs/anchor-gen/0.4.1/src/anchor_gen/lib.rs

Demonstrates how to use the `anchor_gen::generate_cpi_crate!` macro within a Rust `lib.rs` file. This macro automatically generates a fully functional Rust CPI client from a specified Anchor IDL JSON file, simplifying cross-program invocations.

```Rust
anchor_gen::generate_cpi_crate!("../../examples/govern-cpi/idl.json");
```

--------------------------------

### Generate Anchor CPI Crate in Rust lib.rs

Source: https://docs.rs/anchor-gen/0.4.1/anchor_gen/index

This Rust code snippet demonstrates how to use the `anchor_gen::generate_cpi_crate!` macro within your `lib.rs` file. It takes a path to an Anchor program's JSON IDL, automatically generating a fully functional Rust CPI client for that program.

```Rust
anchor_gen::generate_cpi_crate!("../../examples/govern-cpi/idl.json");
```

--------------------------------

### APIDOC: anchor_gen::generate_cpi_interface Macro

Source: https://docs.rs/anchor-gen/0.4.1/anchor_gen

Documentation for the `generate_cpi_interface` macro. Similar to `generate_cpi_crate`, this macro also generates an Anchor CPI crate from a JSON IDL file, likely for interface definitions.

```APIDOC
generate_cpi_interface
:   Generates an Anchor CPI crate from a JSON file.
```

--------------------------------

### Generate CPI Crate in Rust lib.rs

Source: https://docs.rs/anchor-gen/0.4.1/anchor_gen

This Rust snippet demonstrates how to use the `anchor_gen::generate_cpi_crate!` macro within your `lib.rs` file. It takes the path to an Anchor IDL JSON file as input to generate a fully functional Rust CPI client.

```Rust
anchor_gen::generate_cpi_crate!("../../examples/govern-cpi/idl.json");
```

--------------------------------

### API Documentation for `generate_cpi_crate` Macro

Source: https://docs.rs/anchor-gen/0.4.1/anchor_gen/macro.generate_cpi_crate

Details the purpose and arguments of the `generate_cpi_crate` procedural macro. This macro is designed to generate an Anchor CPI (Cross-Program Invocation) crate by processing a specified JSON IDL (Interface Definition Language) file.

```APIDOC
Macro: generate_cpi_crate
  Description: Generates an Anchor CPI crate from a JSON file.
  Arguments:
    input: Path to a JSON IDL relative to the crate’s the Cargo.toml.
```

--------------------------------

### APIDOC: anchor_gen::generate_cpi_crate Macro

Source: https://docs.rs/anchor-gen/0.4.1/anchor_gen

Documentation for the `generate_cpi_crate` macro. This macro is used to generate an Anchor Cross-Program Invocation (CPI) crate directly from a specified JSON IDL file.

```APIDOC
generate_cpi_crate
:   Generates an Anchor CPI crate from a JSON file.
```

--------------------------------

### anchor_gen::generate_cpi_interface Macro Reference

Source: https://docs.rs/anchor-gen/0.4.1/anchor_gen/index

Similar to `generate_cpi_crate`, this macro generates an Anchor Cross-Program Invocation (CPI) interface. It also takes a JSON file as input to define the structure and methods of the interface.

```APIDOC
generate_cpi_interface:
  description: Generates an Anchor CPI crate from a JSON file.
```

--------------------------------

### Add anchor-gen Dependency to Cargo.toml

Source: https://docs.rs/anchor-gen/0.4.1/src/anchor_gen/lib.rs

Adds the `anchor-gen` crate as a dependency to your project's `Cargo.toml` file, specifying version 0.31.1. This enables the use of `anchor-gen` functionalities for generating cross-program invocation (CPI) clients.

```TOML
[dependencies]
anchor-gen = "0.31.1"
```

--------------------------------

### Define `generate_cpi_interface` Procedural Macro

Source: https://docs.rs/anchor-gen/0.4.1/anchor_gen/macro.generate_cpi_interface

This snippet shows the basic definition of the `generate_cpi_interface` procedural macro provided by the `anchor-gen` crate. It indicates that it's a proc-macro.

```Rust
generate_cpi_interface!() { /* proc-macro */ }
```

--------------------------------

### anchor_gen::generate_cpi_crate Macro Reference

Source: https://docs.rs/anchor-gen/0.4.1/anchor_gen/index

This macro is designed to generate a complete Anchor Cross-Program Invocation (CPI) crate. It simplifies the process of creating client libraries for interacting with Anchor programs by consuming a JSON IDL file.

```APIDOC
generate_cpi_crate:
  description: Generates an Anchor CPI crate from a JSON file.
```

--------------------------------

### Add anchor-gen Dependency to Cargo.toml

Source: https://docs.rs/anchor-gen/0.4.1/anchor_gen

This snippet shows how to add the `anchor-gen` crate as a dependency in your `Cargo.toml` file, specifying version 0.31.1. This is the first step to use the `anchor-gen` library in a new Rust project.

```TOML
[dependencies]
anchor-gen = "0.31.1"
```

--------------------------------

### Add anchor-gen Dependency to Cargo.toml

Source: https://docs.rs/anchor-gen/0.4.1/anchor_gen/index

To incorporate the `anchor-gen` crate into your Rust project, add the specified dependency entry to the `[dependencies]` section of your `Cargo.toml` file. This ensures the crate is available for use in your application.

```TOML
[dependencies]
anchor-gen = "0.31.1"
```

--------------------------------

### Rust `generate_cpi_crate` Macro Signature

Source: https://docs.rs/anchor-gen/0.4.1/anchor_gen/macro.generate_cpi_crate

The basic signature for the `generate_cpi_crate` procedural macro, indicating its type and general structure within Rust.

```Rust
generate_cpi_crate!() { /* proc-macro */ }
```
Tokens:
Raw