bApp Onboarding Guide #6

MatheusFranco99 · 2025-01-29T16:35:59Z

Overview

This PR adds an onboarding guide for bApp builders

bapp_onboarding.md

riccardo-ssvlabs · 2025-01-30T09:15:11Z

bapp_onboarding.md

+```go
+Risk map[Token]map[Strategy]float64
+```
+4. **Compute Risk-Aware Weights**: With this information, it can compute the weight of a participant for a certain token by


I still think there could be a function on the contract to compute the weight, so some apps could use this data on-chain...

The model described is a proposal by us, not a must. So, a bApp can actually define any weight model it wants. But I see no issue with adding the default one as a function. I think this is more of a product decision

I see.

@liorrutenberg @mtabasco @GalRogozinski ? Any opinion on this?

riccardo-ssvlabs · 2025-01-30T09:15:26Z

bapp_onboarding.md

+
+where $c_{\text{token}}$ is a normalization constant defined as
+
+$$c_{\text{token}} = \left( \sum_{\text{strategy}} \frac{ObligatedBalance[\text{token}][\text{strategy}]}{TotalBAppBalance[\text{token}]} e^{-\beta_{\text{token}} \times max(1, Risk[\text{token}][\text{strategy}])} \right)^{-1}$$


I have not reviewed the math

bapp_onboarding.md

Co-authored-by: Riccardo Persiani <[email protected]>

liorrutenberg · 2025-01-30T10:42:33Z

@MatheusFranco99 lets move it to a docs folder or examples

GalRogozinski

Just a reminder that we need to add the actual contract address once we have it deployed

GalRogozinski · 2025-01-30T11:09:56Z

bapp_onboarding.md

+   for strategy in strategies do
+
+      # Check if strategy participates in the bApp
+      if !api.HasStrategyOptedInToBApp(strategy, bApp) then


api hints that we have some SDK in place.
Maybe whoever is writing the SDK can put actual runnable code here that uses the abi

bapp_onboarding.md

mtabasco

Thanks @MatheusFranco99 !
I added some ideas/suggestions.

bapp_onboarding.md

MatheusFranco99 · 2025-01-30T17:16:24Z

@liorrutenberg
Moved it to a folder "doc".
I think all comments are addressed.
Pls, follow with your review

GalRogozinski

Still waiting for a link to the deployed contract on etherscan...
Wonder if we can have runnable code snippets

GalRogozinski · 2025-02-02T08:51:40Z

doc/bapp_onboarding.md

+
+Once the bApp is registered, strategies can join it and allocate capital to secure it.
+
+### 2.1 Opting in


I think we are missing how to register operators (accounts) and create strategy

I thought it was a guide mainly for the bApp to register itself and understand how others join.
If strategies registering is really necessary, I can add it
Wdyt @liorrutenberg ?

GalRogozinski · 2025-02-02T09:03:00Z

doc/bapp_onboarding.md

