@alephium/web3 0.2.0-rc.8 → 0.2.0-test.1

package/.eslintignore

@@ -1,2 +1,2 @@
-**/dist/
-**/templates/
+dist/
+templates/

package/.eslintrc.json

@@ -0,0 +1,21 @@
+{
+  "plugins": ["security", "header"],
+  "extends": [
+    "prettier",
+    "plugin:prettier/recommended",
+    "plugin:security/recommended",
+    "plugin:@typescript-eslint/recommended"
+  ],
+  "parser": "@typescript-eslint/parser",
+  "rules": {
+    "header/header": [2, "scripts/header.js"]
+  },
+  "overrides": [
+    {
+      "files": ["*.ts"],
+      "rules": {
+        "security/detect-non-literal-fs-filename": "off"
+      }
+    }
+  ]
+}

package/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

package/README.md

@@ -1,3 +1,136 @@
-# `@alephium/web3`
+# Alephium Web3
 
-The package is the core of web3 SDKs
+[![Github CI][test-badge]][test-link]
+[![Code Coverage][coverage-badge]][coverage-link]
+[![NPM][npm-badge]][npm-link]
+[![code style: prettier][prettier-badge]][prettier-link]
+
+A JavaScript/TypeScript library for building decentralized applications and smart contracts on Alephium.
+
+You could run the following command to scaffold a skeleton project for smart contract development:
+
+```
+npx @alephium/web3 <project-dir> [-t template-name]
+```
+
+## Install
+
+### In Node projects
+
+```shell
+npm install @alephium/web3
+```
+
+💥 Until our library is stable, breaking changes will be introduced in **minor** versions (instead of the traditional major versions of semver). We recommend allowing patch-level updates and to always read the [release notes][release-notes] for breaking changes.
+
+```js
+// package.json
+{
+   "dependencies": {
+      "@alephium/web3": "~X.Y.Z"
+   }
+}
+```
+
+### In browser projects
+
+All you have to do is to include the library in your HTML document. The `alephium` global variable will be available.
+
+```html
+<script src="alephium-web3.min.js"></script>
+<script>
+  const { walletGenerate } = alephium
+  const wallet = walletGenerate()
+  console.log(wallet)
+</script>
+```
+
+You can either build the library by cloning this repo and running the build script (the file will be located at `/dist/alephium-web3.min.js`), or simply using a CDN.
+
+```shell
+npm run build
+```
+
+#### via UNPKG CDN
+
+```html
+<script src="https://unpkg.com/@alephium/web3@X.Y.Z/dist/alephium-web3.min.js"></script>
+```
+
+#### via jsDelivr CDN
+
+```html
+<script src="https://cdn.jsdelivr.net/npm/@alephium/web3@X.Y.Z/dist/alephium-web3.min.js"></script>
+```
+
+## Development
+
+### Update schemas
+
+One first needs to update the version number of `alephium` and `explorer-backend` in `package.json`. Kindly note that one needs to check the compatibility of both OpenAPI files manually.
+
+Typings can automatically generated using the following command:
+
+```shell
+npm run update-schemas
+```
+
+### Packaging
+
+We need to include the `.gitignore` file inside the npm package so that it can be used by the `dist/cli/create-project.js` script. To do that we define the `prepack` and `postpack` npm scripts that will rename the `.gitignore` file to `gitignore`, pack it into the package, and rename it back to `.gitignore`. Similar approach has been followed by `create-react-app`<sup>[1]</sup>.
+
+### Release
+
+To release a new version:
+
+1. Create a commit that updates the package version in package.json and package-lock.json and a tag with:
+   ```shell
+   npm version patch # if you want to bump the patch version, without breaking changes
+   npm version minor # if you want to bump the minor version, with breaking changes
+   npm version prerelease --preid=rc # if you want to create a release candidate
+   npm version prerelease --preid=leman # if you want to create a leman prerelease
+   ```
+2. Push the tag to GitHub and trigger the publish workflow that will publish it on NPM with:
+
+   ```shell
+   git push [remote] <tag>
+   ```
+
+3. Unless you are on `master`, create a new branch and push it to GitHub so that the tagged commit belongs to a branch of this repo with:
+   ```shell
+   git checkout -b <tag>
+   git push
+   ```
+   Otherwise, just push to `master`.
+
+## Build
+
+Compile the TypeScript files into JavaScript:
+
+```shell
+npm run build
+```
+
+## Testing
+
+```shell
+npm run start-devnet # this will start a devnet for smart contract tests
+npm test
+```
+
+or, to watch for changes:
+
+```shell
+npm run test:watch
+```
+
+[test-badge]: https://github.com/alephium/alephium-web3/actions/workflows/test.yml/badge.svg
+[test-link]: https://github.com/alephium/alephium-web3/actions/workflows/test.yml
+[coverage-badge]: https://codecov.io/gh/alephium/alephium-web3/branch/master/graph/badge.svg
+[coverage-link]: https://codecov.io/gh/alephium/alephium-web3
+[npm-badge]: https://img.shields.io/npm/v/@alephium/web3.svg
+[npm-link]: https://www.npmjs.org/package/@alephium/web3
+[prettier-badge]: https://img.shields.io/badge/code_style-prettier-ff69b4.svg
+[prettier-link]: https://github.com/prettier/prettier
+[release-notes]: https://github.com/alephium/alephium-web3/releases
+[1]: https://github.com/facebook/create-react-app/blob/2da5517689b7510ff8d8b0148ce372782cb285d7/packages/react-scripts/scripts/init.js#L264-L278

