feat: SDK POC by BeroBurny · Pull Request #11 · sprintertech/sprinter-sdk

BeroBurny · 2024-06-17T13:20:14Z

Draft, POC

# Conflicts: # packages/sdk/src/index.ts # packages/sdk/src/types.ts

mpetrunic

I think it would make sense to intrudce custom error classes for handling errors

mpetrunic · 2024-06-19T09:31:13Z

packages/sdk/src/api.ts

+  "https://gopher.test.buildwithsygma.com/"
+);
+export function setBaseUrl(url: string): void {
+  BASE_URL = url;


why not set process.env instead?

and you end up in vite that does not to useprocess.env but there is import.meta.env, made helper method to solve this problem and the setter is in a case you have no options to provide .env like in React you need use prefix REACT_ for env's

mpetrunic · 2024-06-19T09:32:40Z

packages/sdk/src/api.ts

+  if (whitelistedSourceChains && whitelistedSourceChains.length)
+    url.searchParams.set(
+      "whitelistedSourceChains",
+      whitelistedSourceChains.toString()


Suggested change

whitelistedSourceChains.toString()

whitelistedSourceChains.join(",")

?

it is the same result

const a = [1,2,3,4]; a.join(); // '1,2,3,4' a.join(','); // '1,2,3,4' a.toString(); // '1,2,3,4'

but you're using one extra character! 🤣

I was going to argue it's more expressive 😂

I wanted but been layz to make benchmarks.

But it is on mu super "short" TODO list for personal projects

web/src/lib/utils.ts

sztok7 · 2024-06-19T13:10:41Z

web/src/lib/utils.ts

+const noNetworkFound: Chain = {
+	chainID: 0,
+	chainType: 'evm',
+	name: 'none',
+	logoURI: 'https://static.thenounproject.com/png/75231-200.png',
+	rpcurls: []
+};


same as last comment, just an observation, maybe satisfies would be more appropriate here

Suggested change

const noNetworkFound: Chain = {

chainID: 0,

chainType: 'evm',

name: 'none',

logoURI: 'https://static.thenounproject.com/png/75231-200.png',

rpcurls: []

};

const noNetworkFound = {

chainID: 0,

chainType: 'evm',

name: 'none',

logoURI: 'https://static.thenounproject.com/png/75231-200.png',

rpcurls: []

} satisfies Chain;

packages/sdk/src/api.ts

packages/sdk/src/index.ts

sztok7 · 2024-06-19T13:44:20Z

packages/sdk/src/index.ts

-    whitelistedSourceChains
-  );
-  return Promise.resolve([]);
+    const tokenList = tokens || (await this.getAvailableTokens());


should we getAvailableTokens if provided tokens array is empty too?

This tricky question is like if you set an intentionally empty array (it is not logical to do) as an optional parameter and you got the result that is not part that reflects that array.

sztok7 · 2024-06-19T13:50:14Z

packages/sdk/src/utils.ts

+      variable = env[envName];
+    }
+  } finally {
+    variable ??= defaultValue;


ES2021 baby 🗡️
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Nullish_coalescing_assignment

packages/sdk/src/types.ts

sztok7 · 2024-06-19T13:56:06Z

packages/sdk/src/types.ts

+export type ChainID = number;
+
+export interface FungibleToken {
+  addresses: { [chainID: ChainID]: Address };


nit: this can also be a Record<ChainID, Address>, but no need to update

packages/sdk/src/types.ts

🤖 I have created a release *beep* *boop* --- ## [0.1.0](sprinter-sdk-v0.0.1...sprinter-sdk-v0.1.0) (2024-09-12) ### Features * api options ([#33](#33)) ([ad1cb88](ad1cb88)) * cross chain contract call ([#21](#21)) ([69c0128](69c0128)) * depricate provider param from sdk ([#41](#41)) ([72297fe](72297fe)) * docs POC ([#14](#14)) ([8cd800d](8cd800d)) * erc20 with contract call ([#39](#39)) ([77e1d8d](77e1d8d)), closes [#38](#38) * native tokens transfers ([#40](#40)) ([d4edf35](d4edf35)), closes [#36](#36) * SDK POC ([#11](#11)) ([6aca865](6aca865)) * web poc (super basic basic) ([#3](#3)) ([25a91f7](25a91f7)) ### Bug Fixes * process approvals from quote ([#26](#26)) ([95d9ebf](95d9ebf)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

🤖 I have created a release *beep* *boop* --- <details><summary>sprinter-sdk: 0.3.0</summary> ## [0.3.0](sprinter-sdk-v0.2.0...sprinter-sdk-v0.3.0) (2024-09-23) ### Features * api options ([#33](#33)) ([ad1cb88](ad1cb88)) * cross chain contract call ([#21](#21)) ([69c0128](69c0128)) * depricate provider param from sdk ([#41](#41)) ([72297fe](72297fe)) * docs POC ([#14](#14)) ([8cd800d](8cd800d)) * erc20 with contract call ([#39](#39)) ([77e1d8d](77e1d8d)), closes [#38](#38) * implement tracing url resolver ([#46](#46)) ([efd1be3](efd1be3)), closes [#44](#44) * native tokens transfers ([#40](#40)) ([d4edf35](d4edf35)), closes [#36](#36) * react sdk context ([#48](#48)) ([39dbe7e](39dbe7e)), closes [#47](#47) * SDK POC ([#11](#11)) ([6aca865](6aca865)) * web poc (super basic basic) ([#3](#3)) ([25a91f7](25a91f7)) ### Bug Fixes * process approvals from quote ([#26](#26)) ([95d9ebf](95d9ebf)) </details> <details><summary>sprinter-react: 0.2.0</summary> ## [0.2.0](sprinter-react-v0.1.0...sprinter-react-v0.2.0) (2024-09-23) ### Features * react sdk context ([#48](#48)) ([39dbe7e](39dbe7e)), closes [#47](#47) ### Bug Fixes * cd and rect hooks export ([#52](#52)) ([33c0604](33c0604)) </details> --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

BeroBurny added 23 commits May 16, 2024 10:31

boilerplate: web

4dd6552

boilerplate: sdk

c2446fe

1st web iteration

30decbf

save

2f109d0

refactor! -c1428

a0039bb

cleanup

f3223e1

1st deploy

6a12e32

save request send

16264bd

request send modal v1

c3babfa

refactor to new BE schema

0f514ee

get quota?

f18dae0

format

1725b1f

unit format

2be2690

move api call to api.ts

be72cba

basic implementation

933a9ec

Merge branch 'refs/heads/master' into beroburny/sdk-poc

03b73f6

# Conflicts: # packages/sdk/src/index.ts # packages/sdk/src/types.ts

Merge branch 'refs/heads/master' into beroburny/sdk-poc

b735448

small improvements

a8a403f

implement setter for env variable

7afab47

basic refactor /w save

044738f

save 2

4548a76

refactor UI to use SDK

76f34d0

implement error on solution

1ec53d2

BeroBurny requested review from mpetrunic and sztok7 June 17, 2024 13:20

github-actions bot temporarily deployed to gopher-poc (Preview) June 17, 2024 13:21 Inactive

BeroBurny added 4 commits June 18, 2024 12:59

env stuff

833c57e

refactor env stuff

4d729d3

refactor GopherManager to Gopher

ff89420

readme v0

5945e2a

readme v0.1

c1f3d65

github-actions bot temporarily deployed to gopher-poc (Preview) June 19, 2024 08:23 Inactive

mpetrunic reviewed Jun 19, 2024

View reviewed changes

sztok7 reviewed Jun 19, 2024

View reviewed changes

comments...

dc145a9

github-actions bot temporarily deployed to gopher-poc (Preview) June 24, 2024 12:50 Inactive

BeroBurny marked this pull request as ready for review June 24, 2024 14:49

BeroBurny merged commit 6aca865 into master Jun 24, 2024

This was referenced Jul 4, 2024

chore(master): release gopher-sdk 0.1.0 #15

Closed

chore(master): release sprinter-sdk 0.1.0 #18

Merged

BeroBurny deleted the beroburny/sdk-poc branch September 23, 2024 16:39

github-actions bot mentioned this pull request Sep 23, 2024

chore: release master #53

Merged

	whitelistedSourceChains.toString()
	whitelistedSourceChains.join(",")

Comments

Conversation

BeroBurny commented Jun 17, 2024

Uh oh!

mpetrunic 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!

mpetrunic Jun 24, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

BeroBurny Jun 24, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

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!

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!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

mpetrunic Jun 24, 2024 •

edited

Loading

BeroBurny Jun 24, 2024 •

edited

Loading