Merge pull request #912 from ava-labs/erictaylor/acp-77-nomenclature

feat: acp-77 nomenclature changes

Author: meeh0w

cspell.json

@@ -19,5 +19,14 @@
   "ignoreRegExpList": ["/.*[0-9].*/"],
   "language": "en",
   "minWordLength": 5,
-  "words": ["amounter", "avalabs", "locktime", "stakeable", "unstakeable", "utxo", "utxos"]
+  "words": [
+    "amounter",
+    "avalabs",
+    "locktime",
+    "permissioned",
+    "stakeable",
+    "unstakeable",
+    "utxo",
+    "utxos"
+  ]
 }

examples/p-chain/etna/convertSubnet.ts renamed to examples/p-chain/etna/convertSubnetToL1.ts

@@ -1,15 +1,19 @@
-import { addTxSignatures, pvm, utils } from '../../../src';
+import {
+  L1Validator,
+  PChainOwner,
+  addTxSignatures,
+  pvm,
+  pvmSerial,
+  utils,
+} from '../../../src';
 import { setupEtnaExample } from './utils/etna-helper';
-import { ConvertSubnetValidator } from '../../../src/serializable/fxs/pvm/convertSubnetValidator';
-import { ProofOfPossession } from '../../../src/serializable/pvm';
-import { PChainOwner } from '../../../src/serializable/fxs/pvm/pChainOwner';
 import { getEnvVars } from '../../utils/getEnvVars';
 
 const AMOUNT_TO_VALIDATE_AVAX: number = 1;
 const BALANCE_AVAX: number = 1;
 
 /**
- * Converts a subnet to permissionless subnet.
+ * Converts a subnet to L1.
  *
  * **Note** A subnet must be created (createSubnetTx) and a chain must be created (createChainTx)
  * before a subnet can be converted from permissioned to permissionless.
@@ -20,7 +24,7 @@ const BALANCE_AVAX: number = 1;
  * @param subnetId the ID of the subnet that is created via `createSubnetTx`.
  * @returns The resulting transaction's ID.
  */
