JS API -viite

@solana/surfpool-paketti tarjoaa yhden luokan, Surfnet, sekä tukityypit, joita tarvitset sen metodien tyyppiturvalliseen kutsumiseen. Tällä sivulla luetellaan kaikki viedyt symbolit; narratiivisesta käytöstä katso oppaat alkaen Yleiskatsauksesta.

Paketin viennit

Symboli	Tyyppi	Huomiot
`Surfnet`	luokka	Käynnissä oleva Surfnet-instanssi huijauskoodi-metodeilla
`SurfnetConfig`	tyyppi	Argumentti kohteelle `Surfnet.startWithConfig`
`DeployOptions`	tyyppi	Argumentti kohteelle `Surfnet.deploy`
`SetTokenAccountUpdate`	tyyppi	Argumentti kohteelle `Surfnet.setTokenAccount`
`ResetAccountOptions`	tyyppi	Argumentti kohteelle `Surfnet.resetAccount`
`StreamAccountOptions`	tyyppi	Argumentti kohteelle `Surfnet.streamAccount`
`SolAccountFunding`	tyyppi	`Surfnet.fundSolMany`-metodille välitetyn taulukon alkio
`SimnetEventValue`	tyyppi	`Surfnet.drainEvents`-metodin palauttama alkio
`KeypairInfo`	tyyppi	Palauttaa `Surfnet.newKeypair`
`ClockValue`	tyyppi	Kenttä kohteessa `SimnetEventValue`
`EpochInfoValue`	tyyppi	Palauttaa aikamatkustusapuohjelmat
`ByteArrayLike`	tyyppi	`Uint8Array \| number[]` — joustava tavusyöte

Surfnet-luokka

Staattiset metodit

class Surfnet {
  static start(): Surfnet;
  static startWithConfig(config: SurfnetConfig): Surfnet;
  static newKeypair(): KeypairInfo;
}

Instanssin ominaisuudet

class Surfnet {
  readonly rpcUrl: string; // http://127.0.0.1:<port>
  readonly wsUrl: string; // ws://127.0.0.1:<port>
  readonly payer: string; // base58 public key
  readonly payerSecretKey: Uint8Array; // 64-byte private key
  readonly instanceId: string;
}

Elinkaari

class Surfnet {
  stop(): void; // idempotent; safe to call from `finally` / test teardown
}

SOL-huijauskoodit

class Surfnet {
  fundSol(address: string, lamports: number): void;
  fundSolMany(accounts: SolAccountFunding[]): void;
  setAccount(
    address: string,
    lamports: number,
    data: Uint8Array,
    owner: string
  ): void;
  resetAccount(address: string, options?: ResetAccountOptions): void;
}

Token-huijauskoodit

class Surfnet {
  fundToken(
    owner: string,
    mint: string,
    amount: number,
    tokenProgram?: string
  ): void;
  fundTokenMany(
    owners: string[],
    mint: string,
    amount: number,
    tokenProgram?: string
  ): void;
  setTokenBalance(
    owner: string,
    mint: string,
    amount: number,
    tokenProgram?: string
  ): void;
  setTokenAccount(
    owner: string,
    mint: string,
    update: SetTokenAccountUpdate,
    tokenProgram?: string
  ): void;
  getAta(owner: string, mint: string, tokenProgram?: string): string;
}

Aikamatkustus

class Surfnet {
  timeTravelToSlot(slot: number): EpochInfoValue;
  timeTravelToEpoch(epoch: number): EpochInfoValue;
  timeTravelToTimestamp(timestampMs: number): EpochInfoValue;
}

Ohjelman käyttöönotto

class Surfnet {
  deployProgram(programName: string): string; // returns program id
  deploy(options: DeployOptions): string; // returns program id
}

Suoratoisto ja tapahtumat

class Surfnet {
  streamAccount(address: string, options?: StreamAccountOptions): void;
  drainEvents(): SimnetEventValue[];
}

Konfiguraatiotyypit

SurfnetConfig

