Merge pull request #5212 from BitGo/support-ada-vote-delegation

ryandengBG · web-flow · commit f16689516118 · 2024-12-16T09:00:31.000-05:00
feat(ada): support vote delegation
diff --git a/modules/sdk-coin-ada/src/lib/index.ts b/modules/sdk-coin-ada/src/lib/index.ts
@@ -10,4 +10,5 @@ export { StakingClaimRewardsBuilder } from './stakingClaimRewardsBuilder';
 export { StakingDeactivateBuilder } from './stakingDeactivateBuilder';
 export { StakingWithdrawBuilder } from './stakingWithdrawBuilder';
 export { StakingPledgeBuilder } from './stakingPledgeBuilder';
+export { VoteDelegationBuilder } from './voteDelegationBuilder';
 export { Utils };
diff --git a/modules/sdk-coin-ada/src/lib/stakingActivateBuilder.ts b/modules/sdk-coin-ada/src/lib/stakingActivateBuilder.ts
@@ -3,6 +3,7 @@ import { BaseCoin as CoinConfig } from '@bitgo/statics';
 import { TransactionBuilder } from './transactionBuilder';
 import { Transaction } from './transaction';
 import * as CardanoWasm from '@emurgo/cardano-serialization-lib-nodejs';
+import adaUtils from './utils';
 
 export class StakingActivateBuilder extends TransactionBuilder {
   constructor(_coinConfig: Readonly<CoinConfig>) {
@@ -25,7 +26,7 @@ export class StakingActivateBuilder extends TransactionBuilder {
    * @param stakingPublicKey The user's public stake key
    * @param poolHash Pool ID Hash of the pool we are going to delegate to
    */
-  stakingCredential(stakingPublicKey: string, poolHash: string): this {
+  stakingCredential(stakingPublicKey: string, poolHash: string, dRepId: string): this {
     const stakeCredential = CardanoWasm.Credential.from_keyhash(
       CardanoWasm.PublicKey.from_bytes(Buffer.from(stakingPublicKey, 'hex')).hash()
     );
@@ -40,6 +41,10 @@ export class StakingActivateBuilder extends TransactionBuilder {
       )
     );
     this._certs.push(stakeDelegationCert);
+    const voteDelegationCert = CardanoWasm.Certificate.new_vote_delegation(
+      CardanoWasm.VoteDelegation.new(stakeCredential, adaUtils.getDRepFromDRepId(dRepId))
+    );
+    this._certs.push(voteDelegationCert);
     return this;
   }
 
diff --git a/modules/sdk-coin-ada/src/lib/transaction.ts b/modules/sdk-coin-ada/src/lib/transaction.ts
@@ -9,6 +9,7 @@ import {
 import * as CardanoWasm from '@emurgo/cardano-serialization-lib-nodejs';
 import { KeyPair } from './keyPair';
 import { BaseCoin as CoinConfig } from '@bitgo/statics';
+import adaUtils from './utils';
 
 export interface TransactionInput {
   transaction_id: string;
@@ -31,17 +32,19 @@ export interface Witness {
   publicKey: string;
   signature: string;
 }
-enum CertType {
+export enum CertType {
   StakeKeyRegistration,
   StakeKeyDelegation,
   StakeKeyDeregistration,
   StakePoolRegistration,
+  VoteDelegation,
 }
 
 export interface Cert {
   type: CertType;
   stakeCredentialHash?: string;
   poolKeyHash?: string;
+  dRepId?: string;
 }
 
 export interface Withdrawal {
@@ -183,6 +186,14 @@ export class Transaction extends BaseTransaction {
             poolKeyHash: Buffer.from(stakePoolRegistration.pool_params().operator().to_bytes()).toString('hex'),
           });
         }
+        if (cert.as_vote_delegation() !== undefined) {
+          const voteDelegation = cert.as_vote_delegation() as CardanoWasm.VoteDelegation;
+          result.certs.push({
+            type: CertType.VoteDelegation,
+            stakeCredentialHash: Buffer.from(voteDelegation.stake_credential().to_bytes()).toString('hex'),
+            dRepId: adaUtils.getDRepIdFromDRep(voteDelegation.drep()),
+          });
+        }
       }
     }
 
@@ -279,6 +290,8 @@ export class Transaction extends BaseTransaction {
           this._type = TransactionType.StakingActivate;
         } else if (certs.some((c) => c.as_stake_deregistration() !== undefined)) {
           this._type = TransactionType.StakingDeactivate;
+        } else if (certs.some((c) => c.as_vote_delegation() !== undefined)) {
+          this._type = TransactionType.VoteDelegation;
         }
       }
       if (this._transaction.body().withdrawals()) {
@@ -394,6 +407,8 @@ export class Transaction extends BaseTransaction {
         ? 'StakingDeactivate'
         : this._type === TransactionType.StakingPledge
         ? 'StakingPledge'
+        : this._type === TransactionType.VoteDelegation
+        ? 'VoteDelegation'
         : 'undefined';
     return {
       displayOrder,
diff --git a/modules/sdk-coin-ada/src/lib/transactionBuilderFactory.ts b/modules/sdk-coin-ada/src/lib/transactionBuilderFactory.ts
@@ -9,6 +9,7 @@ import { StakingDeactivateBuilder } from './stakingDeactivateBuilder';
 import { StakingWithdrawBuilder } from './stakingWithdrawBuilder';
 import { StakingPledgeBuilder } from './stakingPledgeBuilder';
 import { StakingClaimRewardsBuilder } from './stakingClaimRewardsBuilder';
+import { VoteDelegationBuilder } from './voteDelegationBuilder';
 
 export class TransactionBuilderFactory extends BaseTransactionBuilderFactory {
   constructor(_coinConfig: Readonly<CoinConfig>) {
@@ -38,6 +39,8 @@ export class TransactionBuilderFactory extends BaseTransactionBuilderFactory {
           return this.getWalletInitializationBuilder(tx);
         case TransactionType.StakingPledge:
           return this.getStakingPledgeBuilder(tx);
+        case TransactionType.VoteDelegation:
+          return this.getVoteDelegationBuilder(tx);
         default:
           throw new InvalidTransactionError('unsupported transaction');
       }
@@ -60,19 +63,23 @@ export class TransactionBuilderFactory extends BaseTransactionBuilderFactory {
     return TransactionBuilderFactory.initializeBuilder(tx, new StakingActivateBuilder(this._coinConfig));
   }
 
-  getStakingClaimRewardsBuilder(tx?: Transaction) {
+  getVoteDelegationBuilder(tx?: Transaction): VoteDelegationBuilder {
+    return TransactionBuilderFactory.initializeBuilder(tx, new VoteDelegationBuilder(this._coinConfig));
+  }
+
+  getStakingClaimRewardsBuilder(tx?: Transaction): StakingClaimRewardsBuilder {
     return TransactionBuilderFactory.initializeBuilder(tx, new StakingClaimRewardsBuilder(this._coinConfig));
   }
 
-  getStakingDeactivateBuilder(tx?: Transaction) {
+  getStakingDeactivateBuilder(tx?: Transaction): StakingDeactivateBuilder {
     return TransactionBuilderFactory.initializeBuilder(tx, new StakingDeactivateBuilder(this._coinConfig));
   }
 
-  getStakingWithdrawBuilder(tx?: Transaction) {
+  getStakingWithdrawBuilder(tx?: Transaction): StakingWithdrawBuilder {
     return TransactionBuilderFactory.initializeBuilder(tx, new StakingWithdrawBuilder(this._coinConfig));
   }
 
-  getStakingPledgeBuilder(tx?: Transaction) {
+  getStakingPledgeBuilder(tx?: Transaction): StakingPledgeBuilder {
     return TransactionBuilderFactory.initializeBuilder(tx, new StakingPledgeBuilder(this._coinConfig));
   }
 
diff --git a/modules/sdk-coin-ada/src/lib/utils.ts b/modules/sdk-coin-ada/src/lib/utils.ts
@@ -7,11 +7,17 @@ import {
   Credential,
   RewardAddress,
   Transaction as CardanoTransaction,
+  DRep,
+  Ed25519KeyHash,
+  ScriptHash,
+  DRepKind,
 } from '@emurgo/cardano-serialization-lib-nodejs';
 import { KeyPair } from './keyPair';
 import { bech32 } from 'bech32';
 
 export const MIN_ADA_FOR_ONE_ASSET = '1500000';
+export const VOTE_ALWAYS_ABSTAIN = 'always-abstain';
+export const VOTE_ALWAYS_NO_CONFIDENCE = 'always-no-confidence';
 
 export class Utils implements BaseUtils {
   createBaseAddressWithStakeAndPaymentKey(
@@ -75,6 +81,65 @@ export class Utils implements BaseUtils {
     return rewardAddress.to_address().to_bech32();
   }
 
+  isValidDRepId(dRepId: string): boolean {
+    try {
+      this.getDRepFromDRepId(dRepId);
+      return true;
+    } catch (err) {
+      return false;
+    }
+  }
+
+  getDRepFromDRepId(dRepId: string): DRep {
+    switch (dRepId) {
+      case 'always-abstain':
+        return DRep.new_always_abstain();
+      case 'always-no-confidence':
+        return DRep.new_always_no_confidence();
+      default:
+        try {
+          // for parsing CIP-105 standard DRep ID
+          return DRep.from_bech32(dRepId);
+        } catch (err) {
+          // for parsing CIP-129 standard DRep ID
+          // https://cips.cardano.org/cip/CIP-0129
+          const decodedBech32 = bech32.decode(dRepId);
+          const decodedBytes = Buffer.from(bech32.fromWords(decodedBech32.words));
+          const header = decodedBytes[0];
+          const keyBytes = decodedBytes.subarray(1);
+
+          const keyType = (header & 0xf0) >> 4;
+          const credentialType = header & 0x0f;
+
+          if (keyType !== 0x02) {
+            throw new Error('Invalid key type for DRep');
+          }
+
+          switch (credentialType) {
+            case 0x02:
+              const ed25519KeyHash = Ed25519KeyHash.from_bytes(keyBytes);
+              return DRep.new_key_hash(ed25519KeyHash);
+            case 0x03:
+              const scriptHash = ScriptHash.from_bytes(keyBytes);
+              return DRep.new_script_hash(scriptHash);
+            default:
+              throw new Error('Invalid credential type for DRep');
+          }
+        }
+    }
+  }
+
+  getDRepIdFromDRep(dRep: DRep): string {
+    switch (dRep.kind()) {
+      case DRepKind.AlwaysAbstain:
+        return VOTE_ALWAYS_ABSTAIN;
+      case DRepKind.AlwaysNoConfidence:
+        return VOTE_ALWAYS_NO_CONFIDENCE;
+      default:
+        return dRep.to_bech32();
+    }
+  }
+
   /** @inheritdoc */
   // this will validate both stake and payment addresses
   isValidAddress(address: string): boolean {
diff --git a/modules/sdk-coin-ada/src/lib/voteDelegationBuilder.ts b/modules/sdk-coin-ada/src/lib/voteDelegationBuilder.ts
@@ -0,0 +1,56 @@
+import { BaseKey, TransactionType } from '@bitgo/sdk-core';
+import { BaseCoin as CoinConfig } from '@bitgo/statics';
+import { TransactionBuilder } from './transactionBuilder';
+import { Transaction } from './transaction';
+import * as CardanoWasm from '@emurgo/cardano-serialization-lib-nodejs';
+import adaUtils from './utils';
+
+export class VoteDelegationBuilder extends TransactionBuilder {
+  constructor(_coinConfig: Readonly<CoinConfig>) {
+    super(_coinConfig);
+    this._type = TransactionType.VoteDelegation;
+  }
+
+  protected get transactionType(): TransactionType {
+    return TransactionType.VoteDelegation;
+  }
+
+  /** @inheritdoc */
+  initBuilder(tx: Transaction): void {
+    super.initBuilder(tx);
+  }
+
+  /**
+   * Creates the proper certificates needed to delegate a user's vote to a given DRep
+   *
+   * @param stakingPublicKey The user's public stake key
+   * @param dRepId The DRep ID of the DRep we will delegate vote to
+   */
+  addVoteDelegationCertificate(stakingPublicKey: string, dRepId: string): this {
+    const stakeCredential = CardanoWasm.Credential.from_keyhash(
+      CardanoWasm.PublicKey.from_bytes(Buffer.from(stakingPublicKey, 'hex')).hash()
+    );
+    const voteDelegationCert = CardanoWasm.Certificate.new_vote_delegation(
+      CardanoWasm.VoteDelegation.new(stakeCredential, adaUtils.getDRepFromDRepId(dRepId))
+    );
+    this._certs.push(voteDelegationCert);
+    return this;
+  }
+
+  /** @inheritdoc */
+  protected async buildImplementation(): Promise<Transaction> {
+    const tx = await super.buildImplementation();
+    tx.setTransactionType(TransactionType.VoteDelegation);
+    return tx;
+  }
+
+  /** @inheritdoc */
+  protected fromImplementation(rawTransaction: string): Transaction {
+    return super.fromImplementation(rawTransaction);
+  }
+
+  /** @inheritdoc */
+  protected signImplementation(key: BaseKey): Transaction {
+    return super.signImplementation(key);
+  }
+}
diff --git a/modules/sdk-coin-ada/test/resources/index.ts b/modules/sdk-coin-ada/test/resources/index.ts
@@ -141,11 +141,16 @@ export const rawTx = {
     address: 'addr_test1vr8rakm66rcfv4fcxqykg5lf0yv7lsyk9mvapx369jpvtcgfcuk7f',
     value: '248329150',
   },
+  unsignedVoteDelegationTx:
+    '84a500818258203677e75c7ba699bfdc6cd57d42f246f86f63aefd76025006ac78313fad2bba2101018182583901c7b28bcea90d440b5455a6a02a27ca59b8696f067fc1967f47f933e79558e969caa9e57adcfc40b9907eb794363b590faf42fff48c38eb881a003a76a7021a00029259031a2faf0800048183098200581c188fde65b1f9bd69b0edcc4e5a65fa93a13773090e1e2eef7a25cfdb8200581c8b75035882d4165bea8000c4d3f2c123ae33c1d92a751a78135a2402a0f5f6',
+  unsignedVoteDelegationTxBody:
+    'a500818258203677e75c7ba699bfdc6cd57d42f246f86f63aefd76025006ac78313fad2bba2101018182583901c7b28bcea90d440b5455a6a02a27ca59b8696f067fc1967f47f933e79558e969caa9e57adcfc40b9907eb794363b590faf42fff48c38eb881a003a76a7021a00029259031a2faf0800048183098200581c188fde65b1f9bd69b0edcc4e5a65fa93a13773090e1e2eef7a25cfdb8200581c8b75035882d4165bea8000c4d3f2c123ae33c1d92a751a78135a2402',
+  unsignedVoteDelegationTxHash: '6e80e3a2a78ee67f2c79070f37c5bde90845b636972a94cb7766af11d8d907db',
   unsignedStakingActiveTx:
-    '84a500818258203677e75c7ba699bfdc6cd57d42f246f86f63aefd76025006ac78313fad2bba2101018182583901c7b28bcea90d440b5455a6a02a27ca59b8696f067fc1967f47f933e79558e969caa9e57adcfc40b9907eb794363b590faf42fff48c38eb881a001beca7021a000297d9031a2faf0800048282008200581c188fde65b1f9bd69b0edcc4e5a65fa93a13773090e1e2eef7a25cfdb83028200581c188fde65b1f9bd69b0edcc4e5a65fa93a13773090e1e2eef7a25cfdb581c7a623c48348501c2380e60ac2307fcd1b67df4218f819930821a15b3a0f5f6',
+    '84a500818258203677e75c7ba699bfdc6cd57d42f246f86f63aefd76025006ac78313fad2bba2101018182583901c7b28bcea90d440b5455a6a02a27ca59b8696f067fc1967f47f933e79558e969caa9e57adcfc40b9907eb794363b590faf42fff48c38eb881a001be677021a00029e09031a2faf0800048382008200581c188fde65b1f9bd69b0edcc4e5a65fa93a13773090e1e2eef7a25cfdb83028200581c188fde65b1f9bd69b0edcc4e5a65fa93a13773090e1e2eef7a25cfdb581c7a623c48348501c2380e60ac2307fcd1b67df4218f819930821a15b383098200581c188fde65b1f9bd69b0edcc4e5a65fa93a13773090e1e2eef7a25cfdb8102a0f5f6',
   unsignedStakingActiveTxBody:
-    'a500818258203677e75c7ba699bfdc6cd57d42f246f86f63aefd76025006ac78313fad2bba2101018182583901c7b28bcea90d440b5455a6a02a27ca59b8696f067fc1967f47f933e79558e969caa9e57adcfc40b9907eb794363b590faf42fff48c38eb881a001beca7021a000297d9031a2faf0800048282008200581c188fde65b1f9bd69b0edcc4e5a65fa93a13773090e1e2eef7a25cfdb83028200581c188fde65b1f9bd69b0edcc4e5a65fa93a13773090e1e2eef7a25cfdb581c7a623c48348501c2380e60ac2307fcd1b67df4218f819930821a15b3',
-  unsignedStakingActiveTxHash: '4e2777152ebc92c73daebc0075cee8a52ca9fb8c00511ac2c035b58c52f27125',
+    'a500818258203677e75c7ba699bfdc6cd57d42f246f86f63aefd76025006ac78313fad2bba2101018182583901c7b28bcea90d440b5455a6a02a27ca59b8696f067fc1967f47f933e79558e969caa9e57adcfc40b9907eb794363b590faf42fff48c38eb881a001be677021a00029e09031a2faf0800048382008200581c188fde65b1f9bd69b0edcc4e5a65fa93a13773090e1e2eef7a25cfdb83028200581c188fde65b1f9bd69b0edcc4e5a65fa93a13773090e1e2eef7a25cfdb581c7a623c48348501c2380e60ac2307fcd1b67df4218f819930821a15b383098200581c188fde65b1f9bd69b0edcc4e5a65fa93a13773090e1e2eef7a25cfdb8102',
+  unsignedStakingActiveTxHash: 'd8ecaa7bfee2e28691673be378ea6583bc8efd5a6e29ca9cfb278279a06dd216',
   unsignedStakingDeactiveTx:
     '84a500818258203677e75c7ba699bfdc6cd57d42f246f86f63aefd76025006ac78313fad2bba2101018182583901c7b28bcea90d440b5455a6a02a27ca59b8696f067fc1967f47f933e79558e969caa9e57adcfc40b9907eb794363b590faf42fff48c38eb881a005900a7021a00028cd9031a2faf0800048182018200581c188fde65b1f9bd69b0edcc4e5a65fa93a13773090e1e2eef7a25cfdba0f5f6',
   unsignedStakingDeactiveTxBody:
diff --git a/modules/sdk-coin-ada/test/unit/StakingActivateBuilder.ts b/modules/sdk-coin-ada/test/unit/StakingActivateBuilder.ts
@@ -3,7 +3,7 @@ import { TransactionType, AddressFormat } from '@bitgo/sdk-core';
 import * as testData from '../resources';
 import { KeyPair, TransactionBuilderFactory } from '../../src';
 import { coins } from '@bitgo/statics';
-import { Transaction } from '../../src/lib/transaction';
+import { CertType, Transaction } from '../../src/lib/transaction';
 import * as Utils from '../../src/lib/utils';
 
 describe('ADA Staking Activate Transaction Builder', async () => {
@@ -21,19 +21,24 @@ describe('ADA Staking Activate Transaction Builder', async () => {
       'addr1q8rm9z7w4yx5gz652kn2q238efvms6t0qelur9nlglun8eu4tr5knj4fu4adelzqhxg8adu5xca4jra0gtllfrpcawyq9psz23',
       totalInput
     );
-    txBuilder.stakingCredential(keyPairStake.getKeys().pub, '7a623c48348501c2380e60ac2307fcd1b67df4218f819930821a15b3');
+    txBuilder.stakingCredential(
+      keyPairStake.getKeys().pub,
+      '7a623c48348501c2380e60ac2307fcd1b67df4218f819930821a15b3',
+      'always-abstain'
+    );
     txBuilder.ttl(800000000);
     const tx = (await txBuilder.build()) as Transaction;
     should.equal(tx.type, TransactionType.StakingActivate);
     const txData = tx.toJson();
     const fee = tx.getFee;
-    txData.certs.length.should.equal(2);
+    txData.certs.length.should.equal(3);
     txData.certs[0].type.should.equal(0);
     txData.certs[1].type.should.equal(1);
+    txData.certs[2].type.should.equal(CertType.VoteDelegation);
 
     txData.outputs.length.should.equal(1);
     txData.outputs[0].amount.should.equal((Number(totalInput) - 2000000 - Number(fee)).toString());
-    fee.should.equal('169945');
+    fee.should.equal('171529');
     tx.toBroadcastFormat().should.equal(testData.rawTx.unsignedStakingActiveTx);
     should.equal(tx.id, testData.rawTx.unsignedStakingActiveTxHash);
   });
@@ -50,7 +55,11 @@ describe('ADA Staking Activate Transaction Builder', async () => {
       'addr1q8rm9z7w4yx5gz652kn2q238efvms6t0qelur9nlglun8eu4tr5knj4fu4adelzqhxg8adu5xca4jra0gtllfrpcawyq9psz23',
       totalInput
     );
-    txBuilder.stakingCredential(keyPairStake.getKeys().pub, '7a623c48348501c2380e60ac2307fcd1b67df4218f819930821a15b3');
+    txBuilder.stakingCredential(
+      keyPairStake.getKeys().pub,
+      '7a623c48348501c2380e60ac2307fcd1b67df4218f819930821a15b3',
+      'always-abstain'
+    );
     txBuilder.ttl(800000000);
     const tx = (await txBuilder.build()) as Transaction;
     should.equal(tx.type, TransactionType.StakingActivate);
@@ -129,7 +138,11 @@ describe('ADA Staking Activate Transaction Builder', async () => {
     const txBuilder = factory.getStakingActivateBuilder();
     const senderBalance = '22122071';
     txBuilder.changeAddress(senderAddress, senderBalance);
-    txBuilder.stakingCredential(keyPairStake.getKeys().pub, '7a623c48348501c2380e60ac2307fcd1b67df4218f819930821a15b3');
+    txBuilder.stakingCredential(
+      keyPairStake.getKeys().pub,
+      '7a623c48348501c2380e60ac2307fcd1b67df4218f819930821a15b3',
+      'always-no-confidence'
+    );
 
     txBuilder.input({
       transaction_id: '0a4f80d83ba9ce1f83306a79252909241308d7eff317d04c9ea018966d687fe3',
@@ -172,7 +185,11 @@ describe('ADA Staking Activate Transaction Builder', async () => {
     const txBuilder = factory.getStakingActivateBuilder();
     const senderBalance = '22122071';
     txBuilder.changeAddress(senderAddress, senderBalance);
-    txBuilder.stakingCredential(keyPairStake.getKeys().pub, '7a623c48348501c2380e60ac2307fcd1b67df4218f819930821a15b3');
+    txBuilder.stakingCredential(
+      keyPairStake.getKeys().pub,
+      '7a623c48348501c2380e60ac2307fcd1b67df4218f819930821a15b3',
+      'always-no-confidence'
+    );
 
     txBuilder.input({
       transaction_id: '0a4f80d83ba9ce1f83306a79252909241308d7eff317d04c9ea018966d687fe3',
diff --git a/modules/sdk-coin-ada/test/unit/utils.ts b/modules/sdk-coin-ada/test/unit/utils.ts
diff --git a/modules/sdk-coin-ada/test/unit/voteDelegationBuilder.ts b/modules/sdk-coin-ada/test/unit/voteDelegationBuilder.ts
diff --git a/modules/sdk-core/src/account-lib/baseCoin/enum.ts b/modules/sdk-core/src/account-lib/baseCoin/enum.ts
