All sdk services extends from Service base class, which could and actually has it's own methods. In mocks.generator we are scanning services prototype which gave us only mehtods from current class. It would be nice to have all methods for this scan.

in places like https://github.com/Badger-Finance/badger-sdk/blob/main/src/vaults/vaults.service.ts#L286 and https://github.com/Badger-Finance/badger-sdk/blob/main/src/vaults/vaults.service.ts#L281 we are sure we have available the transactions info so there's no need to use the default params type where it is optional

Background

Allow inspection of treasury multi-sigs positions over time and the yield they had generated. Should contain:

• Convex position info breakdown and yield generated

• Aave position info collateral breakdown and yield generated

• Uniswap v3 NFTs position, holdings on each NFT and fees generated over time

• Claimable amounts in the tree from dogfooding, such as the dog food in this sett

Check if Citadel contracts have some data to give on key methods. If so, add service to generator.

Current realisation of mocks.processor taking only one variant of args taken from config to load method and save it .json file. Would be nice to have possibility of adding different variants of args to receive more mocks for the end user.
Here is code placing, that can help:
https://github.com/Badger-Finance/badger-sdk/tree/main/mocks.pkg/src/config
https://github.com/Badger-Finance/badger-sdk/blob/main/mocks.pkg/src/processor/mocks.processor.ts

Background

In order to complete Badger-Finance/v2-ui#2423. Provide interface for interaction with TimelockController contract and further utilisation in api.

Tasks

• Governance service, with abis and interfaces for contract above
• Cover base service and methods
• Dogfood api endpoints in api service
  • Provide data for mocks of endpoints above
• Fetch TimelockController from registry
• Improve deloyedAt script for events in dynamic addresses
• Generate mocks for new service

Background

The SDK / API implementations currently support a subset of the queries possible to the Badger API. Implement the missing API queries.

API documentation in full is found here.

The full list of implemented endpoints is found here.

Tasks

• Add missing API endpoints with proper query params
• Add tests where possible / applicable

Background

To provide convenient unit testing with our sdk, gather responses from onchain and offchain data in separate deployed mocks lib.
As sdk goals to become main fetching point of badger data, it would be easy to mock this resp and use such tools as snapshot testing, to keep ur services coverage at high lvl.

Tasks

• Write mocks processor, that will cover all sdk methods.
• Save responses to .json files, for easy imports
• Export .json files in one entry, pack as a lib
• Deploy with semantic-release-bot (should be synced with main lib)

if a contract call fails before the user signs the transaction it is recognized as a transaction rejected because the status flag that is initially UserConfirmation is never updated. Example:

let result = TransactionStatus.UserConfirmation;

try {
    tx = await contract.call(param, { ...overrides });
} catch (error) {
  // at this point result will always be user confirmation if contract.call threw an error
  if (result === ransactionStatus.UserConfirmation) {
   onRejection()
    ...
  }
}

For now mocks.pkg generates only .json's for eth and polygon networks. Need to enable all other networks, note that not methods would work properly and not all contract are propagated on all networks, so u would need to change args from base config or ignore method, if it`s not possible to make it work.

List of chains that processor is scanning:
https://github.com/Badger-Finance/badger-sdk/blob/main/mocks.pkg/src/constants.ts#L16
Config files with methods args for chains:
https://github.com/Badger-Finance/badger-sdk/tree/main/mocks.pkg/src/config

We already have .json files with responses from all sdk services. But mocks.pkg naturally packed as npm lib. We have clients, which is written in python, so would be gr8 if they could reuse mocks in their test flow.

My variants:

• pack as pypi library and add to deploy github.flow (the best i guess)
• .py script which will load this mocks into project (quick variant)

there are multiple zap options to mint ibbtc, all with a different input asset. This is currently handled in the UI with a factory but can be abstracted in the sdk
Badger-Finance/v2-ui#2098 (comment)

Summary

The Badger DAO needs to provide access to data pertaining to the Citadel DAO. The following are key components in the Citadel ecosystem that need to be supported:

Citadel Minter
https://github.com/Citadel-DAO/citadel-contracts/blob/main/src/CitadelMinter.sol

Supply Schedule
https://github.com/Citadel-DAO/citadel-contracts/blob/main/src/interfaces/citadel/ISupplySchedule.sol

Staked Citadel Locker
https://github.com/Citadel-DAO/staked-citadel-locker/blob/main/src/StakedCitadelLocker.sol

Requirements

Citadel Minter

• support proxied supplySchedule calls
• support lastMintTimestamp
• support CitadelDistributionToStaking historic queries, these should be formatted similarly to VaultPerformanceEvent if possible

Staked Citadel Locker

• support rewardDistributors
• support rewardData query
• support supply, and epochs queries
• support balances, userLocks queries
• getRewardTokens
• claimableRewards
• rewardWeightOf
• lockedBalanceOf
• balanceOf
• balanceAtEpochOf
• etc... (note: we may just skip some of them possible not needed)

Summary

Tokens services loadBalances only allows looking up the user balance who created the SDK provider.
Add LoadBalancesOptions to include

{
  tokens: string[],
  address?: string,
}

The default address looked up is the signer of the SDK provider if one exists, or else throws.

Summary

• replace loadVaults and loadVault with API v3 variants of request / responses
• as an option for temporarily backwards compatibility or optionality expose loadVaultsV2 and loadVaultV2

naming on the latter requirement is potentially suspect, and option to alternative naming conventions - not loving the clash with 'vault version' ideas

