xuperchain / xuper-sdk-js

The JS(TS) SDK for XuperChain

Xuper SDK JS

Xuper SDK (JS/TS) is a software development kit that allows developers to quickly use XuperChain.

The SDK provides a service interface that includes account, transaction, contract and various query functions. It can be used in a browser and Nodejs environment.

---

English | 简体中文

Usage

Install Npm package

npm install --save @xuperchain/xuper-sdk

Quick start

import XuperSDK from '@xuperchain/xuper-sdk';

const node = ''; // node
const chain = ''; // chain

const xsdk = XuperSDK.getInstance({
    node,
    chain
});

const start = async () => {
    const result = await xsdk.getBlockChains();
    console.log(result);
};

start();

Details - API reference

Code examples

Environments

• Browser depends on window.crypto
• Nodejs >= v10.0

In the Nodejs environment, gRPC is supported and used by default, you can choose to close it, and still use Http to request

XuperSDK.getInstance({
    ...,
    env: {
        node: {
            disableGRPC: true // disable gRPC
        }
    }
})

How to build a test environment

Read the documentation , compile and deploy XuperChain

Use XuperChain Docker image to build a single-node service

1. Pull image (XuperChian v3.7 - Repository)

docker pull smilingxinyi/xuperchain

2. Start container

docker run -d -p 8098:8098 -p 37101:37101 -p 47101:47101 --name xc smilingxinyi/xuperchain

API reference documentation

Link

Services

Account

service	name	link	state
Create account	create	LINK	√
Retrieve account	retrieve	LINK	√
Import private key	import	LINK	√
Export private key	export	LINK	√
Chekc address	checkAddress	LINK	√
Check mnemonic	checkMnemonic	LINK	√
Balance	getBalance	LINK	√
Balance Detail	getBalanceDetail	LINK	√

Blockchain infomation

service	name	link	state
Blockchains	getBlockChains	LINK	√
Status	checkStatus	LINK	√
Block by id	getBlockById	LINK	√
Block by height	getBlockByHeight	LINK	√

Transaction

service	name	link	state
Make transfer	transfer	LINK	√
Post tx	postTransaction	LINK	√
Query tx	queryTransaction	LINK	√

Contract

service	name	link	state
New contract account	createContractAccount	LINK	√
Contract list	getContracts	LINK	√
Deploy Wasm contract	deployWasmContract	LINK	√
Invoke Wasm contarct	invokeContarct	LINK	√
Deploy Solidity contract	deploySolidityContract	LINK	√
Invoke Solidity contarct	invokeSolidityContarct	LINK	√
Deploy Native contract	deployNativeContract	LINK	√
Invoke Native contarct	invokeContarct	LINK	√
Query ACL	queryACL	LINK	√
Query stat data about contract	queryContractStatData	LINK	√

Plugin

Endorsement service plugin

The plugin must be used on the public network

EndorsementPlugin

Example:

const params = {
    server: process.env.ENDORSE_SERVER, // ip, port
    fee: process.env.FEE, // fee
    endorseServiceCheckAddr: process.env.SERVICE_SIGN_ADDRESS, // sign address
    endorseServiceFeeAddr: process.env.SERVICE_FEE_ADDRESS // fee address
}

const xsdk = new XuperSDK({
    node,
    chain,
    plugins: [
        EndorsementPlugin({
            transfer: params,
            makeTransaction: params
        })
    ]
});

xuper-sdk-js's Issues

GAS设置为0时，报错提示'utxoOutput' as it is undefined.

TypeError: Cannot destructure property 'utxoList' of 'utxoOutput' as it is undefined.

升级报错

const demo = await xsdk.deploySolidityContract(
'XC1111111111111111@xuper', // 合约账户
'counter6', // 合约名字
bin, // evm 合约 bin
abi, // evm 合约 abi
"evm",
{},
true
);

err: contract for account not confirmed
使用升级功能发布合约时报错

开放网络获取到的数据如何解密？

我使用 js 连接 开放网络，获取到数据，但获取到的数据都是加密后的数据，如何解密相应的数据？

如下图是获取到的加密后的数据：

我通过在 Xuper 控制中心获取到的数据如下：

如何将加密的数据解析成正常数据？

希望增加公钥加密字符串的方法

希望增加使用公钥加密字符串的方法,类似 https://github.com/pubkey/eth-crypto#encryptwithpublickey

安装Npm依赖包这一步成功的输出

安装Npm依赖包
npm install --save @xuperchain/xuper-sdk
这个操作之后输出

