@ocap/asset 1.17.2 → 1.17.5

package/lib/index.d.ts

@@ -1,5 +1,34 @@
+import type { LiteralUnion, PartialDeep } from 'type-fest';
+import type { WalletObject } from '@ocap/wallet';
+import type { AssetFactoryState, CreateAssetTx } from '@ocap/types';
 declare type $TSFixMe = any;
-export declare const isValidHook: (hook: $TSFixMe, quota?: $TSFixMe, throwOnError?: boolean) => boolean;
+export declare type TPickedFactoryState = PartialDeep<AssetFactoryState.AsObject>;
+export declare type TIssuer = {
+    name: string;
+    wallet: WalletObject;
+};
+export declare type TIssuerInput = {
+    id: string;
+    pk: string;
+    name: string;
+};
+export declare type THook = {
+    type: LiteralUnion<'contract' | 'url', string>;
+    name: LiteralUnion<'mint' | 'postMint', string>;
+    hook: string;
+};
+export declare type TInputMap = {
+    [key: string]: string;
+};
+export declare type TMintResult = {
+    address: string;
+    asset: CreateAssetTx.AsObject;
+};
+export declare type TPreMintResult = TMintResult & {
+    variables: TInputMap;
+    issuer: TIssuerInput;
+};
+export declare const isValidHook: (hook: THook, quota?: $TSFixMe, throwOnError?: boolean) => boolean;
 export declare const isValidFactory: (props: $TSFixMe) => boolean;
 /**
  * Find credentialSubject path in the object
@@ -20,14 +49,11 @@ export declare const findPrerenderKeys: (obj: $TSFixMe, keyword: string) => stri
  * @param {object} params.issuer issuer object
  */
 export declare const mintFromFactory: ({ factory, inputs, owner, issuer, }: {
-    factory: $TSFixMe;
-    inputs: $TSFixMe;
+    factory: TPickedFactoryState;
+    inputs: TInputMap;
     owner: string;
-    issuer: $TSFixMe;
-}) => {
-    asset: any;
-    address: string;
-};
+    issuer: TIssuerInput;
+}) => TMintResult;
 /**
  * Simulate minting from an asset factory, used for client side
  *
@@ -38,23 +64,10 @@ export declare const mintFromFactory: ({ factory, inputs, owner, issuer, }: {
  * @param {object} params.issuer factory issuer wallet and name
  */
 export declare const preMintFromFactory: ({ factory, inputs, owner, issuer, }: {
-    factory?: $TSFixMe;
-    inputs: $TSFixMe;
+    factory?: TPickedFactoryState;
+    inputs: TInputMap;
     owner?: string;
-    issuer?: $TSFixMe;
-}) => {
-    address: string;
-    issuer: {
-        id: any;
-        pk: string;
-        name: any;
-    };
-    variables: any;
-    asset: any;
-};
-export declare const formatFactoryState: (state: $TSFixMe) => {
-    address: any;
-    output: any;
-    data: any;
-};
+    issuer?: TIssuer;
+}) => TPreMintResult;
+export declare const formatFactoryState: (state: $TSFixMe) => TPickedFactoryState;
 export {};

package/lib/index.js

@@ -9,6 +9,7 @@ const get_1 = __importDefault(require("lodash/get"));
 const set_1 = __importDefault(require("lodash/set"));
 const uniq_1 = __importDefault(require("lodash/uniq"));
 const uniqBy_1 = __importDefault(require("lodash/uniqBy"));
+const isEmpty_1 = __importDefault(require("lodash/isEmpty"));
 const flat_1 = __importDefault(require("flat"));
 const mustache_1 = __importDefault(require("mustache"));
 const is_absolute_url_1 = __importDefault(require("is-absolute-url"));
@@ -20,7 +21,6 @@ const mcrypto_1 = require("@ocap/mcrypto");
 const util_1 = require("@ocap/util");
 const contract_1 = require("@ocap/contract");
 const debug_1 = __importDefault(require("debug"));
-const lodash_1 = require("lodash");
 const debug = (0, debug_1.default)('@ocap/asset');
 const SUPPORTED_HOOK_NAMES = ['mint', 'postMint'];
 const SUPPORTED_HOOK_TYPES = ['contract', 'url'];
