surfman-sdk 0.1.0

package/dist/index.d.mts

@@ -0,0 +1,345 @@
+interface JsonRpcRequest<T = any> {
+    jsonrpc: '2.0';
+    id: number | string;
+    method: string;
+    params: T;
+}
+interface JsonRpcResponse<T = any> {
+    jsonrpc: '2.0';
+    id: number | string;
+    result?: T;
+    error?: JsonRpcError;
+}
+interface JsonRpcError {
+    code: number;
+    message: string;
+    data?: any;
+}
+interface RpcClientConfig {
+    url: string;
+    timeout?: number;
+    headers?: Record<string, string>;
+}
+
+interface TimeTravelConfig {
+    absoluteEpoch?: number;
+    absoluteSlot?: number;
+    absoluteTimestamp?: number;
+}
+interface TimeTravelResult {
+    absoluteSlot: number;
+    blockHeight: number | null;
+    epoch: number;
+    slotIndex: number;
+    slotsInEpoch: number;
+    transactionCount: number | null;
+}
+interface SetAccountUpdate {
+    data?: string;
+    executable?: boolean;
+    lamports?: number;
+    owner?: string;
+    rentEpoch?: number;
+}
+interface SetProgramAuthorityParams {
+    programId: string;
+    newAuthority: string | null;
+}
+interface TokenAccountUpdate {
+    amount?: number;
+    delegate?: SetSomeAccount;
+    state?: string;
+    delegatedAmount?: number;
+    closeAuthority?: SetSomeAccount;
+}
+interface SetSomeAccount {
+    Account?: string;
+    NoAccount?: boolean;
+}
+interface ResetAccountConfig {
+    includeOwnedAccounts?: boolean;
+}
+interface RpcLogsResponse {
+    signature: string;
+    err: any | null;
+    slot: number;
+    logs?: string[];
+}
+
+interface BlockhashResult {
+    blockhash: string;
+    lastValidBlockHeight: number;
+}
+interface BlockConfig {
+    encoding?: 'json' | 'jsonParsed' | 'base58' | 'base64';
+    transactionDetails?: 'full' | 'signatures' | 'none';
+    rewards?: boolean;
+    commitment?: string;
+    maxSupportedTransactionVersion?: number;
+}
+interface Block {
+    blockhash: string;
+    previousBlockhash: string;
+    parentSlot: number;
+    transactions?: any[];
+    signatures?: string[];
+    rewards?: any[];
+    blockTime?: number | null;
+    blockHeight?: number | null;
+}
+interface TransactionConfig {
+    encoding?: 'json' | 'jsonParsed' | 'base58' | 'base64';
+    commitment?: string;
+    maxSupportedTransactionVersion?: number;
+}
+interface TransactionResult {
+    slot: number;
+    transaction: any;
+    blockTime?: number | null;
+    meta?: any;
+}
+interface SignatureStatus {
+    slot: number;
+    confirmations: number | null;
+    err: any | null;
+    confirmationStatus?: 'processed' | 'confirmed' | 'finalized';
+}
+interface PerformanceSample {
+    slot: number;
+    numTransactions: number;
+    numSlots: number;
+    samplePeriodSecs: number;
+    numNonVoteTransactions?: number;
+}
+interface ClusterNode {
+    pubkey: string;
+    gossip?: string | null;
+    tpu?: string | null;
+    rpc?: string | null;
+    version?: string | null;
+    featureSet?: number | null;
+    shredVersion?: number | null;
+}
+interface SendTransactionConfig {
+    skipPreflight?: boolean;
+    preflightCommitment?: string;
+    encoding?: 'base58' | 'base64';
+    maxRetries?: number;
+    minContextSlot?: number;
+}
+interface SimulateTransactionConfig {
+    commitment?: string;
+    sigVerify?: boolean;
+    replaceRecentBlockhash?: boolean;
+    minContextSlot?: number;
+    encoding?: 'base58' | 'base64';
+    accounts?: {
+        encoding: string;
+        addresses: string[];
+    };
+}
+interface SimulateTransactionResult {
+    err: any | null;
+    logs: string[] | null;
+    accounts?: any[] | null;
+    unitsConsumed?: number;
+    returnData?: any | null;
+}
+interface AccountInfo {
+    lamports: number;
+    owner: string;
+    data: any;
+    executable: boolean;
+    rentEpoch: number;
+    space?: number;
+}
+interface AccountInfoConfig {
+    encoding?: 'base58' | 'base64' | 'base64+zstd' | 'jsonParsed';
+    dataSlice?: {
+        offset: number;
+        length: number;
+    };
+    commitment?: string;
+    minContextSlot?: number;
+}
+interface BlockCommitment {
+    commitment: number[] | null;
+    totalStake: number;
+}
+interface TokenAmount {
+    amount: string;
+    decimals: number;
+    uiAmount: number | null;
+    uiAmountString: string;
+}
+interface ProgramAccountsConfig {
+    filters?: Array<{
+        dataSize: number;
+    } | {
+        memcmp: {
+            offset: number;
+            bytes: string;
+        };
+    }>;
+    encoding?: 'base58' | 'base64' | 'base64+zstd' | 'jsonParsed';
+    withContext?: boolean;
+    commitment?: string;
+    minContextSlot?: number;
+}
+interface KeyedAccount {
+    pubkey: string;
+    account: AccountInfo;
+}
+interface AccountBalance {
+    address: string;
+    lamports: number;
+}
+interface SupplyConfig {
+    commitment?: string;
+    excludeNonCirculatingAccountsList?: boolean;
+}
+interface Supply {
+    total: number;
+    circulating: number;
+    nonCirculating: number;
+    nonCirculatingAccounts: string[];
+}
+interface TokenAccountBalance {
+    address: string;
+    amount: string;
+    decimals: number;
+    uiAmount: number | null;
+    uiAmountString: string;
+}
+type TokenAccountsFilter = {
+    mint: string;
+} | {
+    programId: string;
+};
+
+declare class SurfmanClient {
+    private url;
+    private timeout;
+    private headers;
+    private requestId;
+    constructor(config: string | RpcClientConfig);
+    request<TParams = any, TResult = any>(method: string, params: TParams): Promise<TResult>;
+    setUrl(url: string): void;
+    getUrl(): string;
+}
+
+declare class CheatcodesModule {
+    private client;
+    constructor(client: SurfmanClient);
+    timeTravel(config: TimeTravelConfig): Promise<TimeTravelResult>;
+    setAccount(pubkey: string, update: SetAccountUpdate): Promise<void>;
+    setProgramAuthority(programId: string, newAuthority: string | null): Promise<void>;
+    pauseClock(): Promise<TimeTravelResult>;
+    resumeClock(): Promise<TimeTravelResult>;
+    getLocalSignatures(limit?: number): Promise<RpcLogsResponse[]>;
+    setTokenAccount(owner: string, mint: string, update: TokenAccountUpdate, tokenProgram?: string): Promise<void>;
+    resetAccount(pubkey: string, config?: ResetAccountConfig): Promise<void>;
+    resetNetwork(): Promise<void>;
+}
+
+interface SignatureForAddress {
+    signature: string;
+    slot: number;
+    err: any | null;
+    memo: string | null;
+    blockTime?: number | null;
+}
+interface SignaturesForAddressConfig {
+    limit?: number;
+    before?: string;
+    until?: string;
+    commitment?: string;
+}
+
+interface PrioritizationFee {
+    slot: number;
+    prioritizationFee: number;
+}
+
+declare class NetworkModule {
+    private client;
+    constructor(client: SurfmanClient);
+    getLatestBlockhash(config?: {
+        commitment?: string;
+        minContextSlot?: number;
+    }): Promise<BlockhashResult>;
+    getBlock(slot: number, config?: BlockConfig): Promise<Block | null>;
+    getBlockTime(slot: number): Promise<number | null>;
+    getFirstAvailableBlock(): Promise<number>;
+    minimumLedgerSlot(): Promise<number>;
+    getTransaction(signature: string, config?: TransactionConfig): Promise<TransactionResult | null>;
+    getSignatureStatuses(signatures: string[], config?: {
+        searchTransactionHistory?: boolean;
+    }): Promise<(SignatureStatus | null)[]>;
+    sendTransaction(transaction: string, config?: SendTransactionConfig): Promise<string>;
+    simulateTransaction(transaction: string, config?: SimulateTransactionConfig): Promise<SimulateTransactionResult>;
+    getClusterNodes(): Promise<ClusterNode[]>;
+    getRecentPerformanceSamples(limit?: number): Promise<PerformanceSample[]>;
+    requestAirdrop(pubkey: string, lamports: number, config?: {
+        commitment?: string;
+    }): Promise<string>;
+    getBlocks(startSlot: number, endSlot?: number, config?: {
+        commitment?: string;
+    }): Promise<number[]>;
+    getBlocksWithLimit(startSlot: number, limit: number, config?: {
+        commitment?: string;
+    }): Promise<number[]>;
+    getSignaturesForAddress(address: string, config?: SignaturesForAddressConfig): Promise<SignatureForAddress[]>;
+    isBlockhashValid(blockhash: string, config?: {
+        commitment?: string;
+        minContextSlot?: number;
+    }): Promise<boolean>;
+    getFeeForMessage(message: string, config?: {
+        commitment?: string;
+    }): Promise<number | null>;
+    getRecentPrioritizationFees(addresses?: string[]): Promise<PrioritizationFee[]>;
+}
+
+declare class AccountsModule {
+    private client;
+    constructor(client: SurfmanClient);
+    getAccountInfo(pubkey: string, config?: AccountInfoConfig): Promise<AccountInfo | null>;
+    getMultipleAccounts(pubkeys: string[], config?: AccountInfoConfig): Promise<(AccountInfo | null)[]>;
+    getBlockCommitment(slot: number): Promise<BlockCommitment>;
+    getTokenAccountBalance(pubkey: string, config?: {
+        commitment?: string;
+    }): Promise<TokenAmount | null>;
+    getTokenSupply(mint: string, config?: {
+        commitment?: string;
+    }): Promise<TokenAmount>;
+}
+
+interface LargestAccountsConfig {
+    commitment?: string;
+    filter?: 'circulating' | 'nonCirculating';
+}
+
+declare class ScanModule {
+    private client;
+    constructor(client: SurfmanClient);
+    getProgramAccounts(programId: string, config?: ProgramAccountsConfig): Promise<KeyedAccount[]>;
+    getLargestAccounts(config?: LargestAccountsConfig): Promise<AccountBalance[]>;
+    getSupply(config?: SupplyConfig): Promise<Supply>;
+    getTokenLargestAccounts(mint: string, config?: {
+        commitment?: string;
+    }): Promise<TokenAccountBalance[]>;
+    getTokenAccountsByOwner(owner: string, filter: TokenAccountsFilter, config?: AccountInfoConfig): Promise<KeyedAccount[]>;
+    getTokenAccountsByDelegate(delegate: string, filter: TokenAccountsFilter, config?: AccountInfoConfig): Promise<KeyedAccount[]>;
+}
+
+declare class Surfman {
+    cheatcodes: CheatcodesModule;
+    network: NetworkModule;
+    accounts: AccountsModule;
+    scan: ScanModule;
+    private client;
+    constructor(config: string | RpcClientConfig);
+    getClient(): SurfmanClient;
+}
+
+export { type AccountBalance, type AccountInfo, type AccountInfoConfig, AccountsModule, type Block, type BlockCommitment, type BlockConfig, type BlockhashResult, CheatcodesModule, type ClusterNode, type JsonRpcError, type JsonRpcRequest, type JsonRpcResponse, type KeyedAccount, NetworkModule, type PerformanceSample, type ProgramAccountsConfig, type ResetAccountConfig, type RpcClientConfig, type RpcLogsResponse, ScanModule, type SendTransactionConfig, type SetAccountUpdate, type SetProgramAuthorityParams, type SetSomeAccount, type SignatureStatus, type SimulateTransactionConfig, type SimulateTransactionResult, type Supply, type SupplyConfig, Surfman, SurfmanClient, type TimeTravelConfig, type TimeTravelResult, type TokenAccountBalance, type TokenAccountUpdate, type TokenAccountsFilter, type TokenAmount, type TransactionConfig, type TransactionResult };

