feat: add RegisterSubnetValidatorTx (#891)

* feat: add RegisterSubnetValidatorTx

* docs: adjust RegisterSubnetValidatorTxProps

Author: erictaylor

src/fixtures/primitives.ts

@@ -1,3 +1,4 @@
+import { BlsSignature } from '../serializable/fxs/common/blsSignature';
 import {
   BigIntPr,
   Byte,
@@ -30,7 +31,7 @@ export const bytes = () => new Bytes(new Uint8Array([0x01, 0x02]));
 export const bigIntPrBytes = () =>
   new Uint8Array([0x00, 0x00, 0x00, 0x00, 0x00, 0x1e, 0x84, 0x80]);
 
-export const bigIntPr = () => new BigIntPr(2000000n);
+export const bigIntPr = () => new BigIntPr(2_000_000n);
 
 export const stringPr = () => new Stringpr('Avax');
 
@@ -61,19 +62,28 @@ export const blsSignatureBytes = () =>
     0xd5, 0x9d, 0x55, 0x65, 0x59, 0x27, 0xf7, 0x2b, 0xc6, 0xbf, 0x7c, 0x12,
   ]);
 
+export const blsSignature = () =>
+  BlsSignature.fromBytes(blsSignatureBytes())[0];
+
 export const warpMessageBytes = () =>
   new Uint8Array([
-    0, 0, 0, 215, 0, 0, 0, 0, 48, 57, 112, 95, 61, 68, 21, 249, 144, 34, 93, 61,
-    245, 206, 67, 125, 122, 242, 170, 50, 75, 27, 188, 232, 84, 238, 52, 171,
-    111, 57, 136, 34, 80, 210, 0, 0, 0, 68, 0, 0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0,
-    0, 54, 0, 0, 0, 0, 0, 3, 56, 230, 233, 254, 49, 198, 208, 112, 168, 199,
-    146, 219, 172, 246, 208, 174, 251, 142, 172, 42, 222, 212, 156, 192, 170,
-    159, 66, 45, 31, 221, 158, 205, 0, 0, 0, 0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0,
-    5, 0, 0, 0, 0, 0, 0, 0, 1, 1, 135, 244, 187, 44, 66, 134, 156, 86, 240, 35,
-    161, 202, 129, 4, 90, 255, 3, 74, 205, 73, 11, 143, 21, 181, 6, 144, 37,
-    249, 130, 230, 5, 224, 119, 0, 127, 197, 136, 247, 213, 99, 105, 166, 93,
-    247, 87, 77, 243, 183, 15, 240, 40, 234, 23, 55, 57, 199, 137, 82, 90, 183,
-    238, 191, 203, 92, 17, 91, 19, 204, 168, 240, 43, 54, 33, 4, 183, 0, 199,
-    91, 201, 82, 52, 16, 159, 63, 19, 96, 221, 203, 78, 195, 202, 246, 176, 232,
-    33, 203,
+    0x00, 0x00, 0x00, 0xd7, 0x00, 0x00, 0x00, 0x00, 0x30, 0x39, 0x70, 0x5f,
+    0x3d, 0x44, 0x15, 0xf9, 0x90, 0x22, 0x5d, 0x3d, 0xf5, 0xce, 0x43, 0x7d,
+    0x7a, 0xf2, 0xaa, 0x32, 0x4b, 0x1b, 0xbc, 0xe8, 0x54, 0xee, 0x34, 0xab,
+    0x6f, 0x39, 0x88, 0x22, 0x50, 0xd2, 0x00, 0x00, 0x00, 0x44, 0x00, 0x00,
+    0x00, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x36,
+    0x00, 0x00, 0x00, 0x00, 0x00, 0x03, 0x38, 0xe6, 0xe9, 0xfe, 0x31, 0xc6,
+    0xd0, 0x70, 0xa8, 0xc7, 0x92, 0xdb, 0xac, 0xf6, 0xd0, 0xae, 0xfb, 0x8e,
+    0xac, 0x2a, 0xde, 0xd4, 0x9c, 0xc0, 0xaa, 0x9f, 0x42, 0x2d, 0x1f, 0xdd,
+    0x9e, 0xcd, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x00, 0x00,
+    0x00, 0x00, 0x00, 0x00, 0x00, 0x05, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+    0x00, 0x01, 0x01, 0x87, 0xf4, 0xbb, 0x2c, 0x42, 0x86, 0x9c, 0x56, 0xf0,
+    0x23, 0xa1, 0xca, 0x81, 0x04, 0x5a, 0xff, 0x03, 0x4a, 0xcd, 0x49, 0x0b,
+    0x8f, 0x15, 0xb5, 0x06, 0x90, 0x25, 0xf9, 0x82, 0xe6, 0x05, 0xe0, 0x77,
+    0x00, 0x7f, 0xc5, 0x88, 0xf7, 0xd5, 0x63, 0x69, 0xa6, 0x5d, 0xf7, 0x57,
+    0x4d, 0xf3, 0xb7, 0x0f, 0xf0, 0x28, 0xea, 0x17, 0x37, 0x39, 0xc7, 0x89,
+    0x52, 0x5a, 0xb7, 0xee, 0xbf, 0xcb, 0x5c, 0x11, 0x5b, 0x13, 0xcc, 0xa8,
+    0xf0, 0x2b, 0x36, 0x21, 0x04, 0xb7, 0x00, 0xc7, 0x5b, 0xc9, 0x52, 0x34,
+    0x10, 0x9f, 0x3f, 0x13, 0x60, 0xdd, 0xcb, 0x4e, 0xc3, 0xca, 0xf6, 0xb0,
+    0xe8, 0x21, 0xcb,
   ]);

