BLOCK-2445 - Updated steps for transaction signing and naming of Cont…

…ract Name (#26)

CHANGELOG.md

@@ -2,6 +2,11 @@
 
 All notable changes to the "ultra-cpp" extension will be documented in this file.
 
+## 1.4.2
+
+- Renamed 'Contract Name' to 'Contract Account Name' to reduce the confusion
+- Updated transaction creation flow to remove the extra API selection step
+
 ## 1.4.1
 - Added Wharfkit support
 

README.md

@@ -52,7 +52,7 @@ These can be accessed with `(CTRL / CMD) + SHIFT + P` or through the Command Pal
 
 ### Wallet Service
 
-The wallet service allows you to store private keys inside of VSCode's global state with encryption. However, `1.2.2` of this extension is still missing signing transactions, and such. Will add soon.
+The wallet service allows you to store private keys inside of VSCode's global state with encryption.
 
 - Ultra: Wallet - Create
   - Creates a wallet with 'aes-256-cbc' encryption
@@ -93,4 +93,26 @@ The wallet service allows you to store private keys inside of VSCode's global st
 <br />
 
 - Q. How do I select which contract to compile in a monorepo?
-  - A. Open the root `.cpp` file of the smart contract in VSCode, and have it as the active file. 
+  - A. Open the root `.cpp` file of the smart contract in VSCode, and have it as the active file.
+
+## How to build and install locally
+
+Install the VSCode tool for local packaging
+
+```sh
+npm install -g vsce
+```
+
+Install dependencies within the directory of this repository
+
+```sh
+npm install
+```
+
+Use the following command each time you made some changes and want to apply them and install the extension
+
+```sh
+rm -rf ./ultra-cpp-*.vsix && vsce package && code --install-extension ultra-cpp-*.vsix
+```
+
+You will also need to restart the VSCode window to reload the extension after executing the above command. Otherwise the source code changes will not be reflected. To do this, use `Ctrl + Shift + P` to open command palette and type `>Reload Window`.

package.json

@@ -6,7 +6,7 @@
     "repository": {
         "url": "https://github.com/ultraio/ultra-cpp-extension"
     },
-    "version": "1.4.1",
+    "version": "1.4.2",
     "engines": {
         "vscode": "^1.70.0"
     },

src/commands/apiFlows/getCurrencyBalance.ts

@@ -16,7 +16,7 @@ const multiQuery = [
     {
         property: 'code',
         inputOptions: {
-            title: 'Contract Name',
+            title: 'Contract Account Name',
             value: 'eosio.token',
             placeHolder: 'Name of the contract',
         },

src/commands/apiFlows/getTable.ts

@@ -8,9 +8,9 @@ const multiQuery = [
     {
         property: 'code',
         inputOptions: {
-            title: 'Contract Name',
+            title: 'Contract Account Name',
             value: '',
-            placeHolder: 'Name of the contract the table belongs to',
+            placeHolder: 'Name of the contract account the table belongs to',
         },
     },
     {

src/commands/transact.ts

@@ -1,6 +1,7 @@
 import * as vscode from 'vscode';
 import * as Service from '../service/index';
 import * as Utility from '../utility/index';
+import { API } from '@ultraos/ultra-signer-lib';
 
 async function register() {
     const disposable = vscode.commands.registerCommand(Service.command.commandNames.transact, async () => {
@@ -9,14 +10,22 @@ async function register() {
             return;
         }
 
-        const api = await Service.api.getSignable();
+        const endpoint = await Service.api.pick();
+        if (!endpoint) {
+            return;
+        }
+
+        const api = await Service.api.getSignable(endpoint).catch((err) => {
+            console.log(err);
+            return undefined;
+        });
         if (!api) {
             vscode.window.showErrorMessage('Could not create signable API. Wrong password? Bad endpoint?');
             return;
         }
 
         const contract = await Utility.quickInput.create({
-            title: 'Contract Name',
+            title: 'Contract Account Name',
             placeHolder: 'eosio.token',
             value: '',
         });
@@ -25,7 +34,7 @@ async function register() {
             return;
         }
 
-        const ultraApi = await Service.api.getUltraApi().catch((err) => {
+        const ultraApi = await Service.api.getUltraApi(endpoint).catch((err) => {
             console.log(err);
             return undefined;
         });
@@ -40,8 +49,8 @@ async function register() {
             return undefined;
         });
 
-        if (!result || !result.abi) {
-            vscode.window.showErrorMessage(`Contract '${contract}' does not have a contract set`);
+        if (!result || !result.abi) { 
+            vscode.window.showErrorMessage(`Account '${contract}' does not have a contract set`);
             return;
         }
 
@@ -76,15 +85,40 @@ async function register() {
             return;
         }
 
-        // Ask for Signer
-        const signer = await Utility.quickInput.create({
-            title: 'Who is signing?',
-            placeHolder: 'myacc@active',
-            value: '',
-        });
+        let actor: string = '', permission: string = '';
 
-        if (!signer) {
-            return;
+        while (actor.length <= 0) {
+            // Ask for Signer
+            const signer = await Utility.quickInput.create({
+                title: 'Who is signing?',
+                placeHolder: 'myacc@active',
+                value: '',
+            });
+
+            if (!signer) {
+                return;
+            }
+
+            [actor, permission] = signer.split('@');
+
+            if (!permission) {
+                permission = 'active';
+            }
+
+            try {
+                // Ensure this account can be signed as
+                const testTrx = await api.buildTransaction([{
+                    account: 'eosio.token',
+                    name: 'transfer',
+                    authorization: [{ actor, permission }],
+                    data: {from: actor, to: actor, quantity: '0.00000000 UOS', memo: ''}
+                }]);
+                const signature = await api.signTransaction(testTrx);
+            } catch (err) {
+                console.log(err);
+                vscode.window.showErrorMessage(`Was not able to sign as ${signer}.`);
+                actor = '';
+            }
         }
 
         let formData: any;
@@ -99,11 +133,6 @@ async function register() {
             return;
         }
 
-        let [actor, permission] = signer.split('@');
-        if (!permission) {
-            permission = 'active';
-        }
-
         const outputChannel = Utility.outputChannel.get();
         const transactionResult = await api
             .transact(

src/service/api.ts

@@ -71,17 +71,17 @@ export async function pick(): Promise<string | undefined> {
     return api;
 }
 
-export async function getUltraApi(): Promise<UltraAPI | undefined> {
-    const endpoint = await pick();
+export async function getUltraApi(customEndpoint?: string): Promise<UltraAPI | undefined> {
+    const endpoint = customEndpoint ? customEndpoint : await pick();
     if (!endpoint) {
         return undefined;
     }
 
     return connect(endpoint);
 }
 
-export async function getSignable(): Promise<API | undefined> {
-    const endpoint = await pick();
+export async function getSignable(customEndpoint?: string): Promise<API | undefined> {
+    const endpoint = customEndpoint ? customEndpoint : await pick();
     if (!endpoint) {
         return undefined;
     }