@blocklet/meta 1.15.17 → 1.16.0-beta-8ee536d7

package/lib/payment/v1.d.ts

@@ -0,0 +1,185 @@
+import { BlockletPaymentPrice } from '@abtnode/client';
+import { TBlockletMeta } from '../types';
+declare const createShareContract: ({ tokens, shares, }: {
+    tokens?: Pick<BlockletPaymentPrice, 'address' | 'value'>[];
+    shares: {
+        value: number;
+        address: string;
+    }[];
+}) => string;
+declare const createNftFactoryItx: ({ meta, tokens, shares, issuers, serviceUrl, }: {
+    meta: TBlockletMeta;
+    tokens: Pick<BlockletPaymentPrice, 'address' | 'value'>[];
+    shares: {
+        value: number;
+        address: string;
+    }[];
+    issuers: string[];
+    serviceUrl: string;
+}) => {
+    name: string;
+    description: string;
+    settlement: string;
+    limit: number;
+    trustedIssuers: string[];
+    input: {
+        tokens: Pick<BlockletPaymentPrice, "address" | "value">[];
+        assets: any[];
+        variables: any[];
+    };
+    output: {
+        issuer: string;
+        parent: string;
+        moniker: string;
+        readonly: boolean;
+        transferrable: boolean;
+        data: {
+            type: string;
+            value: {
+                '@context': string;
+                id: string;
+                tag: string[];
+                type: string[];
+                issuer: {
+                    id: string;
+                    pk: string;
+                    name: string;
+                };
+                issuanceDate: string;
+                credentialSubject: {
+                    id: string;
+                    sn: string;
+                    purchased: {
+                        blocklet: {
+                            id: string;
+                            url: string;
+                            name: string;
+                        };
+                    };
+                    display: {
+                        type: string;
+                        content: string;
+                    };
+                };
+                credentialStatus: {
+                    id: string;
+                    type: string;
+                    scope: string;
+                };
+                proof: {
+                    type: string;
+                    created: string;
+                    proofPurpose: string;
+                    jws: string;
+                };
+            };
+        };
+    };
+    data: {
+        type: string;
+        value: {
+            did: string;
+            url: string;
+            name: string;
+        };
+    };
+    hooks: {
+        name: string;
+        type: string;
+        hook: string;
+    }[];
+};
+export { createShareContract };
+export { createNftFactoryItx };
+declare const _default: {
+    createShareContract: ({ tokens, shares, }: {
+        tokens?: Pick<BlockletPaymentPrice, "address" | "value">[];
+        shares: {
+            value: number;
+            address: string;
+        }[];
+    }) => string;
+    createNftFactoryItx: ({ meta, tokens, shares, issuers, serviceUrl, }: {
+        meta: TBlockletMeta;
+        tokens: Pick<BlockletPaymentPrice, "address" | "value">[];
+        shares: {
+            value: number;
+            address: string;
+        }[];
+        issuers: string[];
+        serviceUrl: string;
+    }) => {
+        name: string;
+        description: string;
+        settlement: string;
+        limit: number;
+        trustedIssuers: string[];
+        input: {
+            tokens: Pick<BlockletPaymentPrice, "address" | "value">[];
+            assets: any[];
+            variables: any[];
+        };
+        output: {
+            issuer: string;
+            parent: string;
+            moniker: string;
+            readonly: boolean;
+            transferrable: boolean;
+            data: {
+                type: string;
+                value: {
+                    '@context': string;
+                    id: string;
+                    tag: string[];
+                    type: string[];
+                    issuer: {
+                        id: string;
+                        pk: string;
+                        name: string;
+                    };
+                    issuanceDate: string;
+                    credentialSubject: {
+                        id: string;
+                        sn: string;
+                        purchased: {
+                            blocklet: {
+                                id: string;
+                                url: string;
+                                name: string;
+                            };
+                        };
+                        display: {
+                            type: string;
+                            content: string;
+                        };
+                    };
+                    credentialStatus: {
+                        id: string;
+                        type: string;
+                        scope: string;
+                    };
+                    proof: {
+                        type: string;
+                        created: string;
+                        proofPurpose: string;
+                        jws: string;
+                    };
+                };
+            };
+        };
+        data: {
+            type: string;
+            value: {
+                did: string;
+                url: string;
+                name: string;
+            };
+        };
+        hooks: {
+            name: string;
+            type: string;
+            hook: string;
+        }[];
+    };
+};
+export default _default;

package/lib/payment/v1.js

