stxer 0.2.6 → 0.3.1

package/dist/batch-api.d.ts

@@ -0,0 +1,30 @@
+import { type ClarityValue, type ContractPrincipalCV, type OptionalCV } from '@stacks/transactions';
+export interface BatchReads {
+    variables?: {
+        contract: ContractPrincipalCV;
+        variableName: string;
+    }[];
+    maps?: {
+        contract: ContractPrincipalCV;
+        mapName: string;
+        mapKey: ClarityValue;
+    }[];
+    index_block_hash?: string;
+}
+export interface BatchReadsResult {
+    variables: (ClarityValue | Error)[];
+    maps: (OptionalCV | Error)[];
+}
+export interface BatchApiOptions {
+    stxerApi?: string;
+}
+export declare function batchRead(reads: BatchReads, options?: BatchApiOptions): Promise<BatchReadsResult>;
+export interface BatchReadonlyRequest {
+    readonly: {
+        contract: ContractPrincipalCV;
+        functionName: string;
+        functionArgs: ClarityValue[];
+    }[];
+    index_block_hash?: string;
+}
+export declare function batchReadonly(req: BatchReadonlyRequest, options?: BatchApiOptions): Promise<(ClarityValue | Error)[]>;

package/dist/index.d.ts

@@ -1,52 +1,2 @@
-import { type StacksNetworkName } from '@stacks/network';
-import { type ClarityValue, ClarityVersion, type StacksTransactionWire } from '@stacks/transactions';
-export interface SimulationEval {
-    contract_id: string;
-    code: string;
-}
-export declare function runEval({ contract_id, code }: SimulationEval): import("@stacks/transactions").TupleCV<import("@stacks/transactions").TupleData<import("@stacks/transactions").BufferCV | import("@stacks/transactions").UIntCV>>;
-export declare function runSimulation(apiEndpoint: string, block_hash: string, block_height: number, txs: (StacksTransactionWire | SimulationEval)[]): Promise<string>;
-interface SimulationBuilderOptions {
-    apiEndpoint?: string;
-    stacksNodeAPI?: string;
-    network?: StacksNetworkName | string;
-}
-export declare class SimulationBuilder {
-    private apiEndpoint;
-    private stacksNodeAPI;
-    private network;
-    private constructor();
-    static new(options?: SimulationBuilderOptions): SimulationBuilder;
-    private block;
-    private sender;
-    private steps;
-    useBlockHeight(block: number): this;
-    withSender(address: string): this;
-    addSTXTransfer(params: {
-        recipient: string;
-        amount: number;
-        sender?: string;
-        fee?: number;
-    }): this;
-    addContractCall(params: {
-        contract_id: string;
-        function_name: string;
-        function_args?: ClarityValue[];
-        sender?: string;
-        fee?: number;
-    }): this;
-    addContractDeploy(params: {
-        contract_name: string;
-        source_code: string;
-        deployer?: string;
-        fee?: number;
-        clarity_version?: ClarityVersion;
-    }): this;
-    addEvalCode(inside_contract_id: string, code: string): this;
-    addMapRead(contract_id: string, map: string, key: string): this;
-    addVarRead(contract_id: string, variable: string): this;
-    private getBlockInfo;
-    run(): Promise<string>;
-    pipe(transform: (builder: SimulationBuilder) => SimulationBuilder): SimulationBuilder;
-}
-export {};
+export * from './batch-api';
+export * from './simulation';

package/dist/sample/read.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/simulation.d.ts

