ox/dist/tempo/Channel.d.ts

Ethereum Standard Library

import * as AbiParameters from '../core/AbiParameters.js';
import * as Address from '../core/Address.js';
import type * as Errors from '../core/Errors.js';
import * as Hash from '../core/Hash.js';
import * as Hex from '../core/Hex.js';
/**
 * TIP-20 channel reserve precompile address.
 */
export declare const address: "0x4d50500000000000000000000000000000000000";
/**
 * Delay between payer `requestClose` and `withdraw`, in seconds.
 */
export declare const closeGracePeriod = 900n;
/**
 * EIP-712 type hash for `Voucher(bytes32 channelId,uint96 cumulativeAmount)`.
 */
export declare const voucherTypehash: `0x${string}`;
/**
 * TIP-20 channel descriptor.
 */
export type Channel = {
    /** Optional signer for vouchers. Zero means `payer` signs. */
    authorizedSigner: Address.Address;
    /** Transaction-derived hash assigned when the channel was opened. */
    expiringNonceHash: Hex.Hex;
    /** Optional relayer allowed to submit `settle` for the payee. */
    operator: Address.Address;
    /** Account that receives settled voucher payments. */
    payee: Address.Address;
    /** Account that funded the channel and receives refunds. */
    payer: Address.Address;
    /** User-supplied salt to distinguish otherwise identical channels. */
    salt: Hex.Hex;
    /** TIP-20 token address held by the channel. */
    token: Address.Address;
};
/**
 * Instantiates a TIP-20 channel reserve descriptor.
 *
 * Defaults `operator` and `authorizedSigner` to the zero address.
 *
 * @example
 * ```ts twoslash
 * import { Channel } from 'ox/tempo'
 *
 * const channel = Channel.from({
 *   expiringNonceHash:
 *     '0x0000000000000000000000000000000000000000000000000000000000000002',
 *   payee: '0x2222222222222222222222222222222222222222',
 *   payer: '0x1111111111111111111111111111111111111111',
 *   salt: '0x0000000000000000000000000000000000000000000000000000000000000001',
 *   token: '0x20c0000000000000000000000000000000000001'
 * })
 * ```
 *
 * @param value - The channel descriptor input.
 * @returns The normalized channel descriptor.
 */
export declare function from(value: from.Value): from.ReturnType;
export declare namespace from {
    type Value = {
        /** Optional signer for vouchers. Zero means `payer` signs. */
        authorizedSigner?: Address.Address | undefined;
        /** Transaction-derived hash assigned when the channel was opened. */
        expiringNonceHash: Hex.Hex;
        /** Optional relayer allowed to submit `settle` for the payee. */
        operator?: Address.Address | undefined;
        /** Account that receives settled voucher payments. */
        payee: Address.Address;
        /** Account that funded the channel and receives refunds. */
        payer: Address.Address;
        /** User-supplied salt to distinguish otherwise identical channels. */
        salt: Hex.Hex;
        /** TIP-20 token address held by the channel. */
        token: Address.Address;
    };
    type ReturnType = Channel;
    type ErrorType = Address.from.ErrorType | Errors.GlobalErrorType;
}
/**
 * Computes the canonical TIP-20 channel id for a descriptor.
 *
 * Mirrors `computeChannelId` on the TIP-20 channel reserve precompile without
 * performing an RPC call.
 *
 * @example
 * ```ts twoslash
 * import { Channel } from 'ox/tempo'
 *
 * const channelId = Channel.computeId(
 *   {
 *     authorizedSigner:
 *       '0x0000000000000000000000000000000000000000',
 *     expiringNonceHash:
 *       '0x0000000000000000000000000000000000000000000000000000000000000000',
 *     operator: '0x0000000000000000000000000000000000000000',
 *     payee: '0x2222222222222222222222222222222222222222',
 *     payer: '0x1111111111111111111111111111111111111111',
 *     salt: '0x0000000000000000000000000000000000000000000000000000000000000001',
 *     token: '0x20c0000000000000000000000000000000000001'
 *   },
 *   {
 *     chainId: 4217
 *   }
 * )
 * ```
 *
 * @param channel - Channel descriptor.
 * @param options - Options.
 * @returns The channel id.
 */
export declare function computeId(channel: computeId.Channel, options: computeId.Options): Hex.Hex;
export declare namespace computeId {
    type Channel = from.Value;
    type Options = {
        /** Chain ID used by the channel reserve precompile. */
        chainId: number | bigint;
    };
    type ErrorType = AbiParameters.encode.ErrorType | from.ErrorType | Hash.keccak256.ErrorType;
}
/**
 * Computes the EIP-712 domain separator for the TIP-20 channel reserve.
 *
 * Mirrors `domainSeparator` on the TIP-20 channel reserve precompile without
 * performing an RPC call.
 *
 * @example
 * ```ts twoslash
 * import { Channel } from 'ox/tempo'
 *
 * const separator = Channel.domainSeparator({ chainId: 4217 })
 * ```
 *
 * @param value - Chain id.
 * @returns The EIP-712 domain separator.
 */
export declare function domainSeparator(value: domainSeparator.Value): Hex.Hex;
export declare namespace domainSeparator {
    type Value = {
        /** Chain id used by the channel reserve precompile. */
        chainId: number | bigint;
    };
    type ErrorType = AbiParameters.encode.ErrorType | Hash.keccak256.ErrorType;
}
/**
 * Computes the EIP-712 sign payload for a TIP-20 channel voucher.
 *
 * Mirrors `getVoucherDigest` on the TIP-20 channel reserve precompile without
 * performing an RPC call.
 *
 * @example
 * ```ts twoslash
 * import { Channel } from 'ox/tempo'
 *
 * const payload = Channel.getVoucherSignPayload({
 *   chainId: 4217,
 *   channelId:
 *     '0x0000000000000000000000000000000000000000000000000000000000000000',
 *   cumulativeAmount: 1n
 * })
 * ```
 *
 * @param value - Voucher fields and chain id.
 * @returns The voucher sign payload.
 */
export declare function getVoucherSignPayload(value: getVoucherSignPayload.Value): Hex.Hex;
export declare namespace getVoucherSignPayload {
    type Value = {
        /** Chain id used by the channel reserve precompile. */
        chainId: number | bigint;
        /** Channel id. */
        channelId: Hex.Hex;
        /** Total voucher amount signed for the channel. */
        cumulativeAmount: bigint;
    };
    type ErrorType = AbiParameters.encode.ErrorType | domainSeparator.ErrorType | Hash.keccak256.ErrorType;
}
//# sourceMappingURL=Channel.d.ts.map