{"id":20669656,"url":"https://github.com/fox-one/atm-sdk","last_synced_at":"2026-07-16T17:37:29.802Z","repository":{"id":57532986,"uuid":"278819899","full_name":"fox-one/atm-sdk","owner":"fox-one","description":"fox atm sdk","archived":false,"fork":false,"pushed_at":"2020-07-15T16:28:18.000Z","size":217,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-10-15T21:30:41.053Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fox-one.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-07-11T08:23:50.000Z","updated_at":"2020-07-15T16:28:21.000Z","dependencies_parsed_at":"2022-09-26T18:20:47.477Z","dependency_job_id":null,"html_url":"https://github.com/fox-one/atm-sdk","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/fox-one/atm-sdk","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fox-one%2Fatm-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fox-one%2Fatm-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fox-one%2Fatm-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fox-one%2Fatm-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fox-one","download_url":"https://codeload.github.com/fox-one/atm-sdk/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fox-one%2Fatm-sdk/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":35553295,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-07-16T02:00:06.687Z","response_time":83,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-16T20:15:18.957Z","updated_at":"2026-07-16T17:37:29.765Z","avatar_url":"https://github.com/fox-one.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# atm-sdk\nfox atm sdk\n\n* api host `https://efox.fox.one`\n* atm 默认收款地址 fb151d94-cc0e-358b-9cdb-57215a557a31 \n* atm 注册商户有自己单独的收款地址\n* rest api [文档](./docs/api.md)\n\n## 注册\n\n* 生成 rsa 公私钥对，将公钥放在 memo 转账给 atm\n* 后续用这个私钥作为 token 的签名私钥\n\n**Memo**\n\n```go\nkey, _ := rsa.GenerateKey(rand.Reader, 1024)\npub := key.Public()\ndata,_ := x509.MarshalPKIXPublicKey(pub)\naction := atm.OrderAction{\n    PublicKey: base64.StdEncoding.EncodeToString(data),\n}\nmemo := action.Encode()\n\n// 用上面生成的 memo 随便转一笔 cnb 之类的不值钱的币给 atm 即可完成注册\n```\n\n## 下单\n\n* 构造下单 memo，带上想买的币的 symbol/asset_id 和所使用的策略\n* 转账付款的币给指定下单地址\n* 转账的 `TraceID` 即这笔订单的订单 id，转账人的钱包 id 为这笔订单的用户 id\n\n**Memo**\n\n```go\naction := atm.OrderAction{\n    Asset: \"BTC\", // symbol or asset id\n    Strategy: atm.StrategyMarket, // 默认是 StrategyMarket\n}\nmemo := action.Encode()\n\n// 用上面生成的 memo 转账你想花费的币给 atm 即可完成下单\n```\n\n## 查询订单\n\n下单之后可以开始用下单转账的 `TraceID` 作为订单 id 查询订单。\n因为异步到账的原因，可能会在一小段时间内查询不到订单\n\n```go\nclient := proto.NewMerchantServiceProtobufClient(atm.Endpoint, \u0026http.Client{})\n\ntoken := atm.GenerateToken(merchantID, key, time.Minute)\nctx := atm.WithToken(context.Backgroud(), token)\n\norderID := \"\u003ctrace id\u003e\"\norder, err := client.ReadOrder(ctx, \u0026proto.MerchantServiceReq_ReadOrder{\n    TraceId: orderID,\n})\n\nif err != nil {\n    // 查询订单 404，可能还没到账，等待一会再继续查询\n    if IsErrorNotFound(err) {\n        // handle order not found error\n    }\n\n    // handle err\n}\n```\n\n## 撤单\n\n查询到订单之后，才可以撤单\n\n```go\ntoken := atm.GenerateToken(merchantID, key, time.Minute)\nctx := atm.WithToken(context.Backgroud(), token)\n\nif _, err := client.CancelOrder(ctx, \u0026proto.MerchantServiceReq_CancelOrder{\n    TraceId: orderID,\n}); err != nil {\n    // handle cancel order failed error\n}\n```\n\n## 查询用户历史订单\n\n```go\ntoken := atm.GenerateToken(merchantID, key, time.Minute)\nctx := atm.WithToken(context.Backgroud(), token)\n\nresults, err := client.ListOrders(ctx, \u0026proto.MerchantServiceReq_ListOrders{\n    Symbol:   \"BTCUSDT\",      // pay symbol，为空查询所有交易对\n    Side:     \"ASK\",          // ASK or BID，为空查询所有方向\n    Strategy: StrategyMarket, // 策略，为空查询所有策略\n    State:    \"pending\",      // pending or done，为空则查询所有状态\n    UserId:   order.UserId,   // 用户 id\n    Order:    SortOrder_ASC,  // SortOrder_ASC or SortOrder_DESC\n    Cursor:   \"\",             // 分页 cursor\n    Limit:    100,            // 默认 50\n})\n\nif err != nil {\n    // handle list orders error\n}\n\norders := results.Orders\nnextCuror := results.Pagination.NextCursor\n```\n\n## 订单状态\n\n| state | 状态 | 描述 |\n|------|------|------|\n| Order_Trading | 交易中 | 正在兑换 |\n| Order_Filled | 已成交 | 兑换成功，将买到的币打给下单的用户 |\n| Order_Cancelled | 已取消 | 取消成功，将退还币给用户 |\n| Order_Rejected| 已拒绝| 下单不合法或者对应的交易所进入维护了，将退还币给用户 |\n| Order_Timeout| 已超时 | 订单兑换超时，将退还币给用户；Market 单五分钟超时 |\n\n## ATM 回款 memo\n\n**兑换成功**\n```json5\n{\n  \"s\": \"ATM\",\n  \"c\": \"FILLED\",\n  \"t\": \"order_id\"\n}\n```\n\n**兑换失败**\n```json5\n{\n  \"s\": \"ATM\",\n  \"c\": \"REFUND\",\n  \"t\": \"order_id\"\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffox-one%2Fatm-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffox-one%2Fatm-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffox-one%2Fatm-sdk/lists"}