Schematy

Schemat definiuje strukturę i reguły walidacji dla poświadczeń w Systemie Atestacji Solana. Schematy służą jako szablony określające, jakie pola powinno zawierać poświadczenie i jak powinny być sformatowane. Każdy schemat jest powiązany z typem poświadczenia i może być wersjonowany, aby wspierać ewolucję struktury danych.

Struktura

Struktura Schema reprezentuje schemat w Systemie Atestacji Solana. Każdy schemat definiuje szablon dla poświadczeń, które mogą być tworzone w jego ramach.

Definicje typów

Schema

export type Schema = {
  discriminator: number; // Internal discriminator
  credential: Address; // Associated credential address
  name: ReadonlyUint8Array; // Schema name
  description: ReadonlyUint8Array; // Schema description
  layout: ReadonlyUint8Array; // Schema layout definition
  fieldNames: ReadonlyUint8Array; // Names of fields in the schema
  isPaused: boolean; // Pause status
  version: number; // Schema version
};

Metody

Pobieranie schematów

Serializacja

Przykłady użycia

Pobieranie pojedynczego schematu

const schema = await fetchSchema(rpc, schemaAddress);
console.log("Schema name:", schema.name);

Pobieranie wielu schematów

const schemas = await fetchAllSchema(rpc, [schema1Address, schema2Address]);
schemas.forEach((schema) => console.log("Schema:", schema.name));

Bezpieczne pobieranie

const schema = await fetchMaybeSchema(rpc, schemaAddress);
if (schema) {
  console.log("Schema found:", schema.name);
} else {
  console.log("Schema not found");
}

Typy danych układu schematu

Pole layout używa wartości numerycznych do określenia typów danych dla każdego pola w schemacie:

Przykład użycia

Na przykład układ [12, 0, 12] definiowałby trzy pola: String, po którym następuje liczba całkowita U8, a następnie kolejny String. Tablica fieldNames udostępnia czytelne dla człowieka nazwy, które odpowiadają pozycyjnie każdej wartości układu, więc przy nazwach pól ["name", "age", "country"], pierwsze pole String nosiłoby nazwę "name", pole U8 to "age", a drugie pole String to "country".

Oto przykład tego, jak można je wykorzystać podczas tworzenia schematu:

const createSchemaInstruction = getCreateSchemaInstruction({
  authority,
  payer,
  credential: credentialPda,
  schema: schemaPda,
  name: "Test Schema",
  description: "Just an example",
  fieldNames: ["name", "age", "country"],
  layout: Buffer.from([12, 0, 12])
});

Ważne uwagi

• Pole discriminator jest używane wewnętrznie i nie powinno być modyfikowane
• Pole credential łączy schemat z powiązanym typem poświadczenia
• isPaused może być użyte do tymczasowego wyłączenia użycia schematu
• Pole version umożliwia ewolucję schematu przy jednoczesnym zachowaniu wstecznej kompatybilności
• layout i fieldNames definiują strukturę poświadczeń wykorzystujących ten schemat
• Wszystkie pola tablic bajtów (name, description, layout, fieldNames) powinny być odpowiednio zakodowane/odkodowane zgodnie z potrzebami Twojej aplikacji