Make PromiseIndex type to avoid misuse of promise indices

[austinabell]

Context: this is an optional and breaking suggestion

Currently, most APIs use BigInt or number | BigInt to represent the promise indices, which is very prone for misuse.

Take:

export function promiseBatchActionTransfer(promiseIndex: number | BigInt, amount: number | BigInt)

This function makes it very easy to swap the order of these and cause a bug at runtime either from unexpected behavior or a panic at runtime if the promise index does not exist.

There should be no way to manually construct a promise index, so it would be preferred if promiseCreate and other related functions returned a class/object that are only constructed by those functions. This would allow those bugs to be caught at compile time when using TS and runtime if using JS (but friendlier runtime error than if this wasn't done).

A lot of these APIs are way too easy to misuse, which will cause issues for people.

[ailisp]

Good idea, looks like this is also how rust sdk handles promise index

[ailisp]

It's being addressed in part of #213

[exalate-issue-sync]

Jane Wang commented:

Looks like partially addressed by this PR #213

[exalate-issue-sync]

Serhii Volovyk commented:

Bo Yao https://github.com/near/near-sdk-js/blob/develop/src/types/vm_types.ts