@blockula/sdk 0.2.0 → 0.3.0

package/dist/index.d.ts

@@ -70,6 +70,23 @@ export declare class Wallet {
     approveValidator(validator: string): Promise<any>;
     /** Season 0 admins only. */
     removeValidator(validator: string): Promise<any>;
+    /** Claim a GitHub handle. Verify it by creating a public gist (as that user) containing this account's address. */
+    linkGithub(handle: string, gistId: string): Promise<any>;
+    unlinkGithub(handle: string): Promise<any>;
+    /** Put a bounty on a GitHub issue. `expiresInBlocks` from now (max ~1 year). */
+    createHunt(opts: {
+        repo: string;
+        issue: number;
+        amount: string | number | bigint;
+        title: string;
+        expiresInBlocks: number;
+    }): Promise<any>;
+    fundHunt(huntId: number, amount: string | number | bigint): Promise<any>;
+    /** Pay a hunt's bounty (creator or admin). `to` may be a .boo name; it's resolved and the address is signed. */
+    awardHunt(huntId: number, to: string, pr: number, familiarKey?: string): Promise<any>;
+    cancelHunt(huntId: number): Promise<any>;
+    /** Mark one of this account's session keys (an agent) as a Familiar. */
+    registerFamiliar(keyIdHex: string, label: string): Promise<any>;
     /** Reclaim the bond of a removed validator this account owns. */
     unbond(validator: string): Promise<any>;
     balance(): Promise<string>;
@@ -103,6 +120,11 @@ export declare class Client {
     search(q: string): Promise<any>;
     /** Active set for the current epoch, pending/approved validators, next-epoch set, epoch timing. */
     validators(): Promise<any>;
+    /** Hunts (bounties on GitHub issues), biggest first. */
+    hunts(status?: "open" | "awarded" | "cancelled" | "expired"): Promise<any>;
+    hunt(id: number): Promise<any>;
+    /** Off-chain check of a GitHub link (gist owned by the handle containing the address). */
+    github(handle: string): Promise<any>;
     resolve(nameOrAddress: string): Promise<string>;
     submit(tx: Tx, wait?: boolean): Promise<any>;
     faucet(to: string, wait?: boolean): Promise<any>;

package/dist/index.js

@@ -133,6 +133,33 @@ export class Wallet {
     async removeValidator(validator) {
         return this.client.submit(await this.build({ type: "remove_validator", validator }));
     }
+    /** Claim a GitHub handle. Verify it by creating a public gist (as that user) containing this account's address. */
+    async linkGithub(handle, gistId) {
+        return this.client.submit(await this.build({ type: "link_github", handle, gist_id: gistId }));
+    }
+    async unlinkGithub(handle) {
+        return this.client.submit(await this.build({ type: "unlink_github", handle }));
+    }
+    /** Put a bounty on a GitHub issue. `expiresInBlocks` from now (max ~1 year). */
+    async createHunt(opts) {
+        const { height } = await this.client.status();
+        return this.client.submit(await this.build({ type: "create_hunt", repo: opts.repo, issue: opts.issue, amount: parseFang(opts.amount).toString(), expires_at: height + opts.expiresInBlocks, title: opts.title }));
+    }
+    async fundHunt(huntId, amount) {
+        return this.client.submit(await this.build({ type: "fund_hunt", hunt_id: huntId, amount: parseFang(amount).toString() }));
+    }
+    /** Pay a hunt's bounty (creator or admin). `to` may be a .boo name; it's resolved and the address is signed. */
+    async awardHunt(huntId, to, pr, familiarKey) {
+        const addr = await this.client.resolve(to);
+        return this.client.submit(await this.build({ type: "award_hunt", hunt_id: huntId, to: addr, pr, ...(familiarKey ? { familiar_key: familiarKey } : {}) }));
+    }
+    async cancelHunt(huntId) {
+        return this.client.submit(await this.build({ type: "cancel_hunt", hunt_id: huntId }));
+    }
+    /** Mark one of this account's session keys (an agent) as a Familiar. */
+    async registerFamiliar(keyIdHex, label) {
+        return this.client.submit(await this.build({ type: "register_familiar", key_id: keyIdHex, label }));
+    }
     /** Reclaim the bond of a removed validator this account owns. */
     async unbond(validator) {
         return this.client.submit(await this.build({ type: "unbond", validator }));
@@ -197,6 +224,11 @@ export class Client {
     search(q) { return this.call(`/search/${encodeURIComponent(q)}`); }
     /** Active set for the current epoch, pending/approved validators, next-epoch set, epoch timing. */
     validators() { return this.call("/validators"); }
+    /** Hunts (bounties on GitHub issues), biggest first. */
+    hunts(status) { return this.call(`/hunts${status ? `?status=${status}` : ""}`); }
+    hunt(id) { return this.call(`/hunt/${id}`); }
+    /** Off-chain check of a GitHub link (gist owned by the handle containing the address). */
+    github(handle) { return this.call(`/github/${encodeURIComponent(handle)}`); }
     async resolve(nameOrAddress) {
         if (isAddress(nameOrAddress))
             return nameOrAddress;

package/dist/tx.d.ts

@@ -46,6 +46,43 @@ export type Action = {
  | {
     type: "unbond";
     validator: string;
+}
+/** Claim a GitHub handle; a public gist by that handle containing your boo1 address verifies it. */
+ | {
+    type: "link_github";
+    handle: string;
+    gist_id: string;
+} | {
+    type: "unlink_github";
+    handle: string;
+}
+/** Escrow a bounty on a GitHub issue ("owner/name", issue number). */
+ | {
+    type: "create_hunt";
+    repo: string;
+    issue: number;
+    amount: string;
+    expires_at: number;
+    title: string;
+} | {
+    type: "fund_hunt";
+    hunt_id: number;
+    amount: string;
+} | {
+    type: "award_hunt";
+    hunt_id: number;
+    to: string;
+    pr: number;
+    familiar_key?: string;
+} | {
+    type: "cancel_hunt";
+    hunt_id: number;
+}
+/** Mark one of your session keys as an agent Familiar. */
+ | {
+    type: "register_familiar";
+    key_id: string;
+    label: string;
 };
 export interface UnsignedTx {
     chain_id: string;

package/dist/tx.js

@@ -69,6 +69,44 @@ export function signingBytes(tx) {
             w.u8(7);
             w.str(a.validator);
             break;
+        case "link_github":
+            w.u8(8);
+            w.str(a.handle);
+            w.str(a.gist_id);
+            break;
+        case "unlink_github":
+            w.u8(9);
+            w.str(a.handle);
+            break;
+        case "create_hunt":
+            w.u8(10);
+            w.str(a.repo);
+            w.u64(BigInt(a.issue));
+            w.u64(BigInt(a.amount));
+            w.u64(BigInt(a.expires_at));
+            w.str(a.title);
+            break;
+        case "fund_hunt":
+            w.u8(11);
+            w.u64(BigInt(a.hunt_id));
+            w.u64(BigInt(a.amount));
+            break;
+        case "award_hunt":
+            w.u8(12);
+            w.u64(BigInt(a.hunt_id));
+            w.str(a.to);
+            w.u64(BigInt(a.pr));
+            w.str(a.familiar_key ?? "");
+            break;
+        case "cancel_hunt":
+            w.u8(13);
+            w.u64(BigInt(a.hunt_id));
+            break;
+        case "register_familiar":
+            w.u8(14);
+            w.str(a.key_id);
+            w.str(a.label);
+            break;
     }
     w.str(tx.memo);
     return w.done();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@blockula/sdk",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "\ud83e\udddb TypeScript SDK for Blockula \u2014 post-quantum wallets (ML-DSA-65), .boo names, transfers",
   "type": "module",
   "main": "dist/index.js",
@@ -44,5 +44,14 @@
   },
   "publishConfig": {
     "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/jackdishman/blockula.git",
+    "directory": "sdk-ts"
+  },
+  "homepage": "https://github.com/jackdishman/blockula#readme",
+  "bugs": {
+    "url": "https://github.com/jackdishman/blockula/issues"
   }
 }