Skip to content

Conversation

@alex-stone
Copy link
Contributor

@alex-stone alex-stone commented Aug 22, 2024

What changed? Why?

This preps the v0.1.0 version for release

[0.1.0] - 2024-08-22

Added

  • Add listHistoricalBalances wallet method, that lists the historical balances for the wallet's default address.
  • Add toAddressId() method to Transaction class

Removed

  • Remove user concept from the SDK
  • Remove "pending" status from StakingOperationStatusEnum
  • Add staking operation class helper methods like isTerminalState, isFailedState and isCompleteState.
  • Add validator status enum

Changed

  • The createTransfer and createTrade functions no longer wait for the transactions to confirm or
    fail on-chain.
    • Now they return a Transfer and Trade object respectively, which support the wait
      function, e.g. await transfer.wait().
    • This ensures that the developer has a reference to the object in case there is a timeout while
      waiting to land on-chain.
  • Update reload() method to work with both External and Wallet address.
  • Update createStakingOperation logic to make sure we only pull in newer unsigned txs from the server.
    This is especially important for External Address use-case where tx signing and broadcast status is maintained on client side, and we risk overwriting the existing txs.
  • Increase default timeout for createStakingOperation to 10 min.

Qualified Impact

xinyu-li-cb and others added 30 commits August 14, 2024 19:56
* [HistoricalBalances] add wallet level function

* fix format

* refine comment
Expose toAddressId() method on Transaction class
This makes it so that the SDK passes the address index when
deriving and registering addreses.

This is important so that we can properly track the address index
on the backend and ensure we return addresses in the appopriate
order.
comments

test and make constructor private

add types for params

npm run format
Pass address index when registering address
Cleanup staking operation + wallet address related code
This makes it so that we dynamically update networks as we update
our OpenAPI spec.

This does not add a whole network object like we have in ruby,
because we probably want to play around with how people want to
use the various objects in TS before doing that.
This should be moved to the backend similar to the ruby SDK,
however that will require a bit of a refactor around the network
objects.
…constants

Support dynamic network constants
This removes the user concept in favor of directly creating, listing,
importing, and fetching wallets.
This updates the docs, readmes, and changelog to reflect the
removal of the user concept.
This adds a correlation context header that includes the version
and language of the SDK.

This will be used to track what versions of the SDK developers are
using and to help reach out to upgrade versions.
Add correlation context to request headers
…t_model

Add wallet model support for Dedicated ETH Staking
* [hotfix] patch for page setting

* add test case
@cb-heimdall
Copy link

cb-heimdall commented Aug 22, 2024

✅ Heimdall Review Status

Requirement Status More Info
Reviews 1/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

jazz-cb
jazz-cb previously approved these changes Aug 22, 2024
shreifabdallah and others added 17 commits August 22, 2024 12:59
This decouples the action of creating a transfer or trade object
from the actual waiting for it to confirm or fail on-chain.

Without this we cannot create many transfer concurrently without
running into a plethora of 429 issues.

We also cannot recover gracefully since we never get the transfer
object returns, so cannot subsequently make fetches for its status
if it happens to fail (or returns a temporary error, e.g. 429).
@cb-heimdall cb-heimdall dismissed jazz-cb’s stale review August 22, 2024 20:00

Approved review 2255535173 from jazz-cb is now dismissed due to new commit. Re-request for approval.

@alex-stone alex-stone requested a review from jazz-cb August 22, 2024 20:04
@alex-stone alex-stone merged commit ec60f5a into master Aug 22, 2024
@alex-stone alex-stone deleted the v0.1.0 branch August 22, 2024 20:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

9 participants