@@ -0,0 +1,53 @@
+import { type StacksNetworkName } from '@stacks/network';
+import { type ClarityValue, ClarityVersion, type StacksTransactionWire } from '@stacks/transactions';
+export interface SimulationEval {
+    contract_id: string;
+    code: string;
+}
+export declare function runEval({ contract_id, code }: SimulationEval): import("@stacks/transactions").TupleCV<import("@stacks/transactions").TupleData<import("@stacks/transactions").BufferCV | import("@stacks/transactions").UIntCV>>;
+export declare function runSimulation(apiEndpoint: string, block_hash: string, block_height: number, txs: (StacksTransactionWire | SimulationEval)[]): Promise<string>;
+interface SimulationBuilderOptions {
+    apiEndpoint?: string;
+    stacksNodeAPI?: string;
+    network?: StacksNetworkName | string;
+}
+export declare class SimulationBuilder {
+    private apiEndpoint;
+    private stacksNodeAPI;
+    private network;
+    private constructor();
+    static new(options?: SimulationBuilderOptions): SimulationBuilder;
+    private block;
+    private sender;
+    private steps;
+    useBlockHeight(block: number): this;
+    withSender(address: string): this;
+    inlineSimulation(simulationId: string): this;
+    addSTXTransfer(params: {
+        recipient: string;
+        amount: number;
+        sender?: string;
+        fee?: number;
+    }): this;
+    addContractCall(params: {
+        contract_id: string;
+        function_name: string;
+        function_args?: ClarityValue[];
+        sender?: string;
+        fee?: number;
+    }): this;
+    addContractDeploy(params: {
+        contract_name: string;
+        source_code: string;
+        deployer?: string;
+        fee?: number;
+        clarity_version?: ClarityVersion;
+    }): this;
+    addEvalCode(inside_contract_id: string, code: string): this;
+    addMapRead(contract_id: string, map: string, key: string): this;
+    addVarRead(contract_id: string, variable: string): this;
+    private getBlockInfo;
+    run(): Promise<string>;
+    pipe(transform: (builder: SimulationBuilder) => SimulationBuilder): SimulationBuilder;
+}
+export {};

package/dist/stxer.cjs.development.js

@@ -2,9 +2,9 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
+var transactions = require('@stacks/transactions');
 var tsClarity = require('ts-clarity');
 var network = require('@stacks/network');
-var transactions = require('@stacks/transactions');
 var c32check = require('c32check');
 
 function _arrayLikeToArray(r, a) {
@@ -372,6 +372,145 @@ function _unsupportedIterableToArray(r, a) {
   }
 }
 