@@ -0,0 +1,84 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createNftFactoryItx = exports.createShareContract = void 0;
+const url_join_1 = __importDefault(require("url-join"));
+const util_1 = require("@ocap/util");
+const asset_1 = require("@ocap/asset");
+const did_util_1 = require("@arcblock/did-util");
+const nft_templates_1 = require("../nft-templates");
+const createShareContract = ({ tokens = [], shares = [], }) => {
+    const zeroBN = new util_1.BN(0);
+    const decimals = 1000000; // we only support 6 decimals on share ratio
+    const decimalsBN = new util_1.BN(decimals);
+    const contract = [];
+    const shareSum = shares.reduce((sum, x) => sum + x.value, 0);
+    if (shareSum > 1) {
+        throw new Error('payment.share invalid: share sum should not be greater than 1');
+    }
+    if (Array.isArray(tokens)) {
+        tokens.forEach(({ address: tokenAddress, value: valueItem }) => {
+            const valueBN = new util_1.BN(valueItem);
+            if (valueBN.lt(zeroBN)) {
+                throw new Error('token price must be greater than or equal to zero');
+            }
+            shares.forEach(({ address, value }) => {
+                const ratio = new util_1.BN(value * decimals);
+                const amount = valueBN.mul(ratio).div(decimalsBN);
+                contract.push(`transferToken('${tokenAddress}','${address}','${amount.toString()}')`);
+            });
+        });
+    }
+    return contract.join(';\n');
+};
+exports.createShareContract = createShareContract;
+// we need to ensure that blocklet purchase factory does not change across changes
+const createNftFactoryItx = ({ meta, tokens, shares, issuers, serviceUrl, }) => {
+    const factoryOutput = (0, nft_templates_1.getBlockletPurchaseTemplate)(serviceUrl);
+    const itx = {
+        name: meta.title || meta.name,
+        description: `Purchase NFT factory for blocklet ${meta.name}`,
+        settlement: 'instant',
+        limit: 0,
+        trustedIssuers: issuers,
+        input: {
+            tokens: [...tokens],
+            assets: [],
+            variables: [],
+        },
+        output: {
+            issuer: '{{ctx.issuer.id}}',
+            parent: '{{ctx.factory}}',
+            moniker: 'BlockletPurchaseNFT',
+            readonly: true,
+            transferrable: false,
+            data: factoryOutput,
+        },
+        data: {
+            type: 'json',
+            value: {
+                did: meta.did,
+                url: (0, url_join_1.default)(serviceUrl, `/blocklet/${meta.did}`),
+                name: meta.name,
+            },
+        },
+        hooks: [
+            {
+                name: 'mint',
+                type: 'contract',
+                hook: createShareContract({ tokens, shares }),
+            },
+        ],
+    };
+    // @ts-ignore
+    itx.address = (0, did_util_1.toFactoryAddress)(itx);
+    (0, asset_1.isValidFactory)(itx);
+    return itx;
+};
+exports.createNftFactoryItx = createNftFactoryItx;
+exports.default = {
+    createShareContract,
+    createNftFactoryItx,
+};

package/lib/payment/v2.d.ts