added 75 packages, and audited 76 packages in 17s

5 packages are looking for funding
  run `npm fund` for details

found 0 vulnerabilities
npm notice 
npm notice New major version of npm available! 8.19.3 -> 9.6.2
npm notice Changelog: https://github.com/npm/cli/releases/tag/v9.6.2
npm notice Run npm install -g [email protected] to update!
npm notice 

输出这个是安装成功了吗？

功能建议：增加一个xuper地址和evm地址转换的接口

在利用solidity语言开发是，如ERC20、ERC721等，参数会经常传入以太坊0x的40位地址，这与xuper的16位地址不相同。
目前我是通过cli的形式在转换，既然cli已经支持，为什么sdk不加入该接口呢？

EndorsementPlugin 怎么获取？

在 js 中如何获取 这个插件？

直接使用会报 not defined 错误

交易ID计算版本支持新版本

目前xchain交易ID计算版本最新版本为3，go、java sdk已经支持，目前 JS sdk 还不支持，导致在开放网络使用失败，JS SDK 需要支持新版交易ID计算方式。

如何获取交易hash？

我使用的是超级链的开放网络，连接的 文件hash 智能合约，我在执行存储文件 storeFileInfo 合约方法后，尝试去查询这个交易记录获取他的交易 hash（执行合约方法后没找到交易hash，只获取到一个 txid ）

我尝试使用 xsdk.queryTransaction(txid) 这个方法获取详细的交易信息，看是否可以获取到 交易hash，执行之后输出如下：

好像还是没有 交易hash，但是获取到一个 blockid，再尝试使用xsdk.getBlockById(blockid)这个方法获取区块信息：

通过交易获取到的 blockid 为 vCd/DO/GVsL28MrqljpyB5Dhl3CM+cofvU8J5XJFbuc= ，但是使用这个 id 获取不到区块信息：

这时候发现有个 xsdk.transactionIdToHex('vCd/DO/GVsL28MrqljpyB5Dhl3CM+cofvU8J5XJFbuc=') 转 hex 的方法，于是把 blockid 进行了转换：

xsdk.transactionIdToHex('vCd/DO/GVsL28MrqljpyB5Dhl3CM+cofvU8J5XJFbuc=')
# 输出：bc277f0cefc656c2f6f0caea963a720790e197708cf9ca1fbd4f09e572456ee7

再用 bc277f0cefc656c2f6f0caea963a720790e197708cf9ca1fbd4f09e572456ee7 来查询 区块信息：

await xsdk.getBlockById('bc277f0cefc656c2f6f0caea963a720790e197708cf9ca1fbd4f09e572456ee7')

输出：

确实获取到了区块信息，说明 xsdk.getBlockById(blockid) 这个方法不能直接根据 id 获取，需要先把 blockid 进行 hex 转换之后才行？这是不是不太合理？

另外就是：怎么获取 交易hash ？

Error: 2 UNKNOWN: Err:500-50400-verify tx failed+err:Txid verify failed

js sdk部署合约到测试网络报错
Error: 2 UNKNOWN: Err:500-50400-verify tx failed+err:Txid verify failed
原因是什么呢

js SDK开发连接不到本地虚拟机中的节点是什么原因呢？

希望增加私钥签名字符串的方法

不是签名一个交易,是接收一个普通的字符串,使用私钥签名,类似 personal_sign 方法

8098 是什么端口？

使用文档中的 docker 运行，可以进行正常测试，连接的是 8098 端口

docker run -d -p 8098:8098 -p 37101:37101 -p 47101:47101 --name xc smilingxinyi/xuperchain

但是，使用最新版本的编译，不能使用 37101 端口连接，不知道这个 8098 端口是什么端口？如何配置？

How to use in uni-app[Android]

When I use the createAccount method of xuper-js-sdk in uni-app, it returns
Cannot read property 'getBytes' of null

postTransaction 的 交易 fee 如何提交的？

交易需要消耗 fee，不过 postTransaction 好像并没有 fee 这个参数，fee 如何提交呢？

vue(uniapp)和webpack不兼容 不知道能否解决

https://github.com/grpc/grpc-node/issues/610
vue环境下引入sdk 报http2找不到的错误
你可以uniapp新建个空项目 引入一下就看到了 不知道能否解决？如果不行我就只有用nodejs做后端
无法上传图片 你看下上面那个链接里[christopher-johnson]的发言，应该是webpack和grpc不兼容