@blocklet/meta 1.5.19 → 1.5.20

package/lib/payment.js

@@ -6,52 +6,33 @@ const { toFactoryAddress } = require('@arcblock/did-util');
 const { getBlockletPurchaseTemplate } = require('@arcblock/nft/lib/templates');
 
 const isFreeBlocklet = (meta) => {
-  if (!meta.charging) {
+  if (!meta.payment) {
     return true;
   }
 
-  const primaryPrice = meta.charging.price || 0;
-  const secondaryPrice = (meta.charging.tokens || []).map((x) => x.price || 0);
-  if (primaryPrice <= 0 && secondaryPrice.every((x) => x <= 0)) {
-    return true;
-  }
-
-  return false;
+  const priceList = (meta.payment.price || []).map((x) => x.value || 0);
+  return priceList.every((x) => x === 0);
 };
 
-const createShareContract = ({ price, shares, tokens = [] }) => {
+const createShareContract = ({ tokens = [], shares = [] }) => {
   const zeroBN = new BN(0);
   const decimals = 1000000; // we only support 6 decimals on share ratio
   const decimalsBN = new BN(decimals);
 
   const contract = [];
-  const shareSum = shares.reduce((sum, x) => sum + x.share, 0);
+  const shareSum = shares.reduce((sum, x) => sum + x.value, 0);
   if (shareSum > 1) {
-    throw new Error('charging.shares invalid: share sum should not be greater than 1');
-  }
-
-  // split primary token
-  const priceBN = new BN(price);
-  if (priceBN.lt(zeroBN)) {
-    throw new Error('price must be greater than or equal to zero');
-  }
-  if (priceBN.gt(zeroBN)) {
-    shares.forEach(({ address, share }) => {
-      const ratio = new BN(share * decimals);
-      const amount = priceBN.mul(ratio).div(decimalsBN);
-      contract.push(`transfer('${address}','${amount.toString()}')`);
-    });
+    throw new Error('payment.share invalid: share sum should not be greater than 1');
   }
 
-  // split secondary token
   if (Array.isArray(tokens)) {
-    tokens.forEach(({ address: tokenAddress, value }) => {
-      const valueBN = new BN(value);
+    tokens.forEach(({ address: tokenAddress, value: valueItem }) => {
+      const valueBN = new BN(valueItem);
       if (valueBN.lt(zeroBN)) {
         throw new Error('token price must be greater than or equal to zero');
       }
-      shares.forEach(({ address, share }) => {
-        const ratio = new BN(share * decimals);
+      shares.forEach(({ address, value }) => {
+        const ratio = new BN(value * decimals);
         const amount = valueBN.mul(ratio).div(decimalsBN);
         contract.push(`transferToken('${tokenAddress}','${address}','${amount.toString()}')`);
       });
@@ -62,7 +43,7 @@ const createShareContract = ({ price, shares, tokens = [] }) => {
 };
 
 // we need to ensure that blocklet purchase factory does not change across changes
-const createNftFactoryItx = ({ meta, price, tokens, shares, issuers, serviceUrl }) => {
+const createNftFactoryItx = ({ meta, tokens, shares, issuers, serviceUrl }) => {
   const factoryOutput = getBlockletPurchaseTemplate(serviceUrl);
   const itx = {
     name: meta.title || meta.name,
@@ -71,7 +52,6 @@ const createNftFactoryItx = ({ meta, price, tokens, shares, issuers, serviceUrl
     limit: 0,
     trustedIssuers: issuers,
     input: {
-      value: price,
       tokens: [...tokens],
       assets: [],
       variables: [],
@@ -96,7 +76,7 @@ const createNftFactoryItx = ({ meta, price, tokens, shares, issuers, serviceUrl
       {
         name: 'mint',
         type: 'contract',
-        hook: createShareContract({ price, tokens, shares }),
+        hook: createShareContract({ tokens, shares }),
       },
     ],
   };

package/lib/schema.js

@@ -209,36 +209,45 @@ const createBlockletSchema = (
     // This is usually created and maintained by `blocklet publish` command
     nftFactory: Joi.DID().optional().allow('').default(''),
 
-    // Set the price and shares of the blocklet
-    charging: Joi.object({
-      // How much primary tokens required to purchase this blocklet
-      price: Joi.number(),
-      // How much secondary tokens required to purchase this block
-      tokens: Joi.array()
+    // Set the price and share of the blocklet
+    payment: Joi.object({
+      // How much price required to purchase this block
+      price: Joi.array()
         .max(4)
         .items(
           Joi.object({
-            price: Joi.number().required(),
+            value: Joi.number().required(),
             address: Joi.DID().required(), // token address
           })
         ),
-      // List of beneficiaries that shares the token earns from blocklet purchase
+      // List of beneficiaries that share the token earns from blocklet purchase
       // If left empty, blocklet publish workflow will enforce both the developer and the registry account
       // If not, the blocklet publish workflow will enforce the registry account
-      // In theory, the developer can split as many shares as he wants
+      // In theory, the developer can split as many share as he wants
       // Such as, some developers coauthored the blocklet, and their income get instant settlement on blocklet purchase
-      // For performance reasons, we need to set a hard limit for shares count
-      shares: Joi.array()
+      // For performance reasons, we need to set a hard limit for share count
+      share: Joi.array()
         .max(4)
         .items(
           Joi.object({
             name: Joi.string().required(),
             address: Joi.DID().required(),
-            share: Joi.number().min(0).max(1).required(),
+            value: Joi.number().min(0).max(1).required(),
           })
-        ),
+        )
+        .custom((value) => {
+          // If share is not empty, the total value should be 1
+          if (value.length === 0) {
+            return value;
+          }
+          const total = value.reduce((acc, cur) => acc + cur.value, 0);
+          if (total !== 1) {
+            throw new Error(`invalid share: ${JSON.stringify(value)}`);
+          }
+          return value;
+        }, 'share invalid'),
     })
-      .default({ price: 0, tokens: [], shares: [] })
+      .default({ price: [], share: [] })
       .optional(),
 
     keywords: Joi.alternatives()

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.5.19",
+  "version": "1.5.20",
   "description": "Library to parse/validate/fix blocklet meta",
   "main": "lib/index.js",
   "files": [
@@ -18,14 +18,14 @@
   "author": "wangshijun <wangshijun2020@gmail.com> (http://github.com/wangshijun)",
   "license": "MIT",
   "dependencies": {
-    "@arcblock/did": "^1.13.61",
-    "@arcblock/did-ext": "^1.13.61",
-    "@arcblock/did-util": "^1.13.61",
-    "@arcblock/nft": "^1.13.61",
-    "@ocap/asset": "^1.13.61",
-    "@ocap/mcrypto": "^1.13.61",
-    "@ocap/util": "^1.13.61",
-    "@ocap/wallet": "^1.13.61",
+    "@arcblock/did": "^1.13.64",
+    "@arcblock/did-ext": "^1.13.64",
+    "@arcblock/did-util": "^1.13.64",
+    "@arcblock/nft": "^1.13.64",
+    "@ocap/asset": "^1.13.64",
+    "@ocap/mcrypto": "^1.13.64",
+    "@ocap/util": "^1.13.64",
+    "@ocap/wallet": "^1.13.64",
     "ajv": "^7.0.3",
     "debug": "^4.3.3",
     "fs-extra": "^10.0.0",
@@ -42,5 +42,5 @@
   "devDependencies": {
     "jest": "^27.3.1"
   },
-  "gitHead": "e05f849f5aedca9db5060b075770cdb87949f835"
+  "gitHead": "08771b885d987343780f29b95b71e6e0926b91bf"
 }