ABI generation #301

itegulov · 2022-11-15T11:19:21Z

This is still pretty raw, but sharing for visibility.

Instructions for running:

Clone https://github.com/near/near-abi-js to a sibling directory and run yarn install && yarn build (needed because it is not released yet)
Clone https://github.com/itegulov/typescript-json-schema to a sibling directory and run yarn install && yarn build (needed because I had to expose some API that makes life much much easier).
Run yarn build:counter-ts in examples and see what happens 👀

itegulov · 2022-11-15T11:22:15Z

src/cli/abi.ts

+    const diagnostics = ts.getPreEmitDiagnostics(program);
+    if (diagnostics.length > 0) {
+        diagnostics.forEach((diagnostic) => {
+            const message = ts.flattenDiagnosticMessageText(diagnostic.messageText, "\n");
+            if (diagnostic.file) {
+                const { line, character } = diagnostic.file.getLineAndCharacterOfPosition(diagnostic.start!);
+                console.error(`${diagnostic.file.fileName} (${line + 1},${character + 1}): ${message}`);
+            } else {
+                console.error(message);
+            }
+        });
+        return undefined;
+    }


We can get rid of the preceding CLI step that does typechecking since this piece does effectively the same without having to instantiate tsc twice. But up to you guys.

It is still unclear to me if IBI is a separate package. If it is not - then we can do a TS check once.

Sorry, "ABI"

package.json

src/version.ts

volovyks · 2022-11-15T13:52:36Z

src/cli/abi.ts

+    const diagnostics = ts.getPreEmitDiagnostics(program);
+    if (diagnostics.length > 0) {
+        diagnostics.forEach((diagnostic) => {
+            const message = ts.flattenDiagnosticMessageText(diagnostic.messageText, "\n");
+            if (diagnostic.file) {
+                const { line, character } = diagnostic.file.getLineAndCharacterOfPosition(diagnostic.start!);
+                console.error(`${diagnostic.file.fileName} (${line + 1},${character + 1}): ${message}`);
+            } else {
+                console.error(message);
+            }
+        });
+        return undefined;
+    }


It is still unclear to me if IBI is a separate package. If it is not - then we can do a TS check once.

src/cli/abi.ts

ailisp · 2022-11-16T04:56:09Z

src/cli/abi.ts

+        target: ts.ScriptTarget.ES5,
+        module: ts.ModuleKind.CommonJS,
+        allowUnusedLabels: true,
+    };


So these overrides options load in basePath/tsconfig.json?

So I tried to use contract's tsconfig.json, but then it picks up all TS files in this project, not just the one you directly specify (e.g. all examples under /examples, not just counter-ts). I will play around with this a bit more and see what can be done.

I think I figured out the right way to deal with this, PTAL.

While we are at this, how do you think the path to package.json and tsconfig.json should be specified? I have just added a 3rd and 4th argument to the CLI command, but that's probably not what we want.

src/cli/abi.ts

ailisp · 2022-11-16T05:14:10Z

Generally your implementation and comprehensive validation looks great!

src/cli/abi.ts

itegulov · 2022-11-22T08:58:37Z

I am working on stabilizing this and I have a couple of things that I am not sure how to go about.

Should this be an opt-in feature for now? How do you guys imagine the CLI interface for ABI generation should look like? Do we also provide a separate command abi that just generates ABI without building the contract? I can match what we have in Rust, but not sure if that makes sense as the build tools are quite different, so your call.
I have released https://github.com/itegulov/typescript-json-schema as near-typescript-json-schema for now just to unblock this PR, but not sure how you would like to handle this fork. We have a similar situation with https://github.com/near/schemafy/, so we just moved the fork under near org and are maintaining it ourselves. Ideally we should discuss this with the original repo maintainers and see if they would be open to exposing the APIs that we need, but in my experience open-source work is pretty slow, so I wouldn't count on it short-term (we are still waiting for schemafy maintainers' response for instance).

