Pox4 updates

.gitignore

@@ -0,0 +1,2 @@
+.DS_Store
+/get-btc-address

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "prettier.configPath": "back-end/.prettierrc"
+}

back-end/README.md

@@ -0,0 +1,18 @@
+### run path
+
+0. add deployer as signer
+
+1. client
+   a. allow and join
+   b. delegate
+2. server
+   a. run server npm and see it performs alright the data
+   b. mine block and see rewards getting distributed
+
+### Flows checked nakamoto testnet
+
+- [x] update balance
+- [x] commit agg
+- [x] increase agg
+- [x] delegate stack stx many
+- [ ] distribute rewards

back-end/errors/2024-08-24T20:44:09.664Z.log

@@ -0,0 +1 @@
+Error calling read-only function. Response 503: Service Unavailable. Attempted to fetch https://api.mainnet.hiro.so/v2/contracts/call-read/SP1SCEXE6PMGPAC6B4N5P2MDKX8V4GF9QDE1FNNGJ/degenlab-stacking-pool-pox4/get-pox-addr-indices and failed with the message: "upstream connect error or disconnect/reset before headers. reset reason: connection timeout"

back-end/errors/2024-09-02T06:40:00.996Z.log

@@ -0,0 +1 @@
+Error calling read-only function. Response 503: Service Unavailable. Attempted to fetch https://api.mainnet.hiro.so/v2/contracts/call-read/SP000000000000000000002Q6VF78/pox-4/get-partial-stacked-by-cycle and failed with the message: "upstream connect error or disconnect/reset before headers. reset reason: connection termination"

back-end/errors/2024-09-19T17:54:10.093Z.log

@@ -0,0 +1 @@
+fetch failed

back-end/errors/2024-10-07T04:42:00.648Z.log

@@ -0,0 +1 @@
+Unexpected token u in JSON at position 0

back-end/errors/2024-10-08T10:08:10.028Z.log

@@ -0,0 +1 @@
+fetch failed

back-end/errors/2024-11-03T10:00:02.018Z.log

@@ -0,0 +1 @@
+Error calling read-only function. Response 503: Service Unavailable. Attempted to fetch https://api.mainnet.hiro.so/v2/contracts/call-read/SP000000000000000000002Q6VF78/pox-4/get-pox-info and failed with the message: "upstream connect error or disconnect/reset before headers. reset reason: connection termination"

back-end/errors/2024-11-11T15:00:00.676Z.log

@@ -0,0 +1 @@
+Error calling read-only function. Response 503: Service Unavailable. Attempted to fetch https://api.mainnet.hiro.so/v2/contracts/call-read/SP000000000000000000002Q6VF78/pox-4/get-pox-info and failed with the message: "upstream connect error or disconnect/reset before headers. reset reason: connection termination"

back-end/errors/2024-11-13T05:22:01.313Z.log

@@ -0,0 +1 @@
+Error calling read-only function. Response 503: Service Unavailable. Attempted to fetch https://api.mainnet.hiro.so/v2/contracts/call-read/SP000000000000000000002Q6VF78/pox-4/get-pox-info and failed with the message: "upstream connect error or disconnect/reset before headers. reset reason: connection termination"

back-end/errors/2024-11-13T12:32:01.159Z.log

@@ -0,0 +1 @@
+Error calling read-only function. Response 503: Service Unavailable. Attempted to fetch https://api.mainnet.hiro.so/v2/contracts/call-read/SP000000000000000000002Q6VF78/pox-4/get-partial-stacked-by-cycle and failed with the message: "upstream connect error or disconnect/reset before headers. reset reason: connection termination"

back-end/errors/2024-11-25T11:00:01.656Z.log

@@ -0,0 +1 @@
+Error calling read-only function. Response 503: Service Unavailable. Attempted to fetch https://api.mainnet.hiro.so/v2/contracts/call-read/SP000000000000000000002Q6VF78/pox-4/get-pox-info and failed with the message: "upstream connect error or disconnect/reset before headers. reset reason: connection termination"

back-end/localData.json

@@ -0,0 +1,16 @@
+{
+  "current_burn_block_height": 872797,
+  "current_cycle": 98,
+  "updated_balances_this_cycle": false,
+  "update_balances_txid": "",
+  "update_balances_burn_block_height": 871750,
+  "commit_agg_this_cycle": true,
+  "commit_agg_burn_block_height": 871851,
+  "commit_agg_txid": "8839e3d72a3ea7f24679fed97822f318ff762d44b089a166d8ffd68110f3f93d",
+  "increase_agg_burn_block_height": 861353,
+  "partial_stacked": 0,
+  "distribute_rewards_first_burn_block_height_to_check": 872579,
+  "delegated_stack_stx_many_this_cycle": false,
+  "delegated_stack_stx_many_txid": "",
+  "nonce_to_use": 296
+}

back-end/rewarding/.env.example

