@sudobility/contracts 0.15.1 → 1.10.0

package/dist/unified/src/solana/mailer-client.d.ts

@@ -0,0 +1,209 @@
+import { Connection, PublicKey, Transaction, Keypair, ConfirmOptions } from '@solana/web3.js';
+import { Optional } from '@sudobility/types';
+import { ClaimableInfo, MailerFees } from './types.js';
+/**
+ * Interface for wallet adapter pattern
+ */
+export interface Wallet {
+    publicKey: PublicKey;
+    signTransaction<T extends Transaction>(transaction: T): Promise<T>;
+    signAllTransactions<T extends Transaction>(transactions: T[]): Promise<T[]>;
+}
+/**
+ * @class MailerClient
+ * @description Native Solana program client for the Mailer program
+ * @notice Provides easy-to-use methods for sending messages with USDC fees and revenue sharing
+ *
+ * ## Key Features:
+ * - **Priority Messages**: Full fee (0.1 USDC) with 90% revenue share to recipient
+ * - **Standard Messages**: 10% fee only (0.01 USDC) with no revenue share
+ * - **Revenue Claims**: 60-day claim period for priority message revenue shares
+ * - **Delegation Management**: Delegate message handling with rejection capability
+ *
+ * ## Usage Examples:
+ * ```typescript
+ * // Connect to existing deployed program
+ * const connection = new Connection('https://api.devnet.solana.com');
+ * const wallet = new WalletAdapter(keypair);
+ * const programId = new PublicKey('9FLkBDGpZBcR8LMsQ7MwwV6X9P4TDFgN3DeRh5qYyHJF');
+ * const usdcMint = new PublicKey('EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v');
+ * const client = new MailerClient(connection, wallet, programId, usdcMint);
+ *
+ * // Send message with revenue sharing to recipient
+ * await client.send('recipient-address', 'Subject', 'Message body', true);
+ *
+ * // Claim your revenue share within 60 days (as recipient)
+ * await client.claimRecipientShare();
+ *
+ * // Check claimable amount
+ * const info = await client.getRecipientClaimable();
+ * if (info) console.log(`Claimable: ${formatUSDC(info.amount)} USDC`);
+ * ```
+ *
+ * @author Mailer Team
+ * @version 2.0.0 - Native Solana Program (no Anchor)
+ */
+export declare class MailerClient {
+    private connection;
+    private wallet;
+    private programId;
+    private usdcMint;
+    private mailerStatePda;
+    private mailerBump;
+    constructor(connection: Connection, wallet: Wallet, programId: PublicKey, usdcMint: PublicKey);
+    /**
+     * Initialize the mailer program (owner only)
+     */
+    initialize(): Promise<string>;
+    /**
+     * Send a message with optional revenue sharing
+     * @param to Recipient's public key or address string who receives message and potential revenue share
+     * @param subject Message subject
+     * @param body Message body
+     * @param revenueShareToReceiver If true, recipient gets 90% revenue share; if false, no revenue share
+     * @param resolveSenderToName If true, resolve sender address to name via off-chain service
+     * @returns Transaction signature
+     */
+    send(to: string | PublicKey, subject: string, body: string, revenueShareToReceiver?: boolean, resolveSenderToName?: boolean): Promise<string>;
+    /**
+     * Claim recipient share of revenue
+     * @returns Transaction signature
+     */
+    claimRecipientShare(): Promise<string>;
+    /**
+     * Claim owner share of fees (owner only)
+     * @returns Transaction signature
+     */
+    claimOwnerShare(): Promise<string>;
+    /**
+     * Delegate message handling to another address
+     * @param delegate Address to delegate to, or null to clear delegation
+     * @returns Transaction signature
+     */
+    delegateTo(delegate?: Optional<string | PublicKey>): Promise<string>;
+    /**
+     * Reject a delegation made to you
+     * @param delegator Address that delegated to you
+     * @returns Transaction signature
+     */
+    rejectDelegation(delegator: string | PublicKey): Promise<string>;
+    /**
+     * Set the send fee (owner only)
+     * @param newFee New fee in USDC micro-units (6 decimals)
+     * @returns Transaction signature
+     */
+    setFee(newFee: number | bigint): Promise<string>;
+    /**
+     * Set the delegation fee (owner only)
+     * @param newFee New delegation fee in USDC micro-units (6 decimals)
+     * @returns Transaction signature
+     */
+    setDelegationFee(newFee: number | bigint): Promise<string>;
+    /**
+     * Get current fees from the mailer state
+     * @returns MailerFees object with current fees
+     */
+    getFees(): Promise<MailerFees>;
+    /**
+     * Get recipient claimable information
+     * @param recipient Optional recipient address, defaults to wallet address
+     * @returns ClaimableInfo or null if no claimable amount
+     */
+    getRecipientClaimable(recipient?: Optional<PublicKey>): Promise<Optional<ClaimableInfo>>;
+    /**
+     * Get owner claimable amount
+     * @returns Owner claimable amount in USDC micro-units
+     */
+    getOwnerClaimable(): Promise<number>;
+    /**
+     * Get delegation information for an address
+     * @param delegator Address to check delegation for, defaults to wallet address
+     * @returns Delegation info or null if no delegation
+     */
+    getDelegation(delegator?: Optional<PublicKey>): Promise<Optional<{
+        delegator: string;
+        delegate?: Optional<string>;
+    }>>;
+    /**
+     * Get the mailer state PDA address
+     * @returns PublicKey of the mailer state PDA
+     */
+    getMailerStatePda(): PublicKey;
+    /**
+     * Send a message to an email address (no wallet known)
+     * Charges only 10% owner fee since recipient wallet is unknown
+     * @param toEmail Email address of the recipient
+     * @param subject Message subject
+     * @param body Message body
+     * @param options Transaction confirm options
+     * @returns Transaction signature
+     */
+    sendToEmail(toEmail: string, subject: string, body: string, options?: ConfirmOptions): Promise<string>;
+    /**
+     * Send a prepared message to an email address (no wallet known)
+     * Charges only 10% owner fee since recipient wallet is unknown
+     * @param toEmail Email address of the recipient
+     * @param mailId Pre-prepared message ID
+     * @param options Transaction confirm options
+     * @returns Transaction signature
+     */
+    sendPreparedToEmail(toEmail: string, mailId: string, options?: ConfirmOptions): Promise<string>;
+    /**
+     * Send a prepared message using a mailId (to match EVM behavior)
+     * @param to Recipient's public key or address string
+     * @param mailId Pre-prepared message identifier
+     * @param revenueShareToReceiver If true, recipient gets 90% revenue share
+     * @param resolveSenderToName If true, resolve sender address to name
+     * @returns Transaction signature
+     */
+    sendPrepared(to: string | PublicKey, mailId: string, revenueShareToReceiver?: boolean, resolveSenderToName?: boolean): Promise<string>;
+    /**
+     * Pause the contract and distribute owner claimable funds (owner only)
+     * @param options Transaction confirm options
+     * @returns Transaction signature
+     */
+    pause(options?: ConfirmOptions): Promise<string>;
+    /**
+     * Unpause the contract (owner only)
+     * @param options Transaction confirm options
+     * @returns Transaction signature
+     */
+    unpause(options?: ConfirmOptions): Promise<string>;
+    /**
+     * Emergency unpause without fund distribution (owner only)
+     * @param options Transaction confirm options
+     * @returns Transaction signature
+     */
+    emergencyUnpause(options?: ConfirmOptions): Promise<string>;
+    /**
+     * Distribute claimable funds to a recipient when contract is paused
+     * @param recipient Recipient address to distribute funds for
+     * @param options Transaction confirm options
+     * @returns Transaction signature
+     */
+    distributeClaimableFunds(recipient: string | PublicKey, options?: ConfirmOptions): Promise<string>;
+    /**
+     * Get the current send fee
+     * @returns Send fee in USDC micro-units (6 decimals)
+     */
+    getSendFee(): Promise<bigint>;
+    /**
+     * Check if contract is currently paused
+     * @returns True if contract is paused, false otherwise
+     */
+    isPaused(): Promise<boolean>;
+    /**
+     * Send and confirm a transaction
+     * @param transaction Transaction to send
+     * @param options Confirm options
+     * @returns Transaction signature
+     */
+    private sendTransaction;
+    /**
+     * Create a simple wallet from a keypair for testing
+     * @param keypair Solana keypair
+     * @returns Wallet interface implementation
+     */
+    static createWallet(keypair: Keypair): Wallet;
+}
+//# sourceMappingURL=mailer-client.d.ts.map

