@ocap/contract 1.6.10

package/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2018-2019 ArcBlock
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,30 @@
+![nft](https://www.arcblock.io/.netlify/functions/badge/?text=OCAP+Contract)
+
+[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
+[![docs](https://img.shields.io/badge/powered%20by-arcblock-green.svg)](https://docs.arcblock.io)
+[![Gitter](https://badges.gitter.im/ArcBlock/community.svg)](https://gitter.im/ArcBlock/community?utm_source=badge\&utm_medium=badge\&utm_campaign=pr-badge)
+
+> Utility to validate compile and execute ocap contract
+
+
+## Table of Contents
+
+* [Install](#install)
+* [Usage](#usage)
+
+
+## Install
+
+```sh
+npm install @ocap/contract
+// or
+yarn add @ocap/contract
+```
+
+
+## Usage
+
+```js
+const contract;
+// TODO
+```

package/lib/index.d.ts

@@ -0,0 +1,31 @@
+// Generate by [js2dts@0.3.3](https://github.com/whxaxes/js2dts#readme)
+
+declare const _Lib: _Lib.T105;
+declare namespace _Lib {
+  export interface T100 {
+    [key: string]: any;
+  }
+  export interface T101 {
+    value: any;
+    tokens: any;
+  }
+  export interface T102 {
+    type: string;
+    name: string;
+  }
+  export interface T103 {
+    args: _Lib.T102[];
+  }
+  export interface T104 {
+    transfer: _Lib.T103;
+    transferToken: _Lib.T103;
+  }
+  export interface T105 {
+    compile: (source: string, ...args: any[]) => any[];
+    validate: (compiled: any[], quota: any, ensureZeroSum?: boolean) => boolean;
+    merge: (compiled: any) => any[];
+    getQuota: (input?: _Lib.T100) => _Lib.T101;
+    SUPPORTED_CALLS: _Lib.T104;
+  }
+}
+export = _Lib;

package/lib/index.js

@@ -0,0 +1,249 @@
+/* eslint-disable no-restricted-syntax */
+const get = require('lodash/get');
+const set = require('lodash/set');
+const esprima = require('esprima');
+const { types } = require('@ocap/mcrypto');
+const { BN } = require('@ocap/util');
+const { isValid, toTypeInfo } = require('@arcblock/did');
+
+const isCallExpression = (x) =>
+  x.type === 'ExpressionStatement' && x.expression && x.expression.type === 'CallExpression';
+
+const ZERO = new BN('0');
+
+const SUPPORTED_CALLS = {
+  // used to transfer primary token to someone
+  transfer: {
+    args: [
+      {
+        type: 'Literal',
+        name: 'to',
+      },
+      {
+        type: 'Literal',
+        name: 'amount',
+      },
+    ],
+  },
+  // used to transfer secondary token to someone
+  transferToken: {
+    args: [
+      {
+        type: 'Literal',
+        name: 'tokenAddress',
+      },
+      {
+        type: 'Literal',
+        name: 'to',
+      },
+      {
+        type: 'Literal',
+        name: 'amount',
+      },
+    ],
+  },
+};
+
+/**
+ * Try to compile contract source code and return call set
+ *
+ * @param {string} source
+ * @return {array} list of parsed contract call and its args
+ * @throws {Error} for invalid contract or args
+ */
+const compile = (source) => {
+  if (typeof source !== 'string' || !source) {
+    throw new Error('contract source must be a non-empty string');
+  }
+
+  try {
+    const { body } = esprima.parseScript(source);
+    if (body.every((x) => isCallExpression(x)) === false) {
+      throw new Error('only function call expressions are allowed');
+    }
+
+    const result = [];
+
+    const expressions = body.map((x) => x.expression);
+    const allowedCalls = Object.keys(SUPPORTED_CALLS);
+    for (const expression of expressions) {
+      const name = get(expression, 'callee.name');
+      if (allowedCalls.includes(name) === false) {
+        throw new Error(`unrecognized call ${name}`);
+      }
+
+      const expectedArgs = SUPPORTED_CALLS[name].args;
+      const actualArgs = expression.arguments;
+      const expectedArgCount = expectedArgs.length;
+      const actualArgCount = actualArgs.length;
+      if (actualArgCount !== expectedArgCount) {
+        throw new Error(
+          `invalid number of arguments for ${name}, expected ${expectedArgCount}, but found ${actualArgCount}`
+        );
+      }
+
+      for (let i = 0; i < expectedArgs.length; i++) {
+        const expectedArg = expectedArgs[i];
+        const actualArg = actualArgs[i];
+        if (expectedArg.type !== actualArg.type) {
+          throw new Error(
+            `invalid #${i + 1} argument for ${name}, expected ${expectedArg.type}, but found ${actualArg.type}`
+          );
+        }
+      }
+
+      result.push({
+        call: name,
+        args: expectedArgs.reduce((acc, x, i) => {
+          acc[x.name] = actualArgs[i].value;
+          return acc;
+        }, {}),
+      });
+    }
+
+    if (result.length === 0) {
+      throw new Error('compiled contract result is empty');
+    }
+
+    return result;
+  } catch (err) {
+    throw new Error(`Invalid contract source: ${err.message}`);
+  }
+};
+
+const validateDid = (to, allowedRoleTypes) => {
+  if (isValid(to) === false) {
+    throw new Error('invalid did');
+  }
+
+  const type = toTypeInfo(to);
+  if (allowedRoleTypes.includes(type.role) === false) {
+    throw new Error('invalid did role type');
+  }
+
+  return true;
+};
+
+const validateAmount = (amount) => {
+  let bn = null;
+  try {
+    bn = new BN(amount);
+  } catch (err) {
+    throw new Error(`invalid amount: ${err.message}`);
+  }
+
+  if (bn.toString() !== amount) {
+    throw new Error('invalid amount: not valid big number');
+  }
+
+  return bn;
+};
+
+/**
+ * Validate the compiled contract source
+ *
+ * @param {Array} compiled contract call list
+ * @param {object} quota { value, tokens: { [address]: value }}
+ * @return {boolean}
+ */
+const validate = (compiled, quota, ensureZeroSum = false) => {
+  if (!Array.isArray(compiled) || compiled.length === 0) {
+    throw new Error('no contract calls to validate');
+  }
+
+  // to track consumption
+  let remaining = new BN(quota ? quota.value : '0');
+  const tokenRemaining = Object.keys(quota && quota.tokens ? quota.tokens : {}).reduce((acc, x) => {
+    acc[x] = new BN(quota.tokens[x]);
+    return acc;
+  }, {});
+
+  for (const item of compiled) {
+    const { call, args } = item;
+    if (call === 'transfer') {
+      validateDid(args.to, [types.RoleType.ROLE_APPLICATION, types.RoleType.ROLE_ACCOUNT]);
+      const consumption = validateAmount(args.amount);
+      if (consumption.lte(ZERO)) {
+        throw new Error('transfer amount must be greater than 0');
+      }
+      if (quota) {
+        if (remaining.sub(consumption).lt(ZERO)) {
+          throw new Error('transfer exceeded quota');
+        }
+        remaining = remaining.sub(consumption);
+      }
+    } else if (call === 'transferToken') {
+      validateDid(args.tokenAddress, [types.RoleType.ROLE_TOKEN]);
+      validateDid(args.to, [types.RoleType.ROLE_APPLICATION, types.RoleType.ROLE_ACCOUNT]);
+
+      const token = args.tokenAddress;
+      const consumption = validateAmount(args.amount);
+      if (consumption.lte(ZERO)) {
+        throw new Error('token transfer amount must be greater than 0');
+      }
+      if (quota) {
+        if (!tokenRemaining[token] || tokenRemaining[token].sub(consumption).lt(ZERO)) {
+          throw new Error(`transferToken for ${args.tokenAddress} exceeded quota`);
+        }
+
+        tokenRemaining[token] = tokenRemaining[token].sub(consumption);
+      }
+    }
+  }
+
+  if (ensureZeroSum) {
+    if (remaining.eq(ZERO) === false) {
+      throw new Error('transfer violates zero sum');
+    }
+    const invalidToken = Object.keys(tokenRemaining).find((x) => tokenRemaining[x].eq(ZERO) === false);
+    if (invalidToken) {
+      throw new Error(`transferToken for ${invalidToken} violates zero sum`);
+    }
+  }
+
+  return true;
+};
+
+// merge duplicate receiver transfers if they exist
+const merge = (compiled) => {
+  const mergeAndSum = (items, uniqKey, sumBy) => {
+    const result = {};
+    const keys = Array.isArray(uniqKey) ? uniqKey : [uniqKey];
+    keys.sort();
+    for (const item of items) {
+      const key = keys.map((x) => get(item, x)).join('-');
+      if (result[key] === undefined) {
+        result[key] = item;
+      } else {
+        const old = new BN(get(result[key], sumBy));
+        const delta = new BN(get(item, sumBy));
+        set(result[key], sumBy, old.add(delta).toString());
+      }
+    }
+
+    return Object.values(result);
+  };
+
+  return [
+    ...mergeAndSum(
+      compiled.filter((x) => x.call === 'transfer'),
+      'args.to',
+      'args.amount'
+    ),
+    ...mergeAndSum(
+      compiled.filter((x) => x.call === 'transferToken'),
+      ['args.tokenAddress', 'args.to'],
+      'args.amount'
+    ),
+  ];
+};
+
+const getQuota = (input = {}) => ({
+  value: input.value || '0',
+  tokens: (input.tokens || []).reduce((acc, x) => {
+    acc[x.address] = x.value;
+    return acc;
+  }, {}),
+});
+
+module.exports = { compile, validate, merge, getQuota, SUPPORTED_CALLS };

package/package.json

@@ -0,0 +1,71 @@
+{
+  "name": "@ocap/contract",
+  "description": "Utility to compile/validate and run ocap contract",
+  "version": "1.6.10",
+  "author": {
+    "name": "wangshijun",
+    "email": "shijun@arcblock.io",
+    "url": "https://github.com/wangshijun"
+  },
+  "bugs": {
+    "url": "https://github.com/ArcBlock/asset-chain/issues",
+    "email": "shijun@arcblock.io"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "contributors": [
+    "wangshijun <shijun@arcblock.io> (https://github.com/wangshijun)"
+  ],
+  "dependencies": {
+    "@arcblock/did": "1.6.10",
+    "@ocap/mcrypto": "1.6.10",
+    "@ocap/util": "1.6.10",
+    "debug": "^4.3.3",
+    "esprima": "^4.0.1",
+    "lodash": "^4.17.21"
+  },
+  "devDependencies": {
+    "jest": "^27.3.1",
+    "remark-cli": "^10.0.1",
+    "remark-preset-github": "^4.0.1"
+  },
+  "remarkConfig": {
+    "plugins": [
+      "preset-github",
+      [
+        {
+          "repository": "ArcBlock/asset-chain"
+        }
+      ]
+    ]
+  },
+  "homepage": "https://github.com/ArcBlock/asset-chain/tree/master/core/contract",
+  "keywords": [
+    "blockchain",
+    "arcblock",
+    "sdk",
+    "nodejs"
+  ],
+  "license": "Apache-2.0",
+  "main": "./lib/index.js",
+  "files": [
+    "lib"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ArcBlock/asset-chain/tree/master/core/contract"
+  },
+  "scripts": {
+    "lint": "eslint lib tests",
+    "lint:fix": "eslint --fix lib tests",
+    "docs": "yarn gen-dts && yarn gen-docs && yarn cleanup-docs && yarn format-docs",
+    "cleanup-docs": "node ../../scripts/cleanup-docs.js docs/README.md $npm_package_name",
+    "gen-dts": "j2d lib/index.js",
+    "gen-docs": "jsdoc2md lib/index.js > docs/README.md",
+    "format-docs": "remark . -o",
+    "test": "jest --forceExit --detectOpenHandles",
+    "coverage": "yarn test -- --coverage"
+  },
+  "gitHead": "ab272e8db3a15c6571cc7fae7cc3d3e0fdd4bdb1"
+}