@@ -53,6 +53,8 @@ const isValidHook = (hook, quota, throwOnError = false) => {
     return false;
 };
 exports.isValidHook = isValidHook;
+// FIXME: we should use Joi to validate the schema
+// @link https://github.com/improbable-eng/ts-protoc-gen
 const isValidFactory = (props) => {
     if (!props) {
         throw new Error('Factory props should not be empty');
@@ -66,7 +68,7 @@ const isValidFactory = (props) => {
         throw new Error('Factory settlement prop should only be instant or periodic');
     }
     // input.tokens and input.assets should not be empty
-    if (['value', 'tokens', 'assets'].every((x) => (0, lodash_1.isEmpty)(props.input[x]))) {
+    if (['value', 'tokens', 'assets'].every((x) => (0, isEmpty_1.default)(props.input[x]))) {
         throw new Error('Factory input should contain at least one token or asset');
     }
     if ((0, uniqBy_1.default)(props.input.tokens, 'address').length !== props.input.tokens.length) {
@@ -109,7 +111,7 @@ const isValidFactory = (props) => {
         if (quota.value <= 0 && Object.keys(quota.tokens).every((x) => quota[x] <= 0)) {
             return true;
         }
-        if ((0, lodash_1.isEmpty)(props.hooks)) {
+        if ((0, isEmpty_1.default)(props.hooks)) {
             throw new Error('Factory hooks should not be empty for instant settlement');
         }
         const mintHook = props.hooks.find((x) => x.name === 'mint');
@@ -255,7 +257,7 @@ const preMintFromFactory = ({ factory, inputs, owner, issuer, }) => {
 };
 exports.preMintFromFactory = preMintFromFactory;
 const formatFactoryState = (state) => {
-    const { address, output, data } = state;
+    const { address, output, data, numMinted } = state;
     const outputX = (0, cloneDeep_1.default)(output);
     outputX.data.value = JSON.parse(outputX.data.value);
     outputX.data.type = outputX.data.typeUrl;
@@ -263,6 +265,7 @@ const formatFactoryState = (state) => {
         address,
         output: outputX,
         data: JSON.parse(data.value),
+        numMinted,
     };
 };
 exports.formatFactoryState = formatFactoryState;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ocap/asset",
   "description": "Utility to work with asset and factory on ArcBlock blockchain",
-  "version": "1.17.2",
+  "version": "1.17.5",
   "author": {
     "name": "wangshijun",
     "email": "shijun@arcblock.io",
@@ -18,19 +18,21 @@
     "wangshijun <shijun@arcblock.io> (https://github.com/wangshijun)"
   ],
   "dependencies": {
-    "@arcblock/did": "1.17.2",
-    "@arcblock/did-util": "1.17.2",
-    "@arcblock/vc": "1.17.2",
-    "@ocap/contract": "1.17.2",
-    "@ocap/mcrypto": "1.17.2",
-    "@ocap/util": "1.17.2",
-    "@ocap/wallet": "1.17.2",
+    "@arcblock/did": "1.17.5",
+    "@arcblock/did-util": "1.17.5",
+    "@arcblock/vc": "1.17.5",
+    "@ocap/contract": "1.17.5",
+    "@ocap/mcrypto": "1.17.5",
+    "@ocap/types": "1.17.5",
+    "@ocap/util": "1.17.5",
+    "@ocap/wallet": "1.17.5",
     "debug": "^4.3.3",
     "flat": "^5.0.2",
     "is-absolute-url": "^3.0.3",
     "json-stable-stringify": "^1.0.1",
     "lodash": "^4.17.21",
-    "mustache": "^4.1.0"
+    "mustache": "^4.1.0",
+    "type-fest": "^2.16.0"
   },
   "devDependencies": {
     "@arcblock/eslint-config-ts": "0.2.2",
@@ -71,5 +73,5 @@
     "build": "tsc",
     "build:watch": "npm run build -- -w"
   },
-  "gitHead": "ddb64b9727c9d07bd3df4665444545e43b24a071"
+  "gitHead": "5cacbffd2801318debfe38e5313c63dbdf013eec"
 }