dApp SDK (英语)

@canton-network/dapp-sdk - 用于在平台上建立分散化应用程序的SDK类型 广州网。将用户连接到Canton钱包,管理账户,签名消息,以及执行交易——所有交易都通过一个供应商中立的接口,由 CIP-0103 (中文(简体) )。 。 。 .

[注] 每一份释放的移徙指南都公布于 讨论情况。 。 。 .

特征

• 钱包发现 远程网关,EIP-6963型 canton:announceProvider 事件和可插接的适配器
• 钱包拾取器 UI – 内置,框架不可知的网络组件,允许用户选择钱包,输入自定义网关 URL,并管理最近使用的连接
• 钱包连接 ——连接,断开,并监视连接状态
• 账户管理 ——清单账户并应对账户变动
• 交易执行 - 要求Daml交易的用户批准和签名
• 编目 API 访问 - 代理认证向Canton JSON Ledger API提出的请求
• 实时活动 订阅状态变化、账户变化和交易生命周期事件
• 多种运输 用于远程钱包网关的HTTP/SSE, postMessage 浏览器扩展钱包
• 提供者接口 - EIP-1193型CIP-103供应商通过 getConnectedProvider() 之后 connect()

安装

npm install @canton-network/dapp-sdk

pnpm add @canton-network/dapp-sdk

快速启动

最快的前进方式是通过模块级便利API. 它管理着一个单子 DappClient 在幕后,打开取钱包器,为您处理适配器注册.

import * as sdk from '@canton-network/dapp-sdk'

// Opens the wallet picker and connects to the selected wallet
const result = await sdk.connect()
console.log(result.isConnected)

// List the user's accounts (parties)
const accounts = await sdk.listAccounts()

// Execute a transaction
await sdk.prepareExecute({
    commands: [
        {
            CreateCommand: {
                templateId: '#MyApp:MyModule:MyTemplate',
                createArguments: { owner: accounts[0].partyId },
            },
        },
    ],
})

// Listen for real-time updates
sdk.onTxChanged((tx) => {
    console.log('Transaction update:', tx)
})

// Disconnect when done
await sdk.disconnect()

建筑

SDK是围绕三层构建的:

┌──────────────────────────────────────────────┐
│  DappClient                                  │
│  Thin wrapper: typed RPC helpers, events,    │
│  session persist                             │
├──────────────────────────────────────────────┤
│  DiscoveryClient                             │
│  Adapter registry, session restore,          │
│  wallet picker integration                   │
├──────────────────────────────────────────────┤
│  ProviderAdapter implementations             │
│  ExtensionAdapter (announce protocol)        │
│  (browser / postMessage)                     │
│  RemoteAdapter (HTTP/SSE gateway)            │
└──────────────────────────────────────────────┘

钱包提供者

钱包和扩展作者:参见 钱包提供者(发现) 在dApp 大楼的文档中,说明如何在拾取器中出现(RemoteAdapter, (中文(简体) ), canton:announceProvider,以及 additionalAdapters) (中文(简体) ).

使用量

选项A:模块级API(推荐给大多数应用程序)

导入 SDK 作为命名空间 。 这个 connect() 函数打开内置的钱包拾取器、登记可用的适配器并返回 a ConnectResult。 。 。 .

import * as sdk from '@canton-network/dapp-sdk'
import { RemoteAdapter } from '@canton-network/dapp-sdk'

await sdk.connect()
const status = await sdk.status()

您可以在连接时间提供额外的适配器 :

await sdk.connect({
    additionalAdapters: [
        new RemoteAdapter({
            name: 'My Gateway',
            rpcUrl: 'https://gateway.example.com/api/json-rpc',
        }),
    ],
})

备选案文B:与发现对象的匹配

要对适配器注册和连接流程进行更多的控制,请使用 DiscoveryClient 直接传递给生成的提供者 DappClient。 。 。 .

import {
    DappClient,
    DiscoveryClient,
    RemoteAdapter,
} from '@canton-network/dapp-sdk'

const discovery = await DiscoveryClient.create({
    adapters: [
        new RemoteAdapter({
            name: 'Splice Wallet Gateway',
            rpcUrl: 'https://gateway.example.com/api/json-rpc',
        }),
    ],
})
await discovery.connect() // opens the picker if configured

const session = discovery.getActiveSession()!
const client = new DappClient(session.provider, {
    providerType: session.adapter.type,
})

const status = await client.status()

备选案文C:与供应商直接兼容

如果你已经有一个 Provider<DappRpcTypes> (例如从自己的适配器),你可以完全跳过发现.

import { DappClient, RemoteAdapter } from '@canton-network/dapp-sdk'

const provider = new RemoteAdapter({
    name: 'Splice Wallet Gateway',
    rpcUrl: 'https://gateway.example.com/api/json-rpc',
}).provider()

const client = new DappClient(provider)
const result = await client.connect()

API 参考

达标

Dapplient 选项

发现对象

内建适应器

文档

完整的文档,包括详细的使用指南,API参考,以及钱包网关的配置:

• dApp 建筑指南
• dApp SDK 文档
• 钱包提供者(发现)
• API 规格(开放RPC)
• 示例 dApps

许可证

阿帕奇 - 2.0