@sparkdreamnft/sparkdreamjs 0.0.17 → 0.0.18

package/sparkdream/session/v1/grant.d.ts

@@ -0,0 +1,517 @@
+import { Coin, CoinAmino } from "../../../cosmos/base/v1beta1/coin";
+import { Any, AnyAmino } from "../../../google/protobuf/any";
+import { BinaryReader, BinaryWriter } from "../../../binary";
+import { DeepPartial } from "../../../helpers";
+/**
+ * GrantType enumerates the four typed payload variants of the unified grant
+ * registry. The session-key variant preserves the legacy x/session model;
+ * the other three are introduced by the delegated-authorization-registry
+ * refactor and ship in subsequent phases (P3 RecurringPull, P4
+ * SpendingAllowance, P5 ScheduledOneshot).
+ */
+export declare enum GrantType {
+    GRANT_TYPE_UNSPECIFIED = 0,
+    GRANT_TYPE_SESSION_KEY = 1,
+    GRANT_TYPE_RECURRING_PULL = 2,
+    GRANT_TYPE_SPENDING_ALLOWANCE = 3,
+    GRANT_TYPE_SCHEDULED_ONESHOT = 4,
+    UNRECOGNIZED = -1
+}
+export declare const GrantTypeAmino: typeof GrantType;
+export declare function grantTypeFromJSON(object: any): GrantType;
+export declare function grantTypeToJSON(object: GrantType): string;
+/**
+ * GrantStatus is the state-machine label for a grant. Terminal states
+ * (REVOKED, DECLINED, COMPLETED, FIRED) are absorbing — once entered, the
+ * grant is never re-activated; the granter must create a new grant.
+ */
+export declare enum GrantStatus {
+    GRANT_STATUS_UNSPECIFIED = 0,
+    GRANT_STATUS_ACTIVE = 1,
+    GRANT_STATUS_PAUSED_INSUFFICIENT_FUNDS = 2,
+    GRANT_STATUS_DECLINED = 3,
+    GRANT_STATUS_REVOKED = 4,
+    GRANT_STATUS_COMPLETED = 5,
+    GRANT_STATUS_FIRED = 6,
+    UNRECOGNIZED = -1
+}
+export declare const GrantStatusAmino: typeof GrantStatus;
+export declare function grantStatusFromJSON(object: any): GrantStatus;
+export declare function grantStatusToJSON(object: GrantStatus): string;
+/**
+ * Grant is the unified record for every delegated-authorization primitive
+ * in x/session. One record carries the shared lifecycle fields (id,
+ * granter, grantee, status, expires_at, note) and exactly one of the four
+ * typed payloads.
+ * @name Grant
+ * @package sparkdream.session.v1
+ * @see proto type: sparkdream.session.v1.Grant
+ */
+export interface Grant {
+    id: bigint;
+    granter: string;
+    grantee: string;
+    type: GrantType;
+    status: GrantStatus;
+    createdAt: Date;
+    expiresAt: Date;
+    /**
+     * Human-readable purpose (256-char cap enforced at validation time).
+     */
+    note: string;
+    sessionKey?: SessionKeyPayload;
+    recurringPull?: RecurringPullPayload;
+    spendingAllowance?: SpendingAllowancePayload;
+    scheduledOneshot?: ScheduledOneshotPayload;
+}
+export interface GrantProtoMsg {
+    typeUrl: "/sparkdream.session.v1.Grant";
+    value: Uint8Array;
+}
+/**
+ * Grant is the unified record for every delegated-authorization primitive
+ * in x/session. One record carries the shared lifecycle fields (id,
+ * granter, grantee, status, expires_at, note) and exactly one of the four
+ * typed payloads.
+ * @name GrantAmino
+ * @package sparkdream.session.v1
+ * @see proto type: sparkdream.session.v1.Grant
+ */
+export interface GrantAmino {
+    id?: string;
+    granter?: string;
+    grantee?: string;
+    type?: GrantType;
+    status?: GrantStatus;
+    created_at?: string;
+    expires_at?: string;
+    /**
+     * Human-readable purpose (256-char cap enforced at validation time).
+     */
+    note?: string;
+    session_key?: SessionKeyPayloadAmino;
+    recurring_pull?: RecurringPullPayloadAmino;
+    spending_allowance?: SpendingAllowancePayloadAmino;
+    scheduled_oneshot?: ScheduledOneshotPayloadAmino;
+}
+export interface GrantAminoMsg {
+    type: "/sparkdream.session.v1.Grant";
+    value: GrantAmino;
+}
+/**
+ * SessionKeyPayload preserves the current x/session model: a scoped
+ * message-type allowlist with a SPARK spend-limit budget, an exec-count
+ * cap, and the per-session usage counters.
+ * @name SessionKeyPayload
+ * @package sparkdream.session.v1
+ * @see proto type: sparkdream.session.v1.SessionKeyPayload
+ */
+export interface SessionKeyPayload {
+    allowedMsgTypes: string[];
+    spendLimit: Coin;
+    spent: Coin;
+    maxExecCount: bigint;
+    execCount: bigint;
+    lastUsedAt: Date;
+    /**
+     * If true, this session key may include MsgRevokeGrant in
+     * allowed_msg_types, scoped to grants owned by the same granter. Default
+     * false. Lands with P6's universal MsgRevokeGrant; reserved here so the
+     * proto wire shape is locked at P1.
+     */
+    allowSelfRevoke: boolean;
+}
+export interface SessionKeyPayloadProtoMsg {
+    typeUrl: "/sparkdream.session.v1.SessionKeyPayload";
+    value: Uint8Array;
+}
+/**
+ * SessionKeyPayload preserves the current x/session model: a scoped
+ * message-type allowlist with a SPARK spend-limit budget, an exec-count
+ * cap, and the per-session usage counters.
+ * @name SessionKeyPayloadAmino
+ * @package sparkdream.session.v1
+ * @see proto type: sparkdream.session.v1.SessionKeyPayload
+ */
+export interface SessionKeyPayloadAmino {
+    allowed_msg_types?: string[];
+    spend_limit?: CoinAmino;
+    spent?: CoinAmino;
+    max_exec_count?: string;
+    exec_count?: string;
+    last_used_at?: string;
+    /**
+     * If true, this session key may include MsgRevokeGrant in
+     * allowed_msg_types, scoped to grants owned by the same granter. Default
+     * false. Lands with P6's universal MsgRevokeGrant; reserved here so the
+     * proto wire shape is locked at P1.
+     */
+    allow_self_revoke?: boolean;
+}
+export interface SessionKeyPayloadAminoMsg {
+    type: "/sparkdream.session.v1.SessionKeyPayload";
+    value: SessionKeyPayloadAmino;
+}
+/**
+ * RecurringPullPayload — a granter-authorized periodic SendCoins to a
+ * grantee. The grantee invokes MsgClaimRecurringPull each period.
+ * int64 unix timestamps (start_time, last_claim_advance) mirror the
+ * existing x/commons RecurringSpend record shape to enable a future
+ * straight-shot keeper port. The msg server lands in P3.
+ * @name RecurringPullPayload
+ * @package sparkdream.session.v1
+ * @see proto type: sparkdream.session.v1.RecurringPullPayload
+ */
+export interface RecurringPullPayload {
+    amountPerPeriod: Coin;
+    periodSeconds: bigint;
+    startTime: bigint;
+    lastClaimAdvance: bigint;
+    claimsMade: bigint;
+    /**
+     * User-declared per-epoch ceiling (sdk.Int as string), denominated in
+     * the same denom as amount_per_period. Epoch = UTC calendar day,
+     * computed as floor(block_time.Unix() / 86400).
+     */
+    maxPerEpoch: string;
+}
+export interface RecurringPullPayloadProtoMsg {
+    typeUrl: "/sparkdream.session.v1.RecurringPullPayload";
+    value: Uint8Array;
+}
+/**
+ * RecurringPullPayload — a granter-authorized periodic SendCoins to a
+ * grantee. The grantee invokes MsgClaimRecurringPull each period.
+ * int64 unix timestamps (start_time, last_claim_advance) mirror the
+ * existing x/commons RecurringSpend record shape to enable a future
+ * straight-shot keeper port. The msg server lands in P3.
+ * @name RecurringPullPayloadAmino
+ * @package sparkdream.session.v1
+ * @see proto type: sparkdream.session.v1.RecurringPullPayload
+ */
+export interface RecurringPullPayloadAmino {
+    amount_per_period?: CoinAmino;
+    period_seconds?: string;
+    start_time?: string;
+    last_claim_advance?: string;
+    claims_made?: string;
+    /**
+     * User-declared per-epoch ceiling (sdk.Int as string), denominated in
+     * the same denom as amount_per_period. Epoch = UTC calendar day,
+     * computed as floor(block_time.Unix() / 86400).
+     */
+    max_per_epoch?: string;
+}
+export interface RecurringPullPayloadAminoMsg {
+    type: "/sparkdream.session.v1.RecurringPullPayload";
+    value: RecurringPullPayloadAmino;
+}
+/**
+ * SpendingAllowancePayload — a refilling per-period cap; the grantee picks
+ * the recipient and amount of each pull within the cap and (optional)
+ * whitelist. The msg server lands in P4.
+ * @name SpendingAllowancePayload
+ * @package sparkdream.session.v1
+ * @see proto type: sparkdream.session.v1.SpendingAllowancePayload
+ */
+export interface SpendingAllowancePayload {
+    maxPerPeriod: Coin;
+    periodSeconds: bigint;
+    currentPeriodStart: bigint;
+    spentInCurrentPeriod: Coin;
+    /**
+     * Empty = unrestricted; non-empty = whitelist.
+     */
+    allowedRecipients: string[];
+    /**
+     * Locks denom for the grant; mismatches rejected at pull time.
+     */
+    denom: string;
+}
+export interface SpendingAllowancePayloadProtoMsg {
+    typeUrl: "/sparkdream.session.v1.SpendingAllowancePayload";
+    value: Uint8Array;
+}
+/**
+ * SpendingAllowancePayload — a refilling per-period cap; the grantee picks
+ * the recipient and amount of each pull within the cap and (optional)
+ * whitelist. The msg server lands in P4.
+ * @name SpendingAllowancePayloadAmino
+ * @package sparkdream.session.v1
+ * @see proto type: sparkdream.session.v1.SpendingAllowancePayload
+ */
+export interface SpendingAllowancePayloadAmino {
+    max_per_period?: CoinAmino;
+    period_seconds?: string;
+    current_period_start?: string;
+    spent_in_current_period?: CoinAmino;
+    /**
+     * Empty = unrestricted; non-empty = whitelist.
+     */
+    allowed_recipients?: string[];
+    /**
+     * Locks denom for the grant; mismatches rejected at pull time.
+     */
+    denom?: string;
+}
+export interface SpendingAllowancePayloadAminoMsg {
+    type: "/sparkdream.session.v1.SpendingAllowancePayload";
+    value: SpendingAllowancePayloadAmino;
+}
+/**
+ * ScheduledOneshotPayload — fires once at fire_at, EndBlocker-driven. The
+ * msg server, EndBlocker fire pass, gas-deposit escrow, and retry path
+ * land in P5.
+ * @name ScheduledOneshotPayload
+ * @package sparkdream.session.v1
+ * @see proto type: sparkdream.session.v1.ScheduledOneshotPayload
+ */
+export interface ScheduledOneshotPayload {
+    transfer?: OneshotTransfer;
+    exec?: OneshotExec;
+    fireAt: bigint;
+    /**
+     * Captured failure reason if execution failed at fire time (Exec only).
+     */
+    fireError: string;
+}
+export interface ScheduledOneshotPayloadProtoMsg {
+    typeUrl: "/sparkdream.session.v1.ScheduledOneshotPayload";
+    value: Uint8Array;
+}
+/**
+ * ScheduledOneshotPayload — fires once at fire_at, EndBlocker-driven. The
+ * msg server, EndBlocker fire pass, gas-deposit escrow, and retry path
+ * land in P5.
+ * @name ScheduledOneshotPayloadAmino
+ * @package sparkdream.session.v1
+ * @see proto type: sparkdream.session.v1.ScheduledOneshotPayload
+ */
+export interface ScheduledOneshotPayloadAmino {
+    transfer?: OneshotTransferAmino;
+    exec?: OneshotExecAmino;
+    fire_at?: string;
+    /**
+     * Captured failure reason if execution failed at fire time (Exec only).
+     */
+    fire_error?: string;
+}
+export interface ScheduledOneshotPayloadAminoMsg {
+    type: "/sparkdream.session.v1.ScheduledOneshotPayload";
+    value: ScheduledOneshotPayloadAmino;
+}
+/**
+ * OneshotTransfer dispatches a simple bank SendCoins(granter, recipient,
+ * amount) at fire time.
+ * @name OneshotTransfer
+ * @package sparkdream.session.v1
+ * @see proto type: sparkdream.session.v1.OneshotTransfer
+ */
+export interface OneshotTransfer {
+    recipient: string;
+    amount: Coin;
+}
+export interface OneshotTransferProtoMsg {
+    typeUrl: "/sparkdream.session.v1.OneshotTransfer";
+    value: Uint8Array;
+}
+/**
+ * OneshotTransfer dispatches a simple bank SendCoins(granter, recipient,
+ * amount) at fire time.
+ * @name OneshotTransferAmino
+ * @package sparkdream.session.v1
+ * @see proto type: sparkdream.session.v1.OneshotTransfer
+ */
+export interface OneshotTransferAmino {
+    recipient?: string;
+    amount?: CoinAmino;
+}
+export interface OneshotTransferAminoMsg {
+    type: "/sparkdream.session.v1.OneshotTransfer";
+    value: OneshotTransferAmino;
+}
+/**
+ * OneshotExec dispatches an arbitrary message at fire time, executed as
+ * if signed by the granter. Subject to the same allowed_msg_types
+ * whitelist as session keys and the same NonDelegableSessionMsgs
+ * anti-recursion denylist, both at creation and at fire time.
+ * @name OneshotExec
+ * @package sparkdream.session.v1
+ * @see proto type: sparkdream.session.v1.OneshotExec
+ */
+export interface OneshotExec {
+    msg?: Any;
+    /**
+     * Per-fire gas cap; the granter pre-funds gas_limit * oneshot_gas_price
+     * SPARK at MsgCreateGrant time.
+     */
+    gasLimit: bigint;
+}
+export interface OneshotExecProtoMsg {
+    typeUrl: "/sparkdream.session.v1.OneshotExec";
+    value: Uint8Array;
+}
+/**
+ * OneshotExec dispatches an arbitrary message at fire time, executed as
+ * if signed by the granter. Subject to the same allowed_msg_types
+ * whitelist as session keys and the same NonDelegableSessionMsgs
+ * anti-recursion denylist, both at creation and at fire time.
+ * @name OneshotExecAmino
+ * @package sparkdream.session.v1
+ * @see proto type: sparkdream.session.v1.OneshotExec
+ */
+export interface OneshotExecAmino {
+    msg?: AnyAmino;
+    /**
+     * Per-fire gas cap; the granter pre-funds gas_limit * oneshot_gas_price
+     * SPARK at MsgCreateGrant time.
+     */
+    gas_limit?: string;
+}
+export interface OneshotExecAminoMsg {
+    type: "/sparkdream.session.v1.OneshotExec";
+    value: OneshotExecAmino;
+}
+/**
+ * Grant is the unified record for every delegated-authorization primitive
+ * in x/session. One record carries the shared lifecycle fields (id,
+ * granter, grantee, status, expires_at, note) and exactly one of the four
+ * typed payloads.
+ * @name Grant
+ * @package sparkdream.session.v1
+ * @see proto type: sparkdream.session.v1.Grant
+ */
+export declare const Grant: {
+    typeUrl: string;
+    encode(message: Grant, writer?: BinaryWriter): BinaryWriter;
+    decode(input: BinaryReader | Uint8Array, length?: number): Grant;
+    fromPartial(object: DeepPartial<Grant>): Grant;
+    fromAmino(object: GrantAmino): Grant;
+    toAmino(message: Grant): GrantAmino;
+    fromAminoMsg(object: GrantAminoMsg): Grant;
+    fromProtoMsg(message: GrantProtoMsg): Grant;
+    toProto(message: Grant): Uint8Array;
+    toProtoMsg(message: Grant): GrantProtoMsg;
+};
+/**
+ * SessionKeyPayload preserves the current x/session model: a scoped
+ * message-type allowlist with a SPARK spend-limit budget, an exec-count
+ * cap, and the per-session usage counters.
+ * @name SessionKeyPayload
+ * @package sparkdream.session.v1
+ * @see proto type: sparkdream.session.v1.SessionKeyPayload
+ */
+export declare const SessionKeyPayload: {
+    typeUrl: string;
+    encode(message: SessionKeyPayload, writer?: BinaryWriter): BinaryWriter;
+    decode(input: BinaryReader | Uint8Array, length?: number): SessionKeyPayload;
+    fromPartial(object: DeepPartial<SessionKeyPayload>): SessionKeyPayload;
+    fromAmino(object: SessionKeyPayloadAmino): SessionKeyPayload;
+    toAmino(message: SessionKeyPayload): SessionKeyPayloadAmino;
+    fromAminoMsg(object: SessionKeyPayloadAminoMsg): SessionKeyPayload;
+    fromProtoMsg(message: SessionKeyPayloadProtoMsg): SessionKeyPayload;
+    toProto(message: SessionKeyPayload): Uint8Array;
+    toProtoMsg(message: SessionKeyPayload): SessionKeyPayloadProtoMsg;
+};
+/**
+ * RecurringPullPayload — a granter-authorized periodic SendCoins to a
+ * grantee. The grantee invokes MsgClaimRecurringPull each period.
+ * int64 unix timestamps (start_time, last_claim_advance) mirror the
+ * existing x/commons RecurringSpend record shape to enable a future
+ * straight-shot keeper port. The msg server lands in P3.
+ * @name RecurringPullPayload
+ * @package sparkdream.session.v1
+ * @see proto type: sparkdream.session.v1.RecurringPullPayload
+ */
+export declare const RecurringPullPayload: {
+    typeUrl: string;
+    encode(message: RecurringPullPayload, writer?: BinaryWriter): BinaryWriter;
+    decode(input: BinaryReader | Uint8Array, length?: number): RecurringPullPayload;
+    fromPartial(object: DeepPartial<RecurringPullPayload>): RecurringPullPayload;
+    fromAmino(object: RecurringPullPayloadAmino): RecurringPullPayload;
+    toAmino(message: RecurringPullPayload): RecurringPullPayloadAmino;
+    fromAminoMsg(object: RecurringPullPayloadAminoMsg): RecurringPullPayload;
+    fromProtoMsg(message: RecurringPullPayloadProtoMsg): RecurringPullPayload;
+    toProto(message: RecurringPullPayload): Uint8Array;
+    toProtoMsg(message: RecurringPullPayload): RecurringPullPayloadProtoMsg;
+};
+/**
+ * SpendingAllowancePayload — a refilling per-period cap; the grantee picks
+ * the recipient and amount of each pull within the cap and (optional)
+ * whitelist. The msg server lands in P4.
+ * @name SpendingAllowancePayload
+ * @package sparkdream.session.v1
+ * @see proto type: sparkdream.session.v1.SpendingAllowancePayload
+ */
+export declare const SpendingAllowancePayload: {
+    typeUrl: string;
+    encode(message: SpendingAllowancePayload, writer?: BinaryWriter): BinaryWriter;
+    decode(input: BinaryReader | Uint8Array, length?: number): SpendingAllowancePayload;
+    fromPartial(object: DeepPartial<SpendingAllowancePayload>): SpendingAllowancePayload;
+    fromAmino(object: SpendingAllowancePayloadAmino): SpendingAllowancePayload;
+    toAmino(message: SpendingAllowancePayload): SpendingAllowancePayloadAmino;
+    fromAminoMsg(object: SpendingAllowancePayloadAminoMsg): SpendingAllowancePayload;
+    fromProtoMsg(message: SpendingAllowancePayloadProtoMsg): SpendingAllowancePayload;
+    toProto(message: SpendingAllowancePayload): Uint8Array;
+    toProtoMsg(message: SpendingAllowancePayload): SpendingAllowancePayloadProtoMsg;
+};
+/**
+ * ScheduledOneshotPayload — fires once at fire_at, EndBlocker-driven. The
+ * msg server, EndBlocker fire pass, gas-deposit escrow, and retry path
+ * land in P5.
+ * @name ScheduledOneshotPayload
+ * @package sparkdream.session.v1
+ * @see proto type: sparkdream.session.v1.ScheduledOneshotPayload
+ */
+export declare const ScheduledOneshotPayload: {
+    typeUrl: string;
+    encode(message: ScheduledOneshotPayload, writer?: BinaryWriter): BinaryWriter;
+    decode(input: BinaryReader | Uint8Array, length?: number): ScheduledOneshotPayload;
+    fromPartial(object: DeepPartial<ScheduledOneshotPayload>): ScheduledOneshotPayload;
+    fromAmino(object: ScheduledOneshotPayloadAmino): ScheduledOneshotPayload;
+    toAmino(message: ScheduledOneshotPayload): ScheduledOneshotPayloadAmino;
+    fromAminoMsg(object: ScheduledOneshotPayloadAminoMsg): ScheduledOneshotPayload;
+    fromProtoMsg(message: ScheduledOneshotPayloadProtoMsg): ScheduledOneshotPayload;
+    toProto(message: ScheduledOneshotPayload): Uint8Array;
+    toProtoMsg(message: ScheduledOneshotPayload): ScheduledOneshotPayloadProtoMsg;
+};
+/**
+ * OneshotTransfer dispatches a simple bank SendCoins(granter, recipient,
+ * amount) at fire time.
+ * @name OneshotTransfer
+ * @package sparkdream.session.v1
+ * @see proto type: sparkdream.session.v1.OneshotTransfer
+ */
+export declare const OneshotTransfer: {
+    typeUrl: string;
+    encode(message: OneshotTransfer, writer?: BinaryWriter): BinaryWriter;
+    decode(input: BinaryReader | Uint8Array, length?: number): OneshotTransfer;
+    fromPartial(object: DeepPartial<OneshotTransfer>): OneshotTransfer;
+    fromAmino(object: OneshotTransferAmino): OneshotTransfer;
+    toAmino(message: OneshotTransfer): OneshotTransferAmino;
+    fromAminoMsg(object: OneshotTransferAminoMsg): OneshotTransfer;
+    fromProtoMsg(message: OneshotTransferProtoMsg): OneshotTransfer;
+    toProto(message: OneshotTransfer): Uint8Array;
+    toProtoMsg(message: OneshotTransfer): OneshotTransferProtoMsg;
+};
+/**
+ * OneshotExec dispatches an arbitrary message at fire time, executed as
+ * if signed by the granter. Subject to the same allowed_msg_types
+ * whitelist as session keys and the same NonDelegableSessionMsgs
+ * anti-recursion denylist, both at creation and at fire time.
+ * @name OneshotExec
+ * @package sparkdream.session.v1
+ * @see proto type: sparkdream.session.v1.OneshotExec
+ */
+export declare const OneshotExec: {
+    typeUrl: string;
+    encode(message: OneshotExec, writer?: BinaryWriter): BinaryWriter;
+    decode(input: BinaryReader | Uint8Array, length?: number): OneshotExec;
+    fromPartial(object: DeepPartial<OneshotExec>): OneshotExec;
+    fromAmino(object: OneshotExecAmino): OneshotExec;
+    toAmino(message: OneshotExec): OneshotExecAmino;
+    fromAminoMsg(object: OneshotExecAminoMsg): OneshotExec;
+    fromProtoMsg(message: OneshotExecProtoMsg): OneshotExec;
+    toProto(message: OneshotExec): Uint8Array;
+    toProtoMsg(message: OneshotExec): OneshotExecProtoMsg;
+};