ecash-agora 0.1.1-rc → 0.2.0

package/.eslintrc.js

@@ -0,0 +1,45 @@
+// Copyright (c) 2024 The Bitcoin developers
+// Distributed under the MIT software license, see the accompanying
+// file COPYING or http://www.opensource.org/licenses/mit-license.php.
+
+const headerArray = [
+    {
+        pattern:
+            '^ Copyright \\(c\\) 2[0-9]{3}(-2[0-9]{3})? The Bitcoin developers$',
+        template: ` Copyright (c) ${new Date().getFullYear()} The Bitcoin developers`,
+    },
+    ' Distributed under the MIT software license, see the accompanying',
+    ' file COPYING or http://www.opensource.org/licenses/mit-license.php.',
+];
+
+module.exports = {
+    env: {
+        node: true,
+        commonjs: true,
+        es2021: true,
+        mocha: true,
+    },
+    overrides: [],
+    extends: [
+        'eslint:recommended',
+        'plugin:@typescript-eslint/recommended', // Add TypeScript recommended rules
+    ],
+    parserOptions: {
+        ecmaVersion: 'latest',
+        sourceType: 'module', // If you're using ES modules
+        parser: '@typescript-eslint/parser', // Use the TS parser
+    },
+    plugins: [
+        'header',
+        '@typescript-eslint', // Add the TypeScript plugin
+    ],
+    rules: {
+        'strict': 'error',
+        'header/header': [2, 'line', headerArray, 2],
+        'no-unused-vars': 'off',
+        '@typescript-eslint/no-unused-vars': [
+            'error',
+            { varsIgnorePattern: '^_' },
+        ],
+    },
+};

package/README.md