src/fixtures/pvm.ts

@@ -52,6 +52,7 @@ import {
   stringPrBytes,
   byte,
   byteByte,
+  blsSignature,
 } from './primitives';
 import {
   input,
@@ -69,6 +70,7 @@ import type { FeeState } from '../vms/pvm';
 import { ConvertSubnetTx } from '../serializable/pvm/convertSubnetTx';
 import { ConvertSubnetValidator } from '../serializable/fxs/pvm/convertSubnetValidator';
 import { PChainOwner } from '../serializable/fxs/pvm/pChainOwner';
+import { RegisterSubnetValidatorTx } from '../serializable/pvm/registerSubnetValidatorTx';
 
 export const validator = () =>
   new Validator(nodeId(), bigIntPr(), bigIntPr(), bigIntPr());
@@ -357,6 +359,17 @@ export const convertSubnetTxBytes = () =>
     inputBytes(),
   );
 
+export const registerSubnetValidatorTx = () =>
+  new RegisterSubnetValidatorTx(baseTx(), bigIntPr(), blsSignature(), bytes());
+
+export const registerSubnetValidatorTxBytes = () =>
+  concatBytes(
+    baseTxbytes(),
+    bigIntPrBytes(),
+    blsSignatureBytes(),
+    bytesBytes(),
+  );
+
 export const setSubnetValidatorWeightTx = () =>
   new SetSubnetValidatorWeightTx(baseTx(), bytes());
 

src/serializable/constants.ts