package/contracts/add/add.ral

@@ -0,0 +1,13 @@
+Contract Add(sub: Sub, mut result : U256) {
+    event Add(x: U256, y: U256)
+
+    pub fn add(array: [U256; 2]) -> ([U256; 2]) {
+        return addPrivate(array)
+    }
+
+    fn addPrivate(array: [U256; 2]) -> ([U256; 2]) {
+        emit Add(array[0], array[1])
+        result = result + array[0] + array[1]
+        return [result, sub.sub(array)]
+    }
+}

package/contracts/greeter_main.ral

@@ -1,4 +1,4 @@
-TxScript Main(greeterContractId: ByteVec) {
+TxScript GreeterMain(greeterContractId: ByteVec) {
     let greeter0 = Greeter(greeterContractId)
     assert!(greeter0.greet() == 1, 0)
 

package/contracts/main.ral

@@ -0,0 +1,4 @@
+TxScript Main(addContractId: ByteVec) {
+    let add = Add(addContractId)
+    add.add([2, 1])
+}

package/contracts/sub/sub.ral

@@ -0,0 +1,10 @@
+Contract Sub(mut result : U256) {
+    event Sub(x: U256, y: U256)
+
+    @using(externalCallCheck = false)
+    pub fn sub(array: [U256; 2]) -> U256 {
+        emit Sub(array[0], array[1])
+        result = result + array[0] - array[1]
+        return result
+    }
+}

package/contracts/test/metadata.ral

@@ -0,0 +1,18 @@
+Contract MetaData() {
+    @using(preapprovedAssets = true, assetsInContract = false)
+    pub fn foo() -> () {
+        transferAlph!(callerAddress!(), callerAddress!(), 1 alph)
+        return
+    }
+
+    @using(preapprovedAssets = false, assetsInContract = true)
+    fn bar() -> () {
+        transferAlphToSelf!(selfAddress!(), 1 alph)
+        return
+    }
+
+    @using(readonly = true)
+    fn baz() -> () {
+        return
+    }
+}

package/contracts/test/warnings.ral

@@ -0,0 +1,8 @@
+Contract Warnings(@unused a: U256, b: U256) {
+    const C = 0
+
+    @using(readonly = true)
+    pub fn foo(@unused x: U256, y: U256) -> () {
+        return
+    }
+}