feat: near_abi! macro

examples/abi/Cargo.toml

@@ -0,0 +1,24 @@
+[package]
+name = "abi"
+version = "0.1.0"
+authors = ["Near Inc <[email protected]>"]
+edition = "2021"
+
+[lib]
+crate-type = ["cdylib"]
+
+[dependencies]
+near-sdk = { path = "../../near-sdk", features = ["unstable"] }
+serde = { version = "1", features = ["derive"] }
+schemars = "0.8"
+
+[profile.release]
+codegen-units = 1
+# Tell `rustc` to optimize for small code size.
+opt-level = "z"
+lto = true
+debug = false
+panic = "abort"
+
+[workspace]
+members = []

examples/abi/README.md

@@ -0,0 +1,12 @@
+# ABI
+
+Showcases how to generate ABI from a NEAR contract.
+
+## Generating ABI
+To generate the ABI file run:
+
+```bash
+cargo near abi
+```
+
+This will generate a file located at `target/near/abi.json`.

examples/abi/build.sh

@@ -0,0 +1,8 @@
+#!/bin/bash
+TARGET="${CARGO_TARGET_DIR:-target}"
+set -e
+cd "$(dirname $0)"
+
+cargo build --target wasm32-unknown-unknown --release
+cp $TARGET/wasm32-unknown-unknown/release/abi.wasm ./res/
+#wasm-opt -Oz --output ./res/status_message.wasm ./res/status_message.wasm

examples/abi/res/abi.json

@@ -0,0 +1,120 @@
+{
+  "abi_schema_version": "0.1.0",
+  "metainfo": {
+    "name": "abi",
+    "version": "0.1.0",
+    "authors": [
+      "Near Inc <[email protected]>"
+    ]
+  },
+  "abi": {
+    "functions": [
+      {
+        "name": "add",
+        "is_view": true,
+        "is_init": false,
+        "params": [
+          {
+            "name": "a",
+            "type_id": 0,
+            "serialization_type": "json"
+          },
+          {
+            "name": "b",
+            "type_id": 0,
+            "serialization_type": "json"
+          }
+        ],
+        "result": {
+          "type_id": 0,
+          "serialization_type": "json"
+        }
+      },
+      {
+        "name": "add_callback",
+        "is_view": true,
+        "is_init": false,
+        "callbacks": [
+          {
+            "type_id": 1,
+            "serialization_type": "json"
+          },
+          {
+            "type_id": 1,
+            "serialization_type": "json"
+          }
+        ],
+        "callbacks_vec": {
+          "type_id": 2,
+          "serialization_type": "json"
+        },
+        "result": {
+          "type_id": 1,
+          "serialization_type": "json"
+        }
+      }
+    ],
+    "types": [
+      {
+        "id": 1,
+        "schema": {
+          "$ref": "#/definitions/DoublePair"
+        }
+      },
+      {
+        "id": 0,
+        "schema": {
+          "$ref": "#/definitions/Pair"
+        }
+      },
+      {
+        "id": 2,
+        "schema": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/DoublePair"
+          }
+        }
+      }
+    ],
+    "root_schema": {
+      "$schema": "http://json-schema.org/draft-07/schema#",
+      "title": "String",
+      "type": "string",
+      "definitions": {
+        "DoublePair": {
+          "type": "object",
+          "required": [
+            "first",
+            "second"
+          ],
+          "properties": {
+            "first": {
+              "$ref": "#/definitions/Pair"
+            },
+            "second": {
+              "$ref": "#/definitions/Pair"
+            }
+          }
+        },
+        "Pair": {
+          "type": "array",
+          "items": [
+            {
+              "type": "integer",
+              "format": "uint32",
+              "minimum": 0.0
+            },
+            {
+              "type": "integer",
+              "format": "uint32",
+              "minimum": 0.0
+            }
+          ],
+          "maxItems": 2,
+          "minItems": 2
+        }
+      }
+    }
+  }
+}

examples/abi/src/lib.rs

@@ -0,0 +1,45 @@
+use near_sdk::near_abi;
+
+#[near_abi]
+mod abi {
+    use near_sdk::borsh::{self, BorshDeserialize, BorshSerialize};
+    use near_sdk::near_bindgen;
+    use near_sdk::schemars::JsonSchema;
+    use near_sdk::serde::{Deserialize, Serialize};
+
+    #[derive(JsonSchema, Serialize, Deserialize)]
+    pub struct Pair(u32, u32);
+
+    #[derive(JsonSchema, Serialize, Deserialize)]
+    pub struct DoublePair {
+        first: Pair,
+        second: Pair,
+    }
+
+    #[near_bindgen]
+    #[derive(Default, BorshDeserialize, BorshSerialize)]
+    pub struct Adder {}
+
+    #[near_bindgen]
+    impl Adder {
+        pub fn add(&self, a: Pair, b: Pair) -> Pair {
+            sum_pair(&a, &b)
+        }
+
+        pub fn add_callback(
+            &self,
+            #[callback_unwrap] a: DoublePair,
+            #[callback_unwrap] b: DoublePair,
+            #[callback_vec] others: Vec<DoublePair>,
+        ) -> DoublePair {
+            vec![b].iter().chain(others.iter()).fold(a, |acc, el| DoublePair {
+                first: sum_pair(&acc.first, &el.first),
+                second: sum_pair(&acc.second, &el.second),
+            })
+        }
+    }
+
+    fn sum_pair(a: &Pair, b: &Pair) -> Pair {
+        Pair(a.0 + b.0, a.1 + b.1)
+    }
+}