List staking balances

[marchsu]

What changed? Why?

• merge into v0.0.16
• add StakingBalance with static method to get historical staking balances from backend
• add this feature to Address\Wallet\External Address

Qualified Impact

const { Coinbase, StakingBalance } = require("./dist/index.js");


const coinbase = Coinbase.configureFromJson({ filePath: "~~~", basePath: "~~~" });
StakingBalance.list( Coinbase.networks.EthereumMainnet , Coinbase.assets.Eth, "0x80000001677f23a227dfed6f61b132d114be83b8ad0aa5f3c5d1d77e6ee0bf5f73b0af750cc34e8f2dae73c21dc36f4a", "2024-07-01T00:00:00Z", "2024-07-03T00:00:00Z").then(balances => {
    balances.forEach(balance => {console.log(balance.toString())});
}, error => {
    console.log(error);
});

Result

Model

StakingBalance {
  model: {
    address: '0x80000001677f23a227dfed6f61b132d114be83b8ad0aa5f3c5d1d77e6ee0bf5f73b0af750cc34e8f2dae73c21dc36f4a',
    bonded_stake: { amount: '32', asset: [Object] },
    date: '2024-07-04',
    participant_type: 'VALIDATOR',
    unbonded_balance: { amount: '5.483882434', asset: [Object] }
  }
}
StakingBalance {
  model: {
    address: '0x80000001677f23a227dfed6f61b132d114be83b8ad0aa5f3c5d1d77e6ee0bf5f73b0af750cc34e8f2dae73c21dc36f4a',
    bonded_stake: { amount: '32', asset: [Object] },
    date: '2024-07-03',
    participant_type: 'VALIDATOR',
    unbonded_balance: { amount: '5.481819906', asset: [Object] }
  }
}

ToString()

StakingBalance { date: '2024-07-04T00:00:00.000Z' address: '0x80000001677f23a227dfed6f61b132d114be83b8ad0aa5f3c5d1d77e6ee0bf5f73b0af750cc34e8f2dae73c21dc36f4a' bondedStake: 'Balance { amount: '32' asset: 'Asset{ networkId: ethereum-mainnet, assetId: eth, contractAddress: undefined, decimals: 18 }' }' unbondedBalance: 'Balance { amount: '5.483882434' asset: 'Asset{ networkId: ethereum-mainnet, assetId: eth, contractAddress: undefined, decimals: 18 }' }' participantType: 'VALIDATOR' }

StakingBalance { date: '2024-07-03T00:00:00.000Z' address: '0x80000001677f23a227dfed6f61b132d114be83b8ad0aa5f3c5d1d77e6ee0bf5f73b0af750cc34e8f2dae73c21dc36f4a' bondedStake: 'Balance { amount: '32' asset: 'Asset{ networkId: ethereum-mainnet, assetId: eth, contractAddress: undefined, decimals: 18 }' }' unbondedBalance: 'Balance { amount: '5.481819906' asset: 'Asset{ networkId: ethereum-mainnet, assetId: eth, contractAddress: undefined, decimals: 18 }' }' participantType: 'VALIDATOR' }

[cb-heimdall]

🟡 Heimdall Review Status

Requirement	Status	More Info
Reviews	🟡 0/1	Denominator calculation Show calculation 1 if user is bot 0 1 if user is external 0 From .codeflow.yml 1 Additional review requirements Show calculation Max 0 0 From CODEOWNERS 0 Global minimum 0 Max 1 1 1 if commit is unverified 0 Sum 1

[John-peterson-coinbase]

Should this be a method on the Address class (ref) instead of static method here?

[marchsu]

we have an equivalent for listing staking rewards , I think we need both

[John-peterson-coinbase]

I see. That pattern is fine. Can you please add the Address class change to this PR.

[marchsu]

added, wondering if I can test the change to Address, currently only unit tests added to all related files including Wallet, External Address & Wallet Address
hardcoded the address in the list and verify the call from address functions well

[John-peterson-coinbase]

Cool. Thanks! You can also call this method on an ExternalAddress subclass instance if you want to test on a specific address.

[marchsu]

thanks, that works as well

const addr = new ExternalAddress(Coinbase.networks.EthereumMainnet,  "0x80000001677f23a227dfed6f61b132d114be83b8ad0aa5f3c5d1d77e6ee0bf5f73b0af750cc34e8f2dae73c21dc36f4a")

addr.historicalStakingBalances(Coinbase.assets.Eth, "2024-07-01T00:00:00Z", "2024-07-03T00:00:00Z").then(balances => {
    balances.forEach(balance => {console.log(balance)});
} ).catch(error => {
    console.log(error);
});

StakingBalance {
  model: {
    address: '0x80000001677f23a227dfed6f61b132d114be83b8ad0aa5f3c5d1d77e6ee0bf5f73b0af750cc34e8f2dae73c21dc36f4a',
    bonded_stake: { amount: '32', asset: [Object] },
    date: '2024-07-02',
    participant_type: 'VALIDATOR',
    unbonded_balance: { amount: '5.479839548', asset: [Object] }
  }
}

toString()

StakingBalance { date: '2024-07-02T00:00:00.000Z' address: '0x80000001677f23a227dfed6f61b132d114be83b8ad0aa5f3c5d1d77e6ee0bf5f73b0af750cc34e8f2dae73c21dc36f4a' bondedStake: 'Balance { amount: '32' asset: 'Asset{ networkId: ethereum-mainnet, assetId: eth, contractAddress: undefined, decimals: 18 }' }' unbondedBalance: 'Balance { amount: '5.479839548' asset: 'Asset{ networkId: ethereum-mainnet, assetId: eth, contractAddress: undefined, decimals: 18 }' }' participantType: 'VALIDATOR' }

[John-peterson-coinbase]

Please add an update to CHANGELOG.md with these changes

[John-peterson-coinbase]

Please prefix all of the static method jest descriptions with #

Ex. describe("#staticMethodName", () => {...}

Otherwise LGTM!

[John-peterson-coinbase]

Suggested change

	describe(".list", () => {
	describe("#list", () => {