Clients genereren

Codama genereert TypeScript- en Rust- clients vanuit het IDL-bestand van een programma. De gegenereerde clients bevatten functies voor het aanroepen van instructies en het ophalen van accounts, waardoor het niet meer nodig is om handmatig programma-accounts of instruction data te serialiseren en deserialiseren.

Codama is in actieve ontwikkeling en onderhevig aan veranderingen. Raadpleeg de gelinkte repositories in de snelle referentie voor de meest recente informatie.

Snelle referentie

CLI-opdrachten

Commando	Beschrijving
`codama init`	Genereer een codama-configuratiebestand
`codama run`	Genereer programmaclients vanuit het configuratiebestand

Client-generators

Package	Beschrijving
`@codama/renderers-js`	Genereer `@solana/kit` compatibele TypeScript-clients
`@codama/renderers-rust`	Genereer `solana_sdk` compatibele Rust-clients
`@codama/nodes-from-anchor`	Converteer Anchor IDL's naar Codama IDL's voor het genereren van clients

Aanvullende bronnen

Bron	Beschrijving
Codama	Codama GitHub
Codama CLI	Codama CLI GitHub
Codama Macros	Codama Macros GitHub. Genereer Codama IDL vanuit native Rust-programma's met Codama-macro's
Codama Macros Example Program	Voorbeeldprogramma dat het gebruik van Codama-macro's demonstreert

Voorbeeld

Dit voorbeeld doorloopt het proces van het genereren van clients vanuit een Anchor-programma IDL.

Project bestanden instellen

Om mee te volgen, maak je een nieuwe map aan met de naam example en voeg je het idl.json-bestand en het package.json-bestand toe uit de codefragmenten.

Dit voorbeeld gebruikt een counter programma IDL. Bekijk broncode.

In een Anchor-project vind je de IDL op target/idl/<program_name>.json na het uitvoeren van anchor build.

Maak een Codama configuratiebestand

Codama gebruikt een configuratiebestand om aan te geven waar het IDL-bestand zich bevindt, welke cliënttalen gegenereerd moeten worden en waar de gegenereerde code moet worden opgeslagen. Maak dit configuratiebestand door het volgende uit te voeren:

Terminal

$ npx codama init

Dit zal je vragen stellen om een codama.json-bestand aan te maken in de hoofdmap van je project en de benodigde Codama-afhankelijkheden te installeren.

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

Genereer clients

Zodra het configuratiebestand is aangemaakt, voer je het generatie-commando uit om de clients te genereren:

Terminal

$ npx codama run --all

Dit zal de programmaclients genereren in de bestandspaden die zijn gespecificeerd in het codama-configuratiebestand.

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
        }
      ]
    }
  }
}

Niet alle gegenereerde bestanden worden getoond in de bijbehorende codevoorbeelden.

Project bestanden instellen

Om mee te volgen, maak je een nieuwe map aan met de naam example en voeg je het idl.json-bestand en het package.json-bestand toe uit de codefragmenten.

Dit voorbeeld gebruikt een counter programma IDL. Bekijk broncode.

In een Anchor-project vind je de IDL op target/idl/<program_name>.json na het uitvoeren van anchor build.

Maak een Codama configuratiebestand

Terminal

$ npx codama init

Dit zal je vragen stellen om een codama.json-bestand aan te maken in de hoofdmap van je project en de benodigde Codama-afhankelijkheden te installeren.

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

Genereer clients

Zodra het configuratiebestand is aangemaakt, voer je het generatie-commando uit om de clients te genereren:

Terminal

$ npx codama run --all

Dit zal de programmaclients genereren in de bestandspaden die zijn gespecificeerd in het codama-configuratiebestand.

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
        }
      ]
    }
  }
}

Niet alle gegenereerde bestanden worden getoond in de bijbehorende codevoorbeelden.

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"
          }
        ]
      }
    }
  ]
}

Clients genereren

Snelle referentie

CLI-opdrachten

Client-generators

Aanvullende bronnen

Voorbeeld

Project bestanden instellen

Maak een Codama configuratiebestand

Genereer clients

Project bestanden instellen

Maak een Codama configuratiebestand

Genereer clients

De gegenereerde clients gebruiken

Geïntegreerd in je applicatie

Zelfstandige packages of crates

Inhoudsopgave