@show-karma/karma-gap-sdk 0.4.16 → 0.4.18

package/core/class/types/attestations.d.ts

@@ -0,0 +1,173 @@
+import { Attestation, AttestationArgs } from "../Attestation";
+import { Hex } from "core/types";
+import { Project } from "../entities/Project";
+import { GapSchema } from "../GapSchema";
+import { GrantUpdate } from "../entities/GrantUpdate";
+import { Transaction } from "ethers";
+/** Attestation interfaces */
+export type AttestationWithTx = {
+    uids: Hex[];
+    tx: Transaction[];
+};
+export type ExternalLink = {
+    type: string;
+    url: string;
+}[];
+export type ExternalCustomLink = {
+    type: 'custom';
+    url: string;
+    name: string;
+};
+export interface ICommunityDetails {
+    name: string;
+    description: string;
+    imageURL: string;
+    slug?: string;
+    links?: ExternalLink;
+    type?: string;
+    externalId?: string;
+}
+export declare class CommunityDetails extends Attestation<ICommunityDetails> implements ICommunityDetails {
+    name: string;
+    description: string;
+    imageURL: string;
+    links: ExternalLink;
+    slug?: string;
+    type: string;
+    externalId?: string;
+}
+export interface IGrantDetails {
+    title: string;
+    amount?: string;
+    proposalURL: string;
+    assetAndChainId?: [Hex, number];
+    payoutAddress?: Hex;
+    description?: string;
+    season?: string;
+    cycle?: string;
+    questions?: IGrantDetailsQuestion[];
+    type?: string;
+    startDate?: number;
+    programId?: string;
+    fundUsage?: string;
+    selectedTrackIds?: string[];
+}
+export declare class GrantDetails extends Attestation<IGrantDetails> implements IGrantDetails {
+    title: string;
+    proposalURL: string;
+    programId?: string;
+    payoutAddress?: Hex;
+    amount?: string;
+    assetAndChainId?: [Hex, number];
+    description?: string;
+    season?: string;
+    cycle?: string;
+    questions?: IGrantDetailsQuestion[];
+    type: string;
+    startDate?: number;
+    fundUsage?: string;
+    selectedTrackIds?: string[];
+}
+export interface IGrantRound {
+    name: string;
+}
+export declare class GrantRound extends Attestation<IGrantRound> implements IGrantRound {
+    name: string;
+}
+export interface IGrantVerified {
+    verified: boolean;
+}
+export declare class GrantVerified extends Attestation<IGrantVerified> implements IGrantVerified {
+    verified: boolean;
+}
+export interface IMemberDetails {
+    name: string;
+    profilePictureURL: string;
+}
+export declare class MemberDetails extends Attestation<IMemberDetails> implements IMemberDetails {
+    name: string;
+    profilePictureURL: string;
+}
+export interface IMilestoneCompleted {
+    type?: "approved" | "rejected" | "completed" | "verified";
+    reason?: string;
+    proofOfWork?: string;
+}
+export declare class MilestoneCompleted extends Attestation<IMilestoneCompleted> implements IMilestoneCompleted {
+    type: "approved" | "rejected" | "completed" | "verified";
+    reason?: string;
+    proofOfWork?: string;
+}
+export interface ITag {
+    name: string;
+}
+export declare class Tag extends Attestation<ITag> implements ITag {
+    name: string;
+}
+export interface IProjectDetails {
+    title: string;
+    description: string;
+    problem?: string;
+    solution?: string;
+    missionSummary?: string;
+    locationOfImpact?: string;
+    imageURL: string;
+    links?: Array<ExternalLink[0] | ExternalCustomLink>;
+    tags?: ITag[];
+    externalIds?: string[];
+    slug?: string;
+    type?: string;
+    businessModel?: string;
+    stageIn?: string;
+    raisedMoney?: string;
+    pathToTake?: string;
+}
+export declare class ProjectDetails extends Attestation<IProjectDetails> implements IProjectDetails {
+    title: string;
+    description: string;
+    problem?: string;
+    solution?: string;
+    missionSummary?: string;
+    locationOfImpact?: string;
+    imageURL: string;
+    links: Array<ExternalLink[0] | ExternalCustomLink>;
+    tags: ITag[];
+    slug: string;
+    type: string;
+    externalIds: string[];
+    businessModel?: string;
+    stageIn?: string;
+    raisedMoney?: string;
+    pathToTake?: string;
+}
+export declare class Grantee {
+    address: string;
+    projects: Project[];
+    constructor(address: Hex, projects?: Project[]);
+}
+export declare class GrantCompleted extends GrantUpdate {
+}
+export interface IGrantDetailsQuestion {
+    query: string;
+    explanation: string;
+    type: string;
+}
+export interface IProjectEndorsement {
+    comment?: string;
+    type?: string;
+}
+export declare class ProjectEndorsement extends Attestation<IProjectEndorsement> implements IProjectEndorsement {
+    comment?: string;
+    type?: string;
+    constructor(data: AttestationArgs<IProjectEndorsement, GapSchema>);
+}
+export interface IProjectMilestoneCompleted {
+    type?: "approved" | "rejected" | "completed" | "verified";
+    reason?: string;
+    proofOfWork?: string;
+}
+export declare class ProjectMilestoneCompleted extends Attestation<IProjectMilestoneCompleted> implements IProjectMilestoneCompleted {
+    type: "approved" | "rejected" | "completed" | "verified";
+    reason?: string;
+    proofOfWork?: string;
+}