+var DEFAULT_STXER_API = 'https://api.stxer.xyz';
+function batchRead(_x, _x2) {
+  return _batchRead.apply(this, arguments);
+}
+function _batchRead() {
+  _batchRead = _asyncToGenerator(/*#__PURE__*/_regeneratorRuntime().mark(function _callee(reads, options) {
+    var _options$stxerApi;
+    var payload, _iterator, _step, variable, _iterator2, _step2, map, ibh, url, data, text, results, rs, variablesLength, i, result, _i, _result;
+    return _regeneratorRuntime().wrap(function _callee$(_context) {
+      while (1) switch (_context.prev = _context.next) {
+        case 0:
+          if (options === void 0) {
+            options = {};
+          }
+          payload = [];
+          if (reads.variables != null) {
+            for (_iterator = _createForOfIteratorHelperLoose(reads.variables); !(_step = _iterator()).done;) {
+              variable = _step.value;
+              payload.push([transactions.serializeCV(variable.contract), variable.variableName]);
+            }
+          }
+          if (reads.maps != null) {
+            for (_iterator2 = _createForOfIteratorHelperLoose(reads.maps); !(_step2 = _iterator2()).done;) {
+              map = _step2.value;
+              payload.push([transactions.serializeCV(map.contract), map.mapName, transactions.serializeCV(map.mapKey)]);
+            }
+          }
+          ibh = reads.index_block_hash == null ? null : reads.index_block_hash.startsWith('0x') ? reads.index_block_hash.substring(2) : reads.index_block_hash;
+          url = ((_options$stxerApi = options.stxerApi) != null ? _options$stxerApi : DEFAULT_STXER_API) + "/sidecar/v2/batch-reads" + (ibh == null ? '' : "?tip=" + ibh);
+          _context.next = 8;
+          return fetch(url, {
+            method: 'POST',
+            body: JSON.stringify(payload)
+          });
+        case 8:
+          data = _context.sent;
+          _context.next = 11;
+          return data.text();
+        case 11:
+          text = _context.sent;
+          if (!(!text.includes('Ok') && !text.includes('Err'))) {
+            _context.next = 14;
+            break;
+          }
+          throw new Error("Requesting batch reads failed: " + text + ", url: " + url + ", payload: " + JSON.stringify(payload));
+        case 14:
+          results = JSON.parse(text);
+          rs = {
+            variables: [],
+            maps: []
+          };
+          variablesLength = 0;
+          if (reads.variables != null) {
+            variablesLength = reads.variables.length;
+            for (i = 0; i < variablesLength; i++) {
+              result = results[i];
+              if ('Ok' in result) {
+                rs.variables.push(transactions.deserializeCV(result.Ok));
+              } else {
+                rs.variables.push(new Error(result.Err));
+              }
+            }
+          }
+          if (reads.maps != null) {
+            for (_i = 0; _i < reads.maps.length; _i++) {
+              _result = results[_i + variablesLength];
+              if ('Ok' in _result) {
+                rs.maps.push(transactions.deserializeCV(_result.Ok));
+              } else {
+                rs.maps.push(new Error(_result.Err));
+              }
+            }
+          }
+          return _context.abrupt("return", rs);
+        case 20:
+        case "end":
+          return _context.stop();
+      }
+    }, _callee);
+  }));
+  return _batchRead.apply(this, arguments);
+}
+function batchReadonly(_x3, _x4) {
+  return _batchReadonly.apply(this, arguments);
+}
+function _batchReadonly() {
+  _batchReadonly = _asyncToGenerator(/*#__PURE__*/_regeneratorRuntime().mark(function _callee2(req, options) {
+    var _options$stxerApi2;
+    var payload, ibh, url, data, text, results, rs, _iterator3, _step3, result;
+    return _regeneratorRuntime().wrap(function _callee2$(_context2) {
+      while (1) switch (_context2.prev = _context2.next) {
+        case 0:
+          if (options === void 0) {
+            options = {};
+          }
+          payload = req.readonly.map(function (r) {
+            return [transactions.serializeCV(r.contract), r.functionName].concat(r.functionArgs.map(function (arg) {
+              return transactions.serializeCV(arg);
+            }));
+          });
+          ibh = req.index_block_hash == null ? null : req.index_block_hash.startsWith('0x') ? req.index_block_hash.substring(2) : req.index_block_hash;
+          url = ((_options$stxerApi2 = options.stxerApi) != null ? _options$stxerApi2 : DEFAULT_STXER_API) + "/sidecar/v2/batch-readonly" + (ibh == null ? '' : "?tip=" + ibh);
+          _context2.next = 6;
+          return fetch(url, {
+            method: 'POST',
+            body: JSON.stringify(payload)
+          });
+        case 6:
+          data = _context2.sent;
+          _context2.next = 9;
+          return data.text();
+        case 9:
+          text = _context2.sent;
+          if (!(!text.includes('Ok') && !text.includes('Err'))) {
+            _context2.next = 12;
+            break;
+          }
+          throw new Error("Requesting batch readonly failed: " + text + ", url: " + url + ", payload: " + JSON.stringify(payload));
+        case 12:
+          results = JSON.parse(text);
+          rs = [];
+          for (_iterator3 = _createForOfIteratorHelperLoose(results); !(_step3 = _iterator3()).done;) {
+            result = _step3.value;
+            if ('Ok' in result) {
+              rs.push(transactions.deserializeCV(result.Ok));
+            } else {
+              rs.push(new Error(result.Err));
+            }
+          }
+          return _context2.abrupt("return", rs);
+        case 16:
+        case "end":
+          return _context2.stop();
+      }
+    }, _callee2);
+  }));
+  return _batchReadonly.apply(this, arguments);
+}
+
 function runTx(tx) {
   // type 0: run transaction
   return transactions.tupleCV({
@@ -399,7 +538,7 @@ function runSimulation(_x, _x2, _x3, _x4) {
 }
 function _runSimulation() {
   _runSimulation = _asyncToGenerator(/*#__PURE__*/_regeneratorRuntime().mark(function _callee5(apiEndpoint, block_hash, block_height, txs) {
-    var header, heightBytes, view, hashHex, matches, hashBytes, txBytes, totalLength, body, offset, _iterator2, _step2, tx, rs;
+    var header, heightBytes, view, hashHex, matches, hashBytes, txBytes, totalLength, body, offset, _iterator3, _step4, tx, rs;
     return _regeneratorRuntime().wrap(function _callee5$(_context5) {
       while (1) switch (_context5.prev = _context5.next) {
         case 0:
@@ -436,8 +575,8 @@ function _runSimulation() {
           offset += heightBytes.length;
           body.set(hashBytes, offset);
           offset += hashBytes.length;
-          for (_iterator2 = _createForOfIteratorHelperLoose(txBytes); !(_step2 = _iterator2()).done;) {
-            tx = _step2.value;
+          for (_iterator3 = _createForOfIteratorHelperLoose(txBytes); !(_step4 = _iterator3()).done;) {
+            tx = _step4.value;
             body.set(tx, offset);
             offset += tx.length;
           }
@@ -512,6 +651,12 @@ var SimulationBuilder = /*#__PURE__*/function () {
     this.sender = address;
     return this;
   };
+  _proto.inlineSimulation = function inlineSimulation(simulationId) {
+    this.steps.push({
+      simulationId: simulationId
+    });
+    return this;
+  };
   _proto.addSTXTransfer = function addSTXTransfer(params) {
     var _params$sender, _params$fee;
     if (params.sender == null && this.sender === '') {
@@ -617,7 +762,7 @@ var SimulationBuilder = /*#__PURE__*/function () {
   _proto.run = /*#__PURE__*/function () {
     var _run = /*#__PURE__*/_asyncToGenerator(/*#__PURE__*/_regeneratorRuntime().mark(function _callee3() {
       var _this = this;
-      var block, txs, nonce_by_address, nextNonce, _iterator, _step, step, network$1, _step$function_args, nonce, _step$contract_id$spl, contractAddress, contractName, tx, _nonce, _tx, _nonce2, _tx2, id;
+      var block, txs, nonce_by_address, nextNonce, network$1, _iterator, _step, step, previousSimulation, _iterator2, _step2, _step3, _step$function_args, nonce, _step$contract_id$spl, contractAddress, contractName, tx, _nonce, _tx, _nonce2, _tx2, id;
       return _regeneratorRuntime().wrap(function _callee3$(_context3) {
         while (1) switch (_context3.prev = _context3.next) {
           case 0:
@@ -662,13 +807,6 @@ var SimulationBuilder = /*#__PURE__*/function () {
                 return _ref2.apply(this, arguments);
               };
             }();
-            _iterator = _createForOfIteratorHelperLoose(this.steps);
-          case 9:
-            if ((_step = _iterator()).done) {
-              _context3.next = 50;
-              break;
-            }
-            step = _step.value;
             network$1 = this.network === 'mainnet' ? network.STACKS_MAINNET : network.STACKS_TESTNET;
             if (this.stacksNodeAPI) {
               network$1 = _extends({}, network$1, {
@@ -677,16 +815,47 @@ var SimulationBuilder = /*#__PURE__*/function () {
                 })
               });
             }
-            if (!('sender' in step && 'function_name' in step)) {
-              _context3.next = 25;
+            _iterator = _createForOfIteratorHelperLoose(this.steps);
+          case 11:
+            if ((_step = _iterator()).done) {
+              _context3.next = 57;
+              break;
+            }
+            step = _step.value;
+            if (!('simulationId' in step)) {
+              _context3.next = 20;
               break;
             }
             _context3.next = 16;
-            return nextNonce(step.sender);
+            return fetch("https://api.stxer.xyz/simulations/" + step.simulationId + "/request").then(function (x) {
+              return x.json();
+            });
           case 16:
+            previousSimulation = _context3.sent;
+            for (_iterator2 = _createForOfIteratorHelperLoose(previousSimulation.steps); !(_step2 = _iterator2()).done;) {
+              _step3 = _step2.value;
+              if ('tx' in _step3) {
+                txs.push(transactions.deserializeTransaction(_step3.tx));
+              } else if ('code' in _step3 && 'contract' in _step3) {
+                txs.push({
+                  contract_id: _step3.contract,
+                  code: _step3.code
+                });
+              }
+            }
+            _context3.next = 55;
+            break;
+          case 20:
+            if (!('sender' in step && 'function_name' in step)) {
+              _context3.next = 32;
+              break;
+            }
+            _context3.next = 23;
+            return nextNonce(step.sender);
+          case 23:
             nonce = _context3.sent;
             _step$contract_id$spl = step.contract_id.split('.'), contractAddress = _step$contract_id$spl[0], contractName = _step$contract_id$spl[1];
-            _context3.next = 20;
+            _context3.next = 27;
             return transactions.makeUnsignedContractCall({
               contractAddress: contractAddress,
               contractName: contractName,
@@ -698,22 +867,22 @@ var SimulationBuilder = /*#__PURE__*/function () {
               postConditionMode: transactions.PostConditionMode.Allow,
               fee: step.fee
             });
-          case 20:
+          case 27:
             tx = _context3.sent;
             tx.auth.spendingCondition.signer = c32check.c32addressDecode(step.sender)[1];
             txs.push(tx);
-            _context3.next = 48;
+            _context3.next = 55;
             break;
-          case 25:
+          case 32:
             if (!('sender' in step && 'recipient' in step)) {
-              _context3.next = 36;
+              _context3.next = 43;
               break;
             }
-            _context3.next = 28;
+            _context3.next = 35;
             return nextNonce(step.sender);
-          case 28:
+          case 35:
             _nonce = _context3.sent;
-            _context3.next = 31;
+            _context3.next = 38;
             return transactions.makeUnsignedSTXTokenTransfer({
               recipient: step.recipient,
               amount: step.amount,
@@ -722,22 +891,22 @@ var SimulationBuilder = /*#__PURE__*/function () {
               publicKey: '',
               fee: step.fee
             });
-          case 31:
+          case 38:
             _tx = _context3.sent;
             _tx.auth.spendingCondition.signer = c32check.c32addressDecode(step.sender)[1];
             txs.push(_tx);
-            _context3.next = 48;
+            _context3.next = 55;
             break;
-          case 36:
+          case 43:
             if (!('deployer' in step)) {
-              _context3.next = 47;
+              _context3.next = 54;
               break;
             }
-            _context3.next = 39;
+            _context3.next = 46;
             return nextNonce(step.deployer);
-          case 39:
+          case 46:
             _nonce2 = _context3.sent;
-            _context3.next = 42;
+            _context3.next = 49;
             return transactions.makeUnsignedContractDeploy({
               contractName: step.contract_name,
               codeBody: step.source_code,
@@ -747,30 +916,30 @@ var SimulationBuilder = /*#__PURE__*/function () {
               postConditionMode: transactions.PostConditionMode.Allow,
               fee: step.fee
             });
-          case 42:
+          case 49:
             _tx2 = _context3.sent;
             _tx2.auth.spendingCondition.signer = c32check.c32addressDecode(step.deployer)[1];
             txs.push(_tx2);
-            _context3.next = 48;
+            _context3.next = 55;
             break;
-          case 47:
+          case 54:
             if ('code' in step) {
               txs.push(step);
             } else {
               // biome-ignore lint/style/noUnusedTemplateLiteral: <explanation>
               console.log("Invalid simulation step:", step);
             }
-          case 48:
-            _context3.next = 9;
+          case 55:
+            _context3.next = 11;
             break;
-          case 50:
-            _context3.next = 52;
+          case 57:
+            _context3.next = 59;
             return runSimulation(this.apiEndpoint + "/simulations", block.block_hash, block.block_height, txs);
-          case 52:
+          case 59:
             id = _context3.sent;
             console.log("Simulation will be available at: https://stxer.xyz/simulations/" + this.network + "/" + id);
             return _context3.abrupt("return", id);
-          case 55:
+          case 62:
           case "end":
             return _context3.stop();
         }
@@ -788,6 +957,8 @@ var SimulationBuilder = /*#__PURE__*/function () {
 }();
 
 exports.SimulationBuilder = SimulationBuilder;
+exports.batchRead = batchRead;
+exports.batchReadonly = batchReadonly;
 exports.runEval = runEval;
 exports.runSimulation = runSimulation;
 //# sourceMappingURL=stxer.cjs.development.js.map