package/dist/unified/src/solana/mailer-client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mailer-client.d.ts","sourceRoot":"","sources":["../../../../src/solana/mailer-client.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,SAAS,EACT,WAAW,EAEX,OAAO,EAEP,cAAc,EACf,MAAM,iBAAiB,CAAC;AAMzB,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAE7C,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAEvD;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB,SAAS,EAAE,SAAS,CAAC;IACrB,eAAe,CAAC,CAAC,SAAS,WAAW,EAAE,WAAW,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IACnE,mBAAmB,CAAC,CAAC,SAAS,WAAW,EAAE,YAAY,EAAE,CAAC,EAAE,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC;CAC7E;AAiQD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,qBAAa,YAAY;IACvB,OAAO,CAAC,UAAU,CAAa;IAC/B,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,SAAS,CAAY;IAC7B,OAAO,CAAC,QAAQ,CAAY;IAC5B,OAAO,CAAC,cAAc,CAAY;IAClC,OAAO,CAAC,UAAU,CAAS;gBAGzB,UAAU,EAAE,UAAU,EACtB,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,SAAS,EACpB,QAAQ,EAAE,SAAS;IAgBrB;;OAEG;IACG,UAAU,IAAI,OAAO,CAAC,MAAM,CAAC;IAenC;;;;;;;;OAQG;IACG,IAAI,CACR,EAAE,EAAE,MAAM,GAAG,SAAS,EACtB,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,MAAM,EACZ,sBAAsB,GAAE,OAAe,EACvC,mBAAmB,GAAE,OAAe,GACnC,OAAO,CAAC,MAAM,CAAC;IAwDlB;;;OAGG;IACG,mBAAmB,IAAI,OAAO,CAAC,MAAM,CAAC;IAiC5C;;;OAGG;IACG,eAAe,IAAI,OAAO,CAAC,MAAM,CAAC;IA2BxC;;;;OAIG;IACG,UAAU,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC,MAAM,GAAG,SAAS,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;IAwC1E;;;;OAIG;IACG,gBAAgB,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC;IAsBtE;;;;OAIG;IACG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IActD;;;;OAIG;IACG,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAgBhE;;;OAGG;IACG,OAAO,IAAI,OAAO,CAAC,UAAU,CAAC;IAiBpC;;;;OAIG;IACG,qBAAqB,CACzB,SAAS,CAAC,EAAE,QAAQ,CAAC,SAAS,CAAC,GAC9B,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;IA0BnC;;;OAGG;IACG,iBAAiB,IAAI,OAAO,CAAC,MAAM,CAAC;IAY1C;;;;OAIG;IACG,aAAa,CACjB,SAAS,CAAC,EAAE,QAAQ,CAAC,SAAS,CAAC,GAC9B,OAAO,CAAC,QAAQ,CAAC;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAA;KAAE,CAAC,CAAC;IAqBxE;;;OAGG;IACH,iBAAiB,IAAI,SAAS;IAI9B;;;;;;;;OAQG;IACG,WAAW,CACf,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC;IAmDlB;;;;;;;OAOG;IACG,mBAAmB,CACvB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC;IAmDlB;;;;;;;OAOG;IACG,YAAY,CAChB,EAAE,EAAE,MAAM,GAAG,SAAS,EACtB,MAAM,EAAE,MAAM,EACd,sBAAsB,GAAE,OAAe,EACvC,mBAAmB,GAAE,OAAe,GACnC,OAAO,CAAC,MAAM,CAAC;IAKlB;;;;OAIG;IACG,KAAK,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC;IA2BtD;;;;OAIG;IACG,OAAO,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC;IAcxD;;;;OAIG;IACG,gBAAgB,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC;IAcjE;;;;;OAKG;IACG,wBAAwB,CAC5B,SAAS,EAAE,MAAM,GAAG,SAAS,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC;IAwClB;;;OAGG;IACG,UAAU,IAAI,OAAO,CAAC,MAAM,CAAC;IAKnC;;;OAGG;IACG,QAAQ,IAAI,OAAO,CAAC,OAAO,CAAC;IAelC;;;;;OAKG;YACW,eAAe;IAwB7B;;;;OAIG;IACH,MAAM,CAAC,YAAY,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM;CAiB9C"}