-const convertSubnetTxExample = async () => {
+const convertSubnetToL1TxExample = async () => {
   const {
     AVAX_PUBLIC_URL,
     P_CHAIN_ADDRESS,
@@ -41,9 +45,9 @@ const convertSubnetTxExample = async () => {
 
   const signature = utils.hexToBuffer(BLS_SIGNATURE);
 
-  const signer = new ProofOfPossession(publicKey, signature);
+  const signer = new pvmSerial.ProofOfPossession(publicKey, signature);
 
-  const validator = ConvertSubnetValidator.fromNative(
+  const validator = L1Validator.fromNative(
     NODE_ID,
     BigInt(AMOUNT_TO_VALIDATE_AVAX * 1e9),
     BigInt(BALANCE_AVAX * 1e9),
@@ -52,7 +56,7 @@ const convertSubnetTxExample = async () => {
     pChainOwner,
   );
 
-  const tx = pvm.e.newConvertSubnetTx(
+  const tx = pvm.e.newConvertSubnetToL1Tx(
     {
       feeState,
       fromAddressesBytes: [testPAddr],
@@ -74,4 +78,4 @@ const convertSubnetTxExample = async () => {
   return pvmApi.issueSignedTx(tx.getSignedTx());
 };
 
-convertSubnetTxExample().then(console.log);
+convertSubnetToL1TxExample().then(console.log);

examples/p-chain/etna/increaseBalanceTx.ts

@@ -13,7 +13,7 @@ const increaseBalanceTx = async () => {
 
   const testPAddr = utils.bech32ToBytes(P_CHAIN_ADDRESS);
 
-  const unsignedTx = pvm.e.newIncreaseBalanceTx(
+  const unsignedTx = pvm.e.newIncreaseL1ValidatorBalanceTx(
     {
       balance: BigInt(BALANCE_AVAX * 1e9),
       feeState,

src/fixtures/pvm.ts

@@ -19,9 +19,11 @@ import {
   RemoveSubnetValidatorTx,
   TransferSubnetOwnershipTx,
   TransformSubnetTx,
-  IncreaseBalanceTx,
-  DisableSubnetValidatorTx,
-  SetSubnetValidatorWeightTx,
+  ConvertSubnetToL1Tx,
+  RegisterL1ValidatorTx,
+  SetL1ValidatorWeightTx,
+  IncreaseL1ValidatorBalanceTx,
+  DisableL1ValidatorTx,
 } from '../serializable/pvm';
 import {
   baseTx,
@@ -67,10 +69,8 @@ import {
 import { bytesForInt } from './utils/bytesFor';
 import { makeList, makeListBytes } from './utils/makeList';
 import type { FeeState } from '../vms/pvm';
-import { ConvertSubnetTx } from '../serializable/pvm/convertSubnetTx';
-import { ConvertSubnetValidator } from '../serializable/fxs/pvm/convertSubnetValidator';
+import { L1Validator } from '../serializable/fxs/pvm/L1Validator';
 import { PChainOwner } from '../serializable/fxs/pvm/pChainOwner';
-import { RegisterSubnetValidatorTx } from '../serializable/pvm/registerSubnetValidatorTx';
 
 export const validator = () =>
   new Validator(nodeId(), bigIntPr(), bigIntPr(), bigIntPr());
@@ -318,8 +318,8 @@ export const pChainOwnerBytes = () =>
     addressesBytes(),
   );
 
-export const convertSubnetValidator = () =>
-  new ConvertSubnetValidator(
+export const l1Validator = () =>
+  new L1Validator(
     bytes(),
     bigIntPr(),
     bigIntPr(),
@@ -328,7 +328,7 @@ export const convertSubnetValidator = () =>
     pChainOwner(),
   );
 
-export const convertSubnetValidatorBytes = () =>
+export const l1ValidatorBytes = () =>
   concatBytes(
     bytesBytes(),
     bigIntPrBytes(),
@@ -338,54 +338,54 @@ export const convertSubnetValidatorBytes = () =>
     pChainOwnerBytes(),
   );
 
-export const convertSubnetTx = () =>
-  new ConvertSubnetTx(
+export const convertSubnetToL1Tx = () =>
+  new ConvertSubnetToL1Tx(
     baseTx(),
     id(),
     id(),
     bytes(),
-    makeList(convertSubnetValidator)(),
+    makeList(l1Validator)(),
     input(),
   );
 
-export const convertSubnetTxBytes = () =>
+export const convertSubnetToL1TxBytes = () =>
   concatBytes(
     baseTxbytes(),
     idBytes(),
     idBytes(),
     bytesBytes(),
-    makeListBytes(convertSubnetValidatorBytes)(),
+    makeListBytes(l1ValidatorBytes)(),
     bytesForInt(10),
     inputBytes(),
   );
 
-export const registerSubnetValidatorTx = () =>
-  new RegisterSubnetValidatorTx(baseTx(), bigIntPr(), blsSignature(), bytes());
+export const registerL1ValidatorTx = () =>
+  new RegisterL1ValidatorTx(baseTx(), bigIntPr(), blsSignature(), bytes());
 
-export const registerSubnetValidatorTxBytes = () =>
+export const registerL1ValidatorTxBytes = () =>
   concatBytes(
     baseTxbytes(),
     bigIntPrBytes(),
     blsSignatureBytes(),
     bytesBytes(),
   );
 
-export const setSubnetValidatorWeightTx = () =>
-  new SetSubnetValidatorWeightTx(baseTx(), bytes());
+export const setL1ValidatorWeightTx = () =>
+  new SetL1ValidatorWeightTx(baseTx(), bytes());
 
-export const setSubnetValidatorWeightTxBytes = () =>
+export const setL1ValidatorWeightTxBytes = () =>
   concatBytes(baseTxbytes(), bytesBytes());
 
-export const increaseBalanceTx = () =>
-  new IncreaseBalanceTx(baseTx(), id(), bigIntPr());
+export const increaseL1ValidatorBalanceTx = () =>
+  new IncreaseL1ValidatorBalanceTx(baseTx(), id(), bigIntPr());
 
-export const increaseBalanceTxBytes = () =>
+export const increaseL1ValidatorBalanceTxBytes = () =>
   concatBytes(baseTxbytes(), idBytes(), bigIntPrBytes());
 
-export const disableSubnetValidatorTx = () =>
-  new DisableSubnetValidatorTx(baseTx(), id(), input());
+export const disableL1ValidatorTx = () =>
+  new DisableL1ValidatorTx(baseTx(), id(), input());
 
-export const disableSubnetValidatorTxBytes = () =>
+export const disableL1ValidatorTxBytes = () =>
   concatBytes(baseTxbytes(), idBytes(), bytesForInt(10), inputBytes());
 
 export const feeState = (): FeeState => ({

src/serializable/constants.ts

@@ -81,12 +81,12 @@ export enum TypeSymbols {
   TransformSubnetTx = 'pvm.TransformSubnetTx',
   TransferSubnetOwnershipTx = 'pvm.TransferSubnetOwnershipTx',
 
-  ConvertSubnetTx = 'pvm.ConvertSubnetTx',
-  ConvertSubnetValidator = 'pvm.ConvertSubnetValidator',
-  RegisterSubnetValidatorTx = 'pvm.RegisterSubnetValidatorTx',
-  SetSubnetValidatorWeightTx = 'pvm.SetSubnetValidatorWeightTx',
-  IncreaseBalanceTx = 'pvm.IncreaseBalanceTx',
-  DisableSubnetValidatorTx = 'pvm.DisableSubnetValidatorTx',
+  L1Validator = 'pvm.L1Validator',
+  ConvertSubnetToL1Tx = 'pvm.ConvertSubnetToL1Tx',
+  RegisterL1ValidatorTx = 'pvm.RegisterL1ValidatorTx',
+  SetL1ValidatorWeightTx = 'pvm.SetL1ValidatorWeightTx',
+  IncreaseL1ValidatorBalanceTx = 'pvm.IncreaseL1ValidatorBalanceTx',
+  DisableL1ValidatorTx = 'pvm.DisableL1ValidatorTx',
 
   PChainOwner = 'pvm.PChainOwner',
 

src/serializable/fxs/pvm/L1Validator.test.ts

@@ -0,0 +1,12 @@
+import { testPVMCodec } from '../../../fixtures/codec';
+import { l1Validator, l1ValidatorBytes } from '../../../fixtures/pvm';
+import { testSerialization } from '../../../fixtures/utils/serializable';
+import { L1Validator } from './L1Validator';
+
+testSerialization(
+  'L1Validator',
+  L1Validator,
+  l1Validator,
+  l1ValidatorBytes,
+  testPVMCodec,
+);

src/serializable/fxs/pvm/convertSubnetValidator.ts renamed to src/serializable/fxs/pvm/L1Validator.ts

@@ -8,11 +8,11 @@ import { NodeId } from '../common';
 import { PChainOwner } from './pChainOwner';
 
 /**
- * @see https://github.com/ava-labs/avalanchego/blob/master/vms/platformvm/txs/convert_subnet_tx.go#86
+ * @see https://github.com/avalanche-foundation/ACPs/blob/main/ACPs/77-reinventing-subnets/README.md#convertsubnettol1tx
  */
 @serializable()
-export class ConvertSubnetValidator {
-  _type = TypeSymbols.ConvertSubnetValidator;
+export class L1Validator {
+  _type = TypeSymbols.L1Validator;
 
   constructor(
     public readonly nodeId: Bytes,
@@ -51,7 +51,7 @@ export class ConvertSubnetValidator {
     remainingBalanceOwner: PChainOwner,
     deactivationOwner: PChainOwner,
   ) {
-    return new ConvertSubnetValidator(
+    return new L1Validator(
       new Bytes(NodeId.fromString(nodeId).toBytes()),
       new BigIntPr(weight),
       new BigIntPr(balance),
@@ -61,10 +61,7 @@ export class ConvertSubnetValidator {
     );
   }
 
-  static fromBytes(
-    bytes: Uint8Array,
-    codec: Codec,
-  ): [ConvertSubnetValidator, Uint8Array] {
+  static fromBytes(bytes: Uint8Array, codec: Codec): [L1Validator, Uint8Array] {
     const [
       nodeId,
       weight,
@@ -80,7 +77,7 @@ export class ConvertSubnetValidator {
     );
 
     return [
-      new ConvertSubnetValidator(
+      new L1Validator(
         nodeId,
         weight,
         balance,

src/serializable/fxs/pvm/convertSubnetValidator.test.ts

@@ -1,2 +1,2 @@
-export * from './convertSubnetValidator';
+export * from './L1Validator';
 export * from './pChainOwner';

src/serializable/fxs/pvm/index.ts

@@ -18,11 +18,11 @@ import { RemoveSubnetValidatorTx } from './removeSubnetValidatorTx';
 import { TransferSubnetOwnershipTx } from './transferSubnetOwnershipTx';
 import { TransformSubnetTx } from './transformSubnetTx';
 import { BaseTx } from './baseTx';
-import { ConvertSubnetTx } from './convertSubnetTx';
-import { IncreaseBalanceTx } from './increaseBalanceTx';
-import { DisableSubnetValidatorTx } from './disableSubnetValidatorTx';
-import { SetSubnetValidatorWeightTx } from './setSubnetValidatorWeightTx';
-import { RegisterSubnetValidatorTx } from './registerSubnetValidatorTx';
+import { ConvertSubnetToL1Tx } from './convertSubnetToL1Tx';
+import { IncreaseL1ValidatorBalanceTx } from './increaseL1ValidatorBalanceTx';
+import { DisableL1ValidatorTx } from './disableL1ValidatorTx';
+import { SetL1ValidatorWeightTx } from './setL1ValidatorWeightTx';
+import { RegisterL1ValidatorTx } from './registerL1ValidatorTx';
 
 /**
  * @see https://github.com/ava-labs/avalanchego/blob/master/vms/platformvm/txs/codec.go#L35
@@ -63,11 +63,11 @@ export const codec = new Codec([
   TransferSubnetOwnershipTx, // 33
   BaseTx, // 34
 
-  ConvertSubnetTx, // 35
-  RegisterSubnetValidatorTx, // 36
-  SetSubnetValidatorWeightTx, // 37
-  IncreaseBalanceTx, // 38
-  DisableSubnetValidatorTx, // 39
+  ConvertSubnetToL1Tx, // 35
+  RegisterL1ValidatorTx, // 36
+  SetL1ValidatorWeightTx, // 37
+  IncreaseL1ValidatorBalanceTx, // 38
+  DisableL1ValidatorTx, // 39
 ]);
 
 let manager: Manager;