@ezeonlabs/polestar 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,176 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS

package/README.md

@@ -1,3 +1,172 @@
-# Temporary Holding Version
+# @ezeonlabs/polestar
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+A TypeScript client for Polestar, participatory budgeting for SputnikDAO treasuries on NEAR. It reads rounds, projects and results without a wallet. It builds and sends every Polestar transaction, with amounts encoded exactly. And it prepares the SputnikDAO proposals a council approves to fund rounds and pay milestones.
+
+It has no runtime dependencies, works in browsers and Node.js 20.12+, and doesn't tie you to a wallet.
+
+## What you can build
+
+- **Membership issuers.** A round can be limited to direct sub-accounts of a named account, such as `*.guild.near`. An app that creates those accounts for vouched-for members decides who can vote, with no change to Polestar.
+- **Keeper bots.** Anyone can end voting and run the count once voting closes. [`examples/keeper.mjs`](https://github.com/maelstrom0x8/polestar/blob/main/packages/sdk/examples/keeper.mjs) does both.
+- **Council and treasury tools.** Prepare "fund a round", "pay a milestone" and "return unspent budget" proposals from scripts, scheduled jobs or another treasury interface.
+- **Community front-ends and alerts.** Show a community's rounds on its own site, or post "voting is open" and "results are in" from the contract's event logs.
+- **Dashboards.** Turnout, funded and unfunded projects, payment progress per project.
+
+## Install
+
+```bash
+npm install @ezeonlabs/polestar
+```
+
+To work from a clone of the repository instead:
+
+```bash
+cd packages/sdk
+npm install
+npm run build
+```
+
+## Read without a wallet
+
+```ts
+import { PolestarClient, formatNearAmount } from "@ezeonlabs/polestar";
+
+const polestar = new PolestarClient({
+  contractId: "budgeting.polestar-dev.testnet",
+  daoId: "dao.polestar-dev.testnet",
+});
+
+const round = await polestar.getRound(3);
+const projects = await polestar.getProjects(3);
+const result = await polestar.getAllocationResult(3);
+
+console.log(round?.phase, formatNearAmount(round!.config.budget));
+```
+
+| Method | Returns |
+| --- | --- |
+| `getRoundCount()` | Number of rounds ever created; ids run from `0` |
+| `getRound(id)`, `getRoundPhase(id)` | A round, or `null` |
+| `getProjects(roundId)`, `getProject(roundId, projectId)` | Projects with their milestones and status |
+| `getProjectSupport(roundId, projectId)` | How many ballots approved the project |
+| `getBallot(roundId, voter)` | A voter's ballot, or `null` |
+| `getFirstSeen(accountId)` | Block at which the account registered, or `null` |
+| `getAllocationResult(roundId)`, `getRemaining(roundId)` | The count's result and leftover budget |
+| `getBlock()`, `getChainClock()` | Chain head, and the measured time per block for converting block heights to dates |
+| `governance.getPolicy()`, `governance.getOpenProposals()` | The DAO's policy and its open proposals that call Polestar |
+
+There is no "list all rounds" call: the contract exposes rounds one at a time. For many rounds, read `getRoundCount()` and fetch the ids you need.
+
+Some old rounds can't be decoded by newer contract builds. Reading one throws `ContractPanicError`; skip it.
+
+## Write with a signer
+
+`client.withSigner(signer)` returns a writer. A signer is anything with `signAndSendTransaction({ receiverId, actions })`.
+
+**Browser wallets** through `@hot-labs/near-connect` already have that shape:
+
+```ts
+const { wallet } = await connector.getConnectedWallet();
+const writer = polestar.withSigner({
+  signAndSendTransaction: (tx) => wallet.signAndSendTransaction(tx as never),
+});
+await writer.submitBallot(3, [0, 2]);
+```
+
+**Servers and bots** use a near-api-js account:
+
+```ts
+import { Account, JsonRpcProvider } from "near-api-js";
+import { fromNearApiAccount } from "@ezeonlabs/polestar/near-api-js";
+
+const account = new Account("keeper.testnet", new JsonRpcProvider({ url: "https://test.rpc.fastnear.com" }), privateKey);
+const writer = polestar.withSigner(fromNearApiAccount(account));
+```
+
+| Writer method | What it does |
+| --- | --- |
+| `registerVoter()` | One-time registration that makes an account eligible for rounds opening later |
+| `registerProject({ roundId, recipient, title, summary, milestones, deposit })` | Proposes a project; the cost is the sum of `milestones` |
+| `submitBallot(roundId, projectIds)` | Approves any number of projects |
+| `startVoting(roundId)`, `endVoting(roundId)` | Moves a round into and out of voting; anyone can call these |
+| `processAllocationSteps(roundId, maxSteps?)` | Runs as many counting steps as fit in one transaction |
+| `runCounting(roundId, { onProgress, signal })` | Repeats the above until the results are in |
+
+Every writer method has a pure builder on `polestar.calls` (for example `polestar.calls.submitBallot(3, [0, 2])`) that returns the exact transaction without sending it. Use it to show people what they are about to sign.
+
+## DAO actions are proposals
+
+Three operations can only be carried out by the DAO itself: funding a round, paying a milestone and returning unspent budget. The SDK never offers them as direct calls. It prepares the SputnikDAO proposal, and the DAO's members approve it under their own rules.
+
+```ts
+await writer.governance.proposeFundRound(
+  { budget: parseNear("5")!, opensAt, closesAt, voterNamespace: "guild.near" },
+  { description: "May round for the guild" },
+);
+
+const [proposal] = await polestar.governance.getOpenProposals();
+await writer.governance.approve(proposal);
+```
+
+- The proposal bond is read from the DAO's policy unless you pass `bond`.
+- Leaving out `voterNamespace` creates a round anyone registered can vote in.
+- `approve` and `reject` send the vote the way SputnikDAO requires, echoing the proposal so a vote can't land on a different one.
+- Submitting a proposal does not fund anything. Funding happens when the proposal is approved, and the bond is returned once it's decided.
+
+## Amounts and precision
+
+NEAR amounts are integers in yoctoNEAR (10⁻²⁴ NEAR), far beyond what a JavaScript `number` holds exactly. The contract also returns them as plain JSON numbers, so a normal `JSON.parse` silently corrupts them.
+
+- Every amount the SDK returns or accepts is a `bigint`. Use `parseNear("1.25")` and `formatNearAmount(yocto)` to convert, with no floating point involved.
+- Reads go through `parsePreservingBigNumbers`, which keeps any 16-digit or longer number as a string before converting it to `bigint`.
+- Writes are encoded per method, the way the contract expects: `fund_round`'s budget as a bare integer, `register_project`'s amounts as decimal strings.
+- Round and project ids are `number`s. The SDK throws if one is ever outside JavaScript's safe integer range.
+
+## Errors, and when not to retry
+
+| Error | Meaning | Retry? |
+| --- | --- | --- |
+| `TransactionCancelledError` | The person closed the wallet or declined. Nothing was sent. | Yes, if they want to |
+| `ContractError` | The contract refused. `error.code` is an `ERR_*` code; `ERROR_CODES[code]` explains it. Nothing changed. | Only after fixing the cause |
+| `TransactionOutcomeUnknownError` | The transaction may have been sent, but no result came back. | **No.** Read the chain first: resending `registerProject` can create a duplicate project |
+| `ViewError`, `ContractPanicError` | A read failed, or the contract panicked while reading | Reads are safe to retry |
+
+## Counting
+
+When voting closes, anyone can end it and run the count. The count is deterministic: the same ballots always give the same result, however many transactions it takes. A typical round finishes in one `processAllocationSteps` call. `runCounting` keeps going until the contract reports the results are in, and stops early if you abort its `signal`.
+
+It is not atomic. Each transaction is final on its own, and progress is saved between them.
+
+## Events
+
+The contract logs one line per state change, for example `ProjectFunded round_id=3 project_id=1 stage=Mes amount=300000000000000000000000`. `parseEvents(outcome.logs)` turns them into `{ type, data }` objects.
+
+The event types are: `RoundFunded`, `ProjectRegistered`, `DeclarationOpened`, `BallotSubmitted`, `DeclarationClosed`, `ProjectFunded`, `ProjectUnfunded`, `AllocationFinalized`, `MilestoneAttested`, `MilestoneReleaseFailed`, `RemainingReturned`, `RemainingReturnFailed`.
+
+## Eligibility
+
+`voterStatus(round, accountId, firstSeen)` predicts whether an account can vote in a round: `"eligible"`, `"not-registered"`, `"too-late"` or `"not-member"`. It is an estimate for showing people where they stand; the contract makes the final decision.
+
+Eligibility is a social threshold, not proof of a unique person. A namespace's owner can create as many sub-accounts as they like.
+
+## Examples
+
+```bash
+npm run build
+node examples/read-round.mjs --round 3
+node examples/keeper.mjs
+node examples/keeper.mjs --send --account keeper.testnet --watch 60
+```
+
+The keeper runs dry unless you pass `--send`. It reads the signing key from `~/.near-credentials/testnet/<account>.json`, where the NEAR CLI stores keys.
+
+## Development
+
+```bash
+npm test
+npm run typecheck
+```
+
+## License
+
+[Apache-2.0](LICENSE)

package/dist/calls.d.ts

@@ -0,0 +1,20 @@
+import type { Transaction } from "./types.js";
+export declare const DEFAULT_COUNTING_STEPS = 100;
+export interface RegisterProjectInput {
+    roundId: number;
+    recipient: string;
+    title: string;
+    summary: string;
+    milestones: bigint[];
+    deposit: bigint;
+}
+export declare function polestarCalls(contractId: string): {
+    registerVoter: () => Transaction;
+    registerProject(input: RegisterProjectInput): Transaction;
+    submitBallot(roundId: number, projectIds: number[]): Transaction;
+    startVoting: (roundId: number) => Transaction;
+    endVoting: (roundId: number) => Transaction;
+    processAllocationStep: (roundId: number) => Transaction;
+    processAllocationSteps(roundId: number, maxSteps?: number): Transaction;
+};
+export type PolestarCalls = ReturnType<typeof polestarCalls>;

package/dist/calls.js

@@ -0,0 +1,44 @@
+import { toId, toU128 } from "./serialization.js";
+import { TGAS } from "./units.js";
+export const DEFAULT_COUNTING_STEPS = 100;
+export function polestarCalls(contractId) {
+    const call = (method, args, gas, deposit = 0n) => ({
+        receiverId: contractId,
+        method,
+        args,
+        deposit,
+        gas,
+    });
+    const round = (roundId) => ({ round_id: toId(roundId, "round id") });
+    return {
+        registerVoter: () => call("register_voter", {}, 30n * TGAS),
+        registerProject(input) {
+            if (input.milestones.length === 0)
+                throw new RangeError("a project needs at least one milestone");
+            const amounts = input.milestones.map((m) => toU128(m));
+            const cost = toU128(amounts.reduce((sum, m) => sum + m, 0n));
+            return call("register_project", {
+                ...round(input.roundId),
+                recipient: input.recipient,
+                title: input.title,
+                summary: input.summary,
+                cost: cost.toString(),
+                milestone_amounts: amounts.map((m) => m.toString()),
+            }, 100n * TGAS, toU128(input.deposit));
+        },
+        submitBallot(roundId, projectIds) {
+            const approved = [...new Set(projectIds.map((id) => toId(id, "project id")))].sort((a, b) => a - b);
+            return call("submit_ballot", { ...round(roundId), approved }, 50n * TGAS);
+        },
+        startVoting: (roundId) => call("open_declaration", round(roundId), 300n * TGAS),
+        endVoting: (roundId) => call("close_declaration", round(roundId), 300n * TGAS),
+        processAllocationStep: (roundId) => call("process_allocation_step", round(roundId), 300n * TGAS),
+        processAllocationSteps(roundId, maxSteps = DEFAULT_COUNTING_STEPS) {
+            if (!Number.isInteger(maxSteps) || maxSteps < 1 || maxSteps > 0xffff_ffff) {
+                throw new RangeError("maxSteps must be an integer between 1 and 2^32 - 1");
+            }
+            return call("process_allocation_steps", { ...round(roundId), max_steps: maxSteps }, 300n * TGAS);
+        },
+    };
+}
+//# sourceMappingURL=calls.js.map

package/dist/calls.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"calls.js","sourceRoot":"","sources":["../src/calls.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAElD,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAElC,MAAM,CAAC,MAAM,sBAAsB,GAAG,GAAG,CAAC;AAW1C,MAAM,UAAU,aAAa,CAAC,UAAkB;IAC9C,MAAM,IAAI,GAAG,CAAC,MAAc,EAAE,IAA6B,EAAE,GAAW,EAAE,OAAO,GAAG,EAAE,EAAe,EAAE,CAAC,CAAC;QACvG,UAAU,EAAE,UAAU;QACtB,MAAM;QACN,IAAI;QACJ,OAAO;QACP,GAAG;KACJ,CAAC,CAAC;IACH,MAAM,KAAK,GAAG,CAAC,OAAe,EAAE,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,IAAI,CAAC,OAAO,EAAE,UAAU,CAAC,EAAE,CAAC,CAAC;IAE7E,OAAO;QACL,aAAa,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,EAAE,GAAG,GAAG,IAAI,CAAC;QAE3D,eAAe,CAAC,KAA2B;YACzC,IAAI,KAAK,CAAC,UAAU,CAAC,MAAM,KAAK,CAAC;gBAAE,MAAM,IAAI,UAAU,CAAC,wCAAwC,CAAC,CAAC;YAClG,MAAM,OAAO,GAAG,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;YACvD,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;YAC7D,OAAO,IAAI,CACT,kBAAkB,EAClB;gBACE,GAAG,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC;gBACvB,SAAS,EAAE,KAAK,CAAC,SAAS;gBAC1B,KAAK,EAAE,KAAK,CAAC,KAAK;gBAClB,OAAO,EAAE,KAAK,CAAC,OAAO;gBACtB,IAAI,EAAE,IAAI,CAAC,QAAQ,EAAE;gBACrB,iBAAiB,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;aACpD,EACD,IAAI,GAAG,IAAI,EACX,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CACtB,CAAC;QACJ,CAAC;QAED,YAAY,CAAC,OAAe,EAAE,UAAoB;YAChD,MAAM,QAAQ,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;YACpG,OAAO,IAAI,CAAC,eAAe,EAAE,EAAE,GAAG,KAAK,CAAC,OAAO,CAAC,EAAE,QAAQ,EAAE,EAAE,GAAG,GAAG,IAAI,CAAC,CAAC;QAC5E,CAAC;QAED,WAAW,EAAE,CAAC,OAAe,EAAE,EAAE,CAAC,IAAI,CAAC,kBAAkB,EAAE,KAAK,CAAC,OAAO,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC;QAEvF,SAAS,EAAE,CAAC,OAAe,EAAE,EAAE,CAAC,IAAI,CAAC,mBAAmB,EAAE,KAAK,CAAC,OAAO,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC;QAEtF,qBAAqB,EAAE,CAAC,OAAe,EAAE,EAAE,CAAC,IAAI,CAAC,yBAAyB,EAAE,KAAK,CAAC,OAAO,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC;QAExG,sBAAsB,CAAC,OAAe,EAAE,QAAQ,GAAG,sBAAsB;YACvE,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,QAAQ,GAAG,CAAC,IAAI,QAAQ,GAAG,WAAW,EAAE,CAAC;gBAC1E,MAAM,IAAI,UAAU,CAAC,oDAAoD,CAAC,CAAC;YAC7E,CAAC;YACD,OAAO,IAAI,CAAC,0BAA0B,EAAE,EAAE,GAAG,KAAK,CAAC,OAAO,CAAC,EAAE,SAAS,EAAE,QAAQ,EAAE,EAAE,IAAI,GAAG,IAAI,CAAC,CAAC;QACnG,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/client.d.ts

@@ -0,0 +1,148 @@
+import { polestarCalls, type RegisterProjectInput } from "./calls.js";
+import { governanceCalls, type DaoPolicy, type DaoProposal, type FundRoundInput, type MilestonePaymentInput } from "./governance.js";
+import { type BlockFn, type ViewFn } from "./rpc.js";
+import type { AllocationResult, Ballot, Block, ChainClock, FundingStage, Project, ProjectStatus, Round, RoundPhase, Signer, Transaction, TransactionOutcome } from "./types.js";
+export declare const DEFAULT_TESTNET_RPC = "https://test.rpc.fastnear.com";
+export interface PolestarClientOptions {
+    contractId: string;
+    daoId: string;
+    rpcUrl?: string;
+    fetch?: typeof fetch;
+    view?: ViewFn;
+    block?: BlockFn;
+}
+interface RoundRaw {
+    id: number | string;
+    config: {
+        budget: string | number;
+        opens_at: number | string;
+        closes_at: number | string;
+        t_min: number | string;
+    };
+    phase: RoundPhase;
+    remaining: string | number;
+    remaining_returned?: boolean;
+    voter_namespace?: string | null;
+    project_count: number | string;
+    ballot_count: number | string;
+}
+interface ProjectRaw {
+    id: number | string;
+    proposer: string;
+    recipient: string;
+    title: string;
+    summary: string;
+    cost: string | number;
+    milestones: {
+        amount: string | number;
+        attested: boolean;
+    }[];
+    status: ProjectStatus;
+}
+interface AllocationResultRaw {
+    budget: string | number;
+    funded: {
+        project: number | string;
+        stage: FundingStage;
+        amount: string | number;
+    }[];
+    unfunded: (number | string)[];
+    remaining: string | number;
+}
+export declare function mapRound(raw: RoundRaw): Round;
+export declare function mapProject(raw: ProjectRaw): Project;
+export declare function mapAllocationResult(raw: AllocationResultRaw): AllocationResult;
+export declare function sendTransaction(signer: Signer, transaction: Transaction): Promise<TransactionOutcome>;
+export declare class PolestarClient {
+    readonly contractId: string;
+    readonly daoId: string;
+    readonly calls: ReturnType<typeof polestarCalls>;
+    readonly governance: PolestarGovernanceReader;
+    private readonly viewFn;
+    private readonly blockFn;
+    constructor(options: PolestarClientOptions);
+    view<T>(method: string, args?: Record<string, unknown>, contractId?: string): Promise<T>;
+    getRoundCount(): Promise<number>;
+    getRound(roundId: number): Promise<Round | null>;
+    getRoundPhase(roundId: number): Promise<RoundPhase | null>;
+    getProjects(roundId: number): Promise<Project[]>;
+    getProject(roundId: number, projectId: number): Promise<Project | null>;
+    getProjectSupport(roundId: number, projectId: number): Promise<number>;
+    getBallot(roundId: number, voter: string): Promise<Ballot | null>;
+    getFirstSeen(accountId: string): Promise<number | null>;
+    getAllocationResult(roundId: number): Promise<AllocationResult | null>;
+    getRemaining(roundId: number): Promise<bigint | null>;
+    getBlock(ref?: "final" | number): Promise<Block>;
+    getChainClock(sampleSpan?: number): Promise<ChainClock>;
+    withSigner(signer: Signer): PolestarWriter;
+}
+export declare class PolestarGovernanceReader {
+    readonly calls: ReturnType<typeof governanceCalls>;
+    private readonly client;
+    constructor(client: PolestarClient);
+    getPolicy(): Promise<DaoPolicy>;
+    getOpenProposals(window?: number): Promise<DaoProposal[]>;
+    canSubmit(accountId: string): Promise<boolean>;
+    canVote(accountId: string): Promise<boolean>;
+}
+export interface CountingProgress {
+    transactions: number;
+    outcome: TransactionOutcome;
+    done: boolean;
+}
+export interface CountingOptions {
+    maxStepsPerTransaction?: number;
+    maxTransactions?: number;
+    signal?: AbortSignal;
+    onProgress?: (progress: CountingProgress) => void;
+}
+export interface CountingResult {
+    done: boolean;
+    transactions: number;
+    outcomes: TransactionOutcome[];
+}
+export declare class PolestarWriter {
+    readonly client: PolestarClient;
+    readonly signer: Signer;
+    readonly governance: PolestarGovernanceWriter;
+    constructor(client: PolestarClient, signer: Signer);
+    send(transaction: Transaction): Promise<TransactionOutcome>;
+    registerVoter(): Promise<TransactionOutcome>;
+    registerProject(input: RegisterProjectInput): Promise<{
+        projectId: number;
+        outcome: TransactionOutcome;
+    }>;
+    submitBallot(roundId: number, projectIds: number[]): Promise<TransactionOutcome>;
+    startVoting(roundId: number): Promise<TransactionOutcome>;
+    endVoting(roundId: number): Promise<TransactionOutcome>;
+    processAllocationStep(roundId: number): Promise<{
+        done: boolean;
+        outcome: TransactionOutcome;
+    }>;
+    processAllocationSteps(roundId: number, maxSteps?: number): Promise<{
+        done: boolean;
+        outcome: TransactionOutcome;
+    }>;
+    runCounting(roundId: number, options?: CountingOptions): Promise<CountingResult>;
+}
+export declare class PolestarGovernanceWriter {
+    private readonly writer;
+    constructor(writer: PolestarWriter);
+    private options;
+    private get calls();
+    proposeFundRound(input: FundRoundInput, options: {
+        description: string;
+        bond?: bigint;
+    }): Promise<TransactionOutcome>;
+    proposeMilestonePayment(input: MilestonePaymentInput, options: {
+        description: string;
+        bond?: bigint;
+    }): Promise<TransactionOutcome>;
+    proposeReturnRemaining(roundId: number, options: {
+        description: string;
+        bond?: bigint;
+    }): Promise<TransactionOutcome>;
+    approve(proposal: DaoProposal): Promise<TransactionOutcome>;
+    reject(proposal: DaoProposal): Promise<TransactionOutcome>;
+}
+export {};