genlayer-js 0.9.0 → 0.9.1

package/dist/index-kDM_9wW1.d.cts

@@ -0,0 +1,370 @@
+import { Hex, Address, Client, Transport, WalletActions, PublicActions, Account } from 'viem';
+import { G as GenLayerChain } from './chains-BYSCF33g.cjs';
+
+declare class CalldataAddress {
+    bytes: Uint8Array;
+    constructor(addr: Uint8Array);
+}
+type CalldataEncodable = null | boolean | CalldataAddress | number | bigint | string | Uint8Array | Array<CalldataEncodable> | Map<string, CalldataEncodable> | {
+    [key: string]: CalldataEncodable;
+};
+type MethodDescription = {
+    method: string;
+    args: Array<CalldataEncodable>;
+};
+type TransactionDataElement = string | number | bigint | boolean | Uint8Array;
+
+type Hash = `0x${string}` & {
+    length: 66;
+};
+type TransactionHash = Hash;
+declare enum TransactionStatus {
+    UNINITIALIZED = "UNINITIALIZED",
+    PENDING = "PENDING",
+    PROPOSING = "PROPOSING",
+    COMMITTING = "COMMITTING",
+    REVEALING = "REVEALING",
+    ACCEPTED = "ACCEPTED",
+    UNDETERMINED = "UNDETERMINED",
+    FINALIZED = "FINALIZED",
+    CANCELED = "CANCELED",
+    APPEAL_REVEALING = "APPEAL_REVEALING",
+    APPEAL_COMMITTING = "APPEAL_COMMITTING",
+    READY_TO_FINALIZE = "READY_TO_FINALIZE",
+    VALIDATORS_TIMEOUT = "VALIDATORS_TIMEOUT",
+    LEADER_TIMEOUT = "LEADER_TIMEOUT"
+}
+declare enum TransactionResult {
+    SUCCESS = "SUCCESS",
+    FAILURE = "FAILURE"
+}
+declare enum TransactionResult {
+    IDLE = "IDLE",
+    AGREE = "AGREE",
+    DISAGREE = "DISAGREE",
+    TIMEOUT = "TIMEOUT",
+    DETERMINISTIC_VIOLATION = "DETERMINISTIC_VIOLATION",
+    NO_MAJORITY = "NO_MAJORITY",
+    MAJORITY_AGREE = "MAJORITY_AGREE",
+    MAJORITY_DISAGREE = "MAJORITY_DISAGREE"
+}
+declare const transactionsStatusNumberToName: {
+    "0": TransactionStatus;
+    "1": TransactionStatus;
+    "2": TransactionStatus;
+    "3": TransactionStatus;
+    "4": TransactionStatus;
+    "5": TransactionStatus;
+    "6": TransactionStatus;
+    "7": TransactionStatus;
+    "8": TransactionStatus;
+    "9": TransactionStatus;
+    "10": TransactionStatus;
+    "11": TransactionStatus;
+    "12": TransactionStatus;
+    "13": TransactionStatus;
+};
+declare const transactionsStatusNameToNumber: {
+    UNINITIALIZED: string;
+    PENDING: string;
+    PROPOSING: string;
+    COMMITTING: string;
+    REVEALING: string;
+    ACCEPTED: string;
+    UNDETERMINED: string;
+    FINALIZED: string;
+    CANCELED: string;
+    APPEAL_REVEALING: string;
+    APPEAL_COMMITTING: string;
+    READY_TO_FINALIZE: string;
+    VALIDATORS_TIMEOUT: string;
+    LEADER_TIMEOUT: string;
+};
+declare const transactionResultNumberToName: {
+    "0": TransactionResult;
+    "1": TransactionResult;
+    "2": TransactionResult;
+    "3": TransactionResult;
+    "4": TransactionResult;
+    "5": TransactionResult;
+    "6": TransactionResult;
+    "7": TransactionResult;
+};
+declare const TransactionResultNameToNumber: {
+    IDLE: string;
+    AGREE: string;
+    DISAGREE: string;
+    TIMEOUT: string;
+    DETERMINISTIC_VIOLATION: string;
+    NO_MAJORITY: string;
+    MAJORITY_AGREE: string;
+    MAJORITY_DISAGREE: string;
+};
+declare enum VoteType {
+    NOT_VOTED = "NOT_VOTED",
+    AGREE = "AGREE",
+    DISAGREE = "DISAGREE",
+    TIMEOUT = "TIMEOUT",
+    DETERMINISTIC_VIOLATION = "DETERMINISTIC_VIOLATION"
+}
+declare const voteTypeNumberToName: {
+    "0": VoteType;
+    "1": VoteType;
+    "2": VoteType;
+    "3": VoteType;
+    "4": VoteType;
+};
+declare const voteTypeNameToNumber: {
+    NOT_VOTED: string;
+    AGREE: string;
+    DISAGREE: string;
+    TIMEOUT: string;
+    DETERMINISTIC_VIOLATION: string;
+};
+type TransactionType = "deploy" | "call";
+type DecodedDeployData = {
+    code?: Hex;
+    constructorArgs?: any;
+    leaderOnly?: boolean;
+    type?: TransactionType;
+    contractAddress?: Address;
+};
+type DecodedCallData = {
+    callData?: any;
+    leaderOnly?: boolean;
+    type: TransactionType;
+};
+type GenLayerTransaction = {
+    currentTimestamp?: string;
+    from_address?: Address;
+    sender?: Address;
+    to_address?: Address;
+    recipient?: Address;
+    numOfInitialValidators?: string;
+    txSlot?: string;
+    createdTimestamp?: string;
+    lastVoteTimestamp?: string;
+    randomSeed?: Hash;
+    result?: number;
+    resultName?: TransactionResult;
+    data?: Record<string, unknown>;
+    txData?: Hex;
+    txDataDecoded?: DecodedDeployData | DecodedCallData;
+    txReceipt?: Hash;
+    messages?: unknown[];
+    queueType?: number;
+    queuePosition?: string;
+    activator?: Address;
+    lastLeader?: Address;
+    status?: TransactionStatus | number;
+    statusName?: TransactionStatus;
+    hash?: TransactionHash;
+    txId?: TransactionHash;
+    readStateBlockRange?: {
+        activationBlock: string;
+        processingBlock: string;
+        proposalBlock: string;
+    };
+    numOfRounds?: string;
+    lastRound?: {
+        round: string;
+        leaderIndex: string;
+        votesCommitted: string;
+        votesRevealed: string;
+        appealBond: string;
+        rotationsLeft: string;
+        result: number;
+        roundValidators: Address[];
+        validatorVotesHash: Hash[];
+        validatorVotes: number[];
+        validatorVotesName: VoteType[];
+    };
+    consensus_data?: {
+        final: boolean;
+        leader_receipt?: {
+            calldata: string;
+            class_name: string;
+            contract_state: string;
+            eq_outputs: Record<string, unknown>;
+            error: string | null;
+            execution_result: string;
+            gas_used: number;
+            mode: string;
+            node_config: Record<string, unknown>;
+            pending_transactions: unknown[];
+            vote: string;
+            result: string;
+        };
+        validators?: Record<string, unknown>[];
+        votes?: Record<string, string>;
+    };
+    nonce?: number;
+    value?: number;
+    type?: number;
+    gaslimit?: bigint;
+    created_at?: Date;
+    r?: number;
+    s?: number;
+    v?: number;
+};
+type GenLayerRawTransaction = {
+    currentTimestamp: bigint;
+    sender: Address;
+    recipient: Address;
+    numOfInitialValidators: bigint;
+    txSlot: bigint;
+    createdTimestamp: bigint;
+    lastVoteTimestamp: bigint;
+    randomSeed: Hash;
+    result: number;
+    txData: Hex | undefined | null;
+    txReceipt: Hash;
+    messages: unknown[];
+    queueType: number;
+    queuePosition: bigint;
+    activator: Address;
+    lastLeader: Address;
+    status: number;
+    txId: Hash;
+    readStateBlockRange: {
+        activationBlock: bigint;
+        processingBlock: bigint;
+        proposalBlock: bigint;
+    };
+    numOfRounds: bigint;
+    lastRound: {
+        round: bigint;
+        leaderIndex: bigint;
+        votesCommitted: bigint;
+        votesRevealed: bigint;
+        appealBond: bigint;
+        rotationsLeft: bigint;
+        result: number;
+        roundValidators: Address[];
+        validatorVotesHash: Hash[];
+        validatorVotes: number[];
+    };
+};
+
+type ContractParamsArraySchemaElement = ContractParamsSchema | {
+    $rep: ContractParamsSchema;
+};
+type ContractParamsSchema = "null" | "bool" | "int" | "address" | "string" | "bytes" | "any" | "array" | "dict" | {
+    $or: ContractParamsSchema[];
+} | {
+    $dict: ContractParamsSchema;
+} | {
+    [key: string]: ContractParamsSchema;
+} | ContractParamsArraySchemaElement[];
+interface ContractMethodBase {
+    params: [string, ContractParamsSchema][];
+    kwparams: {
+        [key: string]: ContractParamsSchema;
+    };
+}
+interface ContractMethod extends ContractMethodBase {
+    ret: ContractParamsSchema;
+    readonly: boolean;
+}
+type ContractSchema = {
+    ctor: ContractMethodBase;
+    methods: ContractMethod[];
+};
+
+type Network = 'localnet' | 'testnet' | 'mainnet';
+
+type SnapSource = 'npm' | 'local';
+
+type MetaMaskClientResult = {
+    isFlask: boolean;
+    installedSnaps: Record<string, any>;
+    isGenLayerSnapInstalled: boolean;
+};
+
+type GenLayerMethod = {
+    method: "sim_fundAccount";
+    params: [address: Address, amount: number];
+} | {
+    method: "eth_getTransactionByHash";
+    params: [hash: TransactionHash];
+} | {
+    method: "eth_call";
+    params: [requestParams: any, blockNumberOrHash: string];
+} | {
+    method: "eth_sendRawTransaction";
+    params: [signedTransaction: string];
+} | {
+    method: "gen_getContractSchema";
+    params: [address: Address];
+} | {
+    method: "gen_getContractSchemaForCode";
+    params: [contractCode: string];
+} | {
+    method: "sim_getTransactionsForAddress";
+    params: [address: Address, filter?: "all" | "from" | "to"];
+} | {
+    method: "eth_getTransactionCount";
+    params: [address: Address, block: string];
+} | {
+    method: "gen_call";
+    params: [requestParams: any];
+};
+type GenLayerClient<TGenLayerChain extends GenLayerChain> = Omit<Client<Transport, TGenLayerChain>, "transport" | "getTransaction" | "readContract"> & Omit<WalletActions<TGenLayerChain>, "deployContract" | "writeContract"> & Omit<PublicActions<Transport, TGenLayerChain>, "readContract" | "getTransaction" | "waitForTransactionReceipt"> & {
+    request: Client<Transport, TGenLayerChain>["request"] & {
+        <TMethod extends GenLayerMethod>(args: Extract<GenLayerMethod, {
+            method: TMethod["method"];
+        }>): Promise<unknown>;
+    };
+    readContract: <RawReturn extends boolean | undefined>(args: {
+        account?: Account;
+        address: Address;
+        functionName: string;
+        stateStatus?: TransactionStatus;
+        args?: CalldataEncodable[];
+        kwargs?: Map<string, CalldataEncodable> | {
+            [key: string]: CalldataEncodable;
+        };
+        rawReturn?: RawReturn;
+    }) => Promise<RawReturn extends true ? `0x${string}` : CalldataEncodable>;
+    writeContract: (args: {
+        account?: Account;
+        address: Address;
+        functionName: string;
+        args?: CalldataEncodable[];
+        kwargs?: Map<string, CalldataEncodable> | {
+            [key: string]: CalldataEncodable;
+        };
+        value: bigint;
+        leaderOnly?: boolean;
+        consensusMaxRotations?: number;
+    }) => Promise<any>;
+    deployContract: (args: {
+        account?: Account;
+        code: string | Uint8Array;
+        args?: CalldataEncodable[];
+        kwargs?: Map<string, CalldataEncodable> | {
+            [key: string]: CalldataEncodable;
+        };
+        leaderOnly?: boolean;
+        consensusMaxRotations?: number;
+    }) => Promise<`0x${string}`>;
+    getTransaction: (args: {
+        hash: TransactionHash;
+    }) => Promise<GenLayerTransaction>;
+    getCurrentNonce: (args: {
+        address: Address;
+    }) => Promise<number>;
+    waitForTransactionReceipt: (args: {
+        hash: TransactionHash;
+        status?: TransactionStatus;
+        interval?: number;
+        retries?: number;
+    }) => Promise<GenLayerTransaction>;
+    getContractSchema: (address: Address) => Promise<ContractSchema>;
+    getContractSchemaForCode: (contractCode: string | Uint8Array) => Promise<ContractSchema>;
+    initializeConsensusSmartContract: (forceReset?: boolean) => Promise<void>;
+    connect: (network?: Network, snapSource?: SnapSource) => Promise<void>;
+    metamaskClient: (snapSource?: SnapSource) => Promise<MetaMaskClientResult>;
+};
+
+export { type CalldataEncodable as C, type DecodedDeployData as D, type GenLayerClient as G, type Hash as H, type MethodDescription as M, type Network as N, type SnapSource as S, type TransactionDataElement as T, VoteType as V, CalldataAddress as a, type GenLayerMethod as b, type ContractParamsArraySchemaElement as c, type ContractParamsSchema as d, type ContractMethodBase as e, type ContractMethod as f, type ContractSchema as g, type TransactionHash as h, TransactionStatus as i, TransactionResult as j, transactionsStatusNameToNumber as k, transactionResultNumberToName as l, TransactionResultNameToNumber as m, voteTypeNameToNumber as n, type TransactionType as o, type DecodedCallData as p, type GenLayerTransaction as q, type GenLayerRawTransaction as r, transactionsStatusNumberToName as t, voteTypeNumberToName as v };