package/core/class/types/attestations.js

@@ -0,0 +1,66 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProjectMilestoneCompleted = exports.ProjectEndorsement = exports.GrantCompleted = exports.Grantee = exports.ProjectDetails = exports.Tag = exports.MilestoneCompleted = exports.MemberDetails = exports.GrantVerified = exports.GrantRound = exports.GrantDetails = exports.CommunityDetails = void 0;
+const Attestation_1 = require("../Attestation");
+const GrantUpdate_1 = require("../entities/GrantUpdate");
+class CommunityDetails extends Attestation_1.Attestation {
+    constructor() {
+        super(...arguments);
+        this.links = [];
+        this.type = "community-details";
+    }
+}
+exports.CommunityDetails = CommunityDetails;
+class GrantDetails extends Attestation_1.Attestation {
+    constructor() {
+        super(...arguments);
+        this.type = "grant-details";
+    }
+}
+exports.GrantDetails = GrantDetails;
+class GrantRound extends Attestation_1.Attestation {
+}
+exports.GrantRound = GrantRound;
+class GrantVerified extends Attestation_1.Attestation {
+}
+exports.GrantVerified = GrantVerified;
+class MemberDetails extends Attestation_1.Attestation {
+}
+exports.MemberDetails = MemberDetails;
+class MilestoneCompleted extends Attestation_1.Attestation {
+}
+exports.MilestoneCompleted = MilestoneCompleted;
+class Tag extends Attestation_1.Attestation {
+}
+exports.Tag = Tag;
+class ProjectDetails extends Attestation_1.Attestation {
+    constructor() {
+        super(...arguments);
+        this.links = [];
+        this.tags = [];
+        this.type = "project-details";
+        this.externalIds = [];
+    }
+}
+exports.ProjectDetails = ProjectDetails;
+class Grantee {
+    constructor(address, projects = []) {
+        this.projects = [];
+        this.address = address;
+        this.projects = projects;
+    }
+}
+exports.Grantee = Grantee;
+class GrantCompleted extends GrantUpdate_1.GrantUpdate {
+}
+exports.GrantCompleted = GrantCompleted;
+class ProjectEndorsement extends Attestation_1.Attestation {
+    constructor(data) {
+        data.data.type = "project-endorsement";
+        super(data);
+    }
+}
+exports.ProjectEndorsement = ProjectEndorsement;
+class ProjectMilestoneCompleted extends Attestation_1.Attestation {
+}
+exports.ProjectMilestoneCompleted = ProjectMilestoneCompleted;

package/core/consts.d.ts

@@ -0,0 +1,50 @@
+import { EASNetworkConfig, SchemaInterface, TNetwork, TSchemaName } from "./types";
+/**
+ * Schemas that should use default EAS attestation
+ * instead of the custom contract.
+ */
+export declare const useDefaultAttestation: TSchemaName[];
+export declare const chainIdToNetwork: {
+    11155420: string;
+    42161: string;
+    10: string;
+    11155111: string;
+    84532: string;
+    42220: string;
+    1328: string;
+    1329: string;
+    1135: string;
+    534352: string;
+    8453: string;
+    137: string;
+};
+export declare const nullRef = "0x0000000000000000000000000000000000000000000000000000000000000000";
+export declare const nullResolver = "0x0000000000000000000000000000000000000000";
+export declare const zeroAddress = "0x0000000000000000000000000000000000000000";
+/**
+ * The networks that are supported by the EAS
+ */
+export declare const Networks: Record<TNetwork, EASNetworkConfig>;
+/**
+ * Mounts the schemas for the given network and return all the settings
+ * @param network
+ * @returns
+ */
+export declare const MountEntities: (network: EASNetworkConfig) => Record<TSchemaName, SchemaInterface<TSchemaName>>;
+export declare const alloSupportedNetworks: {
+    mainnet: number[];
+    testnet: number[];
+};
+export declare const AlloContracts: {
+    registry: string;
+    alloProxy: string;
+    alloImplementation: string;
+    strategy: {
+        DonationVotingMerkleDistributionDirectTransferStrategy: string;
+        DirectGrantsSimpleStrategy: string;
+        RFPSimpleStrategy: string;
+        RFPCommitteeStrategy: string;
+        QVSimple: string;
+    };
+    factory: string;
+};