@@ -0,0 +1,13 @@
+# mainnet/testnet/devnet
+NETWORK=devnet
+# local/prod
+DEVELOPMENT=local
+API_KEY_LOCAL_MAINNET=https://api.mainnet.hiro.so
+API_KEY_LOCAL_TESTNET=https://api.testnet.hiro.so
+API_KEY_PROD_MAINNET=https://api.mainnet.hiro.so
+API_KEY_PROD_TESTNET=https://api.testnet.hiro.so
+API_KEY_DEVNET=http://localhost:3999
+
+# my private key
+PRIVATE_KEY=something
+STX_SIGNER_PRIVATE_KEY=something

back-end/rewarding/.gitignore

@@ -0,0 +1,3 @@
+node_modules
+.env
+.DS_Store

back-end/rewarding/.prettierrc

@@ -0,0 +1,5 @@
+{
+  "tabWidth": 2,
+  "useTabs": false,
+  "singleQuote": true
+}

back-end/rewarding/.vscode/launch.json

@@ -0,0 +1,16 @@
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "Launch Program",
+      "skipFiles": ["<node_internals>/**"],
+      "program": "${workspaceFolder}/index.ts",
+      "outFiles": ["${workspaceFolder}/**/*.js"]
+    }
+  ]
+}

back-end/rewarding/.vscode/settings.json

@@ -0,0 +1,4 @@
+{
+  "prettier.configPath": ".prettierrc",
+  "editor.formatOnSave": true
+}

back-end/rewarding/apiPox.ts

@@ -0,0 +1,54 @@
+import { apiMapping, stxAddress } from './network';
+
+export const getApiPoxData = async () => {
+  return await fetch(apiMapping.stackingInfo).then((x) => x.json());
+};
+
+export const getNonceData = async () => {
+  return await fetch(apiMapping.nonce(stxAddress)).then((x) =>
+    x.json().then((x) => Number(x.possible_next_nonce)),
+  );
+};
+
+export const getCurrentBurnchainBlockHeight = (poxData: any): number => {
+  return poxData.current_burnchain_block_height;
+};
+
+export const isInPreparePhase = (poxData: any): boolean => {
+  return poxData.next_cycle.blocks_until_prepare_phase <= 0;
+};
+
+export const getCurrentCycle = (poxData: any): number => {
+  return poxData.current_cycle.id;
+};
+
+/// to be used for triggering maybe-agg-commit on given moments
+export const getBlocksUntilPreparePhase = (poxData: any): number => {
+  return poxData.next_cycle.blocks_until_prepare_phase;
+};
+
+export const getRewardPhaseBlockLength = (poxData: any): number => {
+  return poxData.reward_phase_block_length;
+};
+
+export const getCheckCanDelegateAgainNow = (poxData: any): boolean => {
+  // bigger than first half of the cycle, not in prepare phase
+  const cycleLength: number =
+    poxData.prepare_phase_block_length + poxData.reward_phase_block_length;
+  const rewardPhaseFirstBlock: number =
+    poxData.next_cycle.reward_phase_start_block_height - cycleLength;
+  const isInPreparePhase: boolean =
+    poxData.next_cycle.blocks_until_prepare_phase < 0;
+  return (
+    poxData.current_burnchain_block_height >
+      rewardPhaseFirstBlock + cycleLength / 2 && !isInPreparePhase
+  );
+};
+
+/// TEST
+// const jsonDataTest = await getApiPoxData();
+// console.log(
+//   'current burnchain block height',
+//   getCurrentBurnchainBlockHeight(jsonDataTest),
+// );
+// console.log('is in prepare phase', isInPreparePhase(jsonDataTest));

back-end/rewarding/consts.ts

@@ -0,0 +1,55 @@
+export const maxAmount = 9000000000000000;
+
+export const blockSpanAggIncrease = {
+  mainnet: 300,
+  testnet: 100,
+  nakamotoTestnet: 100,
+  devnet: 3,
+};
+
+export const blockSpanRewardDistribute = {
+  mainnet: 300,
+  testnet: 200,
+  nakamotoTestnet: 200,
+  devnet: 3,
+};
+
+export const offsetRewardDistribute = {
+  mainnet: 10,
+  testnet: 10,
+  nakamotoTestnet: 10,
+  devnet: 4,
+};
+
+export const offsetIncreaseUpdateBalances = {
+  mainnet: 10,
+  testnet: 10,
+  nakamotoTestnet: 10,
+  devnet: 1,
+};
+
+export const triggerNumberOfLastXBlocksBeforeRewardPhase = {
+  mainnet: 10,
+  testnet: 10,
+  nakamotoTestnet: 10,
+  devnet: 5,
+};
+
+export const feeContractCall = {
+  updateBalances: 1,
+  updateBalancesIncreasedFee: 2,
+};
+
+export const thresholdAmounPartialStackedByCycle = {
+  mainnet: 10,
+  testnet: 10,
+  nakamotoTestnet: 10,
+  devnet: 1,
+};
+
+export const limitPerReadOnly = {
+  mainnet: 12,
+  testnet: 12,
+  nakamotoTestnet: 12,
+  devnet: 6,
+};

back-end/rewarding/contracts.ts

@@ -0,0 +1,131 @@
+import { Cl, getAddressFromPrivateKey } from '@stacks/transactions';
+import { NetworkType, privateKey } from './network';
+import { poxAddressToTuple } from '@stacks/stacking';
+
+type NetworkTypeMiningAndStacking = Record<
+  NetworkType,
+  {
+    contractAddress: string;
+    contractName: string;
+    owner: string;
+  }
+>;
+type ContractTypes = 'stacking' | 'pox';
+type ContractMapping = Record<ContractTypes, NetworkTypeMiningAndStacking>;
+
+export const contractMapping: ContractMapping = {
+  // TODO: complete the rest
+  stacking: {
+    mainnet: {
+      contractAddress: 'SP1SCEXE6PMGPAC6B4N5P2MDKX8V4GF9QDE1FNNGJ',
+      contractName: 'degenlab-stacking-pool-pox4',
+      owner: 'SP1SCEXE6PMGPAC6B4N5P2MDKX8V4GF9QDE1FNNGJ',
+    },
+    testnet: {
+      contractAddress: '',
+      contractName: '',
+      owner: '',
+    },
+    devnet: {
+      contractAddress: 'ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM',
+      contractName: 'stacking-pool-test',
+      owner: 'ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM',
+    },
+    nakamotoTestnet: {
+      contractAddress: 'ST2D033K08AW2TPRTCFP3QD5VHZB7494TY0QXERJ1',
+      contractName: 'stacking-pool-v1',
+      owner: 'ST2D033K08AW2TPRTCFP3QD5VHZB7494TY0QXERJ1',
+    },
+  },
+  pox: {
+    mainnet: {
+      contractAddress: 'SP000000000000000000002Q6VF78',
+      contractName: 'pox-4',
+      owner: 'SP000000000000000000002Q6VF78',
+    },
+    testnet: {
+      contractAddress: 'ST000000000000000000002AMW42H',
+      contractName: 'pox-4',
+      owner: 'ST000000000000000000002AMW42H',
+    },
+    devnet: {
+      contractAddress: 'ST000000000000000000002AMW42H',
+      contractName: 'pox-4',
+      owner: 'ST000000000000000000002AMW42H',
+    },
+    nakamotoTestnet: {
+      contractAddress: 'ST000000000000000000002AMW42H',
+      contractName: 'pox-4',
+      owner: 'ST000000000000000000002AMW42H',
+    },
+  },
+};
+
+interface IFunctionMapping {
+  stacking: {
+    readOnlyFunctions: {
+      updatedBalancesGivenCycle: string;
+      checkWonBlockRewardsBatch: string;
+      checkClaimedBlocksRewardsBatch: string;
+      // calculateExtraReservedFunds: string;
+      // canWithdrawExtraReservedNow: string;
+      isPreparePhaseNow: string;
+      getPoxAddrIndices: string;
+      getStackersList: string;
+    };
+    publicFunctions: {
+      updateSCBalances: string;
+      maybeStackAggregationCommit: string;
+      batchRewardDistribution: string;
+      delegateStackStxMany: string;
+      // TODO: increase amount stacked when given threshold is met
+      // unlockExtraReservedFunds: string; // if worthy, unlock extra amount
+    };
+  };
+  pox: {
+    readOnlyFunctions: {
+      getPartialStackedByCycle: string;
+      getStackingMinimum: string;
+      getPoxInfo: string;
+    };
+    publicFunctions: {
+      allowContractCaller: string;
+      revokeDelegate: string;
+      disallowContractCaller: string;
+    };
+  };
+}
+
+export const functionMapping: IFunctionMapping = {
+  stacking: {
+    readOnlyFunctions: {
+      updatedBalancesGivenCycle: 'updated-balances-given-cycle',
+      checkClaimedBlocksRewardsBatch: 'check-claimed-blocks-rewards-batch',
+      checkWonBlockRewardsBatch: 'check-won-block-rewards-batch', // maximum 12 blocks
+      isPreparePhaseNow: 'is-prepare-phase-now',
+      // calculateExtraReservedFunds: 'calculate-extra-reserved-funds',
+      // canWithdrawExtraReservedNow: 'can-withdraw-extra-reserved-now',
+      getPoxAddrIndices: 'get-pox-addr-indices',
+      getStackersList: 'get-pool-members',
+    },
+    publicFunctions: {
+      updateSCBalances: 'update-sc-balances',
+      maybeStackAggregationCommit: 'maybe-stack-aggregation-commit',
+      // unlockExtraReservedFunds: 'unlock-extra-reserved-funds',
+      batchRewardDistribution: 'batch-reward-distribution',
+      delegateStackStxMany: 'delegate-stack-stx-many',
+    },
+  },
+  pox: {
+    readOnlyFunctions: {
+      getPartialStackedByCycle: 'get-partial-stacked-by-cycle',
+      getStackingMinimum: 'get-stacking-minimum',
+      getPoxInfo: 'get-pox-info',
+    },
+    publicFunctions: {
+      allowContractCaller: 'allow-contract-caller',
+      revokeDelegate: 'revoke-delegate-stx',
+      disallowContractCaller: 'disallow-contract-caller',
+    },
+  },
+};