@@ -116,7 +116,49 @@ const acceptTx = txBuilder.sign(ecc);
 await chronik.broadcastTx(acceptTx.ser());
 ```
 
+## Development
+
+### Running the integration tests locally
+
+1. Build the node software from source with chronik and plugins enabled
+
+```
+mkdir build/
+cd build/
+cmake -GNinja .. -DBUILD_BITCOIN_CHRONIK=ON -DBUILD_BITCOIN_CHRONIK_PLUGINS=ON
+ninja
+```
+
+2. You may need to [adjust](https://stackoverflow.com/questions/72409563/unsupported-hash-type-ripemd160-with-hashlib-in-python/72508879#72508879) your `openssl` settings
+
+3. Specify the location of your built chronik-with-plugins node with the `BUILD_DIR` env variable, e.g.
+
+Running from `bitcoin-abc/modules/ecash-agora` if your build dir is `bitcoin-abc/build/`:
+
+`BUILD_DIR="${PWD}/../../build" npm run integration-tests`
+
 ## Changelog
 
 -   0.1.0 - MVP [D16087](https://reviews.bitcoinabc.org/D16087) [D16111](https://reviews.bitcoinabc.org/D16111)
 -   0.1.1 - Upgrading dependencies [D16374](https://reviews.bitcoinabc.org/D16374)
+
+### 0.2.0
+
+-   Add agora.py plugin [D16544](https://reviews.bitcoinabc.org/D16544)
+-   Plugin support [D16745](https://reviews.bitcoinabc.org/D16745)|[D16753](https://reviews.bitcoinabc.org/D16753)|[D16754](https://reviews.bitcoinabc.org/D16754)|[D16755](https://reviews.bitcoinabc.org/D16755)
+-   Improve test framework [D16741](https://reviews.bitcoinabc.org/D16741)
+-   Websocket subscriptions [D16845](https://reviews.bitcoinabc.org/D16845)
+-   Build script for partial SLP offers [D16743](https://reviews.bitcoinabc.org/D16743)
+-   Approximation logic for partial offers [D16735](https://reviews.bitcoinabc.org/D16735)
+-   Add `historicOffers` function to `Agora` [D16819](https://reviews.bitcoinabc.org/D16819)
+-   Patch burned tokens issue in agora partial scripts [D16821](https://reviews.bitcoinabc.org/D16821)
+-   Export partial modules [D16820](https://reviews.bitcoinabc.org/D16820)
+-   Syntax linting [D16919](https://reviews.bitcoinabc.org/D16919)|[D16928](https://reviews.bitcoinabc.org/D16928)
+-   README patch for local integration testing [D16952](https://reviews.bitcoinabc.org/D16952)
+-   Patch minAcceptedTokens() to return true minimum (prepared value) [D16920](https://reviews.bitcoinabc.org/D16920)
+-   Add validation to acceptTx method of AgoraPartial to prevent creation of unspendable offers [D16944](https://reviews.bitcoinabc.org/D16944)
+-   Export `scriptOps` helper function [D16972](https://reviews.bitcoinabc.org/D16972)
+-   Improve approximation for USD-esque tokens [D16995](https://reviews.bitcoinabc.org/D16995)
+-   Update tsconfig to support use in nodejs [D17019](https://reviews.bitcoinabc.org/D17019)
+-   Monorepo linting [D17072](https://reviews.bitcoinabc.org/D17072)
+-   CI publishing [D17243](https://reviews.bitcoinabc.org/D17243)

package/agora.py

@@ -16,6 +16,7 @@ from dataclasses import dataclass
 from io import BytesIO
 from typing import Optional, Union
 
+from chronik_plugin.etoken import Token
 from chronik_plugin.plugin import Plugin, PluginOutput
 from chronik_plugin.script import (
     OP_0,
@@ -70,7 +71,6 @@ from chronik_plugin.script import (
     CScript,
 )
 from chronik_plugin.slp import slp_send
-from chronik_plugin.token import Token
 
 LOKAD_ID = b"AGR0"
 SLP_INT_SIZE = 8
@@ -389,6 +389,7 @@ class AgoraPartial:
     token_type: int
     token_protocol: str
     script_len: int
+    enforced_locktime: int
     dust_amount: int
 
     @classmethod
@@ -424,6 +425,7 @@ class AgoraPartial:
         pushdata.extend(self.token_scale_factor.to_bytes(8, "little"))
         pushdata.extend(self.scaled_trunc_tokens_per_trunc_sat.to_bytes(8, "little"))
         pushdata.extend(self.min_accepted_scaled_trunc_tokens.to_bytes(8, "little"))
+        pushdata.extend(self.enforced_locktime.to_bytes(4, "little"))
         pushdata.extend(self.maker_pk)
         return bytes(pushdata)
 
@@ -435,6 +437,7 @@ class AgoraPartial:
             self.token_scale_factor.to_bytes(8, "little"),
             self.scaled_trunc_tokens_per_trunc_sat.to_bytes(8, "little"),
             self.min_accepted_scaled_trunc_tokens.to_bytes(8, "little"),
+            self.enforced_locktime.to_bytes(4, "little"),
         ]
 
     def script(self) -> CScript:
@@ -547,7 +550,11 @@ class AgoraPartial:
                 OP_NIP,
                 32,
                 OP_SPLIT,
+                4,
+                OP_SPLIT,
                 OP_DROP,
+                self.enforced_locktime.to_bytes(4, "little"),
+                OP_EQUALVERIFY,
                 OP_TOALTSTACK,
                 OP_CAT,
                 OP_HASH160,
@@ -715,10 +722,10 @@ def parse_partial(pushdata: bytes, token) -> Optional[AgoraPartial]:
     data_reader = BytesIO(pushdata)
     # AGR0 PARTIAL pushdata always has the same length
     if token.token_protocol == "SLP":
-        if len(pushdata) != 59:
+        if len(pushdata) != 63:
             return None
     elif token.token_protocol == "ALP":
-        if len(pushdata) != 71:
+        if len(pushdata) != 75:
             return None
         if data_reader.read(4) != b"AGR0":
             return None
@@ -731,6 +738,7 @@ def parse_partial(pushdata: bytes, token) -> Optional[AgoraPartial]:
     token_scale_factor = int.from_bytes(data_reader.read(8), "little")
     scaled_trunc_tokens_per_trunc_sat = int.from_bytes(data_reader.read(8), "little")
     min_accepted_scaled_trunc_tokens = int.from_bytes(data_reader.read(8), "little")
+    enforced_locktime = int.from_bytes(data_reader.read(4), "little")
     maker_pk = data_reader.read(33)
 
     token_trunc_factor = 1 << (8 * num_token_trunc_bytes)
@@ -751,6 +759,7 @@ def parse_partial(pushdata: bytes, token) -> Optional[AgoraPartial]:
         token_type=token.token_type,
         token_protocol=token.token_protocol,
         script_len=0x7F,
+        enforced_locktime=enforced_locktime,
         dust_amount=546,
     )
     measured_len = len(cut_out_codesep(partial_alp.script()))

package/dist/ad.js

@@ -1,10 +1,13 @@
+"use strict";
 // Copyright (c) 2024 The Bitcoin developers
 // Distributed under the MIT software license, see the accompanying
 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
-import { Script, bytesToStr, fromHex, isPushOp, shaRmd160, slpSend, toHex, } from 'ecash-lib';
-import { AGORA_LOKAD_ID_STR } from './consts.js';
-import { AgoraOneshot } from './oneshot.js';
-export function parseAgoraTx(tx) {
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseAgoraTx = void 0;
+const ecash_lib_1 = require("ecash-lib");
+const consts_js_1 = require("./consts.js");
+const oneshot_js_1 = require("./oneshot.js");
+function parseAgoraTx(tx) {
     if (tx.inputs.length === 0) {
         return undefined;
     }
@@ -23,13 +26,13 @@ export function parseAgoraTx(tx) {
     let opreturnScript;
     switch (tokenEntry.tokenType.protocol) {
         case 'SLP':
-            opreturnScript = slpSend(tokenEntry.tokenId, tokenEntry.tokenType.number, [0, BigInt(offerOutput.token.amount)]);
+            opreturnScript = (0, ecash_lib_1.slpSend)(tokenEntry.tokenId, tokenEntry.tokenType.number, [0, BigInt(offerOutput.token.amount)]);
             break;
         case 'ALP':
             // ALP not implemented yet
             return undefined;
     }
-    const scriptSig = new Script(fromHex(adInput.inputScript));
+    const scriptSig = new ecash_lib_1.Script((0, ecash_lib_1.fromHex)(adInput.inputScript));
     const parsedAd = parseAdScriptSig(scriptSig);
     if (parsedAd === undefined) {
         return undefined;
@@ -38,10 +41,10 @@ export function parseAgoraTx(tx) {
     let expectedAgoraScript;
     let expectedAgoraP2sh;
     switch (parsedAd.covenantVariant) {
-        case AgoraOneshot.COVENANT_VARIANT: {
+        case oneshot_js_1.AgoraOneshot.COVENANT_VARIANT: {
             let agoraOneshot;
             try {
-                agoraOneshot = AgoraOneshot.fromRedeemScript(parsedAd.redeemScript, opreturnScript);
+                agoraOneshot = oneshot_js_1.AgoraOneshot.fromRedeemScript(parsedAd.redeemScript, opreturnScript);
             }
             catch (ex) {
                 return undefined;
@@ -51,13 +54,13 @@ export function parseAgoraTx(tx) {
                 params: agoraOneshot,
             };
             expectedAgoraScript = agoraOneshot.script();
-            expectedAgoraP2sh = Script.p2sh(shaRmd160(expectedAgoraScript.bytecode));
+            expectedAgoraP2sh = ecash_lib_1.Script.p2sh((0, ecash_lib_1.shaRmd160)(expectedAgoraScript.bytecode));
             break;
         }
         default:
             return undefined;
     }
-    if (offerOutput.outputScript !== toHex(expectedAgoraP2sh.bytecode)) {
+    if (offerOutput.outputScript !== (0, ecash_lib_1.toHex)(expectedAgoraP2sh.bytecode)) {
         return undefined;
     }
     const outpoint = {
@@ -77,6 +80,7 @@ export function parseAgoraTx(tx) {
         spentBy: offerOutput.spentBy,
     };
 }
+exports.parseAgoraTx = parseAgoraTx;
 /**
  * How many pushops we expect at least for an advertisement.
  * There has to be at least a LOKAD ID, a covenant variant and a redeemScript.
@@ -87,7 +91,7 @@ function parseAdScriptSig(scriptSig) {
     const pushdata = [];
     let op;
     while ((op = ops.next())) {
-        if (!isPushOp(op)) {
+        if (!(0, ecash_lib_1.isPushOp)(op)) {
             return undefined;
         }
         pushdata.push(op.data);
@@ -96,12 +100,12 @@ function parseAdScriptSig(scriptSig) {
         return undefined;
     }
     const lokadId = pushdata[0];
-    if (bytesToStr(lokadId) != AGORA_LOKAD_ID_STR) {
+    if ((0, ecash_lib_1.bytesToStr)(lokadId) != consts_js_1.AGORA_LOKAD_ID_STR) {
         return undefined;
     }
-    const covenantVariant = bytesToStr(pushdata[1]);
+    const covenantVariant = (0, ecash_lib_1.bytesToStr)(pushdata[1]);
     const parsedPushdata = pushdata.slice(2, -1);
-    const redeemScript = new Script(pushdata[pushdata.length - 1]);
+    const redeemScript = new ecash_lib_1.Script(pushdata[pushdata.length - 1]);
     return {
         covenantVariant,
         pushdata: parsedPushdata,

package/dist/ad.js.map

@@ -1 +1 @@
-{"version":3,"file":"ad.js","sourceRoot":"","sources":["../src/ad.ts"],"names":[],"mappings":"AAAA,4CAA4C;AAC5C,mEAAmE;AACnE,sEAAsE;AAGtE,OAAO,EAGH,MAAM,EAEN,UAAU,EACV,OAAO,EACP,QAAQ,EACR,SAAS,EACT,OAAO,EACP,KAAK,GACR,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACjD,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAa5C,MAAM,UAAU,YAAY,CAAC,EAAc;IACvC,IAAI,EAAE,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACzB,OAAO,SAAS,CAAC;IACrB,CAAC;IACD,IAAI,EAAE,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACxB,OAAO,SAAS,CAAC;IACrB,CAAC;IACD,IAAI,EAAE,CAAC,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC/B,OAAO,SAAS,CAAC;IACrB,CAAC;IACD,MAAM,OAAO,GAAG,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IAC7B,MAAM,WAAW,GAAG,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IAClC,IAAI,WAAW,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;QAClC,OAAO,SAAS,CAAC;IACrB,CAAC;IACD,MAAM,UAAU,GAAG,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IACtC,IAAI,cAAsB,CAAC;IAC3B,QAAQ,UAAU,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC;QACpC,KAAK,KAAK;YACN,cAAc,GAAG,OAAO,CACpB,UAAU,CAAC,OAAO,EAClB,UAAU,CAAC,SAAS,CAAC,MAAM,EAC3B,CAAC,CAAC,EAAE,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CACxC,CAAC;YACF,MAAM;QACV,KAAK,KAAK;YACN,0BAA0B;YAC1B,OAAO,SAAS,CAAC;IACzB,CAAC;IACD,MAAM,SAAS,GAAG,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC;IAC3D,MAAM,QAAQ,GAAG,gBAAgB,CAAC,SAAS,CAAC,CAAC;IAC7C,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QACzB,OAAO,SAAS,CAAC;IACrB,CAAC;IACD,IAAI,OAAwB,CAAC;IAC7B,IAAI,mBAA2B,CAAC;IAChC,IAAI,iBAAyB,CAAC;IAC9B,QAAQ,QAAQ,CAAC,eAAe,EAAE,CAAC;QAC/B,KAAK,YAAY,CAAC,gBAAgB,CAAC,CAAC,CAAC;YACjC,IAAI,YAA0B,CAAC;YAC/B,IAAI,CAAC;gBACD,YAAY,GAAG,YAAY,CAAC,gBAAgB,CACxC,QAAQ,CAAC,YAAY,EACrB,cAAc,CACjB,CAAC;YACN,CAAC;YAAC,OAAO,EAAE,EAAE,CAAC;gBACV,OAAO,SAAS,CAAC;YACrB,CAAC;YACD,OAAO,GAAG;gBACN,IAAI,EAAE,SAAS;gBACf,MAAM,EAAE,YAAY;aACvB,CAAC;YACF,mBAAmB,GAAG,YAAY,CAAC,MAAM,EAAE,CAAC;YAC5C,iBAAiB,GAAG,MAAM,CAAC,IAAI,CAC3B,SAAS,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAC1C,CAAC;YACF,MAAM;QACV,CAAC;QACD;YACI,OAAO,SAAS,CAAC;IACzB,CAAC;IACD,IAAI,WAAW,CAAC,YAAY,KAAK,KAAK,CAAC,iBAAiB,CAAC,QAAQ,CAAC,EAAE,CAAC;QACjE,OAAO,SAAS,CAAC;IACrB,CAAC;IACD,MAAM,QAAQ,GAAG;QACb,IAAI,EAAE,EAAE,CAAC,IAAI;QACb,MAAM,EAAE,CAAC;KACZ,CAAC;IACF,OAAO;QACH,GAAG,OAAO;QACV,QAAQ;QACR,cAAc,EAAE;YACZ,OAAO,EAAE,QAAQ;YACjB,QAAQ,EAAE;gBACN,KAAK,EAAE,WAAW,CAAC,KAAK;gBACxB,YAAY,EAAE,mBAAmB;aACpC;SACJ;QACD,OAAO,EAAE,WAAW,CAAC,OAAO;KAC/B,CAAC;AACN,CAAC;AAQD;;;IAGI;AACJ,MAAM,yBAAyB,GAAG,CAAC,CAAC;AAEpC,SAAS,gBAAgB,CAAC,SAAiB;IACvC,MAAM,GAAG,GAAG,SAAS,CAAC,GAAG,EAAE,CAAC;IAC5B,MAAM,QAAQ,GAAG,EAAE,CAAC;IACpB,IAAI,EAAkB,CAAC;IACvB,OAAO,CAAC,EAAE,GAAG,GAAG,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC;QACvB,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,CAAC;YAChB,OAAO,SAAS,CAAC;QACrB,CAAC;QACD,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;IAC3B,CAAC;IACD,IAAI,QAAQ,CAAC,MAAM,GAAG,yBAAyB,EAAE,CAAC;QAC9C,OAAO,SAAS,CAAC;IACrB,CAAC;IACD,MAAM,OAAO,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;IAC5B,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,kBAAkB,EAAE,CAAC;QAC5C,OAAO,SAAS,CAAC;IACrB,CAAC;IACD,MAAM,eAAe,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;IAChD,MAAM,cAAc,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAC7C,MAAM,YAAY,GAAG,IAAI,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;IAC/D,OAAO;QACH,eAAe;QACf,QAAQ,EAAE,cAAc;QACxB,YAAY;KACf,CAAC;AACN,CAAC"}
+{"version":3,"file":"ad.js","sourceRoot":"","sources":["../src/ad.ts"],"names":[],"mappings":";AAAA,4CAA4C;AAC5C,mEAAmE;AACnE,sEAAsE;;;AAGtE,yCAWmB;AACnB,2CAAiD;AACjD,6CAA4C;AAa5C,SAAgB,YAAY,CAAC,EAAc;IACvC,IAAI,EAAE,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACzB,OAAO,SAAS,CAAC;IACrB,CAAC;IACD,IAAI,EAAE,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACxB,OAAO,SAAS,CAAC;IACrB,CAAC;IACD,IAAI,EAAE,CAAC,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC/B,OAAO,SAAS,CAAC;IACrB,CAAC;IACD,MAAM,OAAO,GAAG,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IAC7B,MAAM,WAAW,GAAG,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IAClC,IAAI,WAAW,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;QAClC,OAAO,SAAS,CAAC;IACrB,CAAC;IACD,MAAM,UAAU,GAAG,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IACtC,IAAI,cAAsB,CAAC;IAC3B,QAAQ,UAAU,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC;QACpC,KAAK,KAAK;YACN,cAAc,GAAG,IAAA,mBAAO,EACpB,UAAU,CAAC,OAAO,EAClB,UAAU,CAAC,SAAS,CAAC,MAAM,EAC3B,CAAC,CAAC,EAAE,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CACxC,CAAC;YACF,MAAM;QACV,KAAK,KAAK;YACN,0BAA0B;YAC1B,OAAO,SAAS,CAAC;IACzB,CAAC;IACD,MAAM,SAAS,GAAG,IAAI,kBAAM,CAAC,IAAA,mBAAO,EAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC;IAC3D,MAAM,QAAQ,GAAG,gBAAgB,CAAC,SAAS,CAAC,CAAC;IAC7C,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QACzB,OAAO,SAAS,CAAC;IACrB,CAAC;IACD,IAAI,OAAwB,CAAC;IAC7B,IAAI,mBAA2B,CAAC;IAChC,IAAI,iBAAyB,CAAC;IAC9B,QAAQ,QAAQ,CAAC,eAAe,EAAE,CAAC;QAC/B,KAAK,yBAAY,CAAC,gBAAgB,CAAC,CAAC,CAAC;YACjC,IAAI,YAA0B,CAAC;YAC/B,IAAI,CAAC;gBACD,YAAY,GAAG,yBAAY,CAAC,gBAAgB,CACxC,QAAQ,CAAC,YAAY,EACrB,cAAc,CACjB,CAAC;YACN,CAAC;YAAC,OAAO,EAAE,EAAE,CAAC;gBACV,OAAO,SAAS,CAAC;YACrB,CAAC;YACD,OAAO,GAAG;gBACN,IAAI,EAAE,SAAS;gBACf,MAAM,EAAE,YAAY;aACvB,CAAC;YACF,mBAAmB,GAAG,YAAY,CAAC,MAAM,EAAE,CAAC;YAC5C,iBAAiB,GAAG,kBAAM,CAAC,IAAI,CAC3B,IAAA,qBAAS,EAAC,mBAAmB,CAAC,QAAQ,CAAC,CAC1C,CAAC;YACF,MAAM;QACV,CAAC;QACD;YACI,OAAO,SAAS,CAAC;IACzB,CAAC;IACD,IAAI,WAAW,CAAC,YAAY,KAAK,IAAA,iBAAK,EAAC,iBAAiB,CAAC,QAAQ,CAAC,EAAE,CAAC;QACjE,OAAO,SAAS,CAAC;IACrB,CAAC;IACD,MAAM,QAAQ,GAAG;QACb,IAAI,EAAE,EAAE,CAAC,IAAI;QACb,MAAM,EAAE,CAAC;KACZ,CAAC;IACF,OAAO;QACH,GAAG,OAAO;QACV,QAAQ;QACR,cAAc,EAAE;YACZ,OAAO,EAAE,QAAQ;YACjB,QAAQ,EAAE;gBACN,KAAK,EAAE,WAAW,CAAC,KAAK;gBACxB,YAAY,EAAE,mBAAmB;aACpC;SACJ;QACD,OAAO,EAAE,WAAW,CAAC,OAAO;KAC/B,CAAC;AACN,CAAC;AAhFD,oCAgFC;AAQD;;;IAGI;AACJ,MAAM,yBAAyB,GAAG,CAAC,CAAC;AAEpC,SAAS,gBAAgB,CAAC,SAAiB;IACvC,MAAM,GAAG,GAAG,SAAS,CAAC,GAAG,EAAE,CAAC;IAC5B,MAAM,QAAQ,GAAG,EAAE,CAAC;IACpB,IAAI,EAAkB,CAAC;IACvB,OAAO,CAAC,EAAE,GAAG,GAAG,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC;QACvB,IAAI,CAAC,IAAA,oBAAQ,EAAC,EAAE,CAAC,EAAE,CAAC;YAChB,OAAO,SAAS,CAAC;QACrB,CAAC;QACD,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;IAC3B,CAAC;IACD,IAAI,QAAQ,CAAC,MAAM,GAAG,yBAAyB,EAAE,CAAC;QAC9C,OAAO,SAAS,CAAC;IACrB,CAAC;IACD,MAAM,OAAO,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;IAC5B,IAAI,IAAA,sBAAU,EAAC,OAAO,CAAC,IAAI,8BAAkB,EAAE,CAAC;QAC5C,OAAO,SAAS,CAAC;IACrB,CAAC;IACD,MAAM,eAAe,GAAG,IAAA,sBAAU,EAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;IAChD,MAAM,cAAc,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAC7C,MAAM,YAAY,GAAG,IAAI,kBAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;IAC/D,OAAO;QACH,eAAe;QACf,QAAQ,EAAE,cAAc;QACxB,YAAY;KACf,CAAC;AACN,CAAC"}

package/dist/agora.d.ts

@@ -1,7 +1,7 @@
-import { ChronikClient, Token } from 'chronik-client';
-import { Ecc, OutPoint, Script, Tx, TxBuilderInput, TxInput } from 'ecash-lib';
+import { ChronikClient, Token, WsEndpoint } from 'chronik-client';
+import { Ecc, Op, OutPoint, Script, Tx, TxBuilderInput, TxInput } from 'ecash-lib';
 import { AgoraOneshot } from './oneshot.js';
-import { AgoraPartial } from './partial.js';
+import { AgoraPartial, AgoraPartialParams } from './partial.js';
 /** Offer variant, determines the Script used to enforce the offer */
 export type AgoraOfferVariant = {
     type: 'ONESHOT';
@@ -10,6 +10,8 @@ export type AgoraOfferVariant = {
     type: 'PARTIAL';
     params: AgoraPartial;
 };
+/** Status of the offer, i.e. if it open/taken/canceled */
+export type AgoraOfferStatus = 'OPEN' | 'TAKEN' | 'CANCELED';
 /**
  * Individual token offer on the Agora, i.e. one UTXO offering tokens.
  *
@@ -20,11 +22,13 @@ export declare class AgoraOffer {
     outpoint: OutPoint;
     txBuilderInput: TxInput;
     token: Token;
+    status: AgoraOfferStatus;
     constructor(params: {
         variant: AgoraOfferVariant;
         outpoint: OutPoint;
         txBuilderInput: TxInput;
         token: Token;
+        status: AgoraOfferStatus;
     });
     /**
      * Build a tx accepting this offer.
@@ -64,6 +68,8 @@ export declare class AgoraOffer {
         dustAmount?: number;
         /** Fee per kB to use when building the tx. */
         feePerKb?: number;
+        /**  Allow accepting an offer such that the remaining quantity is unacceptable */
+        allowUnspendable?: boolean;
     }): Tx;
     /**
      * How many extra satoshis are required to fuel this offer so it can be
@@ -137,6 +143,30 @@ export declare class AgoraOffer {
      **/
     askedSats(acceptedTokens?: bigint): bigint;
 }
+/** Which txs to query (confirmed, unconfirmed, reverse history) */
+export type TxHistoryTable = 'CONFIRMED' | 'UNCONFIRMED' | 'HISTORY';
+export type AgoraQueryParamVariants = {
+    type: 'TOKEN_ID';
+    tokenId: string;
+} | {
+    type: 'GROUP_TOKEN_ID';
+    groupTokenId: string;
+} | {
+    type: 'PUBKEY';
+    pubkeyHex: string;
+};
+/** Params which Agora txs to query */
+export type AgoraHistoryParams = AgoraQueryParamVariants & {
+    table: TxHistoryTable;
+    page?: number;
+    pageSize?: number;
+};
+/** Queried offers from the history */
+export interface AgoraHistoryResult {
+    offers: AgoraOffer[];
+    numTxs: number;
+    numPages: number;
+}
 /**
  * Enables access to Agora, via Chronik instances that have the "agora" plugin
  * loaded.
@@ -144,6 +174,7 @@ export declare class AgoraOffer {
  * See agora.py.
  **/
 export declare class Agora {
+    private chronik;
     private plugin;
     private dustAmount;
     /**
@@ -169,10 +200,31 @@ export declare class Agora {
     activeOffersByGroupTokenId(groupTokenId: string): Promise<AgoraOffer[]>;
     /** Query all active offers with the given cancel pubkey. */
     activeOffersByPubKey(pubkeyHex: string): Promise<AgoraOffer[]>;
+    /**
+     * Query historic offers (paginated)
+     *
+     * These are basically the "candlesticks" of a specific token (and also the
+     * cancelled offers, but those would have to be ignored).
+     * Offers can also be queried by pubkey, giving a history of user's offers.
+     **/
+    historicOffers(params: AgoraHistoryParams): Promise<AgoraHistoryResult>;
+    /** Subscribe to updates from the websocket for some params */
+    subscribeWs(ws: WsEndpoint, params: AgoraQueryParamVariants): void;
+    /** Unsubscribe from updates from the websocket for some params */
+    unsubscribeWs(ws: WsEndpoint, params: AgoraQueryParamVariants): void;
+    /**
+     * Build a safe AgoraPartial for the given parameters.
+     *
+     * This looks at the blockchain to avoid creating an identical offer, by
+     * tweaking the enforcedLockTime.
+     */
+    selectParams(params: Omit<AgoraPartialParams, 'enforcedLockTime'> | AgoraPartial): Promise<AgoraPartial>;
+    private _groupHex;
     private _allTokenIdsByPrefix;
     private _activeOffersByGroup;
     private _parseOfferUtxo;
     private _parseOneshotOfferUtxo;
     private _parsePartialOfferUtxo;
 }
+export declare function scriptOps(script: Script): Op[];
 //# sourceMappingURL=agora.d.ts.map

package/dist/agora.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"agora.d.ts","sourceRoot":"","sources":["../src/agora.ts"],"names":[],"mappings":"AAIA,OAAO,EACH,aAAa,EAGb,KAAK,EAER,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAMH,GAAG,EAIH,QAAQ,EAER,MAAM,EAMN,EAAE,EAEF,cAAc,EAEd,OAAO,EAEV,MAAM,WAAW,CAAC;AAEnB,OAAO,EACH,YAAY,EAGf,MAAM,cAAc,CAAC;AACtB,OAAO,EACH,YAAY,EAGf,MAAM,cAAc,CAAC;AAatB,qEAAqE;AACrE,MAAM,MAAM,iBAAiB,GACvB;IACI,IAAI,EAAE,SAAS,CAAC;IAChB,MAAM,EAAE,YAAY,CAAC;CACxB,GACD;IACI,IAAI,EAAE,SAAS,CAAC;IAChB,MAAM,EAAE,YAAY,CAAC;CACxB,CAAC;AAER;;;;GAIG;AACH,qBAAa,UAAU;IACZ,OAAO,EAAE,iBAAiB,CAAC;IAC3B,QAAQ,EAAE,QAAQ,CAAC;IACnB,cAAc,EAAE,OAAO,CAAC;IACxB,KAAK,EAAE,KAAK,CAAC;gBAED,MAAM,EAAE;QACvB,OAAO,EAAE,iBAAiB,CAAC;QAC3B,QAAQ,EAAE,QAAQ,CAAC;QACnB,cAAc,EAAE,OAAO,CAAC;QACxB,KAAK,EAAE,KAAK,CAAC;KAChB;IAOD;;;;;;;SAOK;IACE,QAAQ,CAAC,MAAM,EAAE;QACpB,qCAAqC;QACrC,GAAG,EAAE,GAAG,CAAC;QACT;;;YAGI;QACJ,UAAU,EAAE,UAAU,CAAC;QACvB;;;YAGI;QACJ,UAAU,EAAE,UAAU,CAAC;QACvB;;;;;;;YAOI;QACJ,UAAU,EAAE,cAAc,EAAE,CAAC;QAC7B,mEAAmE;QACnE,eAAe,EAAE,MAAM,CAAC;QACxB,oDAAoD;QACpD,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,+CAA+C;QAC/C,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,8CAA8C;QAC9C,QAAQ,CAAC,EAAE,MAAM,CAAC;KACrB,GAAG,EAAE;IAmBN;;;;;QAKI;IACG,aAAa,CAAC,MAAM,EAAE;QACzB,mEAAmE;QACnE,eAAe,EAAE,MAAM,CAAC;QACxB,mBAAmB;QACnB,WAAW,CAAC,EAAE,cAAc,EAAE,CAAC;QAC/B,8CAA8C;QAC9C,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,cAAc,CAAC,EAAE,MAAM,CAAC;KAC3B,GAAG,MAAM;IAkBV,OAAO,CAAC,gBAAgB;IA0GxB;;;;;;QAMI;IACG,QAAQ,CAAC,MAAM,EAAE;QACpB,qCAAqC;QACrC,GAAG,EAAE,GAAG,CAAC;QACT;;;YAGI;QACJ,QAAQ,EAAE,UAAU,CAAC;QACrB;;;;;;YAMI;QACJ,UAAU,EAAE,cAAc,EAAE,CAAC;QAC7B,wEAAwE;QACxE,eAAe,EAAE,MAAM,CAAC;QACxB,+CAA+C;QAC/C,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,8CAA8C;QAC9C,QAAQ,CAAC,EAAE,MAAM,CAAC;KACrB,GAAG,EAAE;IAiBN;;;;;;;;;;QAUI;IACG,aAAa,CAAC,MAAM,EAAE;QACzB,mEAAmE;QACnE,eAAe,EAAE,MAAM,CAAC;QACxB,mBAAmB;QACnB,WAAW,CAAC,EAAE,cAAc,EAAE,CAAC;QAC/B,8CAA8C;QAC9C,QAAQ,CAAC,EAAE,MAAM,CAAC;KACrB,GAAG,MAAM;IAgBV,OAAO,CAAC,gBAAgB;IA4DxB;;;QAGI;IACG,SAAS,CAAC,cAAc,CAAC,EAAE,MAAM,GAAG,MAAM;CAepD;AAED;;;;;IAKI;AACJ,qBAAa,KAAK;IACd,OAAO,CAAC,MAAM,CAAiB;IAC/B,OAAO,CAAC,UAAU,CAAS;IAE3B;;;QAGI;gBACe,OAAO,EAAE,aAAa,EAAE,UAAU,CAAC,EAAE,MAAM;IAK9D;;;QAGI;IACS,kBAAkB,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAIpD,kEAAkE;IACrD,uBAAuB,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAIzD;;;QAGI;IACS,oBAAoB,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAItD,2CAA2C;IAC9B,qBAAqB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;IAI1E,iDAAiD;IACpC,0BAA0B,CACnC,YAAY,EAAE,MAAM,GACrB,OAAO,CAAC,UAAU,EAAE,CAAC;IAMxB,4DAA4D;IAC/C,oBAAoB,CAC7B,SAAS,EAAE,MAAM,GAClB,OAAO,CAAC,UAAU,EAAE,CAAC;YAIV,oBAAoB;YAmBpB,oBAAoB;IAUlC,OAAO,CAAC,eAAe;IAmBvB,OAAO,CAAC,sBAAsB;IAqD9B,OAAO,CAAC,sBAAsB;CAwEjC"}
+{"version":3,"file":"agora.d.ts","sourceRoot":"","sources":["../src/agora.ts"],"names":[],"mappings":"AAIA,OAAO,EACH,aAAa,EAGb,KAAK,EAGL,UAAU,EACb,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAMH,GAAG,EAIH,EAAE,EAEF,QAAQ,EAER,MAAM,EAMN,EAAE,EAEF,cAAc,EAEd,OAAO,EAEV,MAAM,WAAW,CAAC;AAEnB,OAAO,EACH,YAAY,EAGf,MAAM,cAAc,CAAC;AACtB,OAAO,EACH,YAAY,EAEZ,kBAAkB,EAErB,MAAM,cAAc,CAAC;AAatB,qEAAqE;AACrE,MAAM,MAAM,iBAAiB,GACvB;IACI,IAAI,EAAE,SAAS,CAAC;IAChB,MAAM,EAAE,YAAY,CAAC;CACxB,GACD;IACI,IAAI,EAAE,SAAS,CAAC;IAChB,MAAM,EAAE,YAAY,CAAC;CACxB,CAAC;AAER,0DAA0D;AAC1D,MAAM,MAAM,gBAAgB,GAAG,MAAM,GAAG,OAAO,GAAG,UAAU,CAAC;AAE7D;;;;GAIG;AACH,qBAAa,UAAU;IACZ,OAAO,EAAE,iBAAiB,CAAC;IAC3B,QAAQ,EAAE,QAAQ,CAAC;IACnB,cAAc,EAAE,OAAO,CAAC;IACxB,KAAK,EAAE,KAAK,CAAC;IACb,MAAM,EAAE,gBAAgB,CAAC;gBAEb,MAAM,EAAE;QACvB,OAAO,EAAE,iBAAiB,CAAC;QAC3B,QAAQ,EAAE,QAAQ,CAAC;QACnB,cAAc,EAAE,OAAO,CAAC;QACxB,KAAK,EAAE,KAAK,CAAC;QACb,MAAM,EAAE,gBAAgB,CAAC;KAC5B;IAQD;;;;;;;SAOK;IACE,QAAQ,CAAC,MAAM,EAAE;QACpB,qCAAqC;QACrC,GAAG,EAAE,GAAG,CAAC;QACT;;;YAGI;QACJ,UAAU,EAAE,UAAU,CAAC;QACvB;;;YAGI;QACJ,UAAU,EAAE,UAAU,CAAC;QACvB;;;;;;;YAOI;QACJ,UAAU,EAAE,cAAc,EAAE,CAAC;QAC7B,mEAAmE;QACnE,eAAe,EAAE,MAAM,CAAC;QACxB,oDAAoD;QACpD,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,+CAA+C;QAC/C,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,8CAA8C;QAC9C,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,iFAAiF;QACjF,gBAAgB,CAAC,EAAE,OAAO,CAAC;KAC9B,GAAG,EAAE;IAqBN;;;;;QAKI;IACG,aAAa,CAAC,MAAM,EAAE;QACzB,mEAAmE;QACnE,eAAe,EAAE,MAAM,CAAC;QACxB,mBAAmB;QACnB,WAAW,CAAC,EAAE,cAAc,EAAE,CAAC;QAC/B,8CAA8C;QAC9C,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,cAAc,CAAC,EAAE,MAAM,CAAC;KAC3B,GAAG,MAAM;IAkBV,OAAO,CAAC,gBAAgB;IAwHxB;;;;;;QAMI;IACG,QAAQ,CAAC,MAAM,EAAE;QACpB,qCAAqC;QACrC,GAAG,EAAE,GAAG,CAAC;QACT;;;YAGI;QACJ,QAAQ,EAAE,UAAU,CAAC;QACrB;;;;;;YAMI;QACJ,UAAU,EAAE,cAAc,EAAE,CAAC;QAC7B,wEAAwE;QACxE,eAAe,EAAE,MAAM,CAAC;QACxB,+CAA+C;QAC/C,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,8CAA8C;QAC9C,QAAQ,CAAC,EAAE,MAAM,CAAC;KACrB,GAAG,EAAE;IAiBN;;;;;;;;;;QAUI;IACG,aAAa,CAAC,MAAM,EAAE;QACzB,mEAAmE;QACnE,eAAe,EAAE,MAAM,CAAC;QACxB,mBAAmB;QACnB,WAAW,CAAC,EAAE,cAAc,EAAE,CAAC;QAC/B,8CAA8C;QAC9C,QAAQ,CAAC,EAAE,MAAM,CAAC;KACrB,GAAG,MAAM;IAgBV,OAAO,CAAC,gBAAgB;IA4DxB;;;QAGI;IACG,SAAS,CAAC,cAAc,CAAC,EAAE,MAAM,GAAG,MAAM;CAepD;AAED,mEAAmE;AACnE,MAAM,MAAM,cAAc,GAAG,WAAW,GAAG,aAAa,GAAG,SAAS,CAAC;AAErE,MAAM,MAAM,uBAAuB,GAC7B;IACI,IAAI,EAAE,UAAU,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;CACnB,GACD;IACI,IAAI,EAAE,gBAAgB,CAAC;IACvB,YAAY,EAAE,MAAM,CAAC;CACxB,GACD;IACI,IAAI,EAAE,QAAQ,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;CACrB,CAAC;AAER,sCAAsC;AACtC,MAAM,MAAM,kBAAkB,GAAG,uBAAuB,GAAG;IACvD,KAAK,EAAE,cAAc,CAAC;IACtB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,sCAAsC;AACtC,MAAM,WAAW,kBAAkB;IAC/B,MAAM,EAAE,UAAU,EAAE,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;CACpB;AAED;;;;;IAKI;AACJ,qBAAa,KAAK;IACd,OAAO,CAAC,OAAO,CAAgB;IAC/B,OAAO,CAAC,MAAM,CAAiB;IAC/B,OAAO,CAAC,UAAU,CAAS;IAE3B;;;QAGI;gBACe,OAAO,EAAE,aAAa,EAAE,UAAU,CAAC,EAAE,MAAM;IAM9D;;;QAGI;IACS,kBAAkB,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAIpD,kEAAkE;IACrD,uBAAuB,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAIzD;;;QAGI;IACS,oBAAoB,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAItD,2CAA2C;IAC9B,qBAAqB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;IAI1E,iDAAiD;IACpC,0BAA0B,CACnC,YAAY,EAAE,MAAM,GACrB,OAAO,CAAC,UAAU,EAAE,CAAC;IAMxB,4DAA4D;IAC/C,oBAAoB,CAC7B,SAAS,EAAE,MAAM,GAClB,OAAO,CAAC,UAAU,EAAE,CAAC;IAIxB;;;;;;QAMI;IACS,cAAc,CACvB,MAAM,EAAE,kBAAkB,GAC3B,OAAO,CAAC,kBAAkB,CAAC;IAmE9B,8DAA8D;IACvD,WAAW,CAAC,EAAE,EAAE,UAAU,EAAE,MAAM,EAAE,uBAAuB;IAKlE,kEAAkE;IAC3D,aAAa,CAAC,EAAE,EAAE,UAAU,EAAE,MAAM,EAAE,uBAAuB;IAKpE;;;;;OAKG;IACU,YAAY,CACrB,MAAM,EAAE,IAAI,CAAC,kBAAkB,EAAE,kBAAkB,CAAC,GAAG,YAAY,GACpE,OAAO,CAAC,YAAY,CAAC;IAkCxB,OAAO,CAAC,SAAS;YAaH,oBAAoB;YAmBpB,oBAAoB;IAUlC,OAAO,CAAC,eAAe;IAsBvB,OAAO,CAAC,sBAAsB;IAuD9B,OAAO,CAAC,sBAAsB;CAmFjC;AAED,wBAAgB,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,EAAE,EAAE,CAQ9C"}