Join into AMM pool
流量控制: 5 每 秒
摘要
HTTP 方法
POST
访问路径
/api/v3/amm/join
功能
Return the join request processing status
API 描述
HTTP头
字段 | 类型 | 必须 | 说明 | 举例 |
---|---|---|---|---|
X-API-KEY | string | 是 | ApiKey | "HlkcGxbqBeaF76j4rvPaOasyfPwnkQ 6B6DQ6THZWbvrAGxzEdulXQvOKLrRW ZLnN" |
请求参数
字段 | 类型 | 必须 | 说明 | 举例 |
---|---|---|---|---|
owner | string | 是 | The account owner adderss | "0xe25c94ba03 6d91b48833ac b637f719038f 07372d" |
poolAddress | string | 是 | AMM pool address to be joined | "0xe25c94ba03 6d91b48833ac b637f719038f 07372d" |
joinTokens | AmmPool Join Tokens |
是 | Token amounts to be joined and the minimum mint token to be paied back | "{"pooled": [{"id": 0,"amount": 0}],"minimum Lp": 0}" |
storageIds | string | 是 | Offchain request storage Id | "1" |
fee | string | 是 | fee of join request | "100000000000 0000000" |
validUntil | integer | 是 | Timestamp for order to become invalid | 1598431481 |
eddsaSignature | string | 否 | AMM join request eddsa signature | "0xccf0a141fc e2dc5cbbd4f8 02c52220e9e2 ce260e86704d 6258603eb346 eefe2d4a4500 05c362b223b2 8402d087f706 5ea5eee03145 31adf6a580fc e64c25dca81c 02" |
ecdsaSignature | string | 否 | AMM join request ecdsa signature | "0xeb14773e8a 07d19bc4fe56 e36d041dcb00 2652f7e92160 deaf5e6bf21e 05c7a9eb1477 3e8a07d19bc4 fe56e36d041d cb002652f7e9 2160deaf5e6b f21e05c7a9eb 14773e8a07d1 9bc4fe56e36d 041dcb002652 f7e92160deaf 5e6bf21e05c7 a9" |
请求示例
HTTP
CURL
POST https://api3.loopring.io/api/v3/amm/join HTTP/1.1
Host: api3.loopring.io
Connection: keep-alive
Accept: */*
Accept-Encoding: gzip, deflate, br
Accept-Language: zh,en;q=0.9
X-API-KEY: sra1aavfa
Content-Type: application/json
{
"owner" : "0xe25c94ba036d91b48833acb637f719038f07372d",
"poolAddress" : "0xe25c94ba036d91b48833acb637f719038f07372d",
"joinTokens" : {
"pooled" : [{tokenId:0, volume: 100000},{tokenId:0, volume: 100000}],
"minimumLp" : {
"tokenId" : 0,
"volume" : "1000000000000"
}
},
"storageIds" : "1",
"fee" : "1000000000000000000",
"validUntil" : 1598431481,
"eddsaSignature" : "0xccf0a141fce2dc5cbbd4f802c52220e9e2ce260e86704d6258603eb346eefe2d4a450005c362b223b28402d087f7065ea5eee0314531adf6a580fce64c25dca81c02",
"ecdsaSignature" : "0xeb14773e8a07d19bc4fe56e36d041dcb002652f7e92160deaf5e6bf21e05c7a9eb14773e8a07d19bc4fe56e36d041dcb002652f7e92160deaf5e6bf21e05c7a9eb14773e8a07d19bc4fe56e36d041dcb002652f7e92160deaf5e6bf21e05c7a9"
}
curl -X POST -H "X-API-KEY:sra1aavfa" -H "Content-Type:application/json" https://api3.loopring.io/api/v3/amm/join -d \
'{
"owner" : "0xe25c94ba036d91b48833acb637f719038f07372d",
"poolAddress" : "0xe25c94ba036d91b48833acb637f719038f07372d",
"joinTokens" : {
"pooled" : [{tokenId:0, volume: 100000},{tokenId:0, volume: 100000}],
"minimumLp" : {
"tokenId" : 0,
"volume" : "1000000000000"
}
},
"storageIds" : "1",
"fee" : "1000000000000000000",
"validUntil" : 1598431481,
"eddsaSignature" : "0xccf0a141fce2dc5cbbd4f802c52220e9e2ce260e86704d6258603eb346eefe2d4a450005c362b223b28402d087f7065ea5eee0314531adf6a580fce64c25dca81c02",
"ecdsaSignature" : "0xeb14773e8a07d19bc4fe56e36d041dcb002652f7e92160deaf5e6bf21e05c7a9eb14773e8a07d19bc4fe56e36d041dcb002652f7e92160deaf5e6bf21e05c7a9eb14773e8a07d19bc4fe56e36d041dcb002652f7e92160deaf5e6bf21e05c7a9"
}'
响应字段
字段 | 类型 | 必须 | 说明 | 举例 |
---|---|---|---|---|
hash | string | 是 | The order hash identifier set by the user at the time of submission | "0x1d923ca783 4dc90484fa2e b611f0f0bc7e 741bb107007e bea19ba8caea b4f9d3" |
status | string | 是 | Whether the order was successfully submitted or not, please note, user may query after a while to get real process status, as most offchain requests are async processed 取值范围 : ['received', 'processing', 'processed', 'failed'] |
"received" |
isIdempotent | boolean | 是 | Idempotent of submit order response, submit same order again when order was UNKNOWN or WAIT_FREEZE_BALANCE in relayer, idempotent will be true 取值范围 : [True, False] |
"true" |
响应示例
{
"hash" : "0x1d923ca7834dc90484fa2eb611f0f0bc7e741bb107007ebea19ba8caeab4f9d3",
"status" : "received",
"isIdempotent" : true
}
状态码
状态码 | 描述 |
---|---|
100000 | Unknown error |
100001 | Invalid argument |
102001 | Exchange ID is incorrect |
102021 | Nonce is invalid |
102022 | Transfer sender is invalid |
102023 | Transfer receiver is invalid |
102024 | Fee token is unsupported |
102025 | Transfer token isnt consistent with fee token |
模型
AmmPoolJoinTokens
escribes an AMM join transaction
字段 | 类型 | 必须 | 说明 | 举例 |
---|---|---|---|---|
pooled | List[Token VolumeV3] |
是 | Describes an amount of a specific token to be supplied to the pool, the seq matters, and must be the same as the pool token list returned by pool info | "[{tokenId:0, volume: 100000},{tok enId:0, volume: 100000}]" |
minimumLp | Token VolumeV3 |
是 | The minimum amoun of LP token desired in exchange for supplying liquidity to the pool | "{tokenId:0, volume: 100000}" |
TokenVolumeV3
Wrapper object used to describe a token associated with a certain quantity.
字段 | 类型 | 必须 | 说明 | 举例 |
---|---|---|---|---|
tokenId | integer | 是 | The Loopring's token identifier. | 0 |
volume | string | 是 | The volume of the token | "100000000000 0" |