package/dist/index.d.ts

@@ -0,0 +1,345 @@
+interface JsonRpcRequest<T = any> {
+    jsonrpc: '2.0';
+    id: number | string;
+    method: string;
+    params: T;
+}
+interface JsonRpcResponse<T = any> {
+    jsonrpc: '2.0';
+    id: number | string;
+    result?: T;
+    error?: JsonRpcError;
+}
+interface JsonRpcError {
+    code: number;
+    message: string;
+    data?: any;
+}
+interface RpcClientConfig {
+    url: string;
+    timeout?: number;
+    headers?: Record<string, string>;
+}
+
+interface TimeTravelConfig {
+    absoluteEpoch?: number;
+    absoluteSlot?: number;
+    absoluteTimestamp?: number;
+}
+interface TimeTravelResult {
+    absoluteSlot: number;
+    blockHeight: number | null;
+    epoch: number;
+    slotIndex: number;
+    slotsInEpoch: number;
+    transactionCount: number | null;
+}
+interface SetAccountUpdate {
+    data?: string;
+    executable?: boolean;
+    lamports?: number;
+    owner?: string;
+    rentEpoch?: number;
+}
+interface SetProgramAuthorityParams {
+    programId: string;
+    newAuthority: string | null;
+}
+interface TokenAccountUpdate {
+    amount?: number;
+    delegate?: SetSomeAccount;
+    state?: string;
+    delegatedAmount?: number;
+    closeAuthority?: SetSomeAccount;
+}
+interface SetSomeAccount {
+    Account?: string;
+    NoAccount?: boolean;
+}
+interface ResetAccountConfig {
+    includeOwnedAccounts?: boolean;
+}
+interface RpcLogsResponse {
+    signature: string;
+    err: any | null;
+    slot: number;
+    logs?: string[];
+}
+
+interface BlockhashResult {
+    blockhash: string;
+    lastValidBlockHeight: number;
+}
+interface BlockConfig {
+    encoding?: 'json' | 'jsonParsed' | 'base58' | 'base64';
+    transactionDetails?: 'full' | 'signatures' | 'none';
+    rewards?: boolean;
+    commitment?: string;
+    maxSupportedTransactionVersion?: number;
+}
+interface Block {
+    blockhash: string;
+    previousBlockhash: string;
+    parentSlot: number;
+    transactions?: any[];
+    signatures?: string[];
+    rewards?: any[];
+    blockTime?: number | null;
+    blockHeight?: number | null;
+}
+interface TransactionConfig {
+    encoding?: 'json' | 'jsonParsed' | 'base58' | 'base64';
+    commitment?: string;
+    maxSupportedTransactionVersion?: number;
+}
+interface TransactionResult {
+    slot: number;
+    transaction: any;
+    blockTime?: number | null;
+    meta?: any;
+}
+interface SignatureStatus {
+    slot: number;
+    confirmations: number | null;
+    err: any | null;
+    confirmationStatus?: 'processed' | 'confirmed' | 'finalized';
+}
+interface PerformanceSample {
+    slot: number;
+    numTransactions: number;
+    numSlots: number;
+    samplePeriodSecs: number;
+    numNonVoteTransactions?: number;
+}
+interface ClusterNode {
+    pubkey: string;
+    gossip?: string | null;
+    tpu?: string | null;
+    rpc?: string | null;
+    version?: string | null;
+    featureSet?: number | null;
+    shredVersion?: number | null;
+}
+interface SendTransactionConfig {
+    skipPreflight?: boolean;
+    preflightCommitment?: string;
+    encoding?: 'base58' | 'base64';
+    maxRetries?: number;
+    minContextSlot?: number;
+}
+interface SimulateTransactionConfig {
+    commitment?: string;
+    sigVerify?: boolean;
+    replaceRecentBlockhash?: boolean;
+    minContextSlot?: number;
+    encoding?: 'base58' | 'base64';
+    accounts?: {
+        encoding: string;
+        addresses: string[];
+    };
+}
+interface SimulateTransactionResult {
+    err: any | null;
+    logs: string[] | null;
+    accounts?: any[] | null;
+    unitsConsumed?: number;
+    returnData?: any | null;
+}
+interface AccountInfo {
+    lamports: number;
+    owner: string;
+    data: any;
+    executable: boolean;
+    rentEpoch: number;
+    space?: number;
+}
+interface AccountInfoConfig {
+    encoding?: 'base58' | 'base64' | 'base64+zstd' | 'jsonParsed';
+    dataSlice?: {
+        offset: number;
+        length: number;
+    };
+    commitment?: string;
+    minContextSlot?: number;
+}
+interface BlockCommitment {
+    commitment: number[] | null;
+    totalStake: number;
+}
+interface TokenAmount {
+    amount: string;
+    decimals: number;
+    uiAmount: number | null;
+    uiAmountString: string;
+}
+interface ProgramAccountsConfig {
+    filters?: Array<{
+        dataSize: number;
+    } | {
+        memcmp: {
+            offset: number;
+            bytes: string;
+        };
+    }>;
+    encoding?: 'base58' | 'base64' | 'base64+zstd' | 'jsonParsed';
+    withContext?: boolean;
+    commitment?: string;
+    minContextSlot?: number;
+}
+interface KeyedAccount {
+    pubkey: string;
+    account: AccountInfo;
+}
+interface AccountBalance {
+    address: string;
+    lamports: number;
+}
+interface SupplyConfig {
+    commitment?: string;
+    excludeNonCirculatingAccountsList?: boolean;
+}
+interface Supply {
+    total: number;
+    circulating: number;
+    nonCirculating: number;
+    nonCirculatingAccounts: string[];
+}
+interface TokenAccountBalance {
+    address: string;
+    amount: string;
+    decimals: number;
+    uiAmount: number | null;
+    uiAmountString: string;
+}
+type TokenAccountsFilter = {
+    mint: string;
+} | {
+    programId: string;
+};
+
+declare class SurfmanClient {
+    private url;
+    private timeout;
+    private headers;
+    private requestId;
+    constructor(config: string | RpcClientConfig);
+    request<TParams = any, TResult = any>(method: string, params: TParams): Promise<TResult>;
+    setUrl(url: string): void;
+    getUrl(): string;
+}
+
+declare class CheatcodesModule {
+    private client;
+    constructor(client: SurfmanClient);
+    timeTravel(config: TimeTravelConfig): Promise<TimeTravelResult>;
+    setAccount(pubkey: string, update: SetAccountUpdate): Promise<void>;
+    setProgramAuthority(programId: string, newAuthority: string | null): Promise<void>;
+    pauseClock(): Promise<TimeTravelResult>;
+    resumeClock(): Promise<TimeTravelResult>;
+    getLocalSignatures(limit?: number): Promise<RpcLogsResponse[]>;
+    setTokenAccount(owner: string, mint: string, update: TokenAccountUpdate, tokenProgram?: string): Promise<void>;
+    resetAccount(pubkey: string, config?: ResetAccountConfig): Promise<void>;
+    resetNetwork(): Promise<void>;
+}
+
+interface SignatureForAddress {
+    signature: string;
+    slot: number;
+    err: any | null;
+    memo: string | null;
+    blockTime?: number | null;
+}
+interface SignaturesForAddressConfig {
+    limit?: number;
+    before?: string;
+    until?: string;
+    commitment?: string;
+}
+
+interface PrioritizationFee {
+    slot: number;
+    prioritizationFee: number;
+}
+
+declare class NetworkModule {
+    private client;
+    constructor(client: SurfmanClient);
+    getLatestBlockhash(config?: {
+        commitment?: string;
+        minContextSlot?: number;
+    }): Promise<BlockhashResult>;
+    getBlock(slot: number, config?: BlockConfig): Promise<Block | null>;
+    getBlockTime(slot: number): Promise<number | null>;
+    getFirstAvailableBlock(): Promise<number>;
+    minimumLedgerSlot(): Promise<number>;
+    getTransaction(signature: string, config?: TransactionConfig): Promise<TransactionResult | null>;
+    getSignatureStatuses(signatures: string[], config?: {
+        searchTransactionHistory?: boolean;
+    }): Promise<(SignatureStatus | null)[]>;
+    sendTransaction(transaction: string, config?: SendTransactionConfig): Promise<string>;
+    simulateTransaction(transaction: string, config?: SimulateTransactionConfig): Promise<SimulateTransactionResult>;
+    getClusterNodes(): Promise<ClusterNode[]>;
+    getRecentPerformanceSamples(limit?: number): Promise<PerformanceSample[]>;
+    requestAirdrop(pubkey: string, lamports: number, config?: {
+        commitment?: string;
+    }): Promise<string>;
+    getBlocks(startSlot: number, endSlot?: number, config?: {
+        commitment?: string;
+    }): Promise<number[]>;
+    getBlocksWithLimit(startSlot: number, limit: number, config?: {
+        commitment?: string;
+    }): Promise<number[]>;
+    getSignaturesForAddress(address: string, config?: SignaturesForAddressConfig): Promise<SignatureForAddress[]>;
+    isBlockhashValid(blockhash: string, config?: {
+        commitment?: string;
+        minContextSlot?: number;
+    }): Promise<boolean>;
+    getFeeForMessage(message: string, config?: {
+        commitment?: string;
+    }): Promise<number | null>;
+    getRecentPrioritizationFees(addresses?: string[]): Promise<PrioritizationFee[]>;
+}
+
+declare class AccountsModule {
+    private client;
+    constructor(client: SurfmanClient);
+    getAccountInfo(pubkey: string, config?: AccountInfoConfig): Promise<AccountInfo | null>;
+    getMultipleAccounts(pubkeys: string[], config?: AccountInfoConfig): Promise<(AccountInfo | null)[]>;
+    getBlockCommitment(slot: number): Promise<BlockCommitment>;
+    getTokenAccountBalance(pubkey: string, config?: {
+        commitment?: string;
+    }): Promise<TokenAmount | null>;
+    getTokenSupply(mint: string, config?: {
+        commitment?: string;
+    }): Promise<TokenAmount>;
+}
+
+interface LargestAccountsConfig {
+    commitment?: string;
+    filter?: 'circulating' | 'nonCirculating';
+}
+
+declare class ScanModule {
+    private client;
+    constructor(client: SurfmanClient);
+    getProgramAccounts(programId: string, config?: ProgramAccountsConfig): Promise<KeyedAccount[]>;
+    getLargestAccounts(config?: LargestAccountsConfig): Promise<AccountBalance[]>;
+    getSupply(config?: SupplyConfig): Promise<Supply>;
+    getTokenLargestAccounts(mint: string, config?: {
+        commitment?: string;
+    }): Promise<TokenAccountBalance[]>;
+    getTokenAccountsByOwner(owner: string, filter: TokenAccountsFilter, config?: AccountInfoConfig): Promise<KeyedAccount[]>;
+    getTokenAccountsByDelegate(delegate: string, filter: TokenAccountsFilter, config?: AccountInfoConfig): Promise<KeyedAccount[]>;
+}
+
+declare class Surfman {
+    cheatcodes: CheatcodesModule;
+    network: NetworkModule;
+    accounts: AccountsModule;
+    scan: ScanModule;
+    private client;
+    constructor(config: string | RpcClientConfig);
+    getClient(): SurfmanClient;
+}
+
+export { type AccountBalance, type AccountInfo, type AccountInfoConfig, AccountsModule, type Block, type BlockCommitment, type BlockConfig, type BlockhashResult, CheatcodesModule, type ClusterNode, type JsonRpcError, type JsonRpcRequest, type JsonRpcResponse, type KeyedAccount, NetworkModule, type PerformanceSample, type ProgramAccountsConfig, type ResetAccountConfig, type RpcClientConfig, type RpcLogsResponse, ScanModule, type SendTransactionConfig, type SetAccountUpdate, type SetProgramAuthorityParams, type SetSomeAccount, type SignatureStatus, type SimulateTransactionConfig, type SimulateTransactionResult, type Supply, type SupplyConfig, Surfman, SurfmanClient, type TimeTravelConfig, type TimeTravelResult, type TokenAccountBalance, type TokenAccountUpdate, type TokenAccountsFilter, type TokenAmount, type TransactionConfig, type TransactionResult };