@d13co/escreg-sdk 0.0.1

package/dist/esm/util.js

@@ -0,0 +1,90 @@
+import { makeEmptyTransactionSigner, modelsv2 } from "algosdk";
+import { AlgorandClient } from "@algorandfoundation/algokit-utils";
+export const emptySigner = makeEmptyTransactionSigner();
+export const fnetNodelyClient = AlgorandClient.fromConfig({
+    algodConfig: {
+        server: "https://fnet-api.4160.nodely.dev",
+        port: 443,
+    },
+    indexerConfig: {
+        server: "https://fnet-idx.4160.nodely.dev",
+        port: 443,
+    },
+});
+/** Prepend the 'c' key prefix to a public key for the userCredits box */
+export function creditBoxRef(publicKey) {
+    const ref = new Uint8Array(1 + publicKey.length);
+    ref[0] = 0x63; // 'c'
+    ref.set(publicKey, 1);
+    return ref;
+}
+export function chunk(array, size) {
+    if (size <= 0)
+        throw new Error("Chunk size must be greater than 0");
+    const result = [];
+    for (let i = 0; i < array.length; i += size) {
+        result.push(array.slice(i, i + size));
+    }
+    return result;
+}
+// sync with "increaseBudget opcode cost" contract tests
+export const increaseBudgetBaseCost = 26;
+export const increaseBudgetIncrementCost = 22;
+const SIMULATE_PARAMS = {
+    allowMoreLogging: true,
+    allowUnnamedResources: true,
+    extraOpcodeBudget: 130013,
+    fixSigners: true,
+    allowEmptySignatures: true,
+};
+const simulateRequest = new modelsv2.SimulateRequest({
+    txnGroups: [],
+    ...SIMULATE_PARAMS,
+});
+/* Utility to increase the budget of a transaction group if needed.
+ * Simulates and returns undefined if we are under budget, otherwise returns a new builder with an increaseBudget call prepended.
+ */
+export async function getIncreaseBudgetBuilder(builder, newBuilderFactory, sender, signer, algod) {
+    // maxFee/coverAppCallInnerTransactionFees does not work with builder.simulate() #algokit
+    // increase first txn's fee so we do not fail because of fees
+    // get atc & modify the first txn fee (need to clone to make txns mutable)
+    const atc = (await (await builder.composer()).build()).atc.clone();
+    // @ts-ignore private and readonly
+    atc.transactions[0].txn.fee = 543210n;
+    // we also need to replace signers with empty signers for simulation
+    // otherwise end users would be prompted to sign for this
+    // @ts-ignore private and readonly
+    atc.transactions = atc.transactions.map((t) => {
+        t.signer = makeEmptyTransactionSigner();
+        return t;
+    });
+    const { simulateResponse: { txnGroups: [{ txnResults, appBudgetConsumed = 0 }], }, } = await atc.simulate(algod, simulateRequest);
+    // intentionally doing opup even if there is a failure
+    // we had code here to return early if there was a failureMessage
+    // but that meant that in some cases the actual failure would be obscured by out of budget errors
+    // get existing budget: count app calls
+    // NOTE only goes 1 level deep in itxns
+    const numAppCalls = txnResults.reduce((sum, { txnResult }) => {
+        if (txnResult?.txn.txn.type !== "appl")
+            return sum;
+        const innerTxns = txnResult.innerTxns ?? [];
+        return sum + 1 + innerTxns.length;
+    }, 0);
+    let existingBudget = 700 * numAppCalls;
+    // budget is OK, returning
+    if (appBudgetConsumed <= existingBudget)
+        return;
+    existingBudget += 700 - increaseBudgetBaseCost; // add 700 for increaseBudget, removing its base cost
+    const itxnBudgetNeeded = appBudgetConsumed - existingBudget; // budget to create in itxns
+    const itxns = Math.max(0, Math.ceil(itxnBudgetNeeded / (700 - increaseBudgetIncrementCost)));
+    const increaseBudgetArgs = {
+        args: { itxns },
+        extraFee: (itxns * 1000).microAlgo(),
+        maxFee: ((itxns + 1) * 1000).microAlgo(),
+        note: Math.floor(Math.random() * 100000000).toString(),
+        sender,
+        signer,
+    };
+    return newBuilderFactory().increaseBudget(increaseBudgetArgs);
+}
+//# sourceMappingURL=util.js.map

package/dist/esm/util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.js","sourceRoot":"","sources":["../../src/util.ts"],"names":[],"mappings":"AAAA,OAAO,EAAW,0BAA0B,EAAE,QAAQ,EAAqB,MAAM,SAAS,CAAC;AAG3F,OAAO,EAAE,cAAc,EAAE,MAAM,mCAAmC,CAAC;AAEnE,MAAM,CAAC,MAAM,WAAW,GAAG,0BAA0B,EAAE,CAAC;AAExD,MAAM,CAAC,MAAM,gBAAgB,GAAG,cAAc,CAAC,UAAU,CAAC;IACxD,WAAW,EAAE;QACX,MAAM,EAAE,kCAAkC;QAC1C,IAAI,EAAE,GAAG;KACV;IACD,aAAa,EAAE;QACb,MAAM,EAAE,kCAAkC;QAC1C,IAAI,EAAE,GAAG;KACV;CACF,CAAC,CAAC;AAEH,yEAAyE;AACzE,MAAM,UAAU,YAAY,CAAC,SAAqB;IAChD,MAAM,GAAG,GAAG,IAAI,UAAU,CAAC,CAAC,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC;IACjD,GAAG,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,MAAM;IACrB,GAAG,CAAC,GAAG,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;IACtB,OAAO,GAAG,CAAC;AACb,CAAC;AAED,MAAM,UAAU,KAAK,CAAI,KAAU,EAAE,IAAY;IAC/C,IAAI,IAAI,IAAI,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;IAEpE,MAAM,MAAM,GAAU,EAAE,CAAC;IAEzB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,IAAI,IAAI,EAAE,CAAC;QAC5C,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;IACxC,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,wDAAwD;AACxD,MAAM,CAAC,MAAM,sBAAsB,GAAG,EAAE,CAAC;AACzC,MAAM,CAAC,MAAM,2BAA2B,GAAG,EAAE,CAAC;AAE9C,MAAM,eAAe,GAAG;IACtB,gBAAgB,EAAE,IAAI;IACtB,qBAAqB,EAAE,IAAI;IAC3B,iBAAiB,EAAE,MAAO;IAC1B,UAAU,EAAE,IAAI;IAChB,oBAAoB,EAAE,IAAI;CAC3B,CAAC;AAEF,MAAM,eAAe,GAAG,IAAI,QAAQ,CAAC,eAAe,CAAC;IACnD,SAAS,EAAE,EAAE;IACb,GAAG,eAAe;CACnB,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,wBAAwB,CAC5C,OAA4B,EAC5B,iBAA4C,EAC5C,MAAc,EACd,MAAoD,EACpD,KAAc;IAEd,yFAAyF;IACzF,6DAA6D;IAC7D,0EAA0E;IAC1E,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,MAAM,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC;IACnE,kCAAkC;IAClC,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,GAAG,OAAQ,CAAC;IAEvC,oEAAoE;IACpE,yDAAyD;IACzD,kCAAkC;IAClC,GAAG,CAAC,YAAY,GAAG,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAM,EAAE,EAAE;QACjD,CAAC,CAAC,MAAM,GAAG,0BAA0B,EAAE,CAAC;QACxC,OAAO,CAAC,CAAC;IACX,CAAC,CAAC,CAAC;IAEH,MAAM,EACJ,gBAAgB,EAAE,EAChB,SAAS,EAAE,CAAC,EAAE,UAAU,EAAE,iBAAiB,GAAG,CAAC,EAAE,CAAC,GACnD,GACF,GAAG,MAAM,GAAG,CAAC,QAAQ,CAAC,KAAK,EAAE,eAAe,CAAC,CAAC;IAE/C,sDAAsD;IACtD,iEAAiE;IACjE,iGAAiG;IAEjG,uCAAuC;IACvC,uCAAuC;IACvC,MAAM,WAAW,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,GAAW,EAAE,EAAE,SAAS,EAAO,EAAE,EAAE;QACxE,IAAI,SAAS,EAAE,GAAG,CAAC,GAAG,CAAC,IAAI,KAAK,MAAM;YAAE,OAAO,GAAG,CAAC;QACnD,MAAM,SAAS,GAAG,SAAS,CAAC,SAAS,IAAI,EAAE,CAAC;QAC5C,OAAO,GAAG,GAAG,CAAC,GAAG,SAAS,CAAC,MAAM,CAAC;IACpC,CAAC,EAAE,CAAC,CAAC,CAAC;IAEN,IAAI,cAAc,GAAG,GAAG,GAAG,WAAW,CAAC;IAEvC,0BAA0B;IAC1B,IAAI,iBAAkB,IAAI,cAAc;QAAE,OAAO;IAEjD,cAAc,IAAI,GAAG,GAAG,sBAAsB,CAAC,CAAC,qDAAqD;IACrG,MAAM,gBAAgB,GAAG,iBAAkB,GAAG,cAAc,CAAC,CAAC,4BAA4B;IAE1F,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,gBAAgB,GAAG,CAAC,GAAG,GAAG,2BAA2B,CAAC,CAAC,CAAC,CAAC;IAE7F,MAAM,kBAAkB,GAAG;QACzB,IAAI,EAAE,EAAE,KAAK,EAAE;QACf,QAAQ,EAAE,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC,SAAS,EAAE;QACpC,MAAM,EAAE,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,SAAS,EAAE;QACxC,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,SAAW,CAAC,CAAC,QAAQ,EAAE;QACxD,MAAM;QACN,MAAM;KACP,CAAC;IAEF,OAAO,iBAAiB,EAAE,CAAC,cAAc,CAAC,kBAAkB,CAAC,CAAC;AAChE,CAAC"}

