时代安全钱包API GO-SDK

安装SDK

mod安装

我们推荐mod安装 ,在项目的根目录创建mod文件
go mod init project

创建main.go,在代码里面导入api包

import sdk "github.com/chainlife-doc/safecustody_sdk_go"

在go.mod目录下,命令行输入
go mod tidy

具体操作

+---------------------------------------------------------------------------------------------+
|~:cmd> mkdir project                                                                         |
|~:cmd> cd project                                                                            |
|./project:cmd> go mod init project                                                           |
|./project:cmd> touch main.go                                                                 |
|./project:cmd> echo "package main" > main.go                                                 |
|./project:cmd> echo 'import sdk "github.com/chainlife-doc/safecustody_sdk_go"' >> main.go    |
|./project:cmd> go mod tidy                                                                   |
|./project:cmd>                                                                               |
+──-------------------------------------------------------------------------------------------+

源码安装

直接从GitHup下载源码,把整个safecustody_sdk_go项目放入您的项目目录中,
然后在代码里import sdk "safecustody_sdk_go"

Project //项目
  ├── main.go //代码中写入 import sdk "safecustody_sdk_go"
  ├── ...
  └── safecustody_sdk_go  //safecustody_sdk_go与main.go同级
      ├── sdk.go       
      └── ...

例子

创建sdkApi`mod方式`

   package main
   
   import sdk "github.com/chainlife-doc/safecustody_sdk_go"
   
   api := new(sdk.Api)
   
   api.Host = "https://www.xxxx.com/"  //请向微信群里面的官方人员获取

   api.SetUserInfo(
       "", //对应商户后台的APPID
       "", //对应商户后台的SECRETKEY
       "", //userid;对应商户后台的商户id
       "",//对应商户后台的APIKEY
    )

单个币种查询

r1, err := api.QueryCoinConf("btc")

查询全部币种

r2, _ := api.QueryCoins(0)

查询余额

var coins []sdk.Coins
coins = append(coins, sdk.Coins{Coin: "btc", Chain: "btc"})
r3, _ := api.QueryBalance(coins)

获取充值地址

var addrs []sdk.AddrCoins
addrs = append(addrs, sdk.AddrCoins{Coin: "btc", Chain: "btc", Subuserid: "1"})
r4, err := api.GetDepositAddr(addrs)

获取充值记录

r5, err := api.GetDepositHistory(sdk.History{
		Subuserid: "",
		Chain:     "eth",
		Coin:      "eth",
		Fromid:    0,
		Limit:     100,
	})

内部地址查询

r6, err := api.QueryIsInternalAddr(sdk.QueryIsInternalAddr{Coin: "eth", Chain: "eth", Addr: "3297f672db8afa3"})

提交提币工单

r7, err := api.SubmitWithdraw(sdk.SubmitWithdraw{
		Subuserid: "1",
		Chain:     "btc",
		Coin:      "btc",
		Addr:      "",
		Amount:    0.01,
		Memo:      "xxx",
		Usertags:  "123",
        UserOrderid:"111", //该字段主要是填写用户系统的订单流水号,字段具有唯一性（可选字段)
	})

提币预校验

err11 := api.ValidatorWithdraw(sdk.SubmitWithdraw{
		Subuserid: "1",
		Chain:     "btc",
		Coin:      "btc",
		Addr:      "dddddd",
		Amount:    0.01,
		Memo:      "xxx",
		Usertags:  "123",
        UserOrderid:"111", //该字段主要是填写用户系统的订单流水号,字段具有唯一性（可选字段)
	})

查询工单状态

r9, err := api.QueryWithdrawStatus(sdk.QueryWithdrawStatus{
		Coin:       "btc",
		Chain:      "btc",
		Withdrawid: 1,
	})

查询历史提币记录

r10, err := api.QueryWithdrawHistory(sdk.QueryWithdrawHistory{
		Chain:     "btc",
		Coin:      "btc",
		Subuserid: "1",
		Fromid:    1,
		Limit:     1,
	})

取消提币接口

	err = api.WithdrawCancel(sdk.WithdrawCancel{
		Subuserid:  "",
		Chain:      "",
		Coin:       "",
		Withdrawid: 0,
	})

