feat: Add adapter for Solana #472

gin-lsl · 2024-01-07T08:03:39Z

A lot of updates, so create a pr first.
Test cases and demos will be add later.

changeset-bot · 2024-01-07T08:03:43Z

🦋 Changeset detected

Latest commit: 05979b6

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 4 packages

Name	Type
@ant-design/web3-solana	Major
@ant-design/web3-assets	Minor
@ant-design/web3	Minor
@ant-design/web3-wagmi	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

vercel · 2024-01-07T08:03:45Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
ant-design-web3	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Feb 7, 2024 10:38am

github-actions · 2024-01-07T08:03:54Z

gin-lsl · 2024-01-07T08:08:46Z

有几个问题：

Ethereum 和 Solana 的地址格式不同

按理来说，应该通过 Web3Provider 提供全局默认配置，然后组件的 Props 可以重写配置
但是目前，组件能够在不提供全局 Provider 的情况下单独使用。

所以两种链地址格式互相冲突。

是否应该不要在组件库中辅助处理格式化（添加 0x 前缀），而是遵从用户自己提供的配置呢？
开发者给的是值 0x00000 那么就展示 0x00000；
给的是 00000 那么就展示 00000；
如果有提供 Provider，那么就遵从 Provider 的配置。

因为开发者自己在展示组件的时候，提供一个 prefix 是很简单的事情，不要组件库帮忙处理应该也可以。

与之类似的还有 CroptoPrice 组件的 decimal、symbol 等

获取 SNS（Solana 域名服务）需要引入另一个包

具体在 QuickNode SNS
不确定是否划算。

yutingzhao1991 · 2024-01-08T00:42:57Z

有几个问题：

Ethereum 和 Solana 的地址格式不同

按理来说，应该通过 Web3Provider 提供全局默认配置，然后组件的 Props 可以重写配置但是目前，组件能够在不提供全局 Provider 的情况下单独使用。

所以两种链地址格式互相冲突。

是否应该不要在组件库中辅助处理格式化（添加 0x 前缀），而是遵从用户自己提供的配置呢？开发者给的是值 0x00000 那么就展示 0x00000；给的是 00000 那么就展示 00000；如果有提供 Provider，那么就遵从 Provider 的配置。

因为开发者自己在展示组件的时候，提供一个 prefix 是很简单的事情，不要组件库帮忙处理应该也可以。

与之类似的还有 CroptoPrice 组件的 decimal、symbol 等

获取 SNS（Solana 域名服务）需要引入另一个包

具体在 QuickNode SNS 不确定是否划算。

地址不全 0x 的问题加一个配置吧，现在不可以直接去掉了，不然就算 breakchange 了，加一个类似 addressPrefix: string | boolean 这样的前缀。默认是 0x，支持通过 Web3ConfigProvider 全局配置，然后在 solana 的 adapter 里面默认配置为 false。

SNS 这个可以放到 optionalDep 来支持 https://docs.npmjs.com/cli/v10/configuring-npm/package-json#optionaldependencies 。不过要研究下怎么写，这个可以放到最后再搞吧，可以先不支持。等下一个版本再支持。

gin-lsl · 2024-01-08T02:57:00Z

目前这有个编译错误，没看明白是什么导致的。有人有这个经验吗？

yutingzhao1991 · 2024-01-08T06:33:01Z

目前这有个编译错误，没看明白是什么导致的。有人有这个经验吗？

本地执行下 pnpm run build 看看能复现吗？看上去像是 ts 相关问题。

yutingzhao1991 · 2024-01-08T06:36:14Z

packages/assets/src/chains.tsx

