Merge pull request #35 from Concordium/delegation

Delegation

CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## 0.8.0 2022-03-15
+
+### Added
+
+- Support for getting baker list from node.
+- Support for getting status of Baker-/L-pool (required node to have protocol version 4 or later).
+- Support for getting reward status of chain at specific block.
+- Helper functions for determining the version of `BlockSummary` and nested types. 
+- Helper functions for determining the version of `AccountInfo` variants. 
+
+### Changed
+
+- Updated `BlockSummary` type to include new version, effective from protocol version 4.
+- Updated `AccountInfo` type to include new fields related to delegation introduced with protocol version 4.
+
 ## 0.7.1 2022-03-09
 
 ### Added

README.md

@@ -542,6 +542,26 @@ const peersList = peerListResponse.getPeersList();
 ...
 ```
 
+## getBakerList
+Retrieves the list of ID's for registered bakers on the network at a specific block.
+```js
+const blockHash = "7f7409679e53875567e2ae812c9fcefe90ced8961d08554756f42bf268a42749";
+const bakerIds = await client.getBakerList(blockHash);
+...
+```
+
+## getPoolStatus
+Retrieves the status of a pool (either L-Pool or specific baker) at a specific block.
+If a baker ID is specified, the status of that baker is returned. To get the status of the L-Pool, a baker ID should be left undefined.
+```js
+const blockHash = "7f7409679e53875567e2ae812c9fcefe90ced8961d08554756f42bf268a42749";
+const bakerId = BigInt(1);
+
+const bakerStatus = await client.getPoolStatus(blockHash, bakerId);
+const lPoolStatus = await client.getPoolStatus(blockHash); 
+...
+```
+
 ## Check block for transfers with memo
 The following example demonstrates how to check and parse a block 
 for transfers with a memo.

package.json

@@ -1,6 +1,6 @@
 {
     "name": "@concordium/node-sdk",
-    "version": "0.7.1",
+    "version": "0.8.0-alpha.0",
     "description": "Helpers for interacting with the Concordium node",
     "repository": {
         "type": "git",

src/accountHelpers.ts

@@ -0,0 +1,37 @@
+import {
+    ReduceStakePendingChange,
+    RemovalPendingChange,
+    StakePendingChange,
+    StakePendingChangeV1,
+} from '.';
+import {
+    AccountInfo,
+    AccountInfoBaker,
+    AccountInfoBakerV1,
+    AccountInfoDelegator,
+} from './types';
+
+export const isDelegatorAccount = (
+    ai: AccountInfo
+): ai is AccountInfoDelegator =>
+    (ai as AccountInfoDelegator).accountDelegation !== undefined;
+
+export const isBakerAccount = (ai: AccountInfo): ai is AccountInfoBaker =>
+    (ai as AccountInfoBaker).accountBaker !== undefined;
+
+export const isBakerAccountV1 = (ai: AccountInfo): ai is AccountInfoBakerV1 =>
+    (ai as AccountInfoBakerV1).accountBaker?.bakerPoolInfo !== undefined;
+
+export const isStakePendingChangeV1 = (
+    spc: StakePendingChange
+): spc is StakePendingChangeV1 =>
+    (spc as StakePendingChangeV1).effectiveTime !== undefined;
+
+export const isReduceStakePendingChange = (
+    spc: ReduceStakePendingChange | RemovalPendingChange
+): spc is ReduceStakePendingChange =>
+    (spc as ReduceStakePendingChange).newStake !== undefined;
+
+export const isRemovalPendingChange = (
+    spc: ReduceStakePendingChange | RemovalPendingChange
+): spc is RemovalPendingChange => !isReduceStakePendingChange(spc);

src/blockSummaryHelpers.ts

@@ -0,0 +1,34 @@
+import {
+    Authorizations,
+    AuthorizationsV1,
+    BlockSummary,
+    BlockSummaryV1,
+    ChainParameters,
+    ChainParametersV1,
+    Keys,
+    KeysV1,
+    UpdateQueues,
+    UpdateQueuesV1,
+    Updates,
+    UpdatesV1,
+} from './types';
+
+export const isAuthorizationsV1 = (a: Authorizations): a is AuthorizationsV1 =>
+    (a as AuthorizationsV1).timeParameters !== undefined;
+
+export const isChainParametersV1 = (
+    cp: ChainParameters
+): cp is ChainParametersV1 =>
+    (cp as ChainParametersV1).mintPerPayday !== undefined;
+
+export const isKeysV1 = (k: Keys): k is KeysV1 =>
+    isAuthorizationsV1(k.level2Keys);
+
+export const isUpdateQueuesV1 = (uq: UpdateQueues): uq is UpdateQueuesV1 =>
+    (uq as UpdateQueuesV1).timeParameters !== undefined;
+
+export const isUpdatesV1 = (u: Updates): u is UpdatesV1 =>
+    isUpdateQueuesV1(u.updateQueues);
+
+export const isBlockSummaryV1 = (bs: BlockSummary): bs is BlockSummaryV1 =>
+    (bs as BlockSummaryV1).protocolVersion !== undefined;

src/client.ts

@@ -8,6 +8,7 @@ import {
     BlockHeight,
     Empty,
     GetAddressInfoRequest,
+    GetPoolStatusRequest,
     GetModuleSourceRequest,
     PeerListResponse,
     PeersRequest,
@@ -26,11 +27,8 @@ import {
     AccountTransaction,
     AccountTransactionSignature,
     ArInfo,
-    BakerReduceStakePendingChange,
-    BakerRemovalPendingChange,
     BlockInfo,
     BlockSummary,
-    ChainParameters,
     ConsensusStatus,
     ContractAddress,
     CredentialDeploymentTransaction,
@@ -49,9 +47,25 @@ import {
     Versioned,
     InstanceInfo,
     InstanceInfoSerialized,
+    BakerId,
+    ChainParametersV0,
+    ChainParametersV1,
+    PoolStatus,
+    BakerPoolStatusDetails,
+    CurrentPaydayBakerPoolStatus,
+    LPoolStatusDetails,
+    KeysMatching,
+    BakerPoolPendingChangeReduceBakerCapitalDetails,
+    LPoolStatus,
+    BakerPoolStatus,
+    RewardStatusV0,
+    RewardStatus,
+    RewardStatusV1,
+    ReduceStakePendingChangeV0,
 } from './types';
 import {
     buildJsonResponseReviver,
+    intListToStringList,
     intToStringTransformer,
     isValidHash,
     unwrapBoolResponse,
@@ -60,6 +74,8 @@ import {
 import { GtuAmount } from './types/gtuAmount';
 import { ModuleReference } from './types/moduleReference';
 import { Buffer as BufferFormater } from 'buffer/';
+import { ReduceStakePendingChangeV1 } from '.';
+
 /**
  * A concordium-node specific gRPC client wrapper.
  *
@@ -204,15 +220,17 @@ export default class ConcordiumNodeClient {
             this.client.getAccountInfo,
             getAddressInfoRequest
         );
-        const datePropertyKeys: (keyof ReleaseSchedule)[] = ['timestamp'];
+        const datePropertyKeys: (
+            | keyof ReleaseSchedule
+            | keyof ReduceStakePendingChangeV1
+        )[] = ['timestamp', 'effectiveTime'];
         const bigIntPropertyKeys: (
             | keyof AccountInfo
             | keyof AccountEncryptedAmount
             | keyof AccountReleaseSchedule
             | keyof ReleaseSchedule
             | keyof AccountBakerDetails
-            | keyof BakerReduceStakePendingChange
-            | keyof BakerRemovalPendingChange
+            | keyof ReduceStakePendingChangeV0
         )[] = [
             'accountAmount',
             'accountNonce',
@@ -318,7 +336,7 @@ export default class ConcordiumNodeClient {
             | keyof PartyInfo
             | keyof FinalizationData
             | keyof TransactionSummary
-            | keyof ChainParameters
+            | keyof (ChainParametersV0 & ChainParametersV1)
             | keyof ExchangeRate
             | keyof UpdateQueue
             | keyof KeysWithThreshold
@@ -332,15 +350,23 @@ export default class ConcordiumNodeClient {
             'cost',
             'energyCost',
             'index',
-            'bakerCooldownEpochs',
-            'minimumThresholdForBaking',
             'foundationAccountIndex',
             'numerator',
             'denominator',
             'nextSequenceNumber',
             'amount',
             'index',
             'subindex',
+
+            // v0 keys
+            'bakerCooldownEpochs',
+            'minimumThresholdForBaking',
+
+            // v1 keys
+            'rewardPeriodLength',
+            'minimumEquityCapital',
+            'poolOwnerCooldown',
+            'delegatorCooldown',
         ];
 
         return unwrapJsonResponse<BlockSummary>(
@@ -601,6 +627,140 @@ export default class ConcordiumNodeClient {
         }
     }
 
+    async getRewardStatus(
+        blockHash: string
+    ): Promise<RewardStatus | undefined> {
+        if (!isValidHash(blockHash)) {
+            throw new Error('The input was not a valid hash: ' + blockHash);
+        }
+
+        type DateKey = KeysMatching<RewardStatusV1, Date>;
+        type BigIntKey = KeysMatching<RewardStatusV0 & RewardStatusV1, bigint>;
+
+        const dates: DateKey[] = ['nextPaydayTime'];
+        const bigInts: BigIntKey[] = [
+            'protocolVersion',
+            'gasAccount',
+            'totalAmount',
+            'totalStakedCapital',
+            'bakingRewardAccount',
+            'totalEncryptedAmount',
+            'finalizationRewardAccount',
+            'foundationTransactionRewards',
+        ];
+
+        const bh = new BlockHash();
+        bh.setBlockHash(blockHash);
+
+        const response = await this.sendRequest(
+            this.client.getRewardStatus,
+            bh
+        );
+
+        return unwrapJsonResponse<RewardStatus>(
+            response,
+            buildJsonResponseReviver(dates, bigInts),
+            intToStringTransformer(bigInts)
+        );
+    }
+
+    /**
+     * Retrieve list of bakers on the network.
+     * @param blockHash the block hash to get the smart contact instances at
+     * @returns A JSON list of baker IDs
+     */
+    async getBakerList(blockHash: string): Promise<BakerId[] | undefined> {
+        if (!isValidHash(blockHash)) {
+            throw new Error('The input was not a valid hash: ' + blockHash);
+        }
+
+        const bh = new BlockHash();
+        bh.setBlockHash(blockHash);
+
+        const response = await this.sendRequest(this.client.getBakerList, bh);
+
+        return unwrapJsonResponse<BakerId[]>(
+            response,
+            undefined,
+            intListToStringList
+        )?.map((v) => BigInt(v));
+    }
+
+    /**
+     * Gets the status the L-pool.
+     * @param blockHash the block hash the status at
+     * @returns The status of the L-pool.
+     */
+    async getPoolStatus(blockHash: string): Promise<LPoolStatus | undefined>;
+    /**
+     * Gets the status a baker.
+     * @param blockHash the block hash the status at
+     * @param bakerId the ID of the baker to get the status for.
+     * @returns The status of the corresponding baker pool.
+     */
+    async getPoolStatus(
+        blockHash: string,
+        bakerId: BakerId
+    ): Promise<BakerPoolStatus | undefined>;
+    /**
+     * Gets the status of either a baker, if a baker ID is supplied, or the L-pool if left undefined.
+     * @param blockHash the block hash the status at
+     * @param [bakerId] the ID of the baker to get the status for. If left undefined, the status of the L-pool is returned.
+     * @returns The status of the corresponding pool.
+     */
+    async getPoolStatus(
+        blockHash: string,
+        bakerId?: BakerId
+    ): Promise<PoolStatus | undefined>;
+    async getPoolStatus(
+        blockHash: string,
+        bakerId?: BakerId
+    ): Promise<PoolStatus | undefined> {
+        if (!isValidHash(blockHash)) {
+            throw new Error('The input was not a valid hash: ' + blockHash);
+        }
+
+        const req = new GetPoolStatusRequest();
+        req.setBlockHash(blockHash);
+        req.setLPool(bakerId === undefined);
+
+        if (bakerId !== undefined) {
+            req.setBakerId(bakerId.toString());
+        }
+
+        type DateKey = KeysMatching<
+            BakerPoolPendingChangeReduceBakerCapitalDetails,
+            Date
+        >;
+        type BigIntKey = KeysMatching<
+            BakerPoolStatusDetails &
+                LPoolStatusDetails &
+                CurrentPaydayBakerPoolStatus,
+            bigint
+        >;
+
+        const dates: DateKey[] = ['effectiveTime'];
+        const bigInts: BigIntKey[] = [
+            'bakerId',
+            'bakerEquityCapital',
+            'delegatedCapital',
+            'delegatedCapitalCap',
+            'currentPaydayTransactionFeesEarned',
+            'currentPaydayDelegatedCapital',
+            'blocksBaked',
+            'transactionFeesEarned',
+            'effectiveStake',
+        ];
+
+        const response = await this.sendRequest(this.client.getPoolStatus, req);
+
+        return unwrapJsonResponse<PoolStatus>(
+            response,
+            buildJsonResponseReviver(dates, bigInts),
+            intToStringTransformer(bigInts)
+        );
+    }
+
     async getModuleSource(
         blockHash: string,
         moduleReference: ModuleReference

src/index.ts

@@ -40,3 +40,4 @@ export {
 } from './credentialDeploymentTransactions';
 export { isAlias, getAlias } from './alias';
 export { deserializeContractState } from './deserialization';
+export * from './blockSummaryHelpers';

src/rewardStatusHelpers.ts

@@ -0,0 +1,4 @@
+import { RewardStatus, RewardStatusV1 } from './types';
+
+export const isRewardStatusV1 = (rs: RewardStatus): rs is RewardStatusV1 =>
+    (rs as RewardStatusV1).protocolVersion !== undefined;