@@ -0,0 +1,242 @@
+import { TBlockletMeta } from '../types';
+declare const VERSION = "2.0.0";
+export interface Store {
+    id: string;
+    pk: string;
+    url: string;
+    components: Array<{
+        did: string;
+        version: string;
+    }>;
+}
+export interface Component {
+    meta: TBlockletMeta;
+    storeInfo: {
+        id: string;
+        pk: string;
+    };
+    storeUrl: string;
+    children: Component[];
+}
+/**
+ * Used by CLI and Store to independent compute factory itx
+ *
+ * @param {{
+ *   blockletMeta: TBlockletMeta,
+ *   ocapClient: OcapClient,
+ *   issuers: Array<string>,
+ *   storeUrl: string,
+ * }}
+ * @returns {{
+ *   itx: Itx
+ *   store: Array<{id, url}>
+ *   shares: Array<{
+ *     accountName: string
+ *     accountAddress: DID
+ *     tokenAddress: DID
+ *     amount: string|number,
+ *   }>
+ * }}
+ */
+declare const createNftFactoryItx: ({ blockletMeta, ocapClient, issuers, storeUrl, }: {
+    blockletMeta: TBlockletMeta;
+    ocapClient: any;
+    issuers: string[];
+    storeUrl: string;
+}) => Promise<{
+    itx: any;
+    stores: {
+        id: string;
+        url: string;
+    }[];
+    shares: {
+        amount: string;
+        tokenAddress: string;
+        accountAddress: string;
+    }[];
+}>;
+/**
+ * Used by Store before generating payment signature
+ *
+ * @param {{
+ *   integrity: string,
+ *   blockletMeta: TBlockletMeta,
+ *   ocapClient: OcapClient,
+ *   storeId: string
+ * }}
+ * @returns {string} integrity
+ */
+declare const verifyPaymentIntegrity: ({ integrity: expected, blockletMeta, ocapClient, storeId, }: {
+    integrity: string;
+    blockletMeta: TBlockletMeta;
+    ocapClient: any;
+    storeId: string;
+}) => Promise<string>;
+/**
+ * Used by Store before generating downloadToken
+ *
+ * @param {{
+ *   {FactoryState} factoryState
+ *   {Wallet} signerWallet
+ * }}
+ *
+ * @returns {{
+ *   components: Array<{did: string, version: string}>
+ * }}
+ */
+declare const verifyNftFactory: ({ factoryState, signerWallet, }: {
+    factoryState: {
+        data: {
+            value: string;
+        };
+        input?: any;
+        address?: string;
+        hooks?: Array<{
+            type: string;
+            hook: string;
+        }>;
+    };
+    signerWallet: any;
+}) => Promise<any>;
+/**
+ * Check blocklet and all of components are free
+ * Throw Error if not free
+ *
+ * @param {TBlockletMeta} meta
+ */
+declare const checkFreeBlocklet: (blockletMeta: TBlockletMeta) => Promise<boolean>;
+export declare const _test: {
+    getPriceTokens: (meta: any, ocapClient: any) => Promise<any>;
+    getFactoryInput: (inputTokens: Array<{
+        address: string;
+        value: string | number;
+        decimal: number;
+    }>, { formatToken }?: {
+        formatToken?: boolean;
+    }) => {
+        tokens: Array<{
+            address: string;
+            value: string | number;
+            decimal: number;
+        }>;
+        assets: [];
+        variables: [];
+    };
+    getPaymentIntegrity: ({ contract, factoryInput, storeComponents, meta, client, storeId, }: {
+        contract?: string;
+        factoryInput?: any;
+        storeComponents?: any;
+        meta?: any;
+        client?: any;
+        storeId?: string;
+    }) => Promise<string>;
+    getComponents: (inputMeta: any) => Promise<{
+        components: Component[];
+        stores: Store[];
+    }>;
+    getContract: ({ meta, priceTokens, components, }: {
+        meta: TBlockletMeta;
+        priceTokens: Array<{
+            decimal: number;
+        }>;
+        components: any;
+    }) => Promise<{
+        code: string;
+        shares: {
+            amount: string;
+            tokenAddress: string;
+            accountAddress: string;
+        }[];
+    }>;
+};
+export { createNftFactoryItx };
+export { verifyPaymentIntegrity };
+export { verifyNftFactory };
+export { checkFreeBlocklet };
+export { VERSION as version };
+declare const _default: {
+    createNftFactoryItx: ({ blockletMeta, ocapClient, issuers, storeUrl, }: {
+        blockletMeta: TBlockletMeta;
+        ocapClient: any;
+        issuers: string[];
+        storeUrl: string;
+    }) => Promise<{
+        itx: any;
+        stores: {
+            id: string;
+            url: string;
+        }[];
+        shares: {
+            amount: string;
+            tokenAddress: string;
+            accountAddress: string;
+        }[];
+    }>;
+    verifyPaymentIntegrity: ({ integrity: expected, blockletMeta, ocapClient, storeId, }: {
+        integrity: string;
+        blockletMeta: TBlockletMeta;
+        ocapClient: any;
+        storeId: string;
+    }) => Promise<string>;
+    verifyNftFactory: ({ factoryState, signerWallet, }: {
+        factoryState: {
+            data: {
+                value: string;
+            };
+            input?: any;
+            address?: string;
+            hooks?: {
+                type: string;
+                hook: string;
+            }[];
+        };
+        signerWallet: any;
+    }) => Promise<any>;
+    checkFreeBlocklet: (blockletMeta: TBlockletMeta) => Promise<boolean>;
+    version: string;
+    _test: {
+        getPriceTokens: (meta: any, ocapClient: any) => Promise<any>;
+        getFactoryInput: (inputTokens: {
+            address: string;
+            value: string | number;
+            decimal: number;
+        }[], { formatToken }?: {
+            formatToken?: boolean;
+        }) => {
+            tokens: {
+                address: string;
+                value: string | number;
+                decimal: number;
+            }[];
+            assets: [];
+            variables: [];
+        };
+        getPaymentIntegrity: ({ contract, factoryInput, storeComponents, meta, client, storeId, }: {
+            contract?: string;
+            factoryInput?: any;
+            storeComponents?: any;
+            meta?: any;
+            client?: any;
+            storeId?: string;
+        }) => Promise<string>;
+        getComponents: (inputMeta: any) => Promise<{
+            components: Component[];
+            stores: Store[];
+        }>;
+        getContract: ({ meta, priceTokens, components, }: {
+            meta: TBlockletMeta;
+            priceTokens: {
+                decimal: number;
+            }[];
+            components: any;
+        }) => Promise<{
+            code: string;
+            shares: {
+                amount: string;
+                tokenAddress: string;
+                accountAddress: string;
+            }[];
+        }>;
+    };
+};
+export default _default;