@spindl-xyz/attribution-lite/dist/lib/core/plugins/referral-api.d.ts

Web3 Attribution SDK

import { Metadata } from "./metadata";
import { Sdk } from "./sdk";
export interface ReferrerCode {
    code: string;
    address: string;
}
export interface ReferrerHistory {
    name: string;
    rewardAmount: string;
    description: string;
    address: string;
    conversionChainId: number;
    rewardChainId: number;
    rewardTokenAddress: string;
    rewardTokenDecimals: number;
    blockTime: string;
    txHash: string;
}
export interface ReferrerStats {
    numberOfReferrals: number;
}
export declare function createReferralApiPlugin(sdk: Sdk, metadata: Metadata): {
    getReferrerAttribution: (address: string) => Promise<string>;
    getReferrerStats: (address: string) => Promise<ReferrerStats>;
    getReferrerHistory: (address: string) => Promise<ReferrerHistory[]>;
    createReferrerCode: (address: string, code?: string) => Promise<string>;
    validateReferrerCode: (slug?: string) => boolean;
    checkReferrerCode: (code: string) => Promise<boolean>;
    getReferrerCode: (address: string) => Promise<string>;
    getReferrerAddress: (code: string) => Promise<string>;
};