[FRNT-1039] Feat/Velora SDK #194

Velenir · 2025-05-06T14:55:02Z

Renames and other changes from ParaSwap to Velora
Order.bridge construction for Crosschain Delta Orders
Updated docs/DELTA.md readme portion with Crosschain Order info
Removed Legacy SDK support (this will be a breaking change)

linear · 2025-05-06T14:55:05Z

github-actions · 2025-05-06T14:57:39Z

size-limit report 📦

Path	Size
dist/sdk.cjs.production.min.js	16.12 KB (-0.19% 🔽)
dist/sdk.esm.js	16.17 KB (+0.48% 🔺)

andriy-shymkiv

found a few minor points, but overall very good job!

andriy-shymkiv · 2025-05-07T09:40:34Z

docs/DELTA.md

+  beneficiary: anotherAccount, // if need to send destToken to another account on destChain
+  isBeneficiaryContract: false, // whether the beneficiary on destChain is a smart contract
+  // bridge, // user-constrcuted Bridge object for Crosschain Orders


Suggested change

// bridge, // user-constrcuted Bridge object for Crosschain Orders

// bridge, // user-constructed Bridge object for Crosschain Orders

andriy-shymkiv · 2025-05-07T09:40:47Z

docs/DELTA.md

+```
+
+To constrcut a Crosschain Delta Order it is required to either:


Suggested change

To constrcut a Crosschain Delta Order it is required to either:

To construct a Crosschain Delta Order it is required to either:

andriy-shymkiv · 2025-05-07T09:47:37Z

src/examples/delta.ts

 @@ -29,14 +29,14 @@ const deltaSDK = constructPartialSDK(
 );

 const DAI_TOKEN = '0x6b175474e89094c44da98b954eedeac495271d0f';
-const PSP_TOKEN = '0xcafe001067cdef266afb7eb5a286dcfd277f3de5';
+const USDC_TOKEN = '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48';


the documentation still has PSP tokens, although they are automatically generated if I'm not mistaken

Yes, docs will be regenerated

andriy-shymkiv · 2025-05-07T09:51:26Z

src/methods/delta/helpers/across.ts

+    if beneficiary is an EOA and destToken on destChain = ETH
+    order.destToken=ETH
+    order.bridge.outputToken=WETH_DEST_CHAIN
+    order.bridge.mutliCallHandler=NULL_ADDRESS


typo here and the same below

Suggested change

order.bridge.mutliCallHandler=NULL_ADDRESS

order.bridge.multiCallHandler=NULL_ADDRESS

andriy-shymkiv · 2025-05-07T10:08:28Z

src/methods/delta/helpers/types.ts

@@ -73,7 +69,7 @@ type DeltaAuctionTransaction = {
  auctionId: string;
 };

-export type ParaswapDeltaAuction = {
+export type VeloraDeltaAuction = {


since we're already making the name more abstract, I'd rather change it to simply DeltaAuction

andriy-shymkiv · 2025-05-07T10:09:55Z

src/methods/delta/postDeltaOrder.ts

@@ -17,7 +17,7 @@ export type DeltaOrderToPost = {

 export type PostDeltaOrderParams = Omit<DeltaOrderToPost, 'chainId'>;

-type DeltaOrderApiResponse = ParaswapDeltaAuction;
+type DeltaOrderApiResponse = VeloraDeltaAuction;


typo on the L14, partilly -> partially

andriy-shymkiv · 2025-05-07T10:17:46Z

README.md

@@ -48,15 +48,15 @@ Can be created by providing `chainId` and either `axios` or `window.fetch` (or a
    const signer: JsonRpcSigner = ethers.Wallet.fromMnmemonic('__your_mnemonic__');


Suggested change

const signer: JsonRpcSigner = ethers.Wallet.fromMnmemonic('__your_mnemonic__');

const signer: JsonRpcSigner = ethers.Wallet.fromMnemonic('__your_mnemonic__');

andriy-shymkiv · 2025-05-07T10:19:27Z

README.md

@@ -402,7 +404,8 @@ if (auction?.status === 'EXECUTED') {

 #### A more detailed example of Delta Order usage can be found in [examples/delta](./src/examples/delta.ts)

-#### For more Delta protocol usage refer to [DELTA.md](./docs/DELTA.md)
+For more Delta protocol usage, and **Corsschain Delta Orders**, refer to [DELTA.md](./docs/DELTA.md)


Suggested change

For more Delta protocol usage, and **Corsschain Delta Orders**, refer to [DELTA.md](./docs/DELTA.md)

For more Delta protocol usage, and **Crosschain Delta Orders**, refer to [DELTA.md](./docs/DELTA.md)

alexshchur

Added few small amends in another branch

Also there are few things where we can improve further, after releasing the current update. I left comments on those. Wdyt?

alexshchur · 2025-05-08T06:08:30Z

docs/DELTA.md

@@ -20,12 +20,12 @@ const paraSwap = constructSimpleSDK(

 ```ts
 const DAI_TOKEN = '0x6b175474e89094c44da98b954eedeac495271d0f';
