Skip to content

Commit a977834

Browse files
mr-tronmr-tron
authored
Merge pull request #582 from tonkeeper/extra_currency
create a mock extra currency methods
2 parents bd01a83 + 3b256f3 commit a977834

10 files changed

+1517
-232
lines changed

‎api/openapi.json

+141
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,17 @@
128128
"type": "string"
129129
}
130130
},
131+
"ecIDParameter": {
132+
"description": "extra currency id",
133+
"in": "path",
134+
"name": "id",
135+
"required": true,
136+
"schema": {
137+
"example": 239,
138+
"format": "int32",
139+
"type": "integer"
140+
}
141+
},
131142
"eventIDParameter": {
132143
"description": "event ID or transaction hash in hex (without 0x) or base64url format",
133144
"in": "path",
@@ -3265,6 +3276,20 @@
32653276
],
32663277
"type": "object"
32673278
},
3279+
"ExtraCurrencies": {
3280+
"properties": {
3281+
"extra_currencies": {
3282+
"items": {
3283+
"$ref": "#/components/schemas/EcPreview"
3284+
},
3285+
"type": "array"
3286+
}
3287+
},
3288+
"required": [
3289+
"extra_currencies"
3290+
],
3291+
"type": "object"
3292+
},
32683293
"ExtraCurrency": {
32693294
"properties": {
32703295
"amount": {
@@ -6749,6 +6774,86 @@
67496774
]
67506775
}
67516776
},
6777+
"/v2/accounts/{account_id}/extra-currency/{id}/history": {
6778+
"get": {
6779+
"description": "Get the transfer history of extra currencies for an account.",
6780+
"operationId": "getAccountExtraCurrencyHistoryByID",
6781+
"parameters": [
6782+
{
6783+
"$ref": "#/components/parameters/accountIDParameter"
6784+
},
6785+
{
6786+
"$ref": "#/components/parameters/ecIDParameter"
6787+
},
6788+
{
6789+
"$ref": "#/components/parameters/i18n"
6790+
},
6791+
{
6792+
"description": "omit this parameter to get last events",
6793+
"in": "query",
6794+
"name": "before_lt",
6795+
"required": false,
6796+
"schema": {
6797+
"example": 25758317000002,
6798+
"format": "int64",
6799+
"type": "integer",
6800+
"x-js-format": "bigint"
6801+
}
6802+
},
6803+
{
6804+
"in": "query",
6805+
"name": "limit",
6806+
"required": true,
6807+
"schema": {
6808+
"example": 100,
6809+
"maximum": 1000,
6810+
"minimum": 1,
6811+
"type": "integer"
6812+
}
6813+
},
6814+
{
6815+
"in": "query",
6816+
"name": "start_date",
6817+
"required": false,
6818+
"schema": {
6819+
"example": 1668436763,
6820+
"format": "int64",
6821+
"maximum": 2114380800,
6822+
"type": "integer"
6823+
}
6824+
},
6825+
{
6826+
"in": "query",
6827+
"name": "end_date",
6828+
"required": false,
6829+
"schema": {
6830+
"example": 1668436763,
6831+
"format": "int64",
6832+
"maximum": 2114380800,
6833+
"type": "integer"
6834+
}
6835+
}
6836+
],
6837+
"responses": {
6838+
"200": {
6839+
"content": {
6840+
"application/json": {
6841+
"schema": {
6842+
"$ref": "#/components/schemas/AccountEvents"
6843+
}
6844+
}
6845+
},
6846+
"description": "account extra currency history"
6847+
},
6848+
"default": {
6849+
"$ref": "#/components/responses/Error"
6850+
}
6851+
},
6852+
"tags": [
6853+
"Accounts"
6854+
]
6855+
}
6856+
},
67526857
"/v2/accounts/{account_id}/jettons": {
67536858
"get": {
67546859
"description": "Get all Jettons balances by owner address",
@@ -8440,6 +8545,35 @@
84408545
]
84418546
}
84428547
},
8548+
"/v2/extra-currency/{id}": {
8549+
"get": {
8550+
"description": "Get extra currency info by id",
8551+
"operationId": "getExtraCurrencyInfo",
8552+
"parameters": [
8553+
{
8554+
"$ref": "#/components/parameters/ecIDParameter"
8555+
}
8556+
],
8557+
"responses": {
8558+
"200": {
8559+
"content": {
8560+
"application/json": {
8561+
"schema": {
8562+
"$ref": "#/components/schemas/EcPreview"
8563+
}
8564+
}
8565+
},
8566+
"description": "extra currency info"
8567+
},
8568+
"default": {
8569+
"$ref": "#/components/responses/Error"
8570+
}
8571+
},
8572+
"tags": [
8573+
"ExtraCurrency"
8574+
]
8575+
}
8576+
},
84438577
"/v2/gasless/config": {
84448578
"get": {
84458579
"description": "Returns configuration of gasless transfers",
@@ -10883,6 +11017,13 @@
1088311017
"url": "https://docs.tonconsole.com/tonapi/rest-api/utilities"
1088411018
},
1088511019
"name": "Utilities"
11020+
},
11021+
{
11022+
"externalDocs": {
11023+
"description": "Additional documentation",
11024+
"url": "https://docs.tonconsole.com/tonapi/rest-api/extra-currency"
11025+
},
11026+
"name": "ExtraCurrency"
1088611027
}
1088711028
]
1088811029
}

‎api/openapi.yml

+93
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,10 @@ tags:
8484
externalDocs:
8585
description: Additional documentation
8686
url: https://docs.tonconsole.com/tonapi/rest-api/utilities
87+
- name: ExtraCurrency
88+
externalDocs:
89+
description: Additional documentation
90+
url: https://docs.tonconsole.com/tonapi/rest-api/extra-currency
8791

8892
paths:
8993
/v2/openapi.json:
@@ -1101,6 +1105,59 @@ paths:
11011105
example: 1000000000
11021106
'default':
11031107
$ref: '#/components/responses/Error'
1108+
1109+
/v2/accounts/{account_id}/extra-currency/{id}/history:
1110+
get:
1111+
description: Get the transfer history of extra currencies for an account.
1112+
operationId: getAccountExtraCurrencyHistoryByID
1113+
tags:
1114+
- Accounts
1115+
parameters:
1116+
- $ref: '#/components/parameters/accountIDParameter'
1117+
- $ref: '#/components/parameters/ecIDParameter'
1118+
- $ref: '#/components/parameters/i18n'
1119+
- name: before_lt
1120+
in: query
1121+
description: "omit this parameter to get last events"
1122+
required: false
1123+
schema:
1124+
type: integer
1125+
format: int64
1126+
example: 25758317000002
1127+
x-js-format: bigint
1128+
- name: limit
1129+
in: query
1130+
required: true
1131+
schema:
1132+
type: integer
1133+
example: 100
1134+
maximum: 1000
1135+
minimum: 1
1136+
- name: start_date
1137+
in: query
1138+
required: false
1139+
schema:
1140+
type: integer
1141+
format: int64
1142+
maximum: 2114380800
1143+
example: 1668436763
1144+
- name: end_date
1145+
in: query
1146+
required: false
1147+
schema:
1148+
type: integer
1149+
format: int64
1150+
maximum: 2114380800
1151+
example: 1668436763
1152+
responses:
1153+
'200':
1154+
description: account extra currency history
1155+
content:
1156+
application/json:
1157+
schema:
1158+
$ref: '#/components/schemas/AccountEvents'
1159+
'default':
1160+
$ref: '#/components/responses/Error'
11041161

11051162
/v2/dns/{domain_name}:
11061163
get:
@@ -1667,6 +1724,24 @@ paths:
16671724
$ref: '#/components/schemas/Event'
16681725
'default':
16691726
$ref: '#/components/responses/Error'
1727+
1728+
/v2/extra-currency/{id}:
1729+
get:
1730+
description: Get extra currency info by id
1731+
operationId: getExtraCurrencyInfo
1732+
tags:
1733+
- ExtraCurrency
1734+
parameters:
1735+
- $ref: '#/components/parameters/ecIDParameter'
1736+
responses:
1737+
'200':
1738+
description: extra currency info
1739+
content:
1740+
application/json:
1741+
schema:
1742+
$ref: '#/components/schemas/EcPreview'
1743+
'default':
1744+
$ref: '#/components/responses/Error'
16701745

16711746
/v2/staking/nominator/{account_id}/pools:
16721747
get:
@@ -2955,6 +3030,15 @@ components:
29553030
schema:
29563031
type: string
29573032
example: 97264395BD65A255A429B11326C84128B7D70FFED7949ABAE3036D506BA38621
3033+
ecIDParameter:
3034+
in: path
3035+
name: id
3036+
required: true
3037+
description: "extra currency id"
3038+
schema:
3039+
type: integer
3040+
example: 239
3041+
format: int32
29583042
publicKeyParameter:
29593043
in: path
29603044
name: public_key
@@ -5887,6 +5971,15 @@ components:
58875971
$ref: '#/components/schemas/EncryptedComment'
58885972
refund:
58895973
$ref: '#/components/schemas/Refund'
5974+
ExtraCurrencies:
5975+
type: object
5976+
required:
5977+
- extra_currencies
5978+
properties:
5979+
extra_currencies:
5980+
type: array
5981+
items:
5982+
$ref: '#/components/schemas/EcPreview'
58905983
EcPreview:
58915984
type: object
58925985
required:

‎pkg/api/account_handlers.go

+4
Original file line numberDiff line numberDiff line change
@@ -604,3 +604,7 @@ func (h *Handler) AddressParse(ctx context.Context, params oas.AddressParseParam
604604
}
605605
return &res, nil //todo: add testnet_only
606606
}
607+
608+
func (h *Handler) GetAccountExtraCurrencyHistoryByID(ctx context.Context, params oas.GetAccountExtraCurrencyHistoryByIDParams) (*oas.AccountEvents, error) {
609+
return &oas.AccountEvents{}, nil
610+
}

‎pkg/api/extra_currency_handlers.go

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
package api
2+
3+
import (
4+
"context"
5+
6+
"github.com/tonkeeper/opentonapi/pkg/oas"
7+
)
8+
9+
func (h *Handler) GetExtraCurrencyInfo(ctx context.Context, params oas.GetExtraCurrencyInfoParams) (*oas.EcPreview, error) {
10+
return &oas.EcPreview{}, nil
11+
}

0 commit comments

Comments
 (0)