bond extra reference

bond extra reference

Author: kieranbopbd

dot-staking/fireblocks/nodejs/README.md

@@ -43,12 +43,17 @@ npm install
 ```
 This will install all required packages, including the Fireblocks SDK and Blockdaemon's API interaction tools.
 
-### Step 3. Launch example.ts to generate the Stake Intent request, sign the request with Fireblocks, and broadcast the transaction
+### Step 3. To perform a polkadot stake intent then run.
 ```shell
-npm run example
+npm run stake
 ```
+This will create the transaction to create a proxy on your account to Blockdaemons where we nominate on your behalf.
 
-This will:
+### Step 4. To perform a bond extra 
+```shell
+npm run bond
+```
+This will then bond extra funds to your already nominated pool.
 
 Generate a Stake Intent request to initiate staking.
 Use Fireblocks to sign the transaction.

dot-staking/fireblocks/nodejs/api.ts

@@ -13,6 +13,16 @@ export type StakeIntentResponse = {
     stake_intent_id: string;
 };
 
+export type BondExtraResponse = {
+    network: string;
+    polkadot: {
+        customer_address: string;
+        amount: string;
+        unsigned_transaction: string;
+    };
+    protocol: string;
+}
+
 export type DeriveTransactionResponse = {
     signing_payload: string;
     unsigned_tx: string;
@@ -27,6 +37,11 @@ export type StakeIntentRequest = {
     customer_address: string;
 };
 
+export type BondExtraRequest = {
+    customer_address: string;
+    amount: string;
+};
+
 export type PrepareTransactionRequest = {
     sender_address: string;
     unsigned_tx: string;
@@ -62,6 +77,29 @@ export async function fetchUnsignedTransaction(delegatorAddress: string): Promis
     return (await response.json()) as StakeIntentResponse;
 }
 
+// Fetch Bond Extra
+export async function fetchBondExtraTransaction(delegatorAddress: string, amount: string): Promise<BondExtraResponse> {
+    const requestBody: BondExtraRequest = { customer_address: delegatorAddress, amount: amount };
+    const response = await fetch(
+        `https://svc.blockdaemon.com/boss/v1/polkadot/${process.env.POLKADOT_NETWORK}/bond-extra`,
+        {
+            method: "POST",
+            headers: {
+                "Content-Type": "application/json",
+                Accept: "application/json",
+                "X-API-Key": process.env.BLOCKDAEMON_STAKE_API_KEY!,
+            },
+            body: JSON.stringify(requestBody),
+        }
+    );
+
+    if (response.status !== 200) {
+        throw new Error(`Blockdaemon API Error: ${JSON.stringify(await response.json())}`);
+    }
+
+    return (await response.json()) as BondExtraResponse;
+}
+
 // Prepare Transaction
 export async function prepareTransaction(unsignedTx: string, address: string, compileAndSendUrl: string): Promise<DeriveTransactionResponse> {
     const requestBody: PrepareTransactionRequest = {

dot-staking/fireblocks/nodejs/bond.ts

@@ -0,0 +1,73 @@
+import "dotenv/config";
+import {getFireblocksInformation, getFireblocksSignature} from "./fireblocks";
+import {
+    BondExtraResponse,
+    DeriveTransactionResponse,
+    fetchBondExtraTransaction,
+    fetchUnsignedTransaction,
+    prepareTransaction,
+    StakeIntentResponse
+} from "./api";
+import {compileAndSend} from "./api";
+import {CompileAndSendResponse} from "./api";
+
+
+function checkRequiredEnvVars() {
+    const requiredVars = [
+        'BLOCKDAEMON_STAKE_API_KEY', 'POLKADOT_NETWORK', 'FIREBLOCKS_BASE_PATH',
+        'FIREBLOCKS_API_KEY', 'FIREBLOCKS_SECRET_KEY', 'FIREBLOCKS_VAULT_ACCOUNT_ID', 'BLOCKDAEMON_API_KEY'
+    ];
+
+    requiredVars.forEach(varName => {
+        if (!process.env[varName]) {
+            throw new Error(`${varName} environment variable not set`);
+        }
+    });
+}
+
+// Determine the configuration for mainnet or testnet
+function getConfigForNetwork() {
+    const network = process.env.POLKADOT_NETWORK?.toLowerCase();
+    const isTestnet = network === 'westend';
+
+    return {
+        assetID: isTestnet ? "WND" : "DOT",
+        stakeApiUrl: isTestnet
+            ? 'https://svc.blockdaemon.com/boss/v1/polkadot/westend/bond-extra'
+            : 'https://svc.blockdaemon.com/boss/v1/polkadot/mainnet/bond-extra',
+        compileAndSendUrl: isTestnet
+            ? 'https://svc.blockdaemon.com/tx/v1/polkadot-westend/compile_and_send'
+            : 'https://svc.blockdaemon.com/tx/v1/polkadot-mainnet/compile_and_send',
+        deriveApiUrl: isTestnet
+            ? 'https://svc.blockdaemon.com/tx/v1/polkadot-westend/derive_signing_payload'
+            : 'https://svc.blockdaemon.com/tx/v1/polkadot-mainnet/derive_signing_payload'
+    };
+}
+
+async function main() {
+    checkRequiredEnvVars()
+    const config = getConfigForNetwork()
+
+    const {address: sender, fireblocks} = await getFireblocksInformation(config.assetID);
+    const amount = "1000000000000" //This is 1 DOT & the minimum
+
+    //Call the Staking API to get your unsigned transaction
+    const apiResponse: BondExtraResponse = await fetchBondExtraTransaction(sender, amount);
+    console.log("Blockdaemon Staking API Response::", apiResponse);
+
+    //Call our tx lifecycle API to derive the payload to send to fireblocks
+    const deriveTransactionResponse: DeriveTransactionResponse = await prepareTransaction(apiResponse.polkadot.unsigned_transaction, apiResponse.polkadot.customer_address, config.deriveApiUrl)
+
+    //Call and sign the transaction in fireblocks
+    const {signature, pubKey} = await getFireblocksSignature(
+        fireblocks,
+        process.env.FIREBLOCKS_VAULT_ACCOUNT_ID!,
+        "WND",
+        deriveTransactionResponse.signing_payload
+    );
+
+    //Take the signature, pubkey and unsigned transaction and broadcast to the network
+    await compileAndSend(deriveTransactionResponse.unsigned_tx, signature, pubKey, config.compileAndSendUrl);
+}
+
+main().catch(console.error);

dot-staking/fireblocks/nodejs/package.json

@@ -10,7 +10,8 @@
   "type": "module",
   "scripts": {
     "start": "node --no-warnings=ExperimentalWarning --loader ts-node/esm",
-    "example": "node --loader ts-node/esm example.ts"
+    "stake": "node --loader ts-node/esm stake.ts",
+    "bond": "node --loader ts-node/esm bond.ts"
   },
   "exclude": ["node_modules"]
 }