@stellar/stellar-base 12.0.0 → 12.0.1

package/CHANGELOG.md

@@ -3,6 +3,22 @@
 ## Unreleased
 
 
+## [`v12.0.1`](https://github.com/stellar/js-stellar-base/compare/v12.0.0...v12.0.1)
+
+### Fixed
+* `scValToNative` would fail when the values contained error codes because the parsing routine hadn't been updated to the new error schemas. Errors are now converted to the following format:
+
+```typescript
+interface Error {
+  type: "contract" | "soroban";
+  code: number;
+  value?: string; // only present for type === 'soroban'
+}
+```
+
+You can refer to the [XDR documentation](https://github.com/stellar/stellar-xdr/blob/70180d5e8d9caee9e8645ed8a38c36a8cf403cd9/Stellar-contract.x#L76-L115) for additional explanations for each error code.
+
+
 ## [`v12.0.0`](https://github.com/stellar/js-stellar-base/compare/v11.0.1...v12.0.0)
 
 This is a re-tag of v12.0.0-rc.1 with only developer dependency updates in-between.

package/dist/stellar-base.js

@@ -17126,21 +17126,30 @@ function getSalty() {
 
 
 /**
- * Builds an operation to bump the time-to-live of a footprint (read and written
- * ledger keys). Its only parameter is the new, absolute ledger sequence number
- * at which the entry will expire.
+ * Builds an operation to bump the time-to-live (TTL) of the ledger keys. The
+ * keys for extension have to be provided in the read-only footprint of
+ * the transaction.
  *
- * The footprint itself is derived from the transaction (see
+ * The only parameter of the operation itself is the new minimum TTL for
+ * all the provided entries. If an entry already has a higher TTL, then it
+ * will just be skipped.
+ *
+ * TTL is the number of ledgers from the current ledger (exclusive) until
+ * the last ledger the entry is still considered alive (inclusive). Thus
+ * the exact ledger until the entries will live will only be determined
+ * when transaction has been applied.
+ *
+ * The footprint has to be specified in the transaction. See
  * {@link TransactionBuilder}'s `opts.sorobanData` parameter, which is a
  * {@link xdr.SorobanTransactionData} instance that contains fee data & resource
- * usage as part of {@link xdr.SorobanResources}).
+ * usage as part of {@link xdr.SorobanResources}.
  *
  * @function
  * @alias Operation.extendFootprintTtl
  *
  * @param {object} opts - object holding operation parameters
- * @param {number} opts.extendTo - the absolute ledger sequence number at which
- *     the transaction's ledger keys will now expire
+ * @param {number} opts.extendTo - the minimum TTL that all the entries in
+ *    the read-only footprint will have
  * @param {string} [opts.source] - an optional source account
  *
  * @returns {xdr.Operation} an Extend Footprint TTL operation
@@ -17149,7 +17158,7 @@ function getSalty() {
 function extendFootprintTtl(opts) {
   var _opts$extendTo;
   if (((_opts$extendTo = opts.extendTo) !== null && _opts$extendTo !== void 0 ? _opts$extendTo : -1) <= 0) {
-    throw new RangeError("extendTo isn't a ledger quantity (uint32)");
+    throw new RangeError('extendTo has to be positive');
   }
   var extendFootprintOp = new src_xdr.ExtendFootprintTtlOp({
     ext: new src_xdr.ExtensionPoint(0),
@@ -17165,14 +17174,18 @@ function extendFootprintTtl(opts) {
 
 
 /**
- * Builds a footprint restoration operation.
+ * Builds an operation to restore the archived ledger entries specified
+ * by the ledger keys.
+ *
+ * The ledger keys to restore are specified separately from the operation
+ * in read-write footprint of the transaction.
  *
  * It takes no parameters because the relevant footprint is derived from the
- * transaction itself (see {@link TransactionBuilder}'s `opts.sorobanData`
+ * transaction itself. See {@link TransactionBuilder}'s `opts.sorobanData`
  * parameter (or {@link TransactionBuilder.setSorobanData} /
  * {@link TransactionBuilder.setLedgerKeys}), which is a
  * {@link xdr.SorobanTransactionData} instance that contains fee data & resource
- * usage as part of {@link xdr.SorobanTransactionData}).
+ * usage as part of {@link xdr.SorobanTransactionData}.
  *
  * @function
  * @alias Operation.restoreFootprint
@@ -21137,21 +21150,23 @@ function scValToNative(scv) {
     case src_xdr.ScValType.scvTimepoint().value:
     case src_xdr.ScValType.scvDuration().value:
       return new src_xdr.Uint64(scv.value()).toBigInt();
-    case src_xdr.ScValType.scvStatus().value:
-      // TODO: Convert each status type into a human-readable error string?
-      switch (scv.value()["switch"]()) {
-        case src_xdr.ScStatusType.sstOk().value:
-        case src_xdr.ScStatusType.sstUnknownError().value:
-        case src_xdr.ScStatusType.sstHostValueError().value:
-        case src_xdr.ScStatusType.sstHostObjectError().value:
-        case src_xdr.ScStatusType.sstHostFunctionError().value:
-        case src_xdr.ScStatusType.sstHostStorageError().value:
-        case src_xdr.ScStatusType.sstHostContextError().value:
-        case src_xdr.ScStatusType.sstVmError().value:
-        case src_xdr.ScStatusType.sstContractError().value:
-        case src_xdr.ScStatusType.sstHostAuthError().value:
+    case src_xdr.ScValType.scvError().value:
+      switch (scv.error()["switch"]().value) {
+        // Distinguish errors from the user contract.
+        case src_xdr.ScErrorType.sceContract().value:
+          return {
+            type: 'contract',
+            code: scv.error().contractCode()
+          };
         default:
-          break;
+          {
+            var err = scv.error();
+            return {
+              type: 'system',
+              code: err.code().value,
+              value: err.code().name
+            };
+          }
       }
 
     // in the fallthrough case, just return the underlying value directly