search

coinbase / coinbase-sdk-nodejs

Other
33 stars 16 forks source link

feat: Expose staking reward format #230

Closed drohit-cb closed 1 week ago

drohit-cb commented 1 week ago

What changed? Why?

This PR helps expose a StakingRewardFormat enum so that users can query for rewards based on both USD and Native formats. Earlier this wasn't exposed and user would have to rely on a string such as "usd" to query.

Testing

>> npx ts-node --project tsconfig.json
> import { Coinbase, ExternalAddress, StakingRewardFormat } from "./src";
undefined
> let address = new ExternalAddress(Coinbase.networks.EthereumMainnet, "0x87Bf57c3d7B211a100ee4d00dee08435130A62fA");
undefined
>
undefined
> let rewards = await address.stakingRewards(Coinbase.assets.Eth, "2024-05-01T00:00:00Z", "2024-05-21T00:00:00Z", StakingRewardFormat.NATIVE);
undefined
> rewards.forEach(reward => console.log(reward.toString()));
StakingReward { date: '2024-05-01T00:00:00.000Z' address: '0x87bf57c3d7b211a100ee4d00dee08435130a62fa' amount: '0.000003230829007739' usd_value: '0.01' conversion_price: '2971.419922' conversion_time: '2024-05-02T00:09:00.000Z' }
StakingReward { date: '2024-05-02T00:00:00.000Z' address: '0x87bf57c3d7b211a100ee4d00dee08435130a62fa' amount: '0.000001810463295078' usd_value: '0.01' conversion_price: '2984.810059' conversion_time: '2024-05-03T00:09:00.000Z' }
StakingReward { date: '2024-05-03T00:00:00.000Z' address: '0x87bf57c3d7b211a100ee4d00dee08435130a62fa' amount: '0.000001934541883308' usd_value: '0.01' conversion_price: '3103.570068' conversion_time: '2024-05-04T00:09:00.000Z' }
StakingReward { date: '2024-05-04T00:00:00.000Z' address: '0x87bf57c3d7b211a100ee4d00dee08435130a62fa' amount: '0.00000181602093757' usd_value: '0.01' conversion_price: '3116.860107' conversion_time: '2024-05-05T00:09:00.000Z' }
StakingReward { date: '2024-05-05T00:00:00.000Z' address: '0x87bf57c3d7b211a100ee4d00dee08435130a62fa' amount: '0.000001625176235078' usd_value: '0.01' conversion_price: '3144.01001' conversion_time: '2024-05-06T00:09:00.000Z' }
StakingReward { date: '2024-05-06T00:00:00.000Z' address: '0x87bf57c3d7b211a100ee4d00dee08435130a62fa' amount: '0.000001647341369184' usd_value: '0.01' conversion_price: '3070.639893' conversion_time: '2024-05-07T00:09:00.000Z' }
StakingReward { date: '2024-05-07T00:00:00.000Z' address: '0x87bf57c3d7b211a100ee4d00dee08435130a62fa' amount: '0.000001611182036692' usd_value: '0.01' conversion_price: '3016.580078' conversion_time: '2024-05-08T00:09:00.000Z' }
StakingReward { date: '2024-05-08T00:00:00.000Z' address: '0x87bf57c3d7b211a100ee4d00dee08435130a62fa' amount: '0.000001682407434134' usd_value: '0.01' conversion_price: '2976.870117' conversion_time: '2024-05-09T00:09:00.000Z' }
StakingReward { date: '2024-05-09T00:00:00.000Z' address: '0x87bf57c3d7b211a100ee4d00dee08435130a62fa' amount: '0.000001884275039332' usd_value: '0.01' conversion_price: '3033.02002' conversion_time: '2024-05-10T00:09:00.000Z' }
StakingReward { date: '2024-05-10T00:00:00.000Z' address: '0x87bf57c3d7b211a100ee4d00dee08435130a62fa' amount: '0.000001472758583644' usd_value: '0.01' conversion_price: '2908.919922' conversion_time: '2024-05-11T00:09:00.000Z' }
StakingReward { date: '2024-05-11T00:00:00.000Z' address: '0x87bf57c3d7b211a100ee4d00dee08435130a62fa' amount: '0.000001717129587009' usd_value: '0.01' conversion_price: '2914.639893' conversion_time: '2024-05-12T00:09:00.000Z' }
StakingReward { date: '2024-05-12T00:00:00.000Z' address: '0x87bf57c3d7b211a100ee4d00dee08435130a62fa' amount: '0.000001637753776374' usd_value: '0.01' conversion_price: '2929.969971' conversion_time: '2024-05-13T00:09:00.000Z' }
StakingReward { date: '2024-05-13T00:00:00.000Z' address: '0x87bf57c3d7b211a100ee4d00dee08435130a62fa' amount: '0.000001720645037146' usd_value: '0.01' conversion_price: '2944.370117' conversion_time: '2024-05-14T00:09:00.000Z' }
StakingReward { date: '2024-05-14T00:00:00.000Z' address: '0x87bf57c3d7b211a100ee4d00dee08435130a62fa' amount: '0.000002046328146836' usd_value: '0.01' conversion_price: '2884.929932' conversion_time: '2024-05-15T00:09:00.000Z' }
StakingReward { date: '2024-05-15T00:00:00.000Z' address: '0x87bf57c3d7b211a100ee4d00dee08435130a62fa' amount: '0.000002032340276719' usd_value: '0.01' conversion_price: '3035' conversion_time: '2024-05-16T00:09:00.000Z' }
StakingReward { date: '2024-05-16T00:00:00.000Z' address: '0x87bf57c3d7b211a100ee4d00dee08435130a62fa' amount: '0.000001806634901341' usd_value: '0.01' conversion_price: '2945.51001' conversion_time: '2024-05-17T00:09:00.000Z' }
StakingReward { date: '2024-05-17T00:00:00.000Z' address: '0x87bf57c3d7b211a100ee4d00dee08435130a62fa' amount: '0.000001591502534823' usd_value: '0.01' conversion_price: '3092.560059' conversion_time: '2024-05-18T00:09:00.000Z' }
StakingReward { date: '2024-05-18T00:00:00.000Z' address: '0x87bf57c3d7b211a100ee4d00dee08435130a62fa' amount: '0.00000169055851866' usd_value: '0.01' conversion_price: '3121.060059' conversion_time: '2024-05-19T00:09:00.000Z' }
StakingReward { date: '2024-05-19T00:00:00.000Z' address: '0x87bf57c3d7b211a100ee4d00dee08435130a62fa' amount: '0.000001537556110879' usd_value: '0.01' conversion_price: '3074.280029' conversion_time: '2024-05-20T00:09:00.000Z' }
StakingReward { date: '2024-05-20T00:00:00.000Z' address: '0x87bf57c3d7b211a100ee4d00dee08435130a62fa' amount: '0.000002180781070852' usd_value: '0.01' conversion_price: '3680.570068' conversion_time: '2024-05-21T00:09:00.000Z' }
undefined
> let usdrewards = await address.stakingRewards(Coinbase.assets.Eth, "2024-05-01T00:00:00Z", "2024-05-21T00:00:00Z", StakingRewardFormat.USD);
undefined
> usdrewards.forEach(reward => console.log(reward.toString()));
StakingReward { date: '2024-05-01T00:00:00.000Z' address: '0x87bf57c3d7b211a100ee4d00dee08435130a62fa' amount: '0.01' usd_value: '0.01' conversion_price: '2971.419922' conversion_time: '2024-05-02T00:09:00.000Z' }
StakingReward { date: '2024-05-02T00:00:00.000Z' address: '0x87bf57c3d7b211a100ee4d00dee08435130a62fa' amount: '0.01' usd_value: '0.01' conversion_price: '2984.810059' conversion_time: '2024-05-03T00:09:00.000Z' }
StakingReward { date: '2024-05-03T00:00:00.000Z' address: '0x87bf57c3d7b211a100ee4d00dee08435130a62fa' amount: '0.01' usd_value: '0.01' conversion_price: '3103.570068' conversion_time: '2024-05-04T00:09:00.000Z' }
StakingReward { date: '2024-05-04T00:00:00.000Z' address: '0x87bf57c3d7b211a100ee4d00dee08435130a62fa' amount: '0.01' usd_value: '0.01' conversion_price: '3116.860107' conversion_time: '2024-05-05T00:09:00.000Z' }
StakingReward { date: '2024-05-05T00:00:00.000Z' address: '0x87bf57c3d7b211a100ee4d00dee08435130a62fa' amount: '0.01' usd_value: '0.01' conversion_price: '3144.01001' conversion_time: '2024-05-06T00:09:00.000Z' }
StakingReward { date: '2024-05-06T00:00:00.000Z' address: '0x87bf57c3d7b211a100ee4d00dee08435130a62fa' amount: '0.01' usd_value: '0.01' conversion_price: '3070.639893' conversion_time: '2024-05-07T00:09:00.000Z' }
StakingReward { date: '2024-05-07T00:00:00.000Z' address: '0x87bf57c3d7b211a100ee4d00dee08435130a62fa' amount: '0.01' usd_value: '0.01' conversion_price: '3016.580078' conversion_time: '2024-05-08T00:09:00.000Z' }
StakingReward { date: '2024-05-08T00:00:00.000Z' address: '0x87bf57c3d7b211a100ee4d00dee08435130a62fa' amount: '0.01' usd_value: '0.01' conversion_price: '2976.870117' conversion_time: '2024-05-09T00:09:00.000Z' }
StakingReward { date: '2024-05-09T00:00:00.000Z' address: '0x87bf57c3d7b211a100ee4d00dee08435130a62fa' amount: '0.01' usd_value: '0.01' conversion_price: '3033.02002' conversion_time: '2024-05-10T00:09:00.000Z' }
StakingReward { date: '2024-05-10T00:00:00.000Z' address: '0x87bf57c3d7b211a100ee4d00dee08435130a62fa' amount: '0.01' usd_value: '0.01' conversion_price: '2908.919922' conversion_time: '2024-05-11T00:09:00.000Z' }
StakingReward { date: '2024-05-11T00:00:00.000Z' address: '0x87bf57c3d7b211a100ee4d00dee08435130a62fa' amount: '0.01' usd_value: '0.01' conversion_price: '2914.639893' conversion_time: '2024-05-12T00:09:00.000Z' }
StakingReward { date: '2024-05-12T00:00:00.000Z' address: '0x87bf57c3d7b211a100ee4d00dee08435130a62fa' amount: '0.01' usd_value: '0.01' conversion_price: '2929.969971' conversion_time: '2024-05-13T00:09:00.000Z' }
StakingReward { date: '2024-05-13T00:00:00.000Z' address: '0x87bf57c3d7b211a100ee4d00dee08435130a62fa' amount: '0.01' usd_value: '0.01' conversion_price: '2944.370117' conversion_time: '2024-05-14T00:09:00.000Z' }
StakingReward { date: '2024-05-14T00:00:00.000Z' address: '0x87bf57c3d7b211a100ee4d00dee08435130a62fa' amount: '0.01' usd_value: '0.01' conversion_price: '2884.929932' conversion_time: '2024-05-15T00:09:00.000Z' }
StakingReward { date: '2024-05-15T00:00:00.000Z' address: '0x87bf57c3d7b211a100ee4d00dee08435130a62fa' amount: '0.01' usd_value: '0.01' conversion_price: '3035' conversion_time: '2024-05-16T00:09:00.000Z' }
StakingReward { date: '2024-05-16T00:00:00.000Z' address: '0x87bf57c3d7b211a100ee4d00dee08435130a62fa' amount: '0.01' usd_value: '0.01' conversion_price: '2945.51001' conversion_time: '2024-05-17T00:09:00.000Z' }
StakingReward { date: '2024-05-17T00:00:00.000Z' address: '0x87bf57c3d7b211a100ee4d00dee08435130a62fa' amount: '0.01' usd_value: '0.01' conversion_price: '3092.560059' conversion_time: '2024-05-18T00:09:00.000Z' }
StakingReward { date: '2024-05-18T00:00:00.000Z' address: '0x87bf57c3d7b211a100ee4d00dee08435130a62fa' amount: '0.01' usd_value: '0.01' conversion_price: '3121.060059' conversion_time: '2024-05-19T00:09:00.000Z' }
StakingReward { date: '2024-05-19T00:00:00.000Z' address: '0x87bf57c3d7b211a100ee4d00dee08435130a62fa' amount: '0.01' usd_value: '0.01' conversion_price: '3074.280029' conversion_time: '2024-05-20T00:09:00.000Z' }
StakingReward { date: '2024-05-20T00:00:00.000Z' address: '0x87bf57c3d7b211a100ee4d00dee08435130a62fa' amount: '0.01' usd_value: '0.01' conversion_price: '3680.570068' conversion_time: '2024-05-21T00:09:00.000Z' }
undefined

Qualified Impact