@cityofzion/bs-neo-legacy 1.9.1 → 1.10.0

package/dist/constants/BSNeoLegacyConstants.d.ts

@@ -18,4 +18,7 @@ export declare class BSNeoLegacyConstants {
     static ALL_NETWORKS: Network<BSNeoLegacyNetworkId>[];
     static DEFAULT_BIP44_DERIVATION_PATH: string;
     static DEFAULT_NETWORK: Network<BSNeoLegacyNetworkId>;
+    static readonly MIGRATION_NEO3_COZ_ADDRESS = "AaT27thuyPaqERPwERhk7QhfKrbj4xoyAV";
+    static readonly MIGRATION_NEO3_COZ_FEE = 0.01;
+    static readonly MIGRATION_NEO3_NEP_17_TRANSFER_FEE = 0.0112143;
 }

package/dist/constants/BSNeoLegacyConstants.js

@@ -58,3 +58,6 @@ BSNeoLegacyConstants.TESTNET_NETWORKS = [
 BSNeoLegacyConstants.ALL_NETWORKS = [..._a.MAINNET_NETWORKS, ..._a.TESTNET_NETWORKS];
 BSNeoLegacyConstants.DEFAULT_BIP44_DERIVATION_PATH = "m/44'/888'/0'/0/?";
 BSNeoLegacyConstants.DEFAULT_NETWORK = _a.MAINNET_NETWORKS[0];
+BSNeoLegacyConstants.MIGRATION_NEO3_COZ_ADDRESS = 'AaT27thuyPaqERPwERhk7QhfKrbj4xoyAV';
+BSNeoLegacyConstants.MIGRATION_NEO3_COZ_FEE = 0.01; // 1%
+BSNeoLegacyConstants.MIGRATION_NEO3_NEP_17_TRANSFER_FEE = 0.0112143;

package/dist/services/BSNeoLegacy.d.ts

@@ -1,8 +1,11 @@
-import { Account, BDSClaimable, BlockchainDataService, BlockchainService, BSClaimable, ExchangeDataService, Token, Network, TransferParam, BSWithExplorerService, ExplorerService, BSWithLedger, GetLedgerTransport } from '@cityofzion/blockchain-service';
+import { Account, BDSClaimable, BlockchainDataService, BlockchainService, BSClaimable, ExchangeDataService, Token, Network, TransferParam, BSWithExplorerService, ExplorerService, BSWithLedger, GetLedgerTransport, BSMigrationNeo3, MigrateToNeo3Params, CalculateToMigrateToNeo3ValuesResponse, CalculateToMigrateToNeo3ValuesParams } from '@cityofzion/blockchain-service';
 import { BSNeoLegacyNetworkId } from '../constants/BSNeoLegacyConstants';
 import { NeonJsLedgerServiceNeoLegacy } from './ledger/NeonJsLedgerServiceNeoLegacy';
-export declare class BSNeoLegacy<BSName extends string = string> implements BlockchainService<BSName, BSNeoLegacyNetworkId>, BSClaimable<BSName>, BSWithExplorerService, BSWithLedger<BSName> {
+export declare class BSNeoLegacy<BSName extends string = string> implements BlockchainService<BSName, BSNeoLegacyNetworkId>, BSClaimable<BSName>, BSWithExplorerService, BSWithLedger<BSName>, BSMigrationNeo3<BSName> {
     #private;
+    private readonly NATIVE_ASSETS;
+    private readonly GAS_ASSET;
+    private readonly NEO_ASSET;
     readonly name: BSName;
     readonly bip44DerivationPath: string;
     feeToken: Token;
@@ -28,4 +31,10 @@ export declare class BSNeoLegacy<BSName extends string = string> implements Bloc
     encrypt(key: string, password: string): Promise<string>;
     transfer({ intents, senderAccount, tipIntent, ...params }: TransferParam<BSName>): Promise<string[]>;
     claim(account: Account): Promise<string>;
+    /**
+     * Reference: https://github.com/CityOfZion/legacy-n3-swap-service/blob/master/policy/policy.go
+     */
+    calculateToMigrateToNeo3Values(params: CalculateToMigrateToNeo3ValuesParams<BSName>): Promise<CalculateToMigrateToNeo3ValuesResponse>;
+    migrateToNeo3({ account, address }: MigrateToNeo3Params<BSName>): Promise<string[]>;
+    private getMigrationNeo3ValidatedData;
 }

package/dist/services/BSNeoLegacy.js

@@ -27,6 +27,7 @@ var __rest = (this && this.__rest) || function (s, e) {
 var _BSNeoLegacy_instances, _BSNeoLegacy_generateSigningCallback, _BSNeoLegacy_setTokens;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BSNeoLegacy = void 0;
+const blockchain_service_1 = require("@cityofzion/blockchain-service");
 const neon_js_1 = require("@cityofzion/neon-js");
 const bs_asteroid_sdk_1 = require("@cityofzion/bs-asteroid-sdk");
 const BSNeoLegacyConstants_1 = require("../constants/BSNeoLegacyConstants");
@@ -38,6 +39,9 @@ const NeonJsLedgerServiceNeoLegacy_1 = require("./ledger/NeonJsLedgerServiceNeoL
 class BSNeoLegacy {
     constructor(name, network, getLedgerTransport) {
         _BSNeoLegacy_instances.add(this);
+        this.NATIVE_ASSETS = BSNeoLegacyConstants_1.BSNeoLegacyConstants.NATIVE_ASSETS.map(asset => (Object.assign(Object.assign({}, asset), { hash: (0, blockchain_service_1.normalizeHash)(asset.hash) })));
+        this.GAS_ASSET = this.NATIVE_ASSETS.find(({ symbol }) => symbol === 'GAS');
+        this.NEO_ASSET = this.NATIVE_ASSETS.find(({ symbol }) => symbol === 'NEO');
         network = network !== null && network !== void 0 ? network : BSNeoLegacyConstants_1.BSNeoLegacyConstants.DEFAULT_NETWORK;
         this.name = name;
         this.legacyNetwork = BSNeoLegacyConstants_1.BSNeoLegacyConstants.LEGACY_NETWORK_BY_NETWORK_ID[network.id];
@@ -116,7 +120,7 @@ class BSNeoLegacy {
             const concatIntents = [...intents, ...(tipIntent ? [tipIntent] : [])];
             for (const intent of concatIntents) {
                 const tokenHashFixed = BSNeoLegacyHelper_1.BSNeoLegacyHelper.normalizeHash(intent.tokenHash);
-                const nativeAsset = BSNeoLegacyConstants_1.BSNeoLegacyConstants.NATIVE_ASSETS.find(asset => BSNeoLegacyHelper_1.BSNeoLegacyHelper.normalizeHash(asset.hash) === tokenHashFixed);
+                const nativeAsset = this.NATIVE_ASSETS.find(({ hash }) => hash === tokenHashFixed);
                 if (nativeAsset) {
                     nativeIntents.push(...neon_js_1.api.makeIntent({ [nativeAsset.symbol]: Number(intent.amount) }, intent.receiverAddress));
                     continue;
@@ -180,6 +184,86 @@ class BSNeoLegacy {
             return response.tx.hash;
         });
     }
+    /**
+     * Reference: https://github.com/CityOfZion/legacy-n3-swap-service/blob/master/policy/policy.go
+     */
+    calculateToMigrateToNeo3Values(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { gasAmountNumber, neoAmountNumber } = yield this.getMigrationNeo3ValidatedData(params);
+            const response = {};
+            if (gasAmountNumber) {
+                // Two transfers fee and one transfer fee left over
+                const allNep17TransfersFee = BSNeoLegacyConstants_1.BSNeoLegacyConstants.MIGRATION_NEO3_NEP_17_TRANSFER_FEE * 3;
+                // Necessary to calculate the COZ fee
+                const gasAmountNumberLessAllNep17TransfersFee = gasAmountNumber - allNep17TransfersFee;
+                // Example: ~0.06635710 * 0.01 = ~0.00066357
+                const cozFee = gasAmountNumberLessAllNep17TransfersFee * BSNeoLegacyConstants_1.BSNeoLegacyConstants.MIGRATION_NEO3_COZ_FEE;
+                // Example: ~0.06635710 - ~0.00066357 = ~0.06569352
+                const gasAmountNumberLessCozFee = gasAmountNumberLessAllNep17TransfersFee - cozFee;
+                const allGasFeeNumberThatUserWillPay = cozFee + BSNeoLegacyConstants_1.BSNeoLegacyConstants.MIGRATION_NEO3_NEP_17_TRANSFER_FEE * 2;
+                const allGasAmountNumberThatUserWillReceive = gasAmountNumberLessCozFee + BSNeoLegacyConstants_1.BSNeoLegacyConstants.MIGRATION_NEO3_NEP_17_TRANSFER_FEE;
+                response.gasMigrationTotalFees = (0, blockchain_service_1.formatNumber)(allGasFeeNumberThatUserWillPay, this.GAS_ASSET.decimals);
+                response.gasMigrationAmount = (0, blockchain_service_1.formatNumber)(allGasAmountNumberThatUserWillReceive, this.GAS_ASSET.decimals);
+            }
+            if (neoAmountNumber) {
+                response.neoMigrationTotalFees = (0, blockchain_service_1.formatNumber)(Math.ceil(neoAmountNumber * BSNeoLegacyConstants_1.BSNeoLegacyConstants.MIGRATION_NEO3_COZ_FEE), this.NEO_ASSET.decimals);
+                response.neoMigrationAmount = (0, blockchain_service_1.formatNumber)(neoAmountNumber - Number(response.neoMigrationTotalFees), this.NEO_ASSET.decimals);
+            }
+            return response;
+        });
+    }
+    migrateToNeo3({ account, address }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!address)
+                throw new Error('Must have address');
+            const { gasAmountNumber, neoAmountNumber } = yield this.getMigrationNeo3ValidatedData({ account });
+            const { neonJsAccount, signingCallback } = yield __classPrivateFieldGet(this, _BSNeoLegacy_instances, "m", _BSNeoLegacy_generateSigningCallback).call(this, account);
+            const provider = new neon_js_1.api.neoCli.instance(this.network.url);
+            const intents = [];
+            if (gasAmountNumber)
+                intents.push(...neon_js_1.api.makeIntent({ [this.GAS_ASSET.symbol]: gasAmountNumber }, BSNeoLegacyConstants_1.BSNeoLegacyConstants.MIGRATION_NEO3_COZ_ADDRESS));
+            if (neoAmountNumber)
+                intents.push(...neon_js_1.api.makeIntent({ [this.NEO_ASSET.symbol]: neoAmountNumber }, BSNeoLegacyConstants_1.BSNeoLegacyConstants.MIGRATION_NEO3_COZ_ADDRESS));
+            const response = yield neon_js_1.api.sendAsset({
+                url: this.network.url,
+                api: provider,
+                account: neonJsAccount,
+                intents,
+                fees: 0,
+                signingFunction: signingCallback,
+                override: {
+                    attributes: [
+                        new neon_js_1.tx.TransactionAttribute({
+                            usage: neon_js_1.tx.TxAttrUsage.Remark14,
+                            data: neon_js_1.u.str2hexstring(address),
+                        }),
+                        new neon_js_1.tx.TransactionAttribute({
+                            usage: neon_js_1.tx.TxAttrUsage.Remark15,
+                            data: neon_js_1.u.str2hexstring('Neon Desktop Migration'),
+                        }),
+                    ],
+                },
+            });
+            if (!response.tx)
+                throw new Error('Migration failed on send');
+            return intents.map(() => response.tx.hash);
+        });
+    }
+    getMigrationNeo3ValidatedData({ account }) {
+        var _a, _b;
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!BSNeoLegacyHelper_1.BSNeoLegacyHelper.isMainnet(this.network))
+                throw new Error('Must use Mainnet network');
+            const balances = yield this.blockchainDataService.getBalance(account.address);
+            const gasAmount = (_a = balances.find(({ token }) => (0, blockchain_service_1.normalizeHash)(token.hash) === this.GAS_ASSET.hash)) === null || _a === void 0 ? void 0 : _a.amount;
+            const neoAmount = (_b = balances.find(({ token }) => (0, blockchain_service_1.normalizeHash)(token.hash) === this.NEO_ASSET.hash)) === null || _b === void 0 ? void 0 : _b.amount;
+            const gasAmountNumber = Number(gasAmount) || 0;
+            const neoAmountNumber = Number(neoAmount) || 0;
+            if (gasAmountNumber < 0.1 && neoAmountNumber < 2)
+                throw new Error('Must have at least 0.1 GAS or 2 NEO');
+            return { gasAmountNumber, neoAmountNumber };
+        });
+    }
 }
 exports.BSNeoLegacy = BSNeoLegacy;
 _BSNeoLegacy_instances = new WeakSet(), _BSNeoLegacy_generateSigningCallback = function _BSNeoLegacy_generateSigningCallback(account) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cityofzion/bs-neo-legacy",
-  "version": "1.9.1",
+  "version": "1.10.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "author": "Coz",
@@ -12,7 +12,7 @@
     "@cityofzion/dora-ts": "0.0.11",
     "@cityofzion/neon-js": "4.8.3",
     "@ledgerhq/hw-transport": "~6.30.5",
-    "@cityofzion/blockchain-service": "1.15.1",
+    "@cityofzion/blockchain-service": "1.15.2",
     "@cityofzion/bs-asteroid-sdk": "0.9.0"
   },
   "devDependencies": {