查询区块高度

	r, err := api.BlockHeight(sdk.BlockHeight{Chain: "btc", Coin: "btc"})
	fmt.Println(r)
	fmt.Println(err)

Api接口

单个币种查询

Response

//chain					string	链名
//coin					string	币名
//coin_precision			        int		币的精度,也就是该币支持多少位小数
//min_deposit_amount		        string	最小充值数量
//min_withdraw_amount		        string	最小提币数量
//deposit_enabled			        int		充值是否启用: 1=启用,0=未启用
//withdraw_enabled			        int		提币是否启用: 1=启用,0=未启用
//deposit_confirm_count		        int		充值入账确认数
//need_memo					int		充值是否需要备注: 1=充值需要备注,0=充值不需要备注
type QueryCoinConfBody struct {
	Chain               string `json:"chain"`
	Coin                string `json:"coin"`
	CoinPrecision       int    `json:"coin_precision"`
	MinDepositAmount    string `json:"min_deposit_amount"`
	MinWithdrawAmount   string `json:"min_withdraw_amount"`
	DepositEnabled      int    `json:"deposit_enabled"`
	WithdrawEnabled     int    `json:"withdraw_enabled"`
	DepositConfirmCount int    `json:"deposit_confirm_count"`
	NeedMemo            int    `json:"need_memo"`
}

Request
```
//coin 		string 币名
```

Function

 func (a *Api) QueryCoinConf(coin string) ([]QueryCoinConfBody, error)

查询全部币种

Response

//chain					string	链名
//coin					string	币名
//coin_precision			        int	币的精度,也就是该币支持多少位小数
//min_deposit_amount		        string	最小充值数量
//min_withdraw_amount		        string	最小提币数量
//deposit_enabled			        int	充值是否启用: 1=启用,0=未启用
//withdraw_enabled			        int	提币是否启用: 1=启用,0=未启用
//deposit_confirm_count		        int	充值入账确认数
//need_memo					int	充值是否需要备注: 1=充值需要备注,0=充值不需要备注
type QueryCoinConfBody struct {
    Chain               string `json:"chain"`
    Coin                string `json:"coin"`
    CoinPrecision       int    `json:"coin_precision"`
    MinDepositAmount    string `json:"min_deposit_amount"`
    MinWithdrawAmount   string `json:"min_withdraw_amount"`
    DepositEnabled      int    `json:"deposit_enabled"`
    WithdrawEnabled     int    `json:"withdraw_enabled"`
    DepositConfirmCount int    `json:"deposit_confirm_count"`
    NeedMemo            int    `json:"need_memo"`
    }

Function

func (a *Api) QueryCoins() ([]QueryCoinConfBody, error)

查询余额

Response

//chain	string	主链
//coin	string	币名
//balance	string	余额数量
//as_cny	string	余额以cnc为单位表示的数量
type QueryBalanceBody struct {
   Chain   string `json:"chain"`
   Coin    string `json:"coin"`
   Balance string `json:"balance"`
   AsCny   string `json:"as_cny"`
}

Request

//Coin 币种
//Chain 链名
//subuserid	string	调用端子账号，字符串，平台不管其含义
type Coins struct {
    Coin      string `json:"coin"`
    Chain     string `json:"chain"`
    Subuserid string `json:"subuserid"`
}

Function

func (a *Api) QueryBalance(coins []Coins) ([]QueryBalanceBody, error)

获取充值地址

Response

//chain	    string	主链
//coin	    string	币名
//subuserid	string	调用端子账号，字符串，平台不管其含义
//addr	    string	充币地址
//needmemo	int	0:不需要，1需要
//memo 		string 如果充值需要填写备注，这个字段会列出需要的备注
type GetDepositAddrBody struct {
   Chain     string `json:"chain"`
   Coin      string `json:"coin"`
   Subuserid string `json:"subuserid"`
   Addr      string `json:"addr"`
   NeedMemo  string `json:"needmemo"`
   Memo      string `json:"memo"`
}

request

