API refactory - Githubissues

ChainSafe / sprinter-ts

1 stars 0 forks source link

API refactory #58

Closed mpetrunic closed 3 weeks ago

mpetrunic commented 1 month ago

current api naming is not adequate and causing confusion with the users as they aren't sure which method to call. I would propose following methods:

bridge - calls /solution/call without contract call
bridgeAndCall - calls /solution/call with contract call
aggregateBalance - calls get_solutions_aggregation method. If there is only one network whitelisted, it will call bridge
aggregateBalanceAndCall - calls post_solutions_aggregation If there is only one network whitelisted, it will call bridgeAndCall

itsbobbyzzz168 commented 1 month ago

@mpetrunic @BeroBurny Liviu and I were talking through this, and suggest for the bleeding obviousnessssss

aggregateBalance -> bridgeAggregateBalance aggregateBalanceAndCall -> bridgeAggregateBalanceAndCall

mpetrunic commented 1 month ago

@mpetrunic @BeroBurny Liviu and I were talking through this, and suggest for the bleeding obviousnessssss

aggregateBalance -> bridgeAggregateBalance aggregateBalanceAndCall -> bridgeAggregateBalanceAndCall

Ooops, I've just seen this. This is a bit innacurate, since aggreateBalance doesn't neccessarilly involve bridge, it could involve, unwrapping, amm or just transfer on the same chain

BeroBurny commented 1 month ago

what about solution?

solution
solutionWithCall
aggregateSolutions
aggregateSolutionsWithCall

mpetrunic commented 3 weeks ago

@BeroBurny that would make sense, but I think it might be confusing for the user. Maybe we need to align naming with intent more. For example:

transfer - that's our single step step solution
transferWithHook - that's our single step solution + hook/call/xcall in the end
poolAssetOnDestination - that would be aggregateBalance
poolAsserOnDestinationWithHook - that would be aggregateBalance with Xcalls/cslls and in the future:
sweepFunds - would be new intent to collect funds from all the supported chains

@MakMuftic @itsbobbyzzz168 WDYT?

MakMuftic commented 3 weeks ago

Yep like the last suggestion :+1: I see it is already applied :tada: