Merge pull request #664 from peterslany/peter/feat-runtime-upgrade-1.25

peterslany · web-flow · commit 76f8b9b1c867 · 2023-08-04T15:59:16.000+02:00
feat: handle runtime upgrade 1.25
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -1,7 +1,7 @@
 version: "3.8"
 services:
     interbtc:
-        image: "interlayhq/interbtc:1.24.0-rc2"
+        image: "interlayhq/interbtc:1.25.0-rc5"
         command:
             - --rpc-external
             - --ws-external
@@ -54,19 +54,19 @@ services:
             - "3002:3002"
         restart: always
     oracle:
-        image: "interlayhq/interbtc-clients:oracle-parachain-metadata-kintsugi-testnet-1.22.0"
+        image: "interlayhq/interbtc-clients:oracle-parachain-metadata-kintsugi-1.23.0-rc3"
         command:
-            - oracle-parachain-metadata-kintsugi-testnet
+            - oracle-parachain-metadata-kintsugi
             - --keyring=bob
             - --btc-parachain-url=ws://interbtc:9944
         environment:
             RUST_LOG: info
         volumes:
             - ./docker/oracle-config.json:/oracle-config.json
     vault_1:
-        image: "interlayhq/interbtc-clients:vault-parachain-metadata-kintsugi-testnet-1.22.0"
+        image: "interlayhq/interbtc-clients:vault-parachain-metadata-kintsugi-1.23.0-rc3"
         command:
-            - vault-parachain-metadata-kintsugi-testnet
+            - vault-parachain-metadata-kintsugi
             - --keyfile=/keyfile.json
             - --keyname=vault_1
             - --auto-register=KSM=10000000000000
@@ -81,9 +81,9 @@ services:
         volumes:
             - ./docker/vault_1-keyfile.json:/keyfile.json
     vault_2:
-        image: "interlayhq/interbtc-clients:vault-parachain-metadata-kintsugi-testnet-1.22.0"
+        image: "interlayhq/interbtc-clients:vault-parachain-metadata-kintsugi-1.23.0-rc3"
         command:
-            - vault-parachain-metadata-kintsugi-testnet
+            - vault-parachain-metadata-kintsugi
             - --keyfile=/keyfile.json
             - --keyname=vault_2
             - --auto-register=KSM=10000000000000
@@ -94,9 +94,9 @@ services:
         volumes:
             - ./docker/vault_2-keyfile.json:/keyfile.json
     vault_3:
-        image: "interlayhq/interbtc-clients:vault-parachain-metadata-kintsugi-testnet-1.22.0"
+        image: "interlayhq/interbtc-clients:vault-parachain-metadata-kintsugi-1.23.0-rc3"
         command:
-            - vault-parachain-metadata-kintsugi-testnet
+            - vault-parachain-metadata-kintsugi
             - --keyfile=/keyfile.json
             - --keyname=vault_3
             - --auto-register=KSM=10000000000000
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@interlay/interbtc-api",
-  "version": "2.3.7",
+  "version": "2.4.0",
   "description": "JavaScript library to interact with interBTC",
   "main": "build/src/index.js",
   "typings": "build/src/index.d.ts",