//chain	string	主链
//coin	string	币名
//subuserid	string	调用端子账号，字符串，平台不管其含义
type AddrCoins struct {
	Coin      string `json:"coin"`
	Chain     string `json:"chain"`
	Subuserid string `json:"subuserid"`
}

function

func (a *Api) GetDepositAddr(coins []AddrCoins) ([]GetDepositAddrBody, error)

获取充值记录

Response

//id	int	内部充值序号
//subuserid	string	调用端子账号，字符串，平台不管其含义
//chain	string	哪条主链上充值进来的
//coin	string	币名
//from_addr	string	订单发送地址
//addr	string	订单接收地址
//txid	string	交易ID
//amount	string	充值数量
//balance	string	充值后余额
//time	string	订单生成时间
//api_key   string  api访问公钥
//height    string  交易高度
//status	int 	状态值(0: 无效状态，1: 正常入帐, 2: 待入帐)
//status_desc string 状态值描述
type GetDepositHistoryBody struct {
    Id        int64  `json:"id"`
    Subuserid string `json:"subuserid"`
    Chain     string `json:"chain"`
    Coin      string `json:"coin"`
    FromAddr  string `json:"from_addr"`
    Addr      string `json:"addr"`
    Txid      string `json:"txid"`
    Amount    string `json:"amount"`
    Balance   string `json:"balance"`
    Time      string `json:"time"`
    ApiKey    string `json:"api_key"`
    Height     string `json:"height"`
    Status     int    `json:"status"`
    StatusDesc string `json:"status_desc"`
}

Request

//subuserid	string	子账号，平台不管其含义（空字符串默认不做筛选）
//chain	string	主链 (空字符串默认不做筛选)
//coin	string	币名 (空字符串默认不做筛选)
//fromid	int	从哪个充值序号开始，值大于等于1,查询结果包含fromId对应的充值记录
//limit	int	最多查询多少条记录，包含fromid这条记录
type History struct {
    Subuserid string `json:"subuserid"`
    Chain     string `json:"chain"`
    Coin      string `json:"coin"`
    Fromid    int    `json:"fromid"`
    Limit     int    `json:"limit"`
}

Function

func (a *Api) GetDepositHistory(h History) ([]GetDepositHistoryBody, error)

内部地址查询

Request

//chain	    string	主链
//coin	    string	币名
//addr	    string	地址
type QueryIsInternalAddr struct {
    Coin      string `json:"coin"`
    Chain     string `json:"chain"`
    Addr      string `json:"addr"`
}

Function

//返回的第一个参数true代表是内部地址,否则非内部地址
func (a *Api) QueryIsInternalAddr(param QueryIsInternalAddr)(bool, error)

提交提币工单

Response

//id		int		序号
//subuserid		string	调用端子账号，字符串，平台不管其含义
//chain		string	主链
//coin		string	币名
//from_addr		string	提币发送地址
//addr		string	提币接收地址
//amount		string	提币数量
//amount_sent	string	实际发送的提币数量
//memo		string	该字段主要提供给链上支持备注的币种，内容会更新到链上
//status		int	提币状态: 0=无效状态,1=准备发送,2=发送中,3=发送成功,4=发送失败,5=待确认
//status_desc	string	状态描述
//txid		string	链上的交易ID
//fee_coin          string  手续费币种
//fee_coin_chain 	string  手续费币种所在链
//fee_amount    	string  手续费数量
//usertags		string	用户标签
//time		string	订单创建时间
//ApiKey       string api访问公钥
//user_orderid		string 用户系统流水号ID
type SubmitWithdrawBody struct {
    Id            int64  `json:"id"`
    Subuserid     string `json:"subuserid"`
    Chain         string `json:"chain"`
    Coin          string `json:"coin"`
    FromAddr      string `json:"from_addr"`
    Addr          string `json:"addr"`
    Amount        string `json:"amount"`
    AmountSent    string `json:"amount_sent"`
    Memo          string `json:"memo"`
    Status        int    `json:"status"`
    StatusDesc    string `json:"status_desc"`
    FeeCoin       string `json:"fee_coin"`
    FeeCoinChain  string `json:"fee_coin_chain"`
    FeeAmount     string `json:"fee_amount"`
    Txid          string `json:"txid"`
    Usertags      string `json:"usertags"`
    Time          string `json:"time"`
    ApiKey        string `json:"api_key"`
}

