SDK 接入流程说明

• 环境要求： go 1.3及以上 ；java 1.8.0_45及以上 ；php5.4以上、php7.4以下；python3.7.*
• 准入账号： 在开通服务申请准入后获得

简要业务流程图参考

1. 资产发行流程
2. 用户购买流程

接入流程

一、正确填写配置项

• APPID
• AK
• SK
• endpoint

二、正确引入xaaset-cli(仅PHP SDK需要)

1. PHP 依赖go的密码学服务。需要引入go 编译好的xaaset-cli

通过go sdk源码编译生成bin文件
 
1.下载xasset-sdk-go
    git clone git@github.com:xuperchain/xasset-sdk-go.git
2. 编译
    cd xasset-sdk-go
    cd tools/xasset-cli
    go build -o xasset-cli main.go`
 

2. 按照对应的操作系统下载

• Linux下载地址
• Mac下载地址
• Windows下载地址

三、创建去中心化区块链用户

1. 创建方法
2. 操作步骤：创建2个用户标记为UserA和UserB 并做好存储
3. 参考文档

四、获取上传bos的临时授权凭证

1. 接口地址：POST /xasset/file/v1/getstoken
2. 正常返回授权信息包含bucket，endpoint 等 错误请参考常用错误码
3. 参考文档

五、创建数字资产

1. 接口地址：POST /xasset/horae/v1/create
2. 正常返回创建好的资产id 错误请参考常用错误码
3. 操作步骤：

• 使用userA 获取上传临时sts上传凭证
• 使用userA 上传资产文件到bos
• 使用userA 调用创建数字资产
• 记录下创建资产后返回的assetid 后边会用

4. 参考文档

六、查询数字资产详情

1. 接口地址：POST /xasset/horae/v1/query
2. 正常返回资产详情（无上链部分内容）错误请参考常用错误码
3. 操作步骤：使用创建资产返回的assetid 查询资产详情
4. 参考文档

七、修改未发布的资产

1. 接口地址： POST /xasset/horae/v1/alter
2. 正常返回错误码为0 错误请参考常用错误码
3. 操作步骤：

• asset_info 和 amount 至少一个是修改过的
• 使用userA和创建资产返回的assetid进行修改

4. 参考文档

八、查询数字资产详情

1. 接口地址：POST /xasset/horae/v1/query
2. 正常返回修改后资产详情（无上链部分内容）错误请参考常用错误码
3. 操作步骤：使用创建资产返回的assetid 查询资产详情
4. 参考文档

九、发布资产（上链）

1. 接口地址： POST /xasset/horae/v1/publish
2. 正常返回错误码为0 错误请参考常用错误码
3. 操作步骤：使用userA和创建资产返回的assetid 进行发布上链
4. 参考文档

十、查询数字资产详情

1. 接口地址：POST /xasset/horae/v1/query
2. 正常返回资产详情（包含上链状态 当状态为4时 返回上链hsah txid）错误请参考常用错误码
3. 操作步骤：使用创建资产返回的assetid 查询资产详情
4. 参考文档

十一、拉取账户创造资产列表

1. 接口地址：POST /xasset/horae/v1/listastbyaddr
2. 正常返回资产列表和资产条数，错误请参考常用错误码
3. 操作步骤：使用userA 查询userA 创造的资产列表
4. 参考文档

十二、发布资产成功后 授予碎片

1. 接口地址：POST /xasset/horae/v1/grant
2. 正常返回商品id和碎片id，错误请参考常用错误码
3. 操作步骤：

• 确保发布资产上链成功后再操作
• 使用userA 向userB 授予碎片
• 记录返回的shardid

4. 参考文档

十三、查询碎片信息

1. 接口地址：POST /xasset/horae/v1/querysds
2. 正常返回碎片信息，上链状态和txid。错误请参考常用错误码
3. 操作步骤：

• 使用记录的shardid查询
• 确认现在碎片的owner为userB

4. 参考文档

十四、转移碎片

1. 接口地址：POST /xasset/damocles/v1/transfer
2. 正常错误码为0，错误请参考常用错误码
3. 操作步骤：将碎片从userA 转移到userB
4. 参考文档

十五、查询碎片信息

1. 接口地址：POST /xasset/horae/v1/querysds
2. 正常返回转移后碎片信息，上链状态和txid。错误请参考常用错误码
3. 操作步骤：

• 使用记录的shardid查询
• 确认现在碎片的owner为userA

4. 参考文档

十六、冻结资产

1. 接口地址：POST /xasset/horae/v1/freeze
2. 正常返回错误码为0，错误请参考常用错误码
3. 操作步骤：使用创建资产时返回的assetid和userA 操作
4. 参考文档

十七、查询数字资产详情

1. 接口地址：POST /xasset/horae/v1/query
2. 正常返回冻结后资产详情，错误请参考常用错误码
3. 操作步骤：

• 使用创建资产时返回的assetid和userA查询
• 可以继续调用一次碎片授予核验

4. 参考文档

十八、销毁碎片

1. 接口地址：POST /xasset/horae/v1/consume
2. 正常返回错误码为0，错误请参考常用错误码
3. 操作步骤： 使用记录的shardid 操作
4. 参考文档

十九、查询碎片信息

1. 接口地址：POST /xasset/horae/v1/querysds
2. 正常返回销毁后碎片信息，上链状态和txid。错误请参考常用错误码
3. 操作步骤：

• 使用使用记录的shardid 操作
• 确认当前shardid的操作为已销毁
• 可以调用一次碎片转移核验

4. 参考文档

二十、获取账户持有碎片列表

1. 接口地址：POST /xasset/horae/v1/listsdsbyaddr
2. 正常返回指定账户持有的碎片列表和数量，错误请参考常用错误码
3. 参考文档

二十一、获取指定资产已经授予的列表

1. 接口地址：POST /xasset/horae/v1/listsdsbyast
2. 正常返回指定资产已经授予的资产的列表，错误请参考常用错误码
3. 参考文档

二十二、获取指定资产的历史登记记录包括资产创造、碎片授予、碎片转移的全部操作纪录，按时间倒序排序

1. 接口地址：/xasset/horae/v1/history
2. 正常返回指定资产历史登记列表和操作条目数，错误请参考常用错误码
3. 参考文档

二十三、 其他用户管理接口和应用场景接口，可以在实际应用场景中自由选择操作