+)
+```
+- `tokens`: List of tokens to obligate to the bApp.
+- `obligationPercentages`: The proportion of each token's balance to commit to the bApp.


The encoding format of the obligation percentages is not clear.
We decided on 5000 representing 50.00% right?
It needs to be clear

Maybe @mtabasco or @riccardo-ssvlabs can provide an example of a cli-command that will show examples of how to create the transactions. This will make sure will use proper encoding when creating the txs.

I think clef allows using json as tx data, so maybe a json would be a good idea?
But the contract guys probably know what is the best way to give such examples

Well-spotted.
Because it's a uint32, we could have had far better precision than 2 decimals
But I think that's the current encoding, yes.
I'll add this mention to the encoding

I think one simple way to send transactions using a cli-command is with Foundry's cast.

# install foundry curl -L https://foundry.paradigm.xyz | bash cast send <CONTRACT_ADDRESS> "optInToBApp(uint256,address,address[],uint32[],bytes)" \ <STRATEGY_ID> <BAPP_ADDRESS> \ '["0xTokenAddress1","0xTokenAddress2"]' '[1000,2000]' "0xDataParam" \ --private-key <YOUR_PRIVATE_KEY> --rpc-url <RPC_URL>

You can use --keystore param to access key store instead of passing raw private key to the cli command.

GalRogozinski · 2025-02-02T09:05:07Z

doc/bapp_onboarding.md

+$$W^{\text{final}}_{\text{strategy}} = c_{\text{final}} \times \frac{1}{\frac{2/3}{W_{\text{strategy, A}}} + \frac{1/3}{W_{\text{strategy, B}}}}$$
+
+where $c_{\text{final}}$ is a normalization constant computed as
+
+$$c_{\text{final}} = \left( \sum_{\text{strategy}} \frac{1}{\frac{2/3}{W_{\text{strategy, A}}} + \frac{1/3}{W_{\text{strategy, B}}}} \right)^{-1}$$
+


still doesn't render well on github

It renders locally. I'll try a change

mtabasco

Well done @MatheusFranco99 !

bapp_onboarding.md

RaekwonIII · 2025-01-30T16:25:21Z

bapp_onboarding.md

+
+1. **Define core attributes**:
+- `bApp`: a unique 20-byte EVM address that uniquely identifies the bApp.
+- `tokens`:  A list of ERC-20 tokens to be used in the bApp's security mechanism. For the native ETH token, use the special address [`0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE`](https://github.com/ssvlabs/based-applications/blob/92a5d3d276148604e3fc087c1c121f78b136a741/src/BasedAppManager.sol#L62).


Suggestion: substitute the links with a specific commit with links with main. E.g.:

https://github.com/ssvlabs/based-applications/blob/main/src/BasedAppManager.sol

Lines links may be broken at first, but when the contract stabilizes, people would not be weirded out by visiting a contract's commit page that is months old.

Actually, it was requested to change the links to the ones from etherscan

add bapp onboarding guide

cf60b5a

MatheusFranco99 requested review from GalRogozinski, liorrutenberg and riccardo-ssvlabs January 29, 2025 16:35

MatheusFranco99 self-assigned this Jan 29, 2025

add introductory phrase for subsection

143e466

riccardo-ssvlabs suggested changes Jan 29, 2025

View reviewed changes

riccardo-ssvlabs suggested changes Jan 30, 2025

View reviewed changes

MatheusFranco99 and others added 8 commits January 30, 2025 09:40

creators -> developers

1ea5fac

Co-authored-by: Riccardo Persiani <[email protected]>

explicit evm address

d8089e7

Co-authored-by: Riccardo Persiani <[email protected]>

explicit native ETH token

2191990

Co-authored-by: Riccardo Persiani <[email protected]>

explicit "only the owner can change"

6720115

Co-authored-by: Riccardo Persiani <[email protected]>

opt in -> opt-in

bada2a0

Co-authored-by: Riccardo Persiani <[email protected]>

remove typo

59cb8a3

Co-authored-by: Riccardo Persiani <[email protected]>

- > :

75398d7

Co-authored-by: Riccardo Persiani <[email protected]>

apply suggestions

28c7165

GalRogozinski reviewed Jan 30, 2025

View reviewed changes

riccardo-ssvlabs reviewed Jan 30, 2025

View reviewed changes

bapp_onboarding.md Outdated Show resolved Hide resolved

HasStrategyOptedInToBApp -> GetStrategyOptedInToBApp

3954b8a

mtabasco requested changes Jan 30, 2025

View reviewed changes

bapp_onboarding.md Outdated Show resolved Hide resolved

bapp_onboarding.md Show resolved Hide resolved

bapp_onboarding.md Show resolved Hide resolved

bapp_onboarding.md Outdated Show resolved Hide resolved

bapp_onboarding.md Outdated Show resolved Hide resolved

MatheusFranco99 added 3 commits January 30, 2025 15:41

move to doc folder

503e7da

apply suggestions

6ce8e2d

add numerical example

de38d0a

MatheusFranco99 requested review from mtabasco and riccardo-ssvlabs January 30, 2025 16:59

discard owners non-delegated validator balance

2918763

declare metadata as a link to a JSON file

4e703ca

GalRogozinski requested changes Feb 2, 2025

View reviewed changes

MatheusFranco99 added 2 commits February 3, 2025 09:15

Merge branch 'main' into bapp-onboarding

75202c1

apply suggestions

8b33336

mtabasco approved these changes Feb 3, 2025

View reviewed changes

MatheusFranco99 requested a review from GalRogozinski February 3, 2025 13:38

use etherscan links

f7b8100

riccardo-ssvlabs approved these changes Feb 3, 2025

View reviewed changes

bapp_onboarding.md Outdated Show resolved Hide resolved

try to fix latex rendering

25345cc

GalRogozinski approved these changes Feb 3, 2025

View reviewed changes

RaekwonIII approved these changes Feb 3, 2025

View reviewed changes

fix typos

ef4b4f3

liorrutenberg approved these changes Feb 3, 2025

View reviewed changes

liorrutenberg merged commit 3b9429b into main Feb 3, 2025
3 checks passed

liorrutenberg deleted the bapp-onboarding branch February 3, 2025 18:25


		where $c_{\text{token}}$ is a normalization constant defined as

		$$c_{\text{token}} = \left( \sum_{\text{strategy}} \frac{ObligatedBalance[\text{token}][\text{strategy}]}{TotalBAppBalance[\text{token}]} e^{-\beta_{\text{token}} \times max(1, Risk[\text{token}][\text{strategy}])} \right)^{-1}$$


		Once the bApp is registered, strategies can join it and allocate capital to secure it.

		### 2.1 Opting in

bApp Onboarding Guide #6

bApp Onboarding Guide #6

Uh oh!

Conversation

MatheusFranco99 commented Jan 29, 2025

Overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

liorrutenberg commented Jan 30, 2025

Uh oh!

GalRogozinski left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mtabasco left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

MatheusFranco99 commented Jan 30, 2025

Uh oh!

GalRogozinski left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mtabasco left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development