Request

//subuserid	string	调用端子账号，字符串，平台不管其含义
//chain	string	主链
//coin	string	币名
//addr	int	提币目标地址
//amount	float	提币数量
//memo	string	该字段主要提供给链上支持备注的币种，内容会更新到链上
//user_orderid 	string 该字段主要是填写用户系统的订单流水号,字段具有唯一性（可选字段)
//usertags	string	用户标签, 自定义内容，一般作为订单备注使用,辅助说明
type SubmitWithdraw struct {
    Subuserid string  `json:"subuserid"`
    Chain     string  `json:"chain"`
    Coin      string  `json:"coin"`
    Addr      string  `json:"addr"`
    Amount    float64 `json:"amount"`
    Memo      string  `json:"memo"`
    Usertags  string  `json:"usertags"`
    UserOrderid string  `json:"user_orderid"`
}

Function

func (a *Api) SubmitWithdraw(param SubmitWithdraw) (SubmitWithdrawBody, error)

提币预校验接口

Request

//subuserid	string	调用端子账号，字符串，平台不管其含义
//chain	string	主链
//coin	string	币名
//addr	int	提币目标地址
//amount	float	提币数量
//memo	string	该字段主要提供给链上支持备注的币种，内容会更新到链上
//UserOrderid string 用户自定义订单ID，该字段主要是填写用户系统的订单流水号，字段具有唯一性（可选字段)
//usertags	string	用户标签, 自定义内容，一般作为订单备注使用,辅助说明
type SubmitWithdraw struct {
    Subuserid string  `json:"subuserid"`
    Chain     string  `json:"chain"`
    Coin      string  `json:"coin"`
    Addr      string  `json:"addr"`
    Amount    float64 `json:"amount"`
    Memo      string  `json:"memo"`
    Usertags  string  `json:"usertags"`
    UserOrderid string  `json:"user_orderid"`
}

Function

func (a *Api) ValidateWithdraw(param SubmitWithdraw) error

查询提币工单状态

Response

//id					int		内部充值序号
//subuserid				string	调用端子账号，字符串，平台不管其含义
//chain					string	哪条主链上充值进来的
//coin					string	币名
//from_addr				string	提币发送地址
//addr					string	提币接收地址
//amount				string	充值数量
//amount_sent			string	实际发送的提币数量
//memo					string	该字段主要提供给链上支持备注的币种,内容会更新到链上
//status				int		提币状态:  0=无效状态,1=准备发送,2=发送中,3=发送成功,4=发送失败,5=待确认
//status_desc			string	状态描述
//txid					string	链上的交易ID
//usertags				string	用户标签
//time					string	订单创建时间
//user_orderid			string	用户系统流水号ID
//api_key       		string  api访问公钥
//height   			 	string  交易高度
type QueryWithdrawStatusBody struct {
    Id         int    `json:"id"`
    Subuserid  string `json:"subuserid"`
    Chain      string `json:"chain"`
    Coin       string `json:"coin"`
    FromAddr   string `json:"from_addr"`
    Addr       string `json:"addr"`
    Amount     string `json:"amount"`
    AmountSent string `json:"amount_sent"`
    Memo       string `json:"memo"`
    Status     int    `json:"status"`
    StatusDesc string `json:"status_desc"`
    Txid       string `json:"txid"`
    Usertags   string `json:"usertags"`
    UserOrderid string `json:"user_orderid"`
    Time       string `json:"time"`
    ApiKey     string `json:"api_key"`
    Height      string `json:"height"`
}

Request

//chain			string	主链
//coin			string	币名
//withdrawid	int	提币订单ID
type QueryWithdrawStatus struct {
    Coin       string `json:"coin"`
    Chain      string `json:"chain"`
    Withdrawid int    `json:"withdrawid"`
}

Function

func (a *Api) QueryWithdrawStatus(param QueryWithdrawStatus) (QueryWithdrawStatusBody, error)

查询提币记录

Response

