@tenderly/actions/lib/actions.d.ts

Types for Web3 Actions

import { Network } from './networks';
import { GatewayNetwork } from './gateway-networks';
/**
 * Function must implement ActionFn. Event payload depends on a configured trigger.
 */
export type ActionFn = (ctx: Context, event: Event) => Promise<any>;
/**
 * Event provided to function depends on a configured trigger.
 */
export interface Event {
}
/**
 * For trigger type "periodic"
 */
export interface PeriodicEvent extends Event {
    /**
     * Time when this periodic event is created.
     */
    time: Date;
}
/**
 * For trigger type "webhook"
 */
export interface WebhookEvent extends Event {
    /**
     * Time when webhook required is received.
     */
    time: Date;
    /**
     * JSON-body of POST request.
     */
    payload: any;
}
/**
 * For actions triggered by extensions.
 */
export type ExtensionEvent = any[];
/**
 * For trigger type "block
 */
export interface BlockEvent extends Event {
    /**
     * Chain identifier.
     */
    network: string;
    blockHash: string;
    blockNumber: number;
    blockDifficulty: string;
    totalDifficulty: string;
}
export interface TransactionEvent extends Event {
    /**
     * Chain identifier.
     */
    network: string;
    blockHash: string;
    blockNumber: number;
    /**
     * Transaction hash.
     */
    hash: string;
    /**
     * @deprecated Use hash instead.
     */
    transactionHash: string;
    from: string;
    to?: string;
    logs: Log[];
    /**
     * Hex encoded.
     */
    input: string;
    value: string;
    nonce: string;
    gas: string;
    gasUsed: string;
    cumulativeGasUsed: string;
    gasPrice: string;
    gasTipCap: string;
    gasFeeCap: string;
    /**
     * If event was created from alert.
     */
    alertId?: string;
}
/**
 * Alert type is deprecated. This is for back-compat.
 */
export interface AlertEvent extends TransactionEvent {
}
export interface Log {
    /**
     * Hex-encoded address.
     */
    address: string;
    /**
     * Hex-encoded topics.
     */
    topics: string[];
    /**
     * Hex-encoded data.
     */
    data: string;
}
export interface Context {
    /**
     * Project's key-value store.
     */
    readonly storage: Storage;
    /**
     * Project's secrets.
     */
    readonly secrets: Secrets;
    /**
     * Project's gateways.
     */
    readonly gateways: Gateways;
    /**
     * Execution metadata.
     */
    readonly metadata: Metadata;
}
export interface Secrets {
    /**
     * Gets secret with key or throws if secret does not exist.
     */
    get(key: string): Promise<string>;
}
export interface Storage {
    /**
     * Gets storage entry.
     */
    getStr(key: string): Promise<string>;
    getNumber(key: string): Promise<number>;
    getBigInt(key: string): Promise<bigint>;
    getJson(key: string): Promise<any>;
    /**
     * Writes storage entry.
     */
    putStr(key: string, value: string): Promise<void>;
    putNumber(key: string, value: number): Promise<void>;
    putBigInt(key: string, value: bigint): Promise<void>;
    putJson(key: string, value: any): Promise<void>;
    /**
     * Deletes storage entry.
     */
    delete(key: string): Promise<void>;
}
export interface Gateways {
    /**
     * Creates gateway provider (name param is reserved for future use)
     */
    getGateway(network?: GatewayNetwork, name?: string): string;
}
export interface Metadata {
    /**
     * Gets network of the current execution.
     * If current execution doesn't happen in a context of a network, returns undefined.
     */
    getNetwork(): Network | undefined;
}
export { Network } from './networks';
export { GatewayNetwork } from './gateway-networks';
//# sourceMappingURL=actions.d.ts.map