Add sdk.api in generation process of mocks. Should be added here,
https://github.com/Badger-Finance/badger-sdk/blob/main/mocks.pkg/src/enums/sdk.services.enum.ts as new val.
And args.cfg for chains should be filled this appropriate values. U can find them right here
https://github.com/Badger-Finance/badger-sdk/tree/main/mocks.pkg/src/config

Sometimes it's needed to regen some specific mock only for one method. It would be convenient to do with method name as cli args to mocks:gen command

Allow easy access to Harvest and TreeDistribution event data for all vaults.
A claim of rewards by a vault may trigger multiple of the same event types.

Support the following:

• query last x harvests
• query harvests in specific time ranges (before x, after x, in range x-y)

All requests should group these events by timestamp when counting the number of requested items.

Example:

Background

Allow the SDK to enable one liner deposits into a Badger vault. Vaults require approvals for depositing. A vault deposit should:

• verify adequate token deposit allowances for the deposit contract
• increase allowances for deposit contract as required
• deposit the underlying token into the vault
• add tests where possible / applicable

Methods are discovered from service's prototypes, load responses and save them to .json files. The problem is, that .json files from deleted methods are not removing automatically and will trash library with unnecessary Kbyts.

Add cleaner, and then we can call it on husky hook along with guard.

Summary

Implement the following interface on the base sdk object.

async function getGasPrices(): Record<GasSpeed, BigNumber>;

Requirements

• Support EIP-1559 gas estimations on networks where possible
• Fallback to Legacy gas estimations on networks where required
• Exposed EIP-1559 support in a configured or programmatic way (if possible)

Examples

https://github.com/Badger-Finance/badger-api/blob/main/src/chains/config/chain.config.ts#L110-L150

Background

Allow the SDK to enable one liner withdraws from a Badger vault. Vaults require approvals on receipt tokens for withdrawing. A vault withdraw should:

• #109
• increase allowances for vault contract as required
• withdraw the underlying token from the vault
• add tests where possible / applicable

the current setup of the sdk does not allow for a good testing experience for third party integrations (api, ui, etc.)

https://github.com/Badger-Finance/badger-sdk/blob/main/src/vaults/vaults.service.ts#L300

vaults service, and rewards service both wait on the registry to be ready when they are created. this call cannot be mocked by outside users easily (or stopped)

Summary

• support connecting to a geyser and submitting a withdraw

Summary

The SDK is meant to be used in web apps and should be performant. Optimize our package for the best in browser experience.

Background

Similar to the way the SDK implements the API interface for easily querying data from our implementation, the SDK should also support querying directly the subgraphs that Badger maintains to do whatever data analysis they wish. The GraphQL support should follow the same pattern as the API support. It should be able to be a stand alone usage while also available within the SDK itself.

The SDK is a general purpose tool that will implement all methods of data retrieval for information Badger offers as well as implement a select set of user functionality. The easy of querying the Badger subgraph fits into this goal.

The ideal example of how to integrate this is available in the API GraphQL Configuration.

Tasks

• Add GraphQL, queries, fragments, and configuration
• Add BadgerGraph support as stand alone and sdk offering
• Add test coverage where possible / applicable

It seems like now after mocks:gen command, changed are not commited to master on CI, this cause cache missmatch to grow proportionally to new changes.

Background

Guarded and experimental vaults (status 1 and 2) may have guest lists associated with them. These guest lists enforce who may or may not deposit as well as have metadata information regarding individual and total vault caps.

Enable utility methods to allow for exposing these limits with optional functionality to get user specific caps it an address is provided.

Key Data

• Total Vault Cap
• Total User Cap
• Remaining Vault Cap
• Remaining User Cap (if applicable)

Summary

The SDK has minimal examples, and README documentation is not sufficient to show the support the Badger SDK has and the ease of development it enables. A docusaurus app should be created to better document in a nice way the SDK, its services, and at a granular level provide information on the action / data provided by a given method within a service.

Sdk method ListHarvests during processor work failing with err. For now it`s ignored.
Find out the reason, fix it, and rm method from ignore list.

we have both of the available, they can be used for notifications

https://github.com/Badger-Finance/badger-sdk/blob/main/src/tokens/tokens.service.ts#L72-L78

Summary

Vault v1 and v1.5 have different strategy ABI. This means that using a typed contract for them is not compatible.

https://github.com/Badger-Finance/badger-sdk/blob/main/src/vaults/vaults.service.ts#L139-L155

The getVaultStrategy implementation returns a v1 strategy for every request. Instead, we should just return the address for the strategy and require the user to instantiate (trivially) the version they are expecting as it is anyway a required input.

Tasks

• Update getVaultStrategy to return the strategy address
• Test coverage for getVaultStrategy

Summary

Currently @badger-dao/sdk is currently being deployed manually by myself with manual versioning. Investigate options for automated versioning and releases

Tasks

• Investigate publishing options
• Select + implement publishing solution

Summary

• support fetching vault fees for any vaults
• we should consider implications / performance impacts of adding this information to base vault data returned
• influence vaults have specific not on chain fees (or breakdowns) that don't reflect always on strategies - ensure we have a robust way to handle multiple influence strategy fee set ups for any future considerations

Example

A target replacement for this look up information would be code like this

https://github.com/Badger-Finance/badger-api/blob/main/src/vaults/vaults.utils.ts#L139-L194

In order to stabilize and make refactoring easy, we need to cover all modules with units

• Mocks processor
• FS io
• Methods cache
• Config

Summary

Add some reasonable filter params on getProductionVaults which does not otherwise have filter options.

#83 (comment)