@wharfkit/transact-plugin-resource-provider 0.3.0-ui-5 → 0.3.0-ui-16

package/src/index.ts

@@ -3,8 +3,11 @@ import {
     Action,
     Asset,
     AssetType,
+    Cancelable,
+    Canceled,
     ChainDefinition,
     Name,
+    PromptResponse,
     Serializer,
     Signature,
     SigningRequest,
@@ -15,12 +18,13 @@ import {
     Transaction,
 } from '@wharfkit/session'
 
+import defaultTranslations from './translations.json'
 import {getNewActions, hasOriginalActions} from './utils'
 
 interface ResourceProviderOptions {
     allowFees?: boolean
     // allowActions?: NameType[]
-    endpoints: Record<string, string>
+    endpoints?: Record<string, string>
     maxFee?: AssetType
 }
 
@@ -49,35 +53,60 @@ export class Transfer extends Struct {
     @Struct.field('string') memo!: string
 }
 
-export default class ResourceProviderPlugin extends AbstractTransactPlugin {
-    readonly allowFees: boolean = false
+export const defaultOptions = {
+    endpoints: {
+        aca376f206b8fc25a6ed44dbdc66547c36c6c33e3a119ffbeaef943642f0e906:
+            'https://eos.greymass.com',
+        '73e4385a2708e6d7048834fbc1079f2fabb17b3c125b146af438971e90716c4d':
+            'https://jungle4.greymass.com',
+        '4667b205c6838ef70ff7988f6e8257e8be0e1284a2f59699054a018f743b1d11':
+            'https://telos.greymass.com',
+        '1064487b3cd1a897ce03ae5b6a865651747e2e152090f99c1d19d44e01aea5a4':
+            'https://wax.greymass.com',
+    },
+}
+
+export class TransactPluginResourceProvider extends AbstractTransactPlugin {
+    id = 'transact-plugin-resource-provider'
+    translations = defaultTranslations
+    readonly allowFees: boolean = true
     // readonly allowActions: Name[] = [
     //     Name.from('eosio.token:transfer'),
     //     Name.from('eosio:buyrambytes'),
     // ]
     readonly maxFee?: Asset
 
-    readonly endpoints: Record<string, string> = {}
+    readonly endpoints: Record<string, string> = defaultOptions.endpoints
 
-    constructor(options: ResourceProviderOptions) {
+    constructor(options?: ResourceProviderOptions) {
         super()
-        // Set the endpoints and chains available
-        this.endpoints = options.endpoints
-        if (typeof options?.allowFees !== 'undefined') {
-            this.allowFees = options.allowFees
-        }
-        // TODO: Allow contact/action combos to be passed in and checked against to ensure no rogue actions were appended.
-        // if (typeof options.allowActions !== 'undefined') {
-        //     this.allowActions = options.allowActions.map((action) => Name.from(action))
-        // }
-        if (typeof options?.maxFee !== 'undefined') {
-            this.maxFee = Asset.from(options.maxFee)
+        if (options) {
+            // Set the endpoints and chains available
+            if (options.endpoints) {
+                this.endpoints = options.endpoints
+            }
+            if (typeof options.allowFees !== 'undefined') {
+                this.allowFees = options.allowFees
+            }
+            if (typeof options.maxFee !== 'undefined') {
+                this.maxFee = Asset.from(options.maxFee)
+            }
+            // TODO: Allow contact/action combos to be passed in and checked against to ensure no rogue actions were appended.
+            // if (typeof options.allowActions !== 'undefined') {
+            //     this.allowActions = options.allowActions.map((action) => Name.from(action))
+            // }
         }
     }
 
     register(context: TransactContext): void {
-        context.addHook(TransactHookTypes.beforeSign, (request, context) =>
-            this.request(request, context)
+        context.addHook(
+            TransactHookTypes.beforeSign,
+            async (
+                request: SigningRequest,
+                context: TransactContext
+            ): Promise<TransactHookResponse> => {
+                return this.request(request, context)
+            }
         )
     }
 
@@ -89,6 +118,13 @@ export default class ResourceProviderPlugin extends AbstractTransactPlugin {
         request: SigningRequest,
         context: TransactContext
     ): Promise<TransactHookResponse> {
+        // Mock the translation function if no UI is available
+        let t = (key: string, options: {default: string; [key: string]: unknown}) => options.default
+        if (context.ui) {
+            // Use the translate function if available
+            t = context.ui.getTranslate(this.id)
+        }
+
         // Validate that this request is valid for the resource provider
         this.validateRequest(request, context)
 
@@ -127,8 +163,17 @@ export default class ResourceProviderPlugin extends AbstractTransactPlugin {
         if (requiresPayment) {
             // If the resource provider offered transaction with a fee, but plugin doesn't allow fees, return the original transaction.
             if (!this.allowFees) {
-                // TODO: Notify the script somehow of this, maybe we need an optional logger?
                 // Notify that a fee was required but not allowed via allowFees: false.
+                if (context.ui) {
+                    context.ui.status(
+                        `${t('rejected.no-fees', {
+                            default:
+                                'A resource provider offered to cover this transaction for a fee, but fee-based transactions are disabled by the configuration using `allowFees = false`.',
+                        })} ${t('will-continue', {
+                            default: 'The transaction will continue without the resource provider.',
+                        })}`
+                    )
+                }
                 return {
                     request,
                 }
@@ -144,8 +189,17 @@ export default class ResourceProviderPlugin extends AbstractTransactPlugin {
         )
 
         if (!originalActionsIntact) {
-            // TODO: Notify the script somehow of this, maybe we need an optional logger?
             // Notify that the original actions requested were modified somehow, and reject the modification.
+            if (context.ui) {
+                context.ui.status(
+                    `${t('rejected.original-modified', {
+                        default:
+                            'The original transaction returned by the resource provider has been modified too much. Continuing without the resource provider',
+                    })} ${t('will-continue', {
+                        default: 'The transaction will continue without the resource provider.',
+                    })}`
+                )
+            }
             return {
                 request,
             }
@@ -177,8 +231,17 @@ export default class ResourceProviderPlugin extends AbstractTransactPlugin {
         // If the resource provider offered transaction with a fee, but the fee was higher than allowed, return the original transaction.
         if (this.maxFee) {
             if (addedFees.units > this.maxFee.units) {
-                // TODO: Notify the script somehow of this, maybe we need an optional logger?
                 // Notify that a fee was required but higher than allowed via maxFee.
+                if (context.ui) {
+                    context.ui.status(
+                        `${t('rejected.max-fee', {
+                            default:
+                                'The fee requested by the resource provider is unusually high and has been rejected.',
+                        })} ${t('will-continue', {
+                            default: 'The transaction will continue without the resource provider.',
+                        })}`
+                    )
+                }
                 return {
                     request,
                 }
@@ -188,34 +251,83 @@ export default class ResourceProviderPlugin extends AbstractTransactPlugin {
         // Validate that the response is valid for the session.
         await this.validateResponseData(json)
 
-        // NYI: Interact with interface via context for fee based prompting
-
-        /* Psuedo-code for fee based prompting
-
-        if (response.status === 402) {
-
-            // Prompt for the fee acceptance
-            const promptResponse = context.userPrompt({
-                title: 'Transaction Fee Required',
-                message: `This transaction requires a fee of ${response.json.data.fee} EOS. Do you wish to accept this fee?`,
-            })
+        // Create a new signing request based on the response to return to the session's transact flow.
+        const modified = await this.createRequest(json, context)
 
-            // If the user did not accept the fee, return the original request without modification.
-            if (!promptResponse) {
-                return {
-                    request,
-                }
+        if (context.ui && addedFees.value > 0) {
+            // Determine which resources are being covered by this fee
+            const resourceTypes: string[] = []
+            if (json.data.costs) {
+                const {cpu, net, ram} = json.data.costs
+                if (Asset.from(cpu).value > 0) resourceTypes.push('CPU')
+                if (Asset.from(net).value > 0) resourceTypes.push('NET')
+                if (Asset.from(ram).value > 0) resourceTypes.push('RAM')
+            } else {
+                resourceTypes.push('Unknown')
             }
-        } */
+            // Initiate a new cancelable prompt to inform the user of the fee required
+            const prompt: Cancelable<PromptResponse> = context.ui.prompt({
+                title: t('fee.title', {default: 'Accept Transaction Fee?'}),
+                body: t('fee.body', {
+                    default:
+                        'Additional resources ({{resource}}) are required for your account to perform this transaction. Would you like to automatically purchase these resources and proceed?',
+                    resource: String(resourceTypes.join('/')),
+                }),
+                elements: [
+                    {
+                        type: 'asset',
+                        data: {
+                            label: t('fee.cost', {
+                                default: 'Cost of {{resource}}',
+                                resource: String(resourceTypes.join('/')),
+                            }),
+                            value: addedFees,
+                        },
+                    },
+                    {
+                        type: 'accept',
+                    },
+                ],
+            })
 
-        // Create a new signing request based on the response to return to the session's transact flow.
-        const modified = await this.createRequest(json, context)
+            // TODO: Set the timer to match the expiration of the transaction
+            const timer = setTimeout(() => {
+                prompt.cancel(
+                    t('timeout', {default: 'The offer from the resource provider has expired.'})
+                )
+            }, 120000)
+
+            // Return the promise from the prompt
+            return prompt
+                .then(async () => {
+                    // Return the modified transaction and additional signatures
+                    return new Promise((r) =>
+                        r({
+                            request: modified,
+                            signatures: json.data.signatures.map((sig) => Signature.from(sig)),
+                        })
+                    ) as Promise<TransactHookResponse>
+                })
+                .catch((e) => {
+                    // Throw if what we caught was a cancelation
+                    if (e instanceof Canceled) {
+                        throw e
+                    }
+                    // Otherwise if it wasn't a cancel, it was a reject, and continue without modification
+                    return new Promise((r) => r({request})) as Promise<TransactHookResponse>
+                })
+                .finally(() => {
+                    clearTimeout(timer) // TODO: Remove this, it's just here for testing
+                })
+        }
 
         // Return the modified transaction and additional signatures
-        return {
-            request: modified,
-            signatures: json.data.signatures.map((sig) => Signature.from(sig)),
-        }
+        return new Promise((r) =>
+            r({
+                request: modified,
+                signatures: json.data.signatures.map((sig) => Signature.from(sig)),
+            })
+        )
     }
 
     getModifiedTransaction(json): Transaction {
@@ -235,10 +347,7 @@ export default class ResourceProviderPlugin extends AbstractTransactPlugin {
         context: TransactContext
     ): Promise<SigningRequest> {
         // Create a new signing request based on the response to return to the session's transact flow.
-        const request = await SigningRequest.create(
-            {transaction: response.data.request[1]},
-            context.esrOptions
-        )
+        const request = await context.createRequest(response.data.request[1])
 
         // Set the required fee onto the request itself for wallets to process.
         if (response.code === 402 && response.data.fee) {

package/src/translations.json

@@ -0,0 +1,30 @@
+{
+    "ko": {
+        "timeout": "리소스 공급자의 제안이 만료되었습니다.",
+        "will-continue": "트랜잭션은 리소스 공급자 없이 계속됩니다.",
+        "fee": {
+            "title": "거래 수수료를 수락하시겠습니까?",
+            "body": "계정에서 이 거래를 수행하려면 추가 리소스({{resource}})가 필요합니다. 이러한 리소스를 자동으로 구매하고 계속 진행하시겠습니까?",
+            "cost": "{{resource}}의 비용"
+        },
+        "rejected": {
+            "no-fees": "리소스 공급자가 이 트랜잭션을 유료로 처리하도록 제안했지만 수수료 기반 트랜잭션은 'allowFees = false'를 사용하는 구성에 의해 비활성화됩니다.",
+            "original-modified": "리소스 공급자가 반환한 원래 트랜잭션이 너무 많이 수정되었습니다. 리소스 공급자 없이 계속",
+            "max-fee": "리소스 공급자가 요청한 수수료가 비정상적으로 높아 거부되었습니다."
+        }
+    },
+    "zh": {
+        "timeout": "来自资源提供程序的产品/服务已过期。",
+        "will-continue": "事务将在没有资源提供程序的情况下继续。",
+        "fee": {
+            "title": "接受交易费用？",
+            "body": "您的账户需要其他资源 （{{resource}}） 才能执行此事务。是否要自动购买这些资源并继续？",
+            "cost": "{{resource}} 的成本"
+        },
+        "rejected": {
+            "no-fees": "资源提供程序提供付费支付此事务的费用，但使用“allowFee = false”的配置禁用了基于费用的事务。",
+            "original-modified": "资源提供程序返回的原始事务修改过多。在没有资源提供程序的情况下继续",
+            "max-fee": "资源提供商请求的费用异常高，已被拒绝。"
+        }
+    }
+}

package/lib/resource-provider-plugin.d.ts

@@ -1,84 +0,0 @@
-/**
- * @wharfkit/resource-provider-plugin v0.2.0
- * https://github.com/wharfkit/resource-provider-plugin
- *
- * @license
- * Copyright (c) 2021 FFF00 Agents AB & Greymass Inc. All Rights Reserved.
- * 
- * Redistribution and use in source and binary forms, with or without modification,
- * are permitted provided that the following conditions are met:
- * 
- *  1. Redistribution of source code must retain the above copyright notice, this
- *     list of conditions and the following disclaimer.
- * 
- *  2. Redistribution in binary form must reproduce the above copyright notice,
- *     this list of conditions and the following disclaimer in the documentation
- *     and/or other materials provided with the distribution.
- * 
- *  3. Neither the name of the copyright holder nor the names of its contributors
- *     may be used to endorse or promote products derived from this software without
- *     specific prior written permission.
- * 
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
- * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
- * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
- * IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
- * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
- * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
- * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
- * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
- * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
- * OF THE POSSIBILITY OF SUCH DAMAGE.
- * 
- * YOU ACKNOWLEDGE THAT THIS SOFTWARE IS NOT DESIGNED, LICENSED OR INTENDED FOR USE
- * IN THE DESIGN, CONSTRUCTION, OPERATION OR MAINTENANCE OF ANY MILITARY FACILITY.
- */
-import { Struct, Name, Asset, AbstractTransactPlugin, TransactContext, ChainDefinition, SigningRequest, TransactHookResponse, Transaction, AssetType } from '@wharfkit/session';
-
-interface ResourceProviderOptions {
-    allowFees?: boolean;
-    endpoints: Record<string, string>;
-    maxFee?: AssetType;
-}
-interface ResourceProviderResponseData {
-    request: [string, object];
-    signatures: string[];
-    version: unknown;
-    fee?: AssetType;
-    costs?: {
-        cpu: AssetType;
-        net: AssetType;
-        ram: AssetType;
-    };
-}
-interface ResourceProviderResponse {
-    code: number;
-    data: ResourceProviderResponseData;
-}
-declare class Transfer extends Struct {
-    from: Name;
-    to: Name;
-    quantity: Asset;
-    memo: string;
-}
-declare class ResourceProviderPlugin extends AbstractTransactPlugin {
-    readonly allowFees: boolean;
-    readonly maxFee?: Asset;
-    readonly endpoints: Record<string, string>;
-    constructor(options: ResourceProviderOptions);
-    register(context: TransactContext): void;
-    getEndpoint(chain: ChainDefinition): string;
-    request(request: SigningRequest, context: TransactContext): Promise<TransactHookResponse>;
-    getModifiedTransaction(json: any): Transaction;
-    createRequest(response: ResourceProviderResponse, context: TransactContext): Promise<SigningRequest>;
-    /**
-     * Perform validation against the request to ensure it is valid for the resource provider.
-     */
-    validateRequest(request: SigningRequest, context: TransactContext): void;
-    /**
-     * Perform validation against the response to ensure it is valid for the session.
-     */
-    validateResponseData(response: Record<string, any>): Promise<void>;
-}
-
-export { Transfer, ResourceProviderPlugin as default };