Make PromiseIndex a nominal typing, require explicit construction

near · Oct 12, 2022 · c49abf5 · c49abf5
1 parent 0d9023c
commit c49abf5
Show file tree

Hide file tree

Showing 10 changed files with 34 additions and 31 deletions.
diff --git a/lib/api.d.ts b/lib/api.d.ts
diff --git a/lib/types/index.d.ts b/lib/types/index.d.ts
diff --git a/lib/types/vm_types.d.ts b/lib/types/vm_types.d.ts
diff --git a/lib/utils.d.ts b/lib/utils.d.ts
diff --git a/lib/utils.js b/lib/utils.js
diff --git a/src/api.ts b/src/api.ts
@@ -367,8 +367,8 @@ export function promiseCreate(
   args: Bytes,
   amount: NearAmount,
   gas: NearAmount
-): bigint {
-  return env.promise_create(accountId, methodName, args, amount, gas);
+): PromiseIndex {
+  return env.promise_create(accountId, methodName, args, amount, gas) as PromiseIndex;
 }
 
 /**
@@ -388,33 +388,33 @@ export function promiseThen(
   args: Bytes,
   amount: NearAmount,
   gas: NearAmount
-): bigint {
+): PromiseIndex {
   return env.promise_then(
     promiseIndex,
     accountId,
     methodName,
     args,
     amount,
     gas
-  );
+  ) as PromiseIndex;
 }
 
 /**
  * Join an arbitrary array of NEAR promises.
  *
  * @param promiseIndexes - An arbitrary array of NEAR promise indexes to join.
  */
-export function promiseAnd(...promiseIndexes: PromiseIndex[]): bigint {
-  return env.promise_and(...promiseIndexes);
+export function promiseAnd(...promiseIndexes: PromiseIndex[]): PromiseIndex {
+  return env.promise_and(...promiseIndexes) as PromiseIndex;
 }
 
 /**
  * Create a NEAR promise which will have multiple promise actions inside.
  *
  * @param accountId - The account ID of the target contract.
  */
-export function promiseBatchCreate(accountId: Bytes): bigint {
-  return env.promise_batch_create(accountId);
+export function promiseBatchCreate(accountId: Bytes): PromiseIndex {
+  return env.promise_batch_create(accountId) as PromiseIndex;
 }
 
 /**
@@ -426,8 +426,8 @@ export function promiseBatchCreate(accountId: Bytes): bigint {
 export function promiseBatchThen(
   promiseIndex: PromiseIndex,
   accountId: Bytes
-): bigint {
-  return env.promise_batch_then(promiseIndex, accountId);
+): PromiseIndex {
+  return env.promise_batch_then(promiseIndex, accountId) as PromiseIndex;
 }
 
 /**

diff --git a/src/promise.ts b/src/promise.ts
@@ -255,7 +255,7 @@ class PromiseSingle {
 
   constructRecursively(): PromiseIndex {
     if (this.promiseIndex !== null) {
-      return this.promiseIndex;
+      return this.promiseIndex as PromiseIndex;
     }
 
     const promiseIndex = this.after
@@ -279,7 +279,7 @@ export class PromiseJoint {
 
   constructRecursively(): PromiseIndex {
     if (this.promiseIndex !== null) {
-      return this.promiseIndex;
+      return this.promiseIndex as PromiseIndex;
     }
 
     const result = near.promiseAnd(

diff --git a/src/types/index.ts b/src/types/index.ts
@@ -3,7 +3,6 @@ import { BlockHeight, EpochHeight, Balance, StorageUsage } from "./primitives";
 import {
   PromiseResult,
   PromiseError,
-  PromiseIndex,
   ReceiptIndex,
   IteratorIndex,
 } from "./vm_types";
@@ -26,7 +25,6 @@ export {
   StorageUsage,
   PromiseResult,
   PromiseError,
-  PromiseIndex,
   ReceiptIndex,
   IteratorIndex,
   Gas,

diff --git a/src/types/vm_types.ts b/src/types/vm_types.ts
@@ -1,7 +1,3 @@
-/**
- * The index for NEAR promises.
- */
-export type PromiseIndex = bigint;
 /**
  * The index for NEAR receipts.
  */

diff --git a/src/utils.ts b/src/utils.ts
@@ -4,10 +4,13 @@ import { GetOptions } from "./types/collections";
  * A string containing byte characters. Can be safely used in NEAR calls.
  */
 export type Bytes = string;
+
+// make PromiseIndex a nominal typing
+enum PromiseIndexBrand { _ = "" };
 /**
  * A PromiseIndex which represents the ID of a NEAR Promise.
  */
-export type PromiseIndex = number | bigint;
+export type PromiseIndex = (number | bigint) & PromiseIndexBrand;
 /**
  * A number that specifies the amount of NEAR in yoctoNEAR.
  */