@alpha-dao/ion-dao-types - npm Package Compare versions

Comparing version 0.0.5 to 0.0.6

dist/dao/execute_msg.d.ts

@@ -10,2 +10,7 @@ import { Addr, Config, CosmosMsgFor_OsmosisMsg, Denom, Expiration, Vote } from "./shared-types";
 } | {
+    claim_deposit: {
+        proposal_id: number;
+        [k: string]: unknown;
+    };
+} | {
     vote: VoteMsg;
@@ -12,0 +17,0 @@ } | {

dist/dao/index.d.ts

@@ -7,3 +7,2 @@ export * from "./ballot";
 export * from "./proposal_response";
-export * from "./proposal";
 export * from "./proposals_response";
@@ -10,0 +9,0 @@ export * from "./query_msg";

dist/dao/index.js

@@ -29,5 +29,8 @@ "use strict";
 __exportStar(require("./proposal_response"), exports);
-__exportStar(require("./proposal"), exports);
+// dedup emptied this file
+// export * from "./proposal";
 __exportStar(require("./proposals_response"), exports);
 __exportStar(require("./query_msg"), exports);
+// dedup emptied this file
+// export * from "./range_order";
 __exportStar(require("./shared-types"), exports);
@@ -34,0 +37,0 @@ // dedup emptied this file

dist/dao/proposal_response.d.ts

@@ -1,2 +0,2 @@
-import { BlockTime, CosmosMsgFor_Empty, Decimal, Expiration, Status, Threshold, Uint128, Votes } from "./shared-types";
+import { Addr, BlockTime, CosmosMsgFor_Empty, Decimal, Expiration, Status, Threshold, Uint128, Votes } from "./shared-types";
 /**
@@ -6,2 +6,3 @@ * Note, if you are storing custom messages in the proposal, the querier needs to know what possible custom message types those are in order to parse the response
 export interface ProposalResponse {
+    deposit_claimable: boolean;
     deposit_ends_at: Expiration;
@@ -12,3 +13,3 @@ description: string;
     msgs: CosmosMsgFor_Empty[];
-    proposer: string;
+    proposer: Addr;
     quorum: Decimal;
@@ -15,0 +16,0 @@ status: Status;

dist/dao/proposals_response.d.ts

@@ -1,2 +0,2 @@
-import { BlockTime, CosmosMsgFor_Empty, Decimal, Expiration, Status, Threshold, Uint128, Votes } from "./shared-types";
+import { Addr, BlockTime, CosmosMsgFor_Empty, Decimal, Expiration, Status, Threshold, Uint128, Votes } from "./shared-types";
 export interface ProposalsResponse {
@@ -10,2 +10,3 @@ proposals: ProposalResponseFor_Empty[];
 export interface ProposalResponseFor_Empty {
+    deposit_claimable: boolean;
     deposit_ends_at: Expiration;
@@ -16,3 +17,3 @@ description: string;
     msgs: CosmosMsgFor_Empty[];
-    proposer: string;
+    proposer: Addr;
     quorum: Decimal;
@@ -19,0 +20,0 @@ status: Status;

dist/dao/query_msg.d.ts

@@ -1,27 +0,27 @@
-import { Addr, Denom, Status } from "./shared-types";
-export declare type QueryMsg = {
-    get_config: {
+import { Addr, Denom, Proposal_1, RangeOrder, Status, Votes_1, Vote_1 } from "./shared-types";
+export declare type QueryMsg = GetConfig | TokenList | TokenBalances | Proposal_1 | Proposals | ProposalCount | Vote_1 | Votes_1 | Deposit | Deposits;
+export declare type ProposalsQueryOption = {
+    find_by_status: {
+        status: Status;
         [k: string]: unknown;
     };
 } | {
-    token_list: {
+    find_by_proposer: {
+        proposer: Addr;
         [k: string]: unknown;
     };
 } | {
-    token_balances: {
-        limit?: number | null;
-        order?: RangeOrder | null;
-        start?: Denom | null;
+    everything: {
         [k: string]: unknown;
     };
-} | {
-    proposal: {
+};
+export declare type DepositsQueryOption = {
+    find_by_proposal: {
         proposal_id: number;
+        start?: string | null;
         [k: string]: unknown;
     };
 } | {
-    proposals: {
-        limit?: number | null;
-        order?: RangeOrder | null;
-        query: ProposalsQueryOption;
+    find_by_depositor: {
+        depositor: string;
         start?: number | null;
@@ -31,20 +31,82 @@ [k: string]: unknown;
 } | {
-    proposal_count: {
+    everything: {
+        start?: [number, string] | null;
         [k: string]: unknown;
     };
-} | {
-    vote: {
-        proposal_id: number;
-        voter: string;
+};
+/**
+ * Returns [ConfigResponse]
+ *
+ * ## Example
+ *
+ * ```json { "get_config": {} } ```
+ */
+export interface GetConfig {
+    get_config: {
         [k: string]: unknown;
     };
-} | {
-    votes: {
+}
+/**
+ * Queries list of cw20 Tokens associated with the DAO Treasury. Returns [TokenListResponse]
+ *
+ * ## Example
+ *
+ * ```json { "token_list": {} } ```
+ */
+export interface TokenList {
+    token_list: {
+        [k: string]: unknown;
+    };
+}
+/**
+ * Returns [TokenBalancesResponse] All DAO Cw20 Balances
+ *
+ * ## Example
+ *
+ * ```json { "token_balances": { "start"?: { "native": "uosmo" | "cw20": "osmo1deadbeef" }, "limit": 30 | 10, "order": "asc" | "desc" } } ```
+ */
+export interface TokenBalances {
+    token_balances: {
         limit?: number | null;
         order?: RangeOrder | null;
-        proposal_id: number;
-        start?: string | null;
+        start?: Denom | null;
         [k: string]: unknown;
     };
-} | {
+}
+/**
+ * Returns [ProposalsResponse]
+ *
+ * ## Example
+ *
+ * ```json { "proposals": { "query": { "find_by_status": { "status": "pending" | .. | "executed" } | "find_by_proposer": { "proposer": "osmo1deadbeef" } | "everything": {} }, "start"?: 10, "limit": 30 | 10, "order": "asc" | "desc" } } ```
+ */
+export interface Proposals {
+    proposals: {
+        limit?: number | null;
+        order?: RangeOrder | null;
+        query: ProposalsQueryOption;
+        start?: number | null;
+        [k: string]: unknown;
+    };
+}
+/**
+ * Returns the number of proposals in the DAO (u64)
+ *
+ * ## Example
+ *
+ * ```json { "proposal_count": {} } ```
+ */
+export interface ProposalCount {
+    proposal_count: {
+        [k: string]: unknown;
+    };
+}
+/**
+ * Queries single deposit info by proposal id & address of depositor. Returns [DepositResponse]
+ *
+ * ## Example
+ *
+ * ```json { "deposit": { "proposal_id": 1, "depositor": "osmo1deadbeef" } } ```
+ */
+export interface Deposit {
     deposit: {
@@ -55,3 +117,11 @@ depositor: string;
     };
-} | {
+}
+/**
+ * Queries multiple deposits info by 1. proposal id 2. depositor address Returns [DepositsResponse]
+ *
+ * ## Example
+ *
+ * ```json { "deposits": { "query": { "find_by_proposal": { "proposal_id": 1, "start"?: "osmo1deadbeef" } | "find_by_depositor": { "depositor": "osmo1deadbeef", "start"?: 1 } | "everything": { "start"?: [1, "osmo1deadbeef"] } }, "limit": 30 | 10, "order": "asc" | "desc" } } ```
+ */
+export interface Deposits {
     deposits: {
@@ -63,36 +133,2 @@ limit?: number | null;
     };
-};
-export declare type RangeOrder = "asc" | "desc";
-export declare type ProposalsQueryOption = {
-    find_by_status: {
-        status: Status;
-        [k: string]: unknown;
-    };
-} | {
-    find_by_proposer: {
-        proposer: Addr;
-        [k: string]: unknown;
-    };
-} | {
-    everything: {
-        [k: string]: unknown;
-    };
-};
-export declare type DepositsQueryOption = {
-    find_by_proposal: {
-        proposal_id: number;
-        start?: string | null;
-        [k: string]: unknown;
-    };
-} | {
-    find_by_depositor: {
-        depositor: string;
-        start?: number | null;
-        [k: string]: unknown;
-    };
-} | {
-    everything: {
-        start?: [number, string] | null;
-        [k: string]: unknown;
-    };
-};
+}

dist/dao/shared-types.d.ts

 export declare type Vote = "yes" | "no" | "abstain" | "veto";
 /**
+ * Returns [VoteResponse]
+ *
+ * ## Example
+ *
+ * ```json { "vote": { "proposal_id": 1, "voter": "osmo1deadbeef" } } ```
+ */
+export interface Vote_1 {
+    vote: {
+        proposal_id: number;
+        voter: string;
+        [k: string]: unknown;
+    };
+}
+/**
  * A thin wrapper around u128 that is using strings for JSON encoding/decoding, such that the full u128 range can be used for clients that convert JSON numbers to floats, like JavaScript and jq.
@@ -91,2 +105,3 @@ *
     amount: Uint128;
+    claimed: boolean;
     depositor: string;
@@ -405,2 +420,84 @@ proposal_id: number;
 /**
+ * Returns [VotesResponse]
+ *
+ * ## Example
+ *
+ * ```json { "votes": { "proposal_id": 1, "start"?: "osmo1deadbeef", "limit": 30 | 10, "order": "asc" | "desc" } } ```
+ */
+export interface Votes_1 {
+    votes: {
+        limit?: number | null;
+        order?: RangeOrder | null;
+        proposal_id: number;
+        start?: string | null;
+        [k: string]: unknown;
+    };
+}
+export interface Proposal {
+    [k: string]: unknown;
+    deposit_base_amount: Uint128;
+    deposit_claimable: boolean;
+    deposit_ends_at: Expiration;
+    /**
+     * Proposal Description
+     */
+    description: string;
+    /**
+     * Related link about this proposal
+     */
+    link: string;
+    /**
+     * List of messages to execute
+     */
+    msgs: CosmosMsgFor_OsmosisMsg[];
+    /**
+     * Address of proposer
+     */
+    proposer: Addr;
+    /**
+     * Current status of this proposal
+     */
+    status: Status;
+    /**
+     * Starting time / height information
+     */
+    submitted_at: BlockTime;
+    /**
+     * Pass requirements
+     */
+    threshold: Threshold;
+    /**
+     * Proposal title
+     */
+    title: string;
+    /**
+     * Amount of the native governance token required for voting
+     */
+    total_deposit: Uint128;
+    /**
+     * The total weight when the proposal started (used to calculate percentages)
+     */
+    total_weight: Uint128;
+    vote_ends_at: Expiration;
+    vote_starts_at: BlockTime;
+    /**
+     * summary of existing votes
+     */
+    votes: Votes;
+}
+/**
+ * Returns [ProposalResponse]
+ *
+ * ## Example
+ *
+ * ```json { "proposal": { "proposal_id": 1 } } ```
+ */
+export interface Proposal_1 {
+    proposal: {
+        proposal_id: number;
+        [k: string]: unknown;
+    };
+}
+export declare type RangeOrder = "asc" | "desc";
+/**
  * Returns the vote (opinion as well as weight counted) as well as the address of the voter who submitted it
@@ -407,0 +504,0 @@ */

package.json

 {
   "name": "@alpha-dao/ion-dao-types",
-  "version": "0.0.5",
+  "version": "0.0.6",
   "description": "Official types of ion dao contract",
@@ -5,0 +5,0 @@ "repository": "git://github.com/alpha-dao/ion-dao-contracts.git",

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

42573

increased by9.52%

Lines of code

1228

increased by13.08%

No dependency changes