potlock-nextjs-app/src/common/contracts/core/campaigns/interfaces.ts at 56269b6aa7179677ac821d6f9100b78bcc4db7f3 · PotLock/potlock-nextjs-app · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
import { AccountId, IndivisibleUnits, type TokenId } from "@/common/types";

export type CampaignsContractConfig = {
  owner: AccountId;
  admins: AccountId[];
  protocol_fee_basis_points: number;
  protocol_fee_recipient_account: AccountId;
  default_referral_fee_basis_points: number;
  default_creator_fee_basis_points: number;
  total_campaigns_count: number;
  total_donations_count: number;
};

export type CampaignInputs = {
  name: string;
  description?: string;
  cover_image_url?: string | null;
  start_ms?: number | string;
  end_ms?: number | string;
  target_amount: IndivisibleUnits;
  min_amount?: null | IndivisibleUnits;
  max_amount?: null | IndivisibleUnits;
  recipient?: AccountId;
  owner?: AccountId;
  referral_fee_basis_points?: number;
  creator_fee_basis_points?: number;
  allow_fee_avoidance?: boolean;
  project_name?: string;
  project_description?: string;
  project_banner_image_url?: string;
};

export type Campaign = {
  id: number;
  name: string;
  description: string;
  cover_image_url?: null | string;
  recipient: AccountId;
  owner: AccountId;
  start_ms: number;
  end_ms?: null | number;
  ft_id?: null | TokenId;
  target_amount: IndivisibleUnits;
  min_amount?: null | IndivisibleUnits;
  max_amount?: null | IndivisibleUnits;
  escrow_balance: IndivisibleUnits;
  referral_fee_basis_points?: null | number;
  creator_fee_basis_points?: null | number;
  allow_fee_avoidance?: boolean;
  total_raised_amount: string;
};

/**
 * https://github.com/PotLock/core/blob/6a44907c1beffcfaab7e7fbc0d50be12e897c5a8/contracts/campaigns/src/donations.rs#L51
 */
export interface CampaignDonation {
  id: number;
  campaign_id: Campaign["id"];
  donor_id: AccountId;
  total_amount: IndivisibleUnits;
  net_amount: IndivisibleUnits;
  ft_id?: null | TokenId;
  message?: null | string;
  donated_at_ms: number;
  protocol_fee: IndivisibleUnits;
  referrer_id?: null | AccountId;
  referrer_fee: IndivisibleUnits;
  creator_fee: IndivisibleUnits;
  returned_at_ms?: null | number;
  is_in_escrow: boolean;
  recipient_id: AccountId;
}

export type CampaignDonationArgs = {
  campaign_id: number;
  message?: null | string;
  referrer_id?: null | string;
  bypass_protocol_fee?: null | boolean;
  bypass_creator_fee?: null | boolean;
};