interface SurfnetConfig {
  offline?: boolean; // default: true
  remoteRpcUrl?: string; // setting this implies offline=false
  blockProductionMode?: "manual" | "clock" | "transaction"; // default: "transaction"
  slotTimeMs?: number; // default: 1
  airdropSol?: number; // lamports; default: 10_000_000_000
  airdropAddresses?: string[];
  payerSecretKey?: ByteArrayLike;
  enableFeatures?: string[]; // feature IDs (base58 or kebab name)
  disableFeatures?: string[];
  allFeatures?: boolean;
}

DeployOptions

interface DeployOptions {
  programId: string; // base58 address
  soPath?: string; // mutually exclusive with soBytes
  soBytes?: ByteArrayLike;
  idlPath?: string; // optional Anchor IDL JSON
}

SetTokenAccountUpdate

interface SetTokenAccountUpdate {
  amount?: number;
  delegate?: string; // base58 pubkey
  clearDelegate?: boolean;
  state?: string; // e.g. "initialized", "frozen"
  delegatedAmount?: number;
  closeAuthority?: string;
  clearCloseAuthority?: boolean;
}

ResetAccountOptions

interface ResetAccountOptions {
  includeOwnedAccounts?: boolean;
}

StreamAccountOptions

interface StreamAccountOptions {
  includeOwnedAccounts?: boolean;
}

SolAccountFunding

interface SolAccountFunding {
  address: string;
  lamports: number;
}

KeypairInfo

interface KeypairInfo {
  publicKey: string; // base58
  secretKey: number[]; // 64 bytes
}

ByteArrayLike

type ByteArrayLike = Uint8Array | number[];

Jos metodi hyväksyy ByteArrayLike, voit välittää joko Uint8Array tai tavallisen numerotaulukon. Wrapper normalisoi molemmat muotoon, jonka natiivi binding odottaa.

Tapahtumatyypit

SimnetEventValue

Litteä objekti, jossa on kind-erotinkenttä ja valinnaiset kentät. Katso Tapahtumat varianttiluetteloa varten.

interface SimnetEventValue {
  kind: string;
  message?: string;
  timestamp?: string;
  initialTransactionCount?: number;
  clock?: ClockValue;
  epochInfo?: EpochInfoValue;
  accountPubkey?: string;
  clockCommand?: string;
  slotIntervalMs?: number;
  transactionSignature?: string;
  logs?: string[];
  computeUnitsConsumed?: number;
  fee?: number;
  errorMessage?: string;
  tag?: string;
  profileKey?: string;
  profileSlot?: number;
  runbookId?: string;
  runbookErrors?: string[];
}

ClockValue

interface ClockValue {
  slot: number;
  epoch: number;
  leaderScheduleEpoch: number;
  unixTimestamp: number;
  epochStartTimestamp: number;
}

EpochInfoValue

interface EpochInfoValue {
  absoluteSlot: number;
  slotIndex: number;
  slotsInEpoch: number;
  epoch: number;
  blockHeight: number;
  transactionCount?: number;
}

Virheet

Jokainen metodi heittää tavallisen Error -poikkeuksen, jonka viesti sisältää taustalla olevan Rust- SurfnetError. Tarkista error.message erottaaksesi eri tapaukset.

try {
  surfnet.deploy({ programId, soPath: "missing.so" });
} catch (err) {
  // err.message starts with "Cheatcode:" / "Startup:" / etc.
  console.error(err);
}

Natiivimoduulin jalanjälki

Paketti riippuu alustakohtaisista natiivibinääreistä, jotka on julkaistu nimellä optionalDependencies:

Triple	Paketti
`aarch64-apple-darwin`	`@solana/surfpool-darwin-arm64`
`x86_64-apple-darwin`	`@solana/surfpool-darwin-x64`
`x86_64-unknown-linux-gnu`	`@solana/surfpool-linux-x64-gnu`

Jos mikään alustakohtaisista paketeista ei asennu koneellesi, Surfnet.start() heittää ensimmäisellä kutsukerralla selkeän "natiivimoduulia ei löydy" -virheen. Katso Asennus tukimatriisia ja vianmääritystä varten.

Sisällysluettelo