DRS接口服务

请求参数签名

• 通过私钥签名：在有私钥的情况下，可直接通过私钥签名，实例如下：

  @Service @Slf4j public class SampleService {
  
      @ArkInject ISubmitterService dappService;
      @ArkInject ISignatureService signatureService;
  
      public RespData<?> authPermission(AuthPermissionVO vo) {
          try {
              StacsECKey ecKey = StacsECKey.fromPrivate(Hex.decode("${user privateKey}"));
              String signValue = signatureService.generateSignature(vo);
              vo.setSubmitter(ecKey.getHexAddress());
              vo.setSubmitterSign(ecKey.signMessage(signValue));
              dappService.authPermission(vo);
              return success();
          } catch (DappException e) {
              log.error("has error", e);
              return fail(e);
          }
      }
  }
  

• 通过钱包： 在没有私钥，或是通过钱包管理私钥的情况下，可以通过如下方式生成签名数据

  @Service @Slf4j public class SampleService {
  
      @ArkInject ISignatureService signatureService;
  
      public String getSignature(AuthPermissionVO vo) {
          return  signatureService.generateSignature(vo);
      }
  }
  

将签名数据复制然后在钱包进行签名，拿到签名结果后，在将签名值输入并提交

@Service @Slf4j public class SampleService {

    @ArkInject ISubmitterService dappService;

    public RespData<?> authPermission(AuthPermissionVO vo,String addr, String sign) {
        try {
            vo.setSubmitter(addr);
            vo.setSubmitterSign(sign);
            dappService.authPermission(vo);
            return success();
        } catch (DappException e) {
            log.error("has error", e);
            return fail(e);
        }
    }
}

交易类接口

BD发布

• 接口描述：
• 接口地址：io.stacs.nav.drs.api.ISubmitterService.publishBD(BusinessDefine bd)

• 接口参数：

  • BusinessDefine属性描述:

属性	类型	最大长度	必填	说明
code	String	64	Y	bd code
name	String	40	Y	bd name
bdType	String	32	N	类型 system:系统类型bd;contract:合约类型;assets:合约资产类型bd,:如果bdType为assets，functions必须包含(uint256) balanceOf(address)和(uint256) balanceOf(address)
desc	String	18	N	描述
initPermission	String	64	Y	权限
initPolicy	String		Y	policy
functions	FunctionDefine	32	Y	方法数组
bdVersion	String	64	Y	版本号

• FunctionDefine属性描述:

属性	类型	最大长度	必填	说明
name	String	40	Y	name
type	String	32	N	类型
desc	String	18	N	描述
methodSign	String	64	Y	方法名
execPermission	String	64	Y	权限
execPolicy	String	32	Y	policy

Policy注册

• 接口描述：
• 接口地址：io.stacs.nav.drs.api.ISubmitterService.registerPolicy(RegisterPolicyVO vo)
• 接口参数：
  • RegisterPolicyVO属性描述:

属性	类型	最大长度	必填	说明
txId	String	64	Y	交易ID
subbmiter	String	40	Y	用户地址
feeCurrency	String	32	N	手续费币种
feeMaxAmount	String	18	N	最大允许的手续费
submitterSign	String	64	Y	签名
bdCode	String		Y	BD code
policyId	String	32	Y	注册的policyId
policyName	String	64	Y	ploicy name
votePattern	String		Y	投票模式，1. SYNC 2. ASYNC
callbackType	String		Y	回调类型，1. ALL 2. SELF
decisionType	String		Y	1. FULL_VOTE 2. ONE_VOTE 3. ASSIGN_NUM
domainIds	List<String>		Y	参与投票的domainId列表
requireAuthIds	List<String>		Y	需要通过该集合对应的rs授权才能修改当前policy
assigMeta	AssigMeta		N	指定数量类型时的规则信息

• AssigMeta类型

属性	类型	最大长度	必填	说明
verifyNum	int		N	需要投票的domain数量
mustDomainIds	List<String		N	必须参与投票的domainId列表
expression	String		N	投票规则表达式，example: n/2+1

• 调用实例

Policy更新

• 接口描述：
• 接口地址：io.stacs.nav.drs.api.ISubmitterService.modifyPolicy(ModifyPolicyVO vo)

• 接口参数：

  • ModifyPolicyVO属性描述:

属性	类型	最大长度	必填	说明
txId	String	64	Y	交易ID
subbmiter	String	40	Y	用户地址
feeCurrency	String	32	N	手续费币种
feeMaxAmount	String	18	N	最大允许的手续费
submitterSign	String	64	Y	签名
bdCode	String		Y	BD code
policyId	String	32	Y	注册的policyId
policyName	String	64	Y	ploicy name
votePattern	String		Y	投票模式，1. SYNC 2. ASYNC
callbackType	String		Y	回调类型，1. ALL 2. SELF
decisionType	String		Y	1. FULL_VOTE 2. ONE_VOTE 3. ASSIGN_NUM
domainIds	List<String>		Y	参与投票的domainId列表
requireAuthIds	List<String>		Y	需要通过该集合对应的rs授权才能修改当前policy
assigMeta	AssigMeta		N	指定数量类型时的规则信息

• AssigMeta类型

属性	类型	最大长度	必填	说明
verifyNum	int		N	需要投票的domain数量
mustDomainIds	List<String>		N	必须参与投票的domainId列表
expression	String		N	投票规则表达式，example: n/2+1

Identity创建

• 接口描述：
• 接口地址：io.stacs.nav.drs.api.ISubmitterService.identitySetting(IdentitySettingVO vo)

• 接口参数：

  • IdentitySettingVO 属性描述:

属性	类型	最大长度	必填	说明
txId	String	64	Y	交易ID
subbmiter	String	40	Y	用户地址
feeCurrency	String	32	N	手续费币种
feeMaxAmount	String	18	N	最大允许的手续费
submitterSign	String	64	Y	签名
bdCode	String		Y	BD code
property	String	1024	N	用户自定义属性，Json类型
address	String	40	Y	新增identity地址

Identity冻结/解冻

• 接口描述：
• 接口地址：io.stacs.nav.drs.api.ISubmitterService.identityManager(IdentityBDManageVO vo)

• 接口参数：

  • IdentityBDManageVO 属性描述:

属性	类型	最大长度	必填	说明
txId	String	64	Y	交易ID
subbmiter	String	40	Y	用户地址
feeCurrency	String	32	N	手续费币种
feeMaxAmount	String	18	N	最大允许的手续费
submitterSign	String	64	Y	签名
bdCode	String	64	Y	BD code
targetAddress	String	64	N	地址
BDCodes	[]	40	Y	数组
actionType	String	40	Y	froze / unfroze

Permission注册

• 接口描述：
• 接口地址：io.stacs.nav.drs.api.ISubmitterService.registerPermission(RegisterPermissionVO vo)

• 接口参数：

  • RegisterPermissionVO属性描述:

属性	类型	最大长度	必填	说明
txId	String	64	Y	交易ID
subbmiter	String	40	Y	用户地址
feeCurrency	String	32	N	手续费币种
feeMaxAmount	String	18	N	最大允许的手续费
submitterSign	String	64	Y	签名
bdCode	String		Y	BD code
permissionNames	String[]		Y	PermissionName数组

用户Permission授权

• 接口描述：
• 接口地址：io.stacs.nav.drs.api.ISubmitterService.authPermission(AuthPermissionVO vo)

• 接口参数：

  • AuthPermissionVO 属性描述:

属性	类型	最大长度	必填	说明
txId	String	64	Y	交易ID
subbmiter	String	40	Y	用户地址
feeCurrency	String	32	N	手续费币种
feeMaxAmount	String	18	N	最大允许的手续费
submitterSign	String	64	Y	签名
bdCode	String		Y	BD code
identityAddress	String	40	Y	要授权的identity地址
permissionNames	String[]		Y	给Identity授权的PermissionName数组

用户Permission撤销

• 接口描述：
• 接口地址：io.stacs.nav.drs.api.ISubmitterService.cancelPermission(CancelPermissionVO vo)

• 接口参数：

  • CancelPermissionVO属性描述:

属性	类型	最大长度	必填	说明
txId	String	64	Y	交易ID
subbmiter	String	40	Y	用户地址
feeCurrency	String	32	N	手续费币种
feeMaxAmount	String	18	N	最大允许的手续费
submitterSign	String	64	Y	签名
bdCode	String		Y	BD code
identityAddress	String	40	Y	要撤销授权的identity地址
permissionNames	String[]		Y	给Identity授权的PermissionName数组

KYC注册

• 接口描述：
• 接口地址：io.stacs.nav.drs.api.ISubmitterService.settingKYC(KYCSettingVO vo)

• 接口参数：

  • KYCSettingVO属性描述:

属性	类型	最大长度	必填	说明
txId	String	64	Y	交易ID
subbmiter	String	40	Y	用户地址
feeCurrency	String	32	N	手续费币种
feeMaxAmount	String	18	N	最大允许的手续费
submitterSign	String	64	Y	签名
bdCode	String		Y	BD code
identityAddress	String	40	Y	目标identity地址
KYC	String	1024	Y	KYC属性

