Merge pull request #885 from ava-labs/convertSubnetTx

Implement ConvertSubnetTx

Author: ruijialin-avalabs

.env.example

@@ -4,4 +4,7 @@ PRIVATE_KEY=...
 C_CHAIN_ADDRESS=0x...
 X_CHAIN_ADDRESS=X-fuji...
 P_CHAIN_ADDRESS=P-fuji...
-CORETH_ADDRESS=C-fuji...
+CORETH_ADDRESS=C-fuji...
+NODE_ID=NodeID-...
+BLS_PUBLIC_KEY=0x...
+BLS_SIGNATURE=0x...

examples/c-chain/export.ts

@@ -4,21 +4,15 @@ import { bech32ToBytes, hexToBuffer } from '../../src/utils';
 import { getContextFromURI } from '../../src/vms/context';
 import { newExportTxFromBaseFee } from '../../src/vms/evm';
 import { evmapi } from '../chain_apis';
-
-const C_CHAIN_ADDRESS = process.env.C_CHAIN_ADDRESS;
-const X_CHAIN_ADDRESS = process.env.X_CHAIN_ADDRESS;
-const PRIVATE_KEY = process.env.PRIVATE_KEY;
+import { getEnvVars } from '../utils/getEnvVars';
 
 const main = async () => {
-  if (!C_CHAIN_ADDRESS || !X_CHAIN_ADDRESS || !PRIVATE_KEY) {
-    throw new Error('Missing environment variable(s).');
-  }
+  const { AVAX_PUBLIC_URL, C_CHAIN_ADDRESS, PRIVATE_KEY, X_CHAIN_ADDRESS } =
+    getEnvVars();
 
-  const provider = new JsonRpcProvider(
-    process.env.AVAX_PUBLIC_URL + '/ext/bc/C/rpc',
-  );
+  const provider = new JsonRpcProvider(AVAX_PUBLIC_URL + '/ext/bc/C/rpc');
 
-  const context = await getContextFromURI(process.env.AVAX_PUBLIC_URL);
+  const context = await getContextFromURI(AVAX_PUBLIC_URL);
   const txCount = await provider.getTransactionCount(C_CHAIN_ADDRESS);
   const baseFee = await evmapi.getBaseFee();
   const xAddressBytes = bech32ToBytes(X_CHAIN_ADDRESS);

examples/c-chain/import.ts

@@ -4,18 +4,14 @@ import { getContextFromURI } from '../../src/vms/context';
 import { newImportTxFromBaseFee } from '../../src/vms/evm';
 import { evmapi } from '../chain_apis';
 import { getChainIdFromContext } from '../utils/getChainIdFromContext';
-
-const C_CHAIN_ADDRESS = process.env.C_CHAIN_ADDRESS;
-const CORETH_ADDRESS = process.env.CORETH_ADDRESS;
-const PRIVATE_KEY = process.env.PRIVATE_KEY;
+import { getEnvVars } from '../utils/getEnvVars';
 
 const main = async (sourceChain: 'X' | 'P') => {
-  if (!C_CHAIN_ADDRESS || !CORETH_ADDRESS || !PRIVATE_KEY) {
-    throw new Error('Missing environment variable(s).');
-  }
+  const { AVAX_PUBLIC_URL, C_CHAIN_ADDRESS, PRIVATE_KEY, CORETH_ADDRESS } =
+    getEnvVars();
 
   const baseFee = await evmapi.getBaseFee();
-  const context = await getContextFromURI(process.env.AVAX_PUBLIC_URL);
+  const context = await getContextFromURI(AVAX_PUBLIC_URL);
 
   const { utxos } = await evmapi.getUTXOs({
     sourceChain,

examples/generate-keys.ts

@@ -1,20 +1,31 @@
-import { secp256k1, utils } from '../src';
+import { info, secp256k1, utils } from '../src';
 import { Address } from 'micro-eth-signer';
+import { getEnvVars } from './utils/getEnvVars';
+
+type NodeIdResponse = {
+  nodeID: string;
+  nodePOP: { publicKey: string; proofOfPossession: string };
+};
 
 /**
  * Generate a new private/public key pair and console log out the needed environment variables
  * needed to run the examples. Please these values in a `.env` file.
  */
 const main = async () => {
+  const { AVAX_PUBLIC_URL } = getEnvVars();
+
   const privateKey = secp256k1.randomPrivateKey();
   const publicKey = secp256k1.getPublicKey(privateKey);
-
   const hrp = 'custom';
   const address = utils.formatBech32(
     hrp,
     secp256k1.publicKeyBytesToAddress(publicKey),
   );
 
+  const infoApi = new info.InfoApi(AVAX_PUBLIC_URL);
+
+  const nodeIdResponse = (await infoApi.getNodeId()) as NodeIdResponse;
+
   console.log('Copy the below values to your `.env` file:');
   console.log('------------------------------------------\n');
 
@@ -26,6 +37,13 @@ const main = async () => {
   console.log('X_CHAIN_ADDRESS=', `"X-${address}"`);
   console.log('C_CHAIN_ADDRESS=', `"${Address.fromPublicKey(publicKey)}"`);
   console.log('CORETH_ADDRESS=', `"C-${address}"`);
+
+  console.log('NodeId=', `"${nodeIdResponse.nodeID}"`);
+  console.log('BLS_PUBLIC_KEY=', `"${nodeIdResponse.nodePOP.publicKey}"`);
+  console.log(
+    'BLS_SIGNATURE=',
+    `"${nodeIdResponse.nodePOP.proofOfPossession}"`,
+  );
 };
 
 main();

examples/p-chain/base.ts

@@ -4,17 +4,13 @@ import { bech32ToBytes, hexToBuffer } from '../../src/utils';
 import { getContextFromURI } from '../../src/vms/context';
 import { newBaseTx } from '../../src/vms/pvm';
 import { pvmapi } from '../chain_apis';
-
-const P_CHAIN_ADDRESS = process.env.P_CHAIN_ADDRESS;
-const PRIVATE_KEY = process.env.PRIVATE_KEY;
+import { getEnvVars } from '../utils/getEnvVars';
 
 const main = async () => {
-  if (!P_CHAIN_ADDRESS || !PRIVATE_KEY) {
-    throw new Error('Missing environment variable(s).');
-  }
+  const { AVAX_PUBLIC_URL, P_CHAIN_ADDRESS, PRIVATE_KEY } = getEnvVars();
 
   const { utxos } = await pvmapi.getUTXOs({ addresses: [P_CHAIN_ADDRESS] });
-  const context = await getContextFromURI(process.env.AVAX_PUBLIC_URL);
+  const context = await getContextFromURI(AVAX_PUBLIC_URL);
 
   const tx = newBaseTx(context, [bech32ToBytes(P_CHAIN_ADDRESS)], utxos, [
     TransferableOutput.fromNative(context.avaxAssetID, BigInt(0.1 * 1e9), [

examples/p-chain/delegate.ts

@@ -4,17 +4,13 @@ import { bech32ToBytes, hexToBuffer } from '../../src/utils';
 import { getContextFromURI } from '../../src/vms/context';
 import { PVMApi, newAddPermissionlessDelegatorTx } from '../../src/vms/pvm';
 import { pvmapi } from '../chain_apis';
-
-const P_CHAIN_ADDRESS = process.env.P_CHAIN_ADDRESS;
-const PRIVATE_KEY = process.env.PRIVATE_KEY;
+import { getEnvVars } from '../utils/getEnvVars';
 
 const main = async () => {
-  if (!P_CHAIN_ADDRESS || !PRIVATE_KEY) {
-    throw new Error('Missing environment variable(s).');
-  }
+  const { AVAX_PUBLIC_URL, P_CHAIN_ADDRESS, PRIVATE_KEY } = getEnvVars();
 
   const { utxos } = await pvmapi.getUTXOs({ addresses: [P_CHAIN_ADDRESS] });
-  const context = await getContextFromURI(process.env.AVAX_PUBLIC_URL);
+  const context = await getContextFromURI(AVAX_PUBLIC_URL);
   const startTime = await new PVMApi().getTimestamp();
   const startDate = new Date(startTime.timestamp);
   const start = BigInt(startDate.getTime() / 1000);

examples/p-chain/etna/convertSubnet.ts

@@ -0,0 +1,77 @@
+import { addTxSignatures, pvm, 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.
+ *
+ * **Note** A subnet must be created (createSubnetTx) and a chain must be created (createChainTx)
+ * before a subnet can be converted from permissioned to permissionless.
+ * @param BLS_PUBLIC_KEY BLS key from info.getNodeID on AVAX_PUBLIC_URL
+ * @param BLS_SIGNATURE BLS signature from info.getNodeID on AVAX_PUBLIC_URL
+ * @param NODE_ID the ID of the node from info.getNodeID on AVAX_PUBLIC_URL.
+ * @param chainId the ID of the chain that is created via `createChainTx`.
+ * @param subnetId the ID of the subnet that is created via `createSubnetTx`.
+ * @returns The resulting transaction's ID.
+ */
+const convertSubnetTxExmaple = async () => {
+  const {
+    AVAX_PUBLIC_URL,
+    P_CHAIN_ADDRESS,
+    PRIVATE_KEY,
+    NODE_ID,
+    BLS_PUBLIC_KEY,
+    BLS_SIGNATURE,
+  } = getEnvVars();
+  const { context, feeState, pvmApi } = await setupEtnaExample(AVAX_PUBLIC_URL);
+
+  const { utxos } = await pvmApi.getUTXOs({ addresses: [P_CHAIN_ADDRESS] });
+
+  const testPAddr = utils.bech32ToBytes(P_CHAIN_ADDRESS);
+
+  const pChainOwner = PChainOwner.fromNative([testPAddr], 1);
+
+  const publicKey = utils.hexToBuffer(BLS_PUBLIC_KEY);
+
+  const signature = utils.hexToBuffer(BLS_SIGNATURE);
+
+  const signer = new ProofOfPossession(publicKey, signature);
+
+  const validator = ConvertSubnetValidator.fromNative(
+    NODE_ID,
+    BigInt(AMOUNT_TO_VALIDATE_AVAX * 1e9),
+    BigInt(BALANCE_AVAX * 1e9),
+    signer,
+    pChainOwner,
+    pChainOwner,
+  );
+
+  const tx = pvm.e.newConvertSubnetTx(
+    {
+      feeState,
+      fromAddressesBytes: [testPAddr],
+      subnetId: '', // subnetId from createSubnetTx
+      utxos,
+      chainId: '', // chainId from createChainTx
+      validators: [validator],
+      subnetAuth: [0],
+      address: testPAddr,
+    },
+    context,
+  );
+
+  await addTxSignatures({
+    unsignedTx: tx,
+    privateKeys: [utils.hexToBuffer(PRIVATE_KEY)],
+  });
+
+  return pvmApi.issueSignedTx(tx.getSignedTx());
+};
+
+convertSubnetTxExmaple().then(console.log);

examples/p-chain/etna/createChain.ts

@@ -0,0 +1,49 @@
+import { addTxSignatures, pvm, utils } from '../../../src';
+import { setupEtnaExample } from './utils/etna-helper';
+import { testGenesisData } from '../../../src/fixtures/transactions';
+import { getEnvVars } from '../../utils/getEnvVars';
+
+/**
+ * Create a new chain on the P-Chain.
+ *
+ * **Note** A subnet must be created (createSubnetTx) before a chain can be created.
+ * @param vmId the platform chain's vmID can be found in the `InfoApi.getVMs` response.
+ * @param subnetId the ID of the subnet that is created via `createSubnetTx`.
+ * @param chainName the name of the chain.  Can be any string.
+ * @returns The resulting transaction's ID.
+ */
+const createChainTxExample = async () => {
+  const { AVAX_PUBLIC_URL, P_CHAIN_ADDRESS, PRIVATE_KEY } = getEnvVars();
+  const { context, feeState, pvmApi } = await setupEtnaExample(AVAX_PUBLIC_URL);
+
+  const { utxos } = await pvmApi.getUTXOs({ addresses: [P_CHAIN_ADDRESS] });
+
+  const testPAddr = utils.bech32ToBytes(P_CHAIN_ADDRESS);
+
+  const vmId = 'rWhpuQPF1kb72esV2momhMuTYGkEb1oL29pt2EBXWmSy4kxnT'; // platform vmId
+  const subnetId = ''; // subnetId from createSubnetTx
+
+  const tx = pvm.e.newCreateChainTx(
+    {
+      feeState,
+      fromAddressesBytes: [testPAddr],
+      utxos,
+      chainName: 'test chain',
+      subnetAuth: [0],
+      subnetId,
+      vmId,
+      fxIds: [],
+      genesisData: testGenesisData,
+    },
+    context,
+  );
+
+  await addTxSignatures({
+    unsignedTx: tx,
+    privateKeys: [utils.hexToBuffer(PRIVATE_KEY)],
+  });
+
+  return pvmApi.issueSignedTx(tx.getSignedTx());
+};
+
+createChainTxExample().then(console.log);

examples/p-chain/etna/createSubnet.ts

@@ -0,0 +1,32 @@
+import { addTxSignatures, pvm, utils } from '../../../src';
+import { getEnvVars } from '../../utils/getEnvVars';
+import { setupEtnaExample } from './utils/etna-helper';
+
+const createSubnetTxExample = async () => {
+  const { AVAX_PUBLIC_URL, P_CHAIN_ADDRESS, PRIVATE_KEY } = getEnvVars();
+
+  const { context, feeState, pvmApi } = await setupEtnaExample(AVAX_PUBLIC_URL);
+
+  const { utxos } = await pvmApi.getUTXOs({ addresses: [P_CHAIN_ADDRESS] });
+
+  const testPAddr = utils.bech32ToBytes(P_CHAIN_ADDRESS);
+
+  const tx = pvm.e.newCreateSubnetTx(
+    {
+      feeState,
+      fromAddressesBytes: [testPAddr],
+      utxos,
+      subnetOwners: [testPAddr],
+    },
+    context,
+  );
+
+  await addTxSignatures({
+    unsignedTx: tx,
+    privateKeys: [utils.hexToBuffer(PRIVATE_KEY)],
+  });
+
+  return pvmApi.issueSignedTx(tx.getSignedTx());
+};
+
+createSubnetTxExample().then(console.log);

examples/p-chain/etna/utils/etna-helper.ts

@@ -1,4 +1,4 @@
-import { Context, Info, pvm } from '../../../../src';
+import { Context, info, pvm } from '../../../../src';
 import type { FeeState } from '../../../../src/vms/pvm';
 
 export const setupEtnaExample = async (
@@ -12,9 +12,9 @@ export const setupEtnaExample = async (
   const pvmApi = new pvm.PVMApi(uri);
   const feeState = await pvmApi.getFeeState();
 
-  const info = new Info(uri);
+  const infoApi = new info.InfoApi(uri);
 
-  const { etnaTime } = await info.getUpgradesInfo();
+  const { etnaTime } = await infoApi.getUpgradesInfo();
 
   const etnaDateTime = new Date(etnaTime);
   const now = new Date();