So far most examples work, only NFT is failing because bigint is apparently not supported by typescript-json-schema. There is this PR that was never merged though, so it seems like I can easily add support in our fork if you don't have any objections.

volovyks · 2022-11-22T17:42:00Z

@itegulov our build command now consists of several steps. I think ABI can become one of them. It should be easy to have as a separate command as well. I do not think that we need to keep it as a separate project.

ailisp · 2022-12-02T14:26:03Z

examples/src/parking-lot.ts

@@ -67,7 +67,7 @@ export class ParkingLot {
  }

  @view({})
-  getCarSpecs({ name }: { name: string }) {
+  getCarSpecs({ name }: { name: string }): CarSpecs {


will we get warnings (or configure tsconfig in a way) when method doesn't have return type?

ailisp

Nice work! It's very solid implementation! Also thank you for fixing a few signatures!

volovyks

Great work @itegulov!
Merging now, but do you think it's possible to test ABI somehow?

implement PoC ABI generation

5a91d81

itegulov commented Nov 15, 2022

View reviewed changes

volovyks reviewed Nov 15, 2022

View reviewed changes

ailisp reviewed Nov 16, 2022

View reviewed changes

src/cli/abi.ts Show resolved Hide resolved

ailisp reviewed Nov 16, 2022

View reviewed changes

src/cli/abi.ts Outdated Show resolved Hide resolved

ailisp reviewed Nov 16, 2022

View reviewed changes

src/cli/abi.ts Show resolved Hide resolved

itegulov added 6 commits November 22, 2022 16:37

use published libraries

b2819c2

address comments

cfab20b

validate @NearBindgen for containing class

555a80d

do not overwrite ts config values

04a439c

re-format

b167ce5

fix linting

34429d0

itegulov force-pushed the daniyar/abi-gen branch from 958270f to 34429d0 Compare November 22, 2022 08:26

Merge branch 'develop' into daniyar/abi-gen

a74734c

itegulov added 3 commits November 23, 2022 22:32

simplify package json parsing

ee2a8f6

Merge remote-tracking branch 'origin/develop' into daniyar/abi-gen

29e6fb9

use near-typescript-json-schema 0.55.0

93efba8

itegulov marked this pull request as ready for review December 2, 2022 03:27

lint

7aeede7

itegulov force-pushed the daniyar/abi-gen branch from 588bef6 to 4c9363c Compare December 2, 2022 04:53

migrate examples to not use top-level JSON values

a53a588

itegulov force-pushed the daniyar/abi-gen branch from 4c9363c to a53a588 Compare December 2, 2022 05:00

itegulov added 2 commits December 2, 2022 16:48

no longer require for binding pattern to be destructive

e938137

Merge remote-tracking branch 'origin/develop' into daniyar/abi-gen

94e371e

ailisp reviewed Dec 2, 2022

View reviewed changes

ailisp approved these changes Dec 2, 2022

View reviewed changes

volovyks approved these changes Dec 4, 2022

View reviewed changes

volovyks merged commit 635f7e6 into develop Dec 4, 2022

ailisp mentioned this pull request Jan 17, 2023

near-sdk-js ABI support #245

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ABI generation #301

ABI generation #301

itegulov commented Nov 15, 2022

itegulov Nov 15, 2022

volovyks Nov 15, 2022

itegulov Nov 15, 2022

volovyks Nov 22, 2022

volovyks Nov 15, 2022

ailisp Nov 16, 2022

itegulov Nov 17, 2022

itegulov Nov 22, 2022

ailisp commented Nov 16, 2022

itegulov commented Nov 22, 2022

volovyks commented Nov 22, 2022

ailisp Dec 2, 2022

ailisp left a comment

volovyks left a comment

ABI generation #301

ABI generation #301

Conversation

itegulov commented Nov 15, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ailisp commented Nov 16, 2022

itegulov commented Nov 22, 2022

volovyks commented Nov 22, 2022

Choose a reason for hiding this comment

ailisp left a comment

Choose a reason for hiding this comment

volovyks left a comment

Choose a reason for hiding this comment