@@ -20,6 +20,7 @@ export enum TypeSymbols {
   Id = 'common.Id',
   Address = 'common.Address',
   NodeId = 'common.NodeId',
+  BlsSignature = 'common.BlsSignature',
 
   // PRIMITIVES
   Int = 'primitives.Int',
@@ -82,6 +83,7 @@ export enum TypeSymbols {
 
   ConvertSubnetTx = 'pvm.ConvertSubnetTx',
   ConvertSubnetValidator = 'pvm.ConvertSubnetValidator',
+  RegisterSubnetValidatorTx = 'pvm.RegisterSubnetValidatorTx',
   SetSubnetValidatorWeightTx = 'pvm.SetSubnetValidatorWeightTx',
   IncreaseBalanceTx = 'pvm.IncreaseBalanceTx',
   DisableSubnetValidatorTx = 'pvm.DisableSubnetValidatorTx',

src/serializable/fxs/common/blsSignature.spec.ts

@@ -0,0 +1,10 @@
+import { blsSignature, blsSignatureBytes } from '../../../fixtures/primitives';
+import { testSerialization } from '../../../fixtures/utils/serializable';
+import { BlsSignature } from './blsSignature';
+
+testSerialization(
+  'BlsSignature',
+  BlsSignature,
+  blsSignature,
+  blsSignatureBytes,
+);

src/serializable/fxs/common/blsSignature.ts

@@ -0,0 +1,49 @@
+import type { Signature } from '../../../crypto/bls';
+import {
+  SIGNATURE_LENGTH,
+  signatureFromBytes,
+  signatureToBytes,
+} from '../../../crypto/bls';
+import { hexToBuffer } from '../../../utils/buffer';
+import { serializable } from '../../common/types';
+import { TypeSymbols } from '../../constants';
+import { Primitives } from '../../primitives/primatives';
+
+@serializable()
+export class BlsSignature extends Primitives {
+  _type = TypeSymbols.BlsSignature;
+
+  constructor(public readonly signature: Signature) {
+    super();
+  }
+
+  static fromSignatureBytes(signatureBytes: Uint8Array): BlsSignature {
+    return new BlsSignature(signatureFromBytes(signatureBytes));
+  }
+
+  static fromBytes(
+    bytes: Uint8Array,
+  ): [blsSignature: BlsSignature, rest: Uint8Array] {
+    const blsSignatureBytes = bytes.slice(0, SIGNATURE_LENGTH);
+    const signature = signatureFromBytes(blsSignatureBytes);
+    const rest = bytes.slice(SIGNATURE_LENGTH);
+
+    return [new BlsSignature(signature), rest];
+  }
+
+  static fromHex(hex: string): BlsSignature {
+    return new BlsSignature(signatureFromBytes(hexToBuffer(hex)));
+  }
+
+  toBytes() {
+    return signatureToBytes(this.signature);
+  }
+
+  toString() {
+    return this.signature.toHex();
+  }
+
+  toJSON() {
+    return this.toString();
+  }
+}

src/serializable/fxs/common/index.ts

@@ -1,5 +1,6 @@
 import { Address } from './address';
+import { BlsSignature } from './blsSignature';
 import { Id } from './id';
 import { NodeId } from './nodeId';
 
-export { Address, Id, NodeId };
+export { Address, BlsSignature, Id, NodeId };

src/serializable/pvm/codec.ts

@@ -22,6 +22,7 @@ import { ConvertSubnetTx } from './convertSubnetTx';
 import { IncreaseBalanceTx } from './increaseBalanceTx';
 import { DisableSubnetValidatorTx } from './disableSubnetValidatorTx';
 import { SetSubnetValidatorWeightTx } from './setSubnetValidatorWeightTx';
+import { RegisterSubnetValidatorTx } from './registerSubnetValidatorTx';
 
 /**
  * @see https://github.com/ava-labs/avalanchego/blob/master/vms/platformvm/txs/codec.go#L35
@@ -63,8 +64,7 @@ export const codec = new Codec([
   BaseTx, // 34
 
   ConvertSubnetTx, // 35
-  // Replace these with the actual txs when they are implemented
-  ...new Array(1), // 36 RegisterSubnetValidatorTx
+  RegisterSubnetValidatorTx, // 36
   SetSubnetValidatorWeightTx, // 37
   IncreaseBalanceTx, // 38
   DisableSubnetValidatorTx, // 39

src/serializable/pvm/index.ts

@@ -20,6 +20,7 @@ import { AbstractSubnetTx } from './abstractSubnetTx';
 import { TransferSubnetOwnershipTx } from './transferSubnetOwnershipTx';
 import { TransformSubnetTx } from './transformSubnetTx';
 import { ConvertSubnetTx } from './convertSubnetTx';
+import { RegisterSubnetValidatorTx } from './registerSubnetValidatorTx';
 import { SetSubnetValidatorWeightTx } from './setSubnetValidatorWeightTx';
 import { IncreaseBalanceTx } from './increaseBalanceTx';
 import { DisableSubnetValidatorTx } from './disableSubnetValidatorTx';
@@ -49,6 +50,7 @@ export {
   TransferSubnetOwnershipTx,
   TransformSubnetTx,
   ConvertSubnetTx,
+  RegisterSubnetValidatorTx,
   SetSubnetValidatorWeightTx,
   IncreaseBalanceTx,
   DisableSubnetValidatorTx,

src/serializable/pvm/registerSubnetValidator.spec.ts

@@ -0,0 +1,15 @@
+import { testPVMCodec } from '../../fixtures/codec';
+import {
+  registerSubnetValidatorTx,
+  registerSubnetValidatorTxBytes,
+} from '../../fixtures/pvm';
+import { testSerialization } from '../../fixtures/utils/serializable';
+import { RegisterSubnetValidatorTx } from './registerSubnetValidatorTx';
+
+testSerialization(
+  'RegisterSubnetValidatorTx',
+  RegisterSubnetValidatorTx,
+  registerSubnetValidatorTx,
+  registerSubnetValidatorTxBytes,
+  testPVMCodec,
+);

src/serializable/pvm/registerSubnetValidatorTx.ts

@@ -0,0 +1,44 @@
+import { pack, unpack } from '../../utils/struct';
+import { BaseTx } from '../avax/baseTx';
+import type { Codec } from '../codec/codec';
+import { serializable } from '../common/types';
+import { TypeSymbols } from '../constants';
+import { BlsSignature } from '../fxs/common/blsSignature';
+import { BigIntPr, Bytes } from '../primitives';
+import { PVMTx } from './abstractTx';
+
+@serializable()
+export class RegisterSubnetValidatorTx extends PVMTx {
+  _type = TypeSymbols.RegisterSubnetValidatorTx;
+
+  constructor(
+    public readonly baseTx: BaseTx,
+    public readonly balance: BigIntPr,
+    public readonly blsSignature: BlsSignature,
+    public readonly message: Bytes,
+  ) {
+    super();
+  }
+
+  static fromBytes(
+    bytes: Uint8Array,
+    codec: Codec,
+  ): [registerSubnetValidatorTx: RegisterSubnetValidatorTx, rest: Uint8Array] {
+    const [baseTx, balance, blsSignature, message, rest] = unpack(
+      bytes,
+      [BaseTx, BigIntPr, BlsSignature, Bytes],
+      codec,
+    );
+    return [
+      new RegisterSubnetValidatorTx(baseTx, balance, blsSignature, message),
+      rest,
+    ];
+  }
+
+  toBytes(codec: Codec) {
+    return pack(
+      [this.baseTx, this.balance, this.blsSignature, this.message],
+      codec,
+    );
+  }
+}

src/serializable/pvm/typeGuards.spec.ts

@@ -22,6 +22,7 @@ import {
   isIncreaseBalanceTx,
   isDisableSubnetValidatorTx,
   isSetSubnetValidatorWeightTx,
+  isRegisterSubnetValidatorTx,
 } from './typeGuards';
 
 const cases: [any, TypeSymbols][] = [
@@ -43,6 +44,7 @@ const cases: [any, TypeSymbols][] = [
   [isTransferSubnetOwnershipTx, TypeSymbols.TransferSubnetOwnershipTx],
   [isTransformSubnetTx, TypeSymbols.TransformSubnetTx],
   [isConvertSubnetTx, TypeSymbols.ConvertSubnetTx],
+  [isRegisterSubnetValidatorTx, TypeSymbols.RegisterSubnetValidatorTx],
   [isSetSubnetValidatorWeightTx, TypeSymbols.SetSubnetValidatorWeightTx],
   [isIncreaseBalanceTx, TypeSymbols.IncreaseBalanceTx],
   [isDisableSubnetValidatorTx, TypeSymbols.DisableSubnetValidatorTx],

src/serializable/pvm/typeGuards.ts

@@ -20,6 +20,7 @@ import type { ConvertSubnetTx } from './convertSubnetTx';
 import type { IncreaseBalanceTx } from './increaseBalanceTx';
 import type { DisableSubnetValidatorTx } from './disableSubnetValidatorTx';
 import type { SetSubnetValidatorWeightTx } from './setSubnetValidatorWeightTx';
+import type { RegisterSubnetValidatorTx } from './registerSubnetValidatorTx';
 
 export function isPvmBaseTx(tx: Transaction): tx is BaseTx {
   return tx._type === TypeSymbols.PvmBaseTx;
@@ -95,6 +96,12 @@ export function isConvertSubnetTx(tx: Transaction): tx is ConvertSubnetTx {
   return tx._type === TypeSymbols.ConvertSubnetTx;
 }
 
+export function isRegisterSubnetValidatorTx(
+  tx: Transaction,
+): tx is RegisterSubnetValidatorTx {
+  return tx._type === TypeSymbols.RegisterSubnetValidatorTx;
+}
+
 export function isSetSubnetValidatorWeightTx(
   tx: Transaction,
 ): tx is SetSubnetValidatorWeightTx {

src/utils/validateBurnedAmount/validateBurnedAmount.ts

@@ -23,6 +23,7 @@ import {
   isPvmBaseTx,
   isExportTx as isPvmExportTx,
   isImportTx as isPvmImportTx,
+  isRegisterSubnetValidatorTx,
   isRemoveSubnetValidatorTx,
   isSetSubnetValidatorWeightTx,
   isTransferSubnetOwnershipTx,
@@ -51,6 +52,7 @@ const isEtnaSupported = (tx: Transaction) => {
     isRemoveSubnetValidatorTx(tx) ||
     isTransferSubnetOwnershipTx(tx) ||
     isConvertSubnetTx(tx) ||
+    isRegisterSubnetValidatorTx(tx) ||
     isSetSubnetValidatorWeightTx(tx) ||
     isIncreaseBalanceTx(tx) ||
     isDisableSubnetValidatorTx(tx)