//id		int	内部充值序号
//subuserid		string	调用端子账号，字符串，平台不管其含义
//chain		string	哪条主链上充值进来的
//coin		string	币名
//from_addr		string	提币发送地址
//addr		string	提币接收地址
//amount		string	充值数量
//amount_sent	string	实际发送的提币数量
//memo		string	该字段主要提供给链上支持备注的币种,内容会更新到链上
//status		int	提币状态: 1=准备发送,2=发送中,3=发送成功,4=发送失败,5=发送已取消
//status_desc	string	状态描述
//txid		string	链上的交易ID
//usertags		string	用户标签
//user_orderid	string	用户系统流水号ID
//time		string	订单创建时间
//api_key 		string  api访问公钥
//height 		string  交易高度
type QueryWithdrawHistoryBody struct {
    Id         int    `json:"id"`
    Subuserid  string `json:"subuserid"`
    Chain      string `json:"chain"`
    Coin       string `json:"coin"`
    FromAddr   string `json:"from_addr"`
    Addr       string `json:"addr"`
    Amount     string `json:"amount"`
    AmountSent string `json:"amount_sent"`
    Memo       string `json:"memo"`
    Status     int    `json:"status"`
    StatusDesc string `json:"status_desc"`
    Txid       string `json:"txid"`
    Usertags   string `json:"usertags"`
    UserOrderid string `json:"user_orderid"`
    Time       string `json:"time"`
    ApiKey     string `json:"api_key"`
    Height     string `json:"height"`
}

Request

//subuserid		string	子账号，平台不管其含义（空字符串默认不做筛选）
//chain		string	主链 (空字符串默认不做筛选)
//coin		string	币名 (空字符串默认不做筛选)
//fromid		int	从哪个充值序号开始，值大于等于1,查询结果包含fromId对应的充值记录
//limit		int	最多查询多少条记录，包含fromid这条记录
type QueryWithdrawHistory struct {
    Subuserid string `json:"subuserid"`
    Chain     string `json:"chain"`
    Coin      string `json:"coin"`
    Fromid    int    `json:"fromid"`
    Limit     int    `json:"limit"`
}

Function

Func (a *Api) QueryWithdrawHistory(param QueryWithdrawHistory) (QueryWithdrawHistoryBody, error)

取消提币接口

Request

    //subuserid		string	子账号，平台不管其含义（空字符串默认不做筛选）
    //chain			string	主链
    //coin			string	币名
    //withdrawid	int64 	订单ID
    type WithdrawCancel struct {
    	Subuserid  string `json:"subuserid"`
    	Chain      string `json:"chain"`
    	Coin       string `json:"coin"`
    	Withdrawid int64  `json:"withdrawid"`
    }

Function

func (a *Api) WithdrawCancel(param WithdrawCancel) error

查询区块高度

Response

//查询区块高度响应
//update_on 更新时间
//height 节点高度
type BlockHeightBody struct {
	Height   string `json:"height"`
	UpdateOn string `json:"update_on"`
}

Request

//查询区块高度
//chain			string	主链
//coin			string	币名
type BlockHeight struct {
	Chain string `json:"chain"`
	Coin  string `json:"coin"`
}

Name		Name	Last commit message	Last commit date
Latest commit History 21 Commits
example		example
README.md		README.md
api.go		api.go
go.mod		go.mod
request.go		request.go
route.go		route.go

chainlife-doc/safecustody_sdk_go

Folders and files

Latest commit

History

Repository files navigation

时代安全钱包API GO-SDK

安装SDK

mod安装

源码安装

例子

创建sdkApimod方式

单个币种查询

查询全部币种

查询余额

获取充值地址

获取充值记录

内部地址查询

提交提币工单

提币预校验

查询工单状态

查询历史提币记录

取消提币接口

查询区块高度

Api接口

单个币种查询

查询全部币种

查询余额

获取充值地址

获取充值记录

内部地址查询

提交提币工单

提币预校验接口

查询提币工单状态

查询提币记录

取消提币接口

查询区块高度

About

Topics

Resources

Uh oh!

Stars

Watchers

Forks

Releases 6

Packages 0

Uh oh!

Contributors 2

Uh oh!

Languages

创建sdkApi`mod方式`

Packages