合约发布

• 接口描述：
• 接口地址：io.stacs.nav.drs.api.ISubmitterService.contractPublish(ContractCreateVO vo)
• 接口参数：

-ContractCreateVO 属性描述:

属性	类型	最大长度	必填	说明
txId	String	64	Y	交易ID
subbmiter	String	40	Y	用户地址
feeCurrency	String	32	N	手续费币种
feeMaxAmount	String	18	N	最大允许的手续费
submitterSign	String	64	Y	签名
bdCode	String		Y	BD code
methodName	String		Y	合约构造方法
args	Object[]		Y	合约参数 方法执行入参参数，（签名时需使用逗号分隔拼接(参见StringUtils.join(args,",")),如果参数中包含数组，数组请使用JSONArray来装）
code	String		Y	合约代码
bizData	JsonObject		N	业务数据json

合约执行

• 接口描述：
• 接口地址：io.stacs.nav.drs.api.ISubmitterService.contractInvoke(ContractInvokeVO vo)

• 接口参数：

  • ContractInvokeVO属性描述:

属性	类型	最大长度	必填	说明
txId	String	64	Y	交易ID
subbmiter	String	40	Y	用户地址
feeCurrency	String	32	N	手续费币种
feeMaxAmount	String	18	N	最大允许的手续费
submitterSign	String	64	Y	签名
bdCode	String		Y	BD code
methodName	String		Y	合约方法
args	Object[]		Y	合约参数方法执行入参参数，（签名时需使用逗号分隔拼接(参见StringUtils.join(args,",")),如果参数中包含数组，数组请使用JSONArray来装）
bizData	JsonObject		N	业务数据json

存证交易

• 接口描述：
• 接口地址：io.stacs.nav.drs.api.ISubmitterService.saveAttestation(SaveAttestationVO vo)

• 接口参数：

  -SaveAttestationVO属性描述:

属性	类型	最大长度	必填	说明
txId	String	64	Y	交易ID
subbmiter	String	40	Y	用户地址
feeCurrency	String	32	N	手续费币种
feeMaxAmount	String	18	N	最大允许的手续费
submitterSign	String	64	Y	签名
bdCode	String		Y	BD code
attestation	String	4096	Y	存证内容

快照交易

• 接口描述：
• 接口地址：io.stacs.nav.drs.api.ISubmitterService.buildSnapshot(BuildSnapshotVO vo)

• 接口参数：

  • BuildSnapshotVO属性描述:

属性	类型	最大长度	必填	说明
txId	String	64	Y	交易ID
subbmiter	String	40	Y	用户地址
feeCurrency	String	32	N	手续费币种
feeMaxAmount	String	18	N	最大允许的手续费
submitterSign	String	64	Y	签名

查询类接口

BD查询

• 接口描述：
• 接口地址：io.stacs.nav.drs.api.IQueryService.queryBDByCode(String bdCode)
• 接口参数：

属性	类型	最大长度	必填	说明
bdCode	String	64	Y	bdCode

返回参数：io.stacs.nav.drs.api.model.bd.BusinessDefine

属性	类型	说明

注册回调

• 接口描述：DRS收到上链成功的交易时，回调到dapp，dapp需要实现回调接口，实现supportType和handle方法
• 接口地址：io.stacs.nav.dapp.core.callback.ITxCallbackHandler example

      @Component @Slf4j
      public class CustomerHandler implements ITxCallbackHandler {
          @Override public CallbackType[] supportType() {
            /**
           *注册所有有交易回调，上链所有的交易都会回调到该handler：CallbackType.of("*")
           *注册functionName回调，当执行的交易functionName为KYC_SETTING会回调到该handler: CallbackType.of("KYC_SETTING")
           *注册bdCode+functionName回调，当执行的交易functionName为KYC_SETTING，bdCode为systemBD 会回调到该handler: CallbackType.of("KYC_SETTING","systemBD")
           *注册bdCode+functionName回调，当执行的交易functionName为KYC_SETTING，bdCode为systemBD 会回调到该handler: CallbackType.of("KYC_SETTING","systemBD")
           *注册bdCode+functionName+version回调，当执行的交易functionName为KYC_SETTING，bdCode为systemBD ,version为4.0时会
           * 回调到该handler: CallbackType.of("KYC_SETTING","systemBD","4.0.0")
           */
              return new CallbackType[]{CallbackType.of("*")};
          }
  
          @Override public void handle(TransactionPO transactionPO) {
              log.info("all call back invoked transactionPO:{}",transactionPO);
          }
      }