@@ -77,7 +78,7 @@ export const Optimism: Chain = {
 };

 export const Avalanche: Chain = {
-  id: ChainIds.Avalanche,
+  id: ChainIdToken.fromValue(ChainIds.Avalanche),


这里这么改是为什么？

简单来说：主要是想将基于 wagmi EVM 这种提供了 chain.id 的，和 Solana 这种没有 chain.id 的，封装为一个统一的对象，提供一种统一的根据 id 判断是否是同一个链的方法。

EVM 的链，有个 chain id，number 格式。Solana 那些没有这个值。

所以整了个包装类型。数据结构是：

class { value: any; __key: string; contractor(value, __key) { // 如果有 value 则 this.value 就是 value // 如果没有提供，this.value 就是 this 本身 } }

实际使用的时候：

如果有 id

const chainMetadata = { id: 1, name: 'foo' }; const idToken = ChainIdToken.fromValue(chainMetadata.id); const chainAssets1 = { id: idToken, name: 'foo' }; const chainAssets2 = { id: idToken, name: 'foo2' }; // 判断的时候 chainAssets1.value === chainAssets2.value; // -> true

如果是 Solana 这种没有 id 的

const chainMetadata = { name: 'foo' }; const idToken = ChainIdToken.fromKey(chainMetadata.name); const chainAssets1 = { id: idToken, name: 'foo' }; const chainAssets2 = { id: idToken, name: 'foo2' }; // 判断的时候 chainAssets1.value === chainAssets2.value; // -> true

不太建议这么改，我们的核心还是 EVM 链，而 chainId 在以太坊生态算是比较公认的概念了，它总是作为一个十进制数字或者以 0x 开头的十六进制字符串；
这里我觉得可以沿用当前的设计，简单的做个兼容，避免和以太坊生态的 chainId 重复即可。

感觉可以加一个 network 用来标明是什么链，默认是 Ethereum，为 Solana 就认为是 solana。

gin-lsl · 2024-01-08T08:01:36Z

目前这有个编译错误，没看明白是什么导致的。有人有这个经验吗？

本地执行下 pnpm run build 看看能复现吗？看上去像是 ts 相关问题。

能复现，不过没看明白详细原因，本地报错也是就那两行 -_-

jeasonstudio · 2024-01-08T09:58:06Z

packages/assets/src/chains.tsx

@@ -77,7 +78,7 @@ export const Optimism: Chain = {
 };

 export const Avalanche: Chain = {
-  id: ChainIds.Avalanche,
+  id: ChainIdToken.fromValue(ChainIds.Avalanche),


不太建议这么改，我们的核心还是 EVM 链，而 chainId 在以太坊生态算是比较公认的概念了，它总是作为一个十进制数字或者以 0x 开头的十六进制字符串；
这里我觉得可以沿用当前的设计，简单的做个兼容，避免和以太坊生态的 chainId 重复即可。

jeasonstudio · 2024-01-08T10:00:06Z

packages/solana/CHANGELOG.md

@@ -0,0 +1 @@
+# @ant-design/web3-solana


CHANGELOG 会在发布前自动生成，这里需要在分支上执行 changeset 来记录下变更；

jeasonstudio · 2024-01-08T10:01:56Z

packages/solana/src/solana-provider/config-provider.tsx

+    });
+  }, [publicKey, connected]);
+
+  const wallets: Wallet[] = useMemo(() => {


这层 useMemo 没有实际起作用，可以考虑去掉

修复的问题点一下下面的 resolve conversation

packages/solana/src/solana-provider/config-provider.tsx

packages/wagmi/package.json

jeasonstudio · 2024-01-08T10:06:30Z

packages/web3/package.json

@@ -45,6 +45,8 @@
  },
  "devDependencies": {
    "@ant-design/web3-wagmi": "workspace:*",
+    "@ant-design/web3-solana": "workspace:*",
+    "@solana/wallet-adapter-wallets": "^0.19.24",


同上，依赖需要梳理下，是否不需要声明 @solana/wallet-adapter-wallets

jeasonstudio · 2024-01-08T10:09:24Z

目前这有个编译错误，没看明白是什么导致的。有人有这个经验吗？

本地执行下 pnpm run build 看看能复现吗？看上去像是 ts 相关问题。

能复现，不过没看明白详细原因，本地报错也是就那两行 -_-

CI 的报错是构建类型文件 .d.ts 的时候有错误，也就是代码中有 TS Error，可以再检查下或者贴下报错信息

gin-lsl · 2024-01-08T13:38:40Z

目前这有个编译错误，没看明白是什么导致的。有人有这个经验吗？

本地执行下 pnpm run build 看看能复现吗？看上去像是 ts 相关问题。

能复现，不过没看明白详细原因，本地报错也是就那两行 -_-

CI 的报错是构建类型文件 .d.ts 的时候有错误，也就是代码中有 TS Error，可以再检查下或者贴下报错信息

我发现执行 pnpm build 的时候，只要 /web3/solana/demos/basic.tsx 中的代码，只要 import 了 @ant-design/web3-solana，就一定会报错。会不会是因为这个包实际上还没有发布，所以无法使用？

gin-lsl · 2024-01-08T13:51:49Z

暂时先把 demos 里面的代码删掉了，报错改变了。现在的 error 是 chainid 类型问题，我再改成之前的 number 应该就可以了。

packages/solana/src/index.tsx

codecov · 2024-01-09T05:05:41Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (dc8f442) 100.00% compared to head (05979b6) 100.00%.

Additional details and impacted files

@@            Coverage Diff             @@
##              main      #472    +/-   ##
==========================================
  Coverage   100.00%   100.00%            
==========================================
  Files           96       102     +6     
  Lines         4377      4796   +419     
  Branches       453       506    +53     
==========================================
+ Hits          4377      4796   +419

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

yutingzhao1991 · 2024-01-10T02:04:07Z

暂时先把 demos 里面的代码删掉了，报错改变了。现在的 error 是 chainid 类型问题，我再改成之前的 number 应该就可以了。

如果是 demo 报错的话估计是 dumi 配置的问题。可能是 dumi 的 alias 配置有问题。我看现在 dumi 的 alias 配置是自动读取文件夹内容生成的。你可以调试下看看是不是生成的逻辑有问题。https://github.com/ant-design/ant-design-web3/blob/main/.dumirc.ts#L7

yutingzhao1991 · 2024-01-10T11:38:04Z

可以先写下 API 文档，这样可以 review 下用法，看看用户测使用的接口上有没有问题。这个可能更重要。内部实现都好改，对外接口一旦定义确定了就不好改了。

yutingzhao1991

没什么大问题了，先合并一个版本发布 0.x，后面再单独提 PR 优化，然后再发 1.0

gin-lsl requested review from yutingzhao1991, kiner-tang and jeasonstudio and removed request for yutingzhao1991 January 7, 2024 08:03

vercel bot deployed to Preview January 7, 2024 08:40 View deployment

vercel bot deployed to Preview January 7, 2024 09:00 View deployment

vercel bot deployed to Preview January 7, 2024 10:04 View deployment

yutingzhao1991 reviewed Jan 8, 2024

View reviewed changes

jeasonstudio reviewed Jan 8, 2024

View reviewed changes

vercel bot deployed to Preview January 8, 2024 13:48 View deployment

jeasonstudio reviewed Jan 9, 2024

View reviewed changes

packages/solana/src/index.tsx Outdated Show resolved Hide resolved

vercel bot deployed to Preview January 9, 2024 05:03 View deployment

github-actions bot added the major label Jan 9, 2024

vercel bot deployed to Preview January 9, 2024 06:08 View deployment

vercel bot deployed to Preview January 10, 2024 07:45 View deployment

gin-lsl and others added 24 commits February 7, 2024 18:36

docs: add solana demos

7cbfbda

test: add solana test cases

d4c8448

feat: improve

48e9320

test: update test

c37876a

test: fix test

3764da3

chore: remove log

3a9181a

chore: update web3-assets entry point

d2ee272

feat: delete mainnet

6499f02

fix: rename solana index.tsx to index.ts for fix ci

7b252d8

chore: fix build and typescript error

4f41f0c

docs: enable demos

b356b6f

test: add tests

6e113dd

refactor: format

72000b1

chore: update pnpm-lock.yaml

127aad0

feat: Components adapts Solana's address format

5a83aa8

test: add address format tests

fdf717d

chore: add changeset

87b39bc

chore: update changeset

eef53a4

feat: remove selectWallet event and solana chain check

36dd6ee

test: add test

858939c

test: remove unused tests

577f988

chore: remove comment

2c71eb1

test: fix vitest config

da8e5ab

chore: improve assets multi entry conf

05979b6

gin-lsl force-pushed the feat/solana branch from ba5b784 to 05979b6 Compare February 7, 2024 10:36

vercel bot deployed to Preview February 7, 2024 10:38 View deployment

yutingzhao1991 approved these changes Feb 18, 2024

View reviewed changes

yutingzhao1991 merged commit d601345 into main Feb 18, 2024
10 checks passed

yutingzhao1991 deleted the feat/solana branch February 18, 2024 05:53

yutingzhao1991 mentioned this pull request Feb 27, 2024

Add a new adatper for Solana #418

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Add adapter for Solana #472

feat: Add adapter for Solana #472

gin-lsl commented Jan 7, 2024

changeset-bot bot commented Jan 7, 2024 •

edited

Loading

vercel bot commented Jan 7, 2024 •

edited

Loading

github-actions bot commented Jan 7, 2024 •

edited

Loading

gin-lsl commented Jan 7, 2024

yutingzhao1991 commented Jan 8, 2024 •

edited

Loading

Ethereum 和 Solana 的地址格式不同

获取 SNS（Solana 域名服务）需要引入另一个包

gin-lsl commented Jan 8, 2024

yutingzhao1991 commented Jan 8, 2024

yutingzhao1991 Jan 8, 2024

gin-lsl Jan 8, 2024

jeasonstudio Jan 8, 2024

yutingzhao1991 Jan 10, 2024

gin-lsl commented Jan 8, 2024

jeasonstudio Jan 8, 2024

jeasonstudio Jan 8, 2024

jeasonstudio Jan 8, 2024

yutingzhao1991 Jan 29, 2024

jeasonstudio Jan 8, 2024

jeasonstudio commented Jan 8, 2024

gin-lsl commented Jan 8, 2024 •

edited

Loading

gin-lsl commented Jan 8, 2024

codecov bot commented Jan 9, 2024 •

edited

Loading

yutingzhao1991 commented Jan 10, 2024

yutingzhao1991 commented Jan 10, 2024

yutingzhao1991 left a comment

feat: Add adapter for Solana #472

feat: Add adapter for Solana #472

Conversation

gin-lsl commented Jan 7, 2024

changeset-bot bot commented Jan 7, 2024 • edited Loading

🦋 Changeset detected

vercel bot commented Jan 7, 2024 • edited Loading

github-actions bot commented Jan 7, 2024 • edited Loading

gin-lsl commented Jan 7, 2024

Ethereum 和 Solana 的地址格式不同

获取 SNS（Solana 域名服务）需要引入另一个包

yutingzhao1991 commented Jan 8, 2024 • edited Loading

Ethereum 和 Solana 的地址格式不同

获取 SNS（Solana 域名服务）需要引入另一个包

gin-lsl commented Jan 8, 2024

yutingzhao1991 commented Jan 8, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gin-lsl commented Jan 8, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jeasonstudio commented Jan 8, 2024

gin-lsl commented Jan 8, 2024 • edited Loading

gin-lsl commented Jan 8, 2024

codecov bot commented Jan 9, 2024 • edited Loading

Codecov Report

yutingzhao1991 commented Jan 10, 2024

yutingzhao1991 commented Jan 10, 2024

yutingzhao1991 left a comment

Choose a reason for hiding this comment

changeset-bot bot commented Jan 7, 2024 •

edited

Loading

vercel bot commented Jan 7, 2024 •

edited

Loading

github-actions bot commented Jan 7, 2024 •

edited

Loading

yutingzhao1991 commented Jan 8, 2024 •

edited

Loading

gin-lsl commented Jan 8, 2024 •

edited

Loading

codecov bot commented Jan 9, 2024 •

edited

Loading