diff --git a/src/external/electrs.ts b/src/external/electrs.ts
@@ -129,6 +129,13 @@ export interface ElectrsAPI {
      * @returns A tuple representing [merkleProof, transaction]
      */
     getParsedExecutionParameters(txid: string): Promise<[BitcoinMerkleProof, BitcoinTransaction]>;
+    /**
+     * Returns tx id of the coinbase tx of block in which `userTxId` was included.
+     *
+     * @param userTxId User tx ID which block's txId will be returned.
+     * @returns {string} Tx ID of coinbase transaction or undefined if block was not found.
+     */
+    getCoinbaseTxId(userTxId: string): Promise<string | undefined>;
     /**
      * Return a promise that either resolves to the first txid with the given opreturn `data`,
      * or rejects if the `timeout` has elapsed.
@@ -422,6 +429,16 @@ export class DefaultElectrsAPI implements ElectrsAPI {
         return this.getData(this.txApi.getTxHex(txid));
     }
 
+    async getCoinbaseTxId(userTxId: string): Promise<string | undefined> {
+        const blockHash = (await this.getTxStatus(userTxId)).block_hash;
+
+        if (blockHash === undefined) {
+            return undefined;
+        }
+
+        return this.getData(this.blockApi.getBlockTxByIndex(blockHash, 0));
+    }
+
     /**
      * Use the TxAPI to get the confirmationation
      * @param txid The ID of a Bitcoin transaction
diff --git a/src/json/parachain.json b/src/json/parachain.json
diff --git a/src/parachain/index.ts b/src/parachain/index.ts
@@ -18,4 +18,4 @@ export * from "./transaction";
 export * from "./amm/";
 
 // Hacky way of forcing the resolution of these types in test files
-export { InterbtcPrimitivesVaultId, VaultRegistryVault, SecurityStatusCode, LoansMarket } from "@polkadot/types/lookup";
+export { InterbtcPrimitivesVaultId, VaultRegistryVault, LoansMarket } from "@polkadot/types/lookup";
diff --git a/src/parachain/issue.ts b/src/parachain/issue.ts
@@ -283,13 +283,8 @@ export class DefaultIssueAPI implements IssueAPI {
         btcTxId: string
     ): Promise<SubmittableExtrinsic<"promise", ISubmittableResult>> {
         const parsedRequestId = ensureHashEncoded(this.api, requestId);
-        const txInclusionDetails = await getTxProof(this.electrsAPI, btcTxId);
-        return this.api.tx.issue.executeIssue(
-            parsedRequestId,
-            txInclusionDetails.merkleProof,
-            txInclusionDetails.transaction,
-            txInclusionDetails.lengthBound
-        );
+        const fullTxProof = await getTxProof(this.electrsAPI, btcTxId);
+        return this.api.tx.issue.executeIssue(parsedRequestId, fullTxProof);
     }
 
     async execute(requestId: string, btcTxId: string): Promise<ExtrinsicData> {
diff --git a/src/parachain/oracle.ts b/src/parachain/oracle.ts
@@ -3,7 +3,7 @@ import { Option, Bool } from "@polkadot/types";
 import { Moment } from "@polkadot/types/interfaces";
 import Big from "big.js";
 import { Bitcoin, ExchangeRate, MonetaryAmount } from "@interlay/monetary-js";
-import { SecurityErrorCode, InterbtcPrimitivesOracleKey } from "@polkadot/types/lookup";
+import { InterbtcPrimitivesOracleKey } from "@polkadot/types/lookup";
 
 import {
     ATOMIC_UNIT,
@@ -49,9 +49,10 @@ export interface OracleAPI {
      */
     getSourcesById(): Promise<Map<string, string>>;
     /**
-     * @returns Boolean value indicating whether the oracle is online
+     * @returns Boolean value indicating whether the oracle is online for currency
+     * @param currency Currency for which we check status of oracle.
      */
-    isOnline(): Promise<boolean>;
+    isOnline(currency: CurrencyExt): Promise<boolean>;
     /**
      * Create a transaction to set the exchange rate between Bitcoin and a collateral currency
      * @param exchangeRate The rate to set
@@ -208,22 +209,16 @@ export class DefaultOracleAPI implements OracleAPI {
         return validUntil.isSome ? convertMoment(validUntil.value as Moment) : Promise.reject("No such oracle key");
     }
 
-    async isOnline(): Promise<boolean> {
-        const errors = await this.api.query.security.errors();
-        return !this.hasOracleError(Array.from(errors));
+    async isOnline(currency: CurrencyExt): Promise<boolean> {
+        const oracleKey = createExchangeRateOracleKey(this.api, currency);
+        const value = await this.api.query.oracle.aggregate(oracleKey);
+
+        // If the oracle has value then it is active for the given currency.
+        return value.isSome;
     }
 
     async getRawValuesUpdated(key: InterbtcPrimitivesOracleKey): Promise<boolean> {
         const isSet = await this.api.query.oracle.rawValuesUpdated<Option<Bool>>(key);
         return isSet.unwrap().isTrue;
     }
-
-    private hasOracleError(errors: SecurityErrorCode[]): boolean {
-        for (const error of errors.values()) {
-            if (error.isOracleOffline) {
-                return true;
-            }
-        }
-        return false;
-    }
 }
diff --git a/src/parachain/redeem.ts b/src/parachain/redeem.ts
@@ -224,7 +224,7 @@ export class DefaultRedeemAPI implements RedeemAPI {
         private oracleAPI: OracleAPI,
         private transactionAPI: TransactionAPI,
         private systemAPI: SystemAPI
-    ) { }
+    ) {}
 
     async request(
         amount: MonetaryAmount<WrappedCurrency>,
@@ -280,13 +280,8 @@ export class DefaultRedeemAPI implements RedeemAPI {
         btcTxId: string
     ): Promise<SubmittableExtrinsic<"promise", ISubmittableResult>> {
         const parsedRequestId = ensureHashEncoded(this.api, redeemId);
-        const txInclusionDetails = await getTxProof(this.electrsAPI, btcTxId);
-        return this.api.tx.redeem.executeRedeem(
-            parsedRequestId,
-            txInclusionDetails.merkleProof,
-            txInclusionDetails.transaction,
-            txInclusionDetails.lengthBound,
-        );
+        const fullTxProof = await getTxProof(this.electrsAPI, btcTxId);
+        return this.api.tx.redeem.executeRedeem(parsedRequestId, fullTxProof);
     }
 
     async execute(requestId: string, btcTxId: string): Promise<ExtrinsicData> {
@@ -333,9 +328,10 @@ export class DefaultRedeemAPI implements RedeemAPI {
     }
 
     async getMaxBurnableTokens(collateralCurrency: CollateralCurrencyExt): Promise<MonetaryAmount<WrappedCurrency>> {
-        const liquidationVault: SystemVaultExt | null = await this.vaultsAPI.getLiquidationVault(collateralCurrency)
-            // method rejects if no vault was found, wrap as null    
-            .catch((reason) => (reason === NO_LIQUIDATION_VAULT_FOUND_REJECTION) ? null : Promise.reject(reason));
+        const liquidationVault: SystemVaultExt | null = await this.vaultsAPI
+            .getLiquidationVault(collateralCurrency)
+            // method rejects if no vault was found, wrap as null
+            .catch((reason) => (reason === NO_LIQUIDATION_VAULT_FOUND_REJECTION ? null : Promise.reject(reason)));
 
         if (liquidationVault === null) {
             // no liquidation vault exists, therefore, no burnable tokens)
diff --git a/src/parachain/replace.ts b/src/parachain/replace.ts
@@ -156,7 +156,7 @@ export class DefaultReplaceAPI implements ReplaceAPI {
         private btcNetwork: Network,
         private electrsAPI: ElectrsAPI,
         private wrappedCurrency: WrappedCurrency
-    ) { }
+    ) {}
 
     buildRequestReplaceExtrinsic(
         amount: MonetaryAmount<WrappedCurrency>,
@@ -221,13 +221,8 @@ export class DefaultReplaceAPI implements ReplaceAPI {
         btcTxId: string
     ): Promise<SubmittableExtrinsic<"promise", ISubmittableResult>> {
         const parsedRequestId = ensureHashEncoded(this.api, requestId);
-        const txInclusionDetails = await getTxProof(this.electrsAPI, btcTxId);
-        return this.api.tx.replace.executeReplace(
-            parsedRequestId,
-            txInclusionDetails.merkleProof,
-            txInclusionDetails.transaction,
-            txInclusionDetails.lengthBound,
-        );
+        const fullTxProof = await getTxProof(this.electrsAPI, btcTxId);
+        return this.api.tx.replace.executeReplace(parsedRequestId, fullTxProof);
     }
 
     async execute(requestId: string, btcTxId: string): Promise<ExtrinsicData> {
diff --git a/src/parachain/system.ts b/src/parachain/system.ts
@@ -1,6 +1,5 @@
 import { ApiPromise } from "@polkadot/api";
 import { Header, BlockHash } from "@polkadot/types/interfaces";
-import { SecurityStatusCode } from "@polkadot/types/lookup";
 import { ExtrinsicData } from "../types";
 import { BLOCK_TIME_SECONDS } from "../utils";
 
@@ -30,10 +29,6 @@ export interface SystemAPI {
      */
     subscribeToCurrentBlockHeads(callback: (blockHeader: Header) => void): Promise<() => void>;
 
-    /**
-     * @returns The parachain status code object.
-     */
-    getStatusCode(): Promise<SecurityStatusCode>;
     /**
      * @remarks Upgrades runtime using `sudoUncheckedWeight`
      * @param code Hex-encoded wasm blob
@@ -85,10 +80,6 @@ export class DefaultSystemAPI implements SystemAPI {
         return unsub;
     }
 
-    async getStatusCode(): Promise<SecurityStatusCode> {
-        return await this.api.query.security.parachainStatus();
-    }
-
     setCode(code: string): ExtrinsicData {
         const tx = this.api.tx.sudo.sudoUncheckedWeight(this.api.tx.system.setCode(code), "0");
         return { extrinsic: tx, event: this.api.events.system.CodeUpdated };
diff --git a/src/utils/bitcoin.ts b/src/utils/bitcoin.ts
@@ -5,7 +5,6 @@ import { H160 } from "@polkadot/types/interfaces";
 import { BitcoinAddress } from "@polkadot/types/lookup";
 import { TypeRegistry } from "@polkadot/types";
 
-import { ElectrsAPI } from "../external";
 import { BTCRelayAPI } from "../parachain";
 import {
     sleep,
@@ -25,6 +24,9 @@ import {
     TransactionOutput,
 } from "../types";
 
+import { Transaction as BitcoinTransaction } from "bitcoinjs-lib";
+import { ElectrsAPI } from "../external";
+
 export function encodeBtcAddress(address: BitcoinAddress, network: Network): string {
     let btcAddress: string | undefined;
     try {
@@ -137,15 +139,13 @@ const parseLockTime = (locktime: number): TransactionLocktime => {
     return { time: locktime };
 };
 
-export async function getTxProof(
-    electrsAPI: ElectrsAPI,
-    btcTxId: string
-): Promise<{
+interface PartialTxProof {
     merkleProof: MerkleProof;
     transaction: Transaction;
-    lengthBound: number;
-}> {
-    const [proof, tx] = await electrsAPI.getParsedExecutionParameters(btcTxId);
+    txEncodedLen: number;
+}
+
+function getPartialTxProof(proof: BitcoinMerkleProof, tx: BitcoinTransaction): PartialTxProof {
     if (proof.blockHeader.merkleRoot === undefined) {
         throw new Error("Block header data is missing merkle root");
     }
@@ -174,7 +174,34 @@ export async function getTxProof(
             outputs: tx.outs.map(parseTxOutput),
             lockAt: parseLockTime(tx.locktime),
         },
-        lengthBound: tx.byteLength(),
+        txEncodedLen: tx.byteLength(),
+    };
+}
+
+export async function getTxProof(
+    electrsAPI: ElectrsAPI,
+    userTxId: string
+): Promise<{
+    userTxProof: PartialTxProof;
+    coinbaseProof: PartialTxProof;
+}> {
+    const coinbaseTxId = await electrsAPI.getCoinbaseTxId(userTxId);
+
+    if (coinbaseTxId === undefined) {
+        throw new Error(`Coinbase txid not found for transaction ${userTxId}`);
+    }
+
+    const [userTxParams, coinbaseTxParams] = await Promise.all([
+        electrsAPI.getParsedExecutionParameters(userTxId),
+        electrsAPI.getParsedExecutionParameters(coinbaseTxId),
+    ]);
+
+    const userTxPartialProof = getPartialTxProof(userTxParams[0], userTxParams[1]);
+    const coinbaseTxPartialProof = getPartialTxProof(coinbaseTxParams[0], coinbaseTxParams[1]);
+
+    return {
+        userTxProof: userTxPartialProof,
+        coinbaseProof: coinbaseTxPartialProof,
     };
 }
 
diff --git a/test/integration/parachain/staging/fee.test.ts b/test/integration/parachain/staging/fee.test.ts
@@ -42,7 +42,7 @@ describe("fee", () => {
         const nativeCurrency = oracleInterBtcAPI.getGovernanceCurrency();
 
         await callWithExchangeRate(sudoInterBtcAPI, nativeCurrency, exchangeRateValue, async () => {
-            const amountBtc = newMonetaryAmount(0.001, wrappedCurrency, true);
+            const amountBtc = newMonetaryAmount(0.00001, wrappedCurrency, true);
             const griefingCollateral = await oracleInterBtcAPI.fee.getGriefingCollateral(
                 amountBtc,
                 GriefingCollateralType.Issue
diff --git a/test/integration/parachain/staging/sequential/oracle.test.ts b/test/integration/parachain/staging/sequential/oracle.test.ts
@@ -5,7 +5,13 @@ import { Bitcoin, BitcoinAmount, ExchangeRate } from "@interlay/monetary-js";
 import { createSubstrateAPI } from "../../../../../src/factory";
 import { assert } from "../../../../chai";
 import { ESPLORA_BASE_PATH, ORACLE_URI, PARACHAIN_ENDPOINT } from "../../../../config";
-import { CollateralCurrencyExt, DefaultInterBtcApi, getSS58Prefix, InterBtcApi } from "../../../../../src";
+import {
+    CollateralCurrencyExt,
+    DefaultInterBtcApi,
+    getSS58Prefix,
+    InterBtcApi,
+    tokenSymbolToCurrency,
+} from "../../../../../src";
 import {
     getCorrespondingCollateralCurrenciesForTests,
     getExchangeRateValueToSetForTesting,
@@ -99,7 +105,10 @@ describe("OracleAPI", () => {
     });
 
     it("should be online", async () => {
-        const isOnline = await interBtcAPI.oracle.isOnline();
+        const relayChainCurrencyId = api.consts.currency.getRelayChainCurrencyId;
+        const relayChainCurrency = tokenSymbolToCurrency(relayChainCurrencyId.asToken);
+
+        const isOnline = await interBtcAPI.oracle.isOnline(relayChainCurrency);
         assert.isTrue(isOnline);
     });
 });
diff --git a/test/integration/parachain/staging/setup/initialize.test.ts b/test/integration/parachain/staging/setup/initialize.test.ts
diff --git a/test/integration/parachain/staging/system.test.ts b/test/integration/parachain/staging/system.test.ts
diff --git a/test/unit/utils/bitcoin.test.ts b/test/unit/utils/bitcoin.test.ts

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@interlay/interbtc-api",`
`3`		`- "version": "2.3.7",`
	`3`	`+ "version": "2.4.0",`
`4`	`4`	`"description": "JavaScript library to interact with interBTC",`
`5`	`5`	`"main": "build/src/index.js",`
`6`	`6`	`"typings": "build/src/index.d.ts",`