package/dist/esm/wrapErrors.d.ts

@@ -0,0 +1,7 @@
+import { ErrorTransformer } from "@algorandfoundation/algokit-utils/types/composer";
+/**
+ * Map of error codes to human-readable error messages
+ */
+export declare const errorMap: Record<string, string>;
+export declare const errorTransformer: ErrorTransformer;
+export declare function wrapErrorsInternal<T>(promiseOrGenerator: Promise<T> | (() => Promise<T>)): Promise<T>;

package/dist/esm/wrapErrors.js

@@ -0,0 +1,32 @@
+import { ErrorMessages } from "./generated/errors";
+/**
+ * Map of error codes to human-readable error messages
+ */
+export const errorMap = ErrorMessages;
+export const errorTransformer = async (ogError) => {
+    const [errCode] = /ERR:[^" ]+/.exec(ogError.message) ?? [];
+    if (errCode) {
+        const humanMessage = errorMap[errCode] ?? "Unknown error";
+        const message = `${errCode.replace("ERR:", "Error ")}: ${humanMessage}`;
+        ogError.stack = `${message}\n    ${ogError.message}\n${ogError.stack}`;
+        ogError.message = message;
+        ogError.code = errCode;
+        ogError.description = humanMessage;
+        return ogError;
+    }
+    return ogError;
+};
+export async function wrapErrorsInternal(promiseOrGenerator) {
+    try {
+        if (typeof promiseOrGenerator === "function") {
+            return await promiseOrGenerator();
+        }
+        else {
+            return await promiseOrGenerator;
+        }
+    }
+    catch (e) {
+        throw await errorTransformer(e);
+    }
+}
+//# sourceMappingURL=wrapErrors.js.map

package/dist/esm/wrapErrors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"wrapErrors.js","sourceRoot":"","sources":["../../src/wrapErrors.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEnD;;GAEG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,aAAa,CAAC;AAEtC,MAAM,CAAC,MAAM,gBAAgB,GAAqB,KAAK,EAAE,OAAO,EAAE,EAAE;IAClE,MAAM,CAAC,OAAO,CAAC,GAAG,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;IAC3D,IAAI,OAAO,EAAE,CAAC;QACZ,MAAM,YAAY,GAAG,QAAQ,CAAC,OAAO,CAAC,IAAI,eAAe,CAAC;QAC1D,MAAM,OAAO,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,QAAQ,CAAC,KAAK,YAAY,EAAE,CAAA;QAEvE,OAAO,CAAC,KAAK,GAAG,GAAG,OAAO,SAAS,OAAO,CAAC,OAAO,KAAK,OAAO,CAAC,KAAK,EAAE,CAAC;QACvE,OAAO,CAAC,OAAO,GAAG,OAAO,CAAC;QACzB,OAAe,CAAC,IAAI,GAAG,OAAO,CAAC;QAC/B,OAAe,CAAC,WAAW,GAAG,YAAY,CAAC;QAC5C,OAAO,OAAO,CAAC;IACjB,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC,CAAC;AAEF,MAAM,CAAC,KAAK,UAAU,kBAAkB,CAAI,kBAAmD;IAC7F,IAAI,CAAC;QACH,IAAI,OAAO,kBAAkB,KAAK,UAAU,EAAE,CAAC;YAC7C,OAAO,MAAM,kBAAkB,EAAE,CAAC;QACpC,CAAC;aAAM,CAAC;YACN,OAAO,MAAM,kBAAkB,CAAC;QAClC,CAAC;IACH,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,MAAM,MAAM,gBAAgB,CAAC,CAAU,CAAC,CAAC;IAC3C,CAAC;AACH,CAAC"}

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@d13co/escreg-sdk",
+  "version": "0.0.1",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "types": "dist/esm/index.d.ts",
+  "exports": {
+    ".": {
+      "require": "./dist/cjs/index.js",
+      "import": "./dist/esm/index.js"
+    }
+  },
+  "files": [
+    "dist/",
+    "README.md"
+  ],
+  "scripts": {
+    "clean": "rm -rf dist/ src/generated/",
+    "prebuild": "npm run clean && npm run generate && npm run generate:errors",
+    "generate": "npx @algorandfoundation/algokit-client-generator generate -m minimal -o src/generated/EscregGenerated.ts -a ../contract/smart_contracts/artifacts/escreg/Escreg.arc56.json",
+    "generate:errors": "tsx scripts/generate-errors.ts",
+    "build:cjs": "tsc --project tsconfig.cjs.json",
+    "build:esm": "tsc --project tsconfig.esm.json",
+    "build": "concurrently 'npm run build:cjs' 'npm run build:esm'"
+  },
+  "author": "Tasos Bitsios",
+  "license": "ISC",
+  "description": "TypeScript SDK for the Escreg on-chain escrow registry on Algorand",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/d13co/escreg.git",
+    "directory": "projects/ts-sdk"
+  },
+  "homepage": "https://github.com/d13co/escreg#sdk",
+  "bugs": {
+    "url": "https://github.com/d13co/escreg/issues"
+  },
+  "keywords": [
+    "algorand",
+    "escrow",
+    "registry",
+    "sdk"
+  ],
+  "devDependencies": {
+    "@algorandfoundation/algokit-client-generator": "^6.0.0",
+    "@types/node": "^24.0.14",
+    "concurrently": "^9.2.0",
+    "tsx": "^4.21.0",
+    "typescript": "^5.8.3"
+  },
+  "peerDependencies": {
+    "@algorandfoundation/algokit-utils": "^9.0.0",
+    "algosdk": "^3.0.0"
+  },
+  "dependencies": {
+    "p-map": "^7.0.3"
+  }
+}