-const PSP_TOKEN = '0xcafe001067cdef266afb7eb5a286dcfd277f3de5';
+const USDC_TOKEN = '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48';


btw, now that we change it to USDC, it's not 18 decimals any more in the snippets down below

alexshchur · 2025-05-08T06:14:18Z

docs/DELTA.md

+```ts
+// poll if necessary
+const auction = await deltaSDK.getDeltaOrderById(deltaAuction.id)
F438
;


how about creating an internal method that performs polling?

I believe polling should be done in userland.
Same as you would use react-query to fetch, cache, refetch, etc. You would use some library that already takes care of all edge cases, like refetchInterval.

outcome of DM convo: can add a sample in the doc with some simple polling helper lib (I can take care of that)

alexshchur · 2025-05-08T06:16:01Z

docs/DELTA.md

+```
+
+See more on accepted Permit variants in [Velora documentation](https://developers.velora.xyz/api/velora-api/velora-delta-api/build-a-delta-order-to-sign#supported-permits)


would it be feasible to integrate permit logic to into the SDK in the next iterations?

Not feasible at all. Remember the complex logic to get Token's data for permit, how many tokens don't follow the standard for domain, version, nonce and other methods.

outcome after DM convo: permit2 seems worth embedding

alexshchur · 2025-05-08T06:18:28Z

docs/DELTA.md

+
+To construct a Crosschain Delta Order it is required to either:
+* construct Bridge object. Refer to [documentation](https://developers.velora.xyz/api/velora-api/velora-delta-api/build-a-delta-order-to-sign#sign-an-order-cross-chain) for how to do that.


is there a plan to integrate bridge params handling?

Literally the next line says that it is handled by SDK if only the user gives isBeneficiaryContract param

If you think it's not clear, feel free to reword

somehow I misread the next line as "in the case when beneficiary is tha contract", you can rely on SDK

Yes, I'd change the wording (specifically - order of options, "rely on SDK" option should go first imo) and also maybe change isBeneficiaryContract : boolean to smth like beneficiaryContract : "EOA" | "SmartContract", like by the API DOC link referred.

Wdyt?

Reword all you like, but I believe a Boolean better conveys the intent.
beneficiaryContract implies address. Even something like beneficiaryType would be useless in vanilla JS, for example, always need TS to guide the correct value

Feat/velora more

…'SmartContract'`

Feat/velora more

chore: add js-level `beneficiaryType` validation

… into feat/velora

Velenir added 16 commits April 29, 2025 15:24

remove legacy

7fca8e8

fix types

c4082b0

update some links

e88cf31

rename to velora in Readme

a0ac685

type renames

2c6dcac

tests/rename vars

6440b2a

examples/rename vars

142bf53

src/update some vars and links

5b10c9c

remove deriveCompactSignature

a8ebcfd

remove dummy test files

6622fd1

replace PSP token

033955b

update DeltaPriceResponse & BridgePrice

12a4c26

buildDeltaOrder/ Bridge construction

cb6fa46

Readme/Delta

24230d2

update Readme

26f804f

cleanup

96b50a9

Velenir requested review from alexshchur and andriy-shymkiv May 6, 2025 14:55

Velenir added 3 commits May 6, 2025 17:48

Delta/buildCrosschainOrderBridge method

9fb7b11

delta/buildCrosschainOrderBridge/fix destToken

e7beb1a

simplify types

b2fe92d

andriy-shymkiv approved these changes May 7, 2025

View reviewed changes

Velenir and others added 6 commits May 7, 2025 14:51

delta tests/add Order.bridge tests

20e76bc

getDeltaBridgeAndDestToken/fix default case

f8faf1f

fix typos

334dbd6

fix more typos

bded21f

simplify type naming

31a7ea7

fix: typo

e42ebc2

alexshchur added 3 commits May 8, 2025 08:53

fix: typo

928bd76

chore: more consistent

db9b52a

fix: awkward indent

3436ba6

alexshchur approved these changes May 8, 2025

View reviewed changes

alexshchur and others added 15 commits May 8, 2025 09:44

fix: destAmount

41a1947

Merge pull request #195 from VeloraDEX/feat/velora-more

3ad8a1d

Feat/velora more

chore: isBeneficiaryContract: boolean -> `beneficiaryType: 'EOA' | …

3512221

…'SmartContract'`

chore: change order of ways to build crosschain order

870d881

Merge pull request #196 from VeloraDEX/feat/velora-more

fd1254c

Feat/velora more

chore: add js-level beneficiaryType validation

39ba519

Merge pull request #197 from VeloraDEX/feat/velora-more

39b53e6

chore: add js-level `beneficiaryType` validation

fix: absolute url for brand banner

140664d

Merge branch 'feat/velora' of https://github.com/VeloraDEX/paraswap-sdk…

5db1cba

… into feat/velora

fix: change @paraswap/sdk to @velora-dex/sdk and update major versio

c077b53

fix: few typos

730fec3

chore: theme-specific banner for Velora

1a6d6e0

chore: cleanup

f5479d0

chore: update package json

b795bf5

chore: re-genrated docs

0ffb395

alexshchur merged commit e792038 into master May 9, 2025
1 of 2 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[FRNT-1039] Feat/Velora SDK #194

[FRNT-1039] Feat/Velora SDK #194

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

	// bridge, // user-constrcuted Bridge object for Crosschain Orders
	// bridge, // user-constructed Bridge object for Crosschain Orders

		```

		To constrcut a Crosschain Delta Order it is required to either:

	To constrcut a Crosschain Delta Order it is required to either:
	To construct a Crosschain Delta Order it is required to either:

	order.bridge.mutliCallHandler=NULL_ADDRESS
	order.bridge.multiCallHandler=NULL_ADDRESS

		@@ -48,15 +48,15 @@ Can be created by providing `chainId` and either `axios` or `window.fetch` (or a
		const signer: JsonRpcSigner = ethers.Wallet.fromMnmemonic('__your_mnemonic__');

	For more Delta protocol usage, and Corsschain Delta Orders, refer to [DELTA.md](./docs/DELTA.md)
	For more Delta protocol usage, and Crosschain Delta Orders, refer to [DELTA.md](./docs/DELTA.md)

		```

		See more on accepted Permit variants in [Velora documentation](https://developers.velora.xyz/api/velora-api/velora-delta-api/build-a-delta-order-to-sign#supported-permits)


		To construct a Crosschain Delta Order it is required to either:
		* construct Bridge object. Refer to [documentation](https://developers.velora.xyz/api/velora-api/velora-delta-api/build-a-delta-order-to-sign#sign-an-order-cross-chain) for how to do that.

[FRNT-1039] Feat/Velora SDK #194

[FRNT-1039] Feat/Velora SDK #194

Uh oh!

Conversation

Uh oh!

Uh oh!

Uh oh!

size-limit report 📦

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!

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!

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!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!