Generando clientes

Codama genera clientes en TypeScript y Rust a partir del archivo IDL de un programa. Los clientes generados incluyen funciones para llamar a instrucciones y obtener cuentas, eliminando la necesidad de serializar y deserializar manualmente las cuentas del programa o instruction data.

Codama está en desarrollo activo y sujeto a cambios. Consulta los repositorios enlazados en la referencia rápida para obtener la información más reciente.

Referencia rápida

Comandos CLI

Comando	Descripción
`codama init`	Generar un archivo de configuración de codama
`codama run`	Generar clientes de programa desde el archivo de configuración

Generadores de clientes

Paquete	Descripción
`@codama/renderers-js`	Genera clientes TypeScript compatibles con `@solana/kit`
`@codama/renderers-rust`	Genera clientes Rust compatibles con `solana_sdk`
`@codama/nodes-from-anchor`	Convierte IDLs de Anchor a IDLs de Codama para generar clientes

Recursos adicionales

Recurso	Descripción
Codama	GitHub de Codama
Codama CLI	GitHub de Codama CLI
Codama Macros	GitHub de Codama Macros. Genera IDL de Codama desde programas nativos de Rust con macros de Codama
Codama Macros Example Program	Programa de ejemplo que demuestra el uso de macros de Codama

Ejemplo

Este ejemplo muestra el proceso de generación de clientes a partir de un IDL de programa Anchor.

Configurar archivos del proyecto

Para seguir el ejemplo, crea un nuevo directorio llamado example y añade el archivo idl.json y el archivo package.json de los fragmentos de código.

Este ejemplo utiliza un IDL de programa contador. Ver código fuente.

En un proyecto de Anchor, el IDL se encuentra en target/idl/<program_name>.json después de ejecutar anchor build.

Crear archivo de configuración de Codama

Codama utiliza un archivo de configuración para especificar dónde se encuentra el archivo IDL, qué lenguajes de cliente generar y dónde guardar el código generado. Crea esta configuración ejecutando:

Terminal

$ npx codama init

Esto te mostrará preguntas para crear un archivo codama.json en la raíz de tu proyecto e instalar las dependencias necesarias de Codama.

example output

Welcome to Codama!
✔ Where is your IDL located? (Supports Codama and Anchor IDLs). … idl.json
✔ Which script preset would you like to use? › Generate JavaScript client, Generate Rust client
✔ [js] Where should the JavaScript code be generated? … clients/js/src/generated
✔ [rust] Where is the Rust client crate located? … clients/rust
✔ [rust] Where should the Rust code be generated? … clients/rust/src/generated
▲ Your configuration requires additional dependencies.
▲ Install command: pnpm install @codama/nodes-from-anchor @codama/renderers-js @codama/renderers-rust
✔ Install dependencies? … yes
→ Installing
  ├─ @codama/nodes-from-anchor
  ├─ @codama/renderers-js
  └─ @codama/renderers-rust
✔ Dependencies installed successfully.

✔ Configuration file created.
  └─ Path: /example/codama.json

Generar clientes

Una vez creado el archivo de configuración, ejecuta el comando de generación para generar los clientes:

Terminal

$ npx codama run --all

Esto generará los clientes del programa en las rutas de archivo especificadas en el archivo de configuración de codama.

codama.json

{
  "idl": "idl.json",
  "before": [],
  "scripts": {
    "js": {
      "from": "@codama/renderers-js",
      "args": ["clients/js/src/generated"]
    },
    "rust": {
      "from": "@codama/renderers-rust",
      "args": [
        "clients/rust/src/generated",
        {
          "crateFolder": "clients/rust",
          "formatCode": true
        }
      ]
    }
  }
}

No todos los archivos generados se muestran en los fragmentos de código correspondientes.

Configurar archivos del proyecto

Para seguir el ejemplo, crea un nuevo directorio llamado example y añade el archivo idl.json y el archivo package.json de los fragmentos de código.

Este ejemplo utiliza un IDL de programa contador. Ver código fuente.

En un proyecto de Anchor, el IDL se encuentra en target/idl/<program_name>.json después de ejecutar anchor build.

Crear archivo de configuración de Codama

Terminal

$ npx codama init

Esto te mostrará preguntas para crear un archivo codama.json en la raíz de tu proyecto e instalar las dependencias necesarias de Codama.

example output

Welcome to Codama!
✔ Where is your IDL located? (Supports Codama and Anchor IDLs). … idl.json
✔ Which script preset would you like to use? › Generate JavaScript client, Generate Rust client
✔ [js] Where should the JavaScript code be generated? … clients/js/src/generated
✔ [rust] Where is the Rust client crate located? … clients/rust
✔ [rust] Where should the Rust code be generated? … clients/rust/src/generated
▲ Your configuration requires additional dependencies.
▲ Install command: pnpm install @codama/nodes-from-anchor @codama/renderers-js @codama/renderers-rust
✔ Install dependencies? … yes
→ Installing
  ├─ @codama/nodes-from-anchor
  ├─ @codama/renderers-js
  └─ @codama/renderers-rust
✔ Dependencies installed successfully.

✔ Configuration file created.
  └─ Path: /example/codama.json

Generar clientes

Una vez creado el archivo de configuración, ejecuta el comando de generación para generar los clientes:

Terminal

$ npx codama run --all

Esto generará los clientes del programa en las rutas de archivo especificadas en el archivo de configuración de codama.

codama.json

{
  "idl": "idl.json",
  "before": [],
  "scripts": {
    "js": {
      "from": "@codama/renderers-js",
      "args": ["clients/js/src/generated"]
    },
    "rust": {
      "from": "@codama/renderers-rust",
      "args": [
        "clients/rust/src/generated",
        {
          "crateFolder": "clients/rust",
          "formatCode": true
        }
      ]
    }
  }
}

No todos los archivos generados se muestran en los fragmentos de código correspondientes.

idl.json

package.json

{
  "address": "8PY1q5J3Aq2z7TBDLBrVjv77mYzjXSCz6iHQaFEFw9hY",
  "metadata": {
    "name": "counter",
    "version": "0.1.0",
    "spec": "0.1.0",
    "description": "Created with Anchor"
  },
  "instructions": [
    {
      "name": "decrement",
      "discriminator": [106, 227, 168, 59, 248, 27, 150, 101],
      "accounts": [
        {
          "name": "user",
          "writable": true,
          "signer": true
        },
        {
          "name": "counter",
          "writable": true,
          "pda": {
            "seeds": [
              {
                "kind": "const",
                "value": [99, 111, 117, 110, 116, 101, 114]
              }
            ]
          }
        },
        {
          "name": "vault",
          "writable": true,
          "pda": {
            "seeds": [
              {
                "kind": "const",
                "value": [118, 97, 117, 108, 116]
              },
              {
                "kind": "account",
                "path": "user"
              }
            ]
          }
        },
        {
          "name": "system_program",
          "address": "11111111111111111111111111111111"
        }
      ],
      "args": []
    },
    {
      "name": "increment",
      "discriminator": [11, 18, 104, 9, 104, 174, 59, 33],
      "accounts": [
        {
          "name": "user",
          "writable": true,
          "signer": true
        },
        {
          "name": "counter",
          "writable": true,
          "pda": {
            "seeds": [
              {
                "kind": "const",
                "value": [99, 111, 117, 110, 116, 101, 114]
              }
            ]
          }
        },
        {
          "name": "vault",
          "writable": true,
          "pda": {
            "seeds": [
              {
                "kind": "const",
                "value": [118, 97, 117, 108, 116]
              },
              {
                "kind": "account",
                "path": "user"
              }
            ]
          }
        },
        {
          "name": "system_program",
          "address": "11111111111111111111111111111111"
        }
      ],
      "args": []
    }
  ],
  "accounts": [
    {
      "name": "Counter",
      "discriminator": [255, 176, 4, 245, 188, 253, 124, 25]
    }
  ],
  "errors": [
    {
      "code": 6000,
      "name": "UnderflowError",
      "msg": "Counter cannot be decremented below zero"
    }
  ],
  "types": [
    {
      "name": "Counter",
      "type": {
        "kind": "struct",
        "fields": [
          {
            "name": "count",
            "type": "u64"
          }
        ]
      }
    }
  ]
}

Generando clientes

Referencia rápida

Comandos CLI

Generadores de clientes

Recursos adicionales

Ejemplo

Configurar archivos del proyecto

Crear archivo de configuración de Codama

Generar clientes

Configurar archivos del proyecto

Crear archivo de configuración de Codama

Generar clientes

Uso de los clientes generados

Integración en tu aplicación

Paquetes o crates independientes

Tabla de Contenidos