mirror of
https://github.com/aljazceru/ark.git
synced 2025-12-17 04:04:21 +01:00
f0a90c06ee
* api-spec: move the api-spec to root and init go.mod * go mod tidy * move buf files in the root as well * gh action for api-spec changes only * gh action for api-spec on push and pr
198 lines
4.7 KiB
JSON
198 lines
4.7 KiB
JSON
{
|
|
"swagger": "2.0",
|
|
"info": {
|
|
"title": "ocean/v1/wallet.proto",
|
|
"version": "version not set"
|
|
},
|
|
"tags": [
|
|
{
|
|
"name": "WalletService"
|
|
}
|
|
],
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"paths": {},
|
|
"definitions": {
|
|
"GetInfoResponseNetwork": {
|
|
"type": "string",
|
|
"enum": [
|
|
"NETWORK_UNSPECIFIED",
|
|
"NETWORK_MAINNET",
|
|
"NETWORK_TESTNET",
|
|
"NETWORK_REGTEST"
|
|
],
|
|
"default": "NETWORK_UNSPECIFIED"
|
|
},
|
|
"googlerpcStatus": {
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"message": {
|
|
"type": "string"
|
|
},
|
|
"details": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"$ref": "#/definitions/protobufAny"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"protobufAny": {
|
|
"type": "object",
|
|
"properties": {
|
|
"@type": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": {}
|
|
},
|
|
"v1AccountInfo": {
|
|
"type": "object",
|
|
"properties": {
|
|
"namespace": {
|
|
"type": "string",
|
|
"description": "Account namespace."
|
|
},
|
|
"label": {
|
|
"type": "string",
|
|
"description": "Account label."
|
|
},
|
|
"derivationPath": {
|
|
"type": "string",
|
|
"description": "Derivation path."
|
|
},
|
|
"xpubs": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"description": "Xpubs."
|
|
},
|
|
"masterBlindingKey": {
|
|
"type": "string",
|
|
"description": "The master blinding key of the account to derive blinding keypairs from."
|
|
}
|
|
}
|
|
},
|
|
"v1AuthResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"verified": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
},
|
|
"v1BuildInfo": {
|
|
"type": "object",
|
|
"properties": {
|
|
"version": {
|
|
"type": "string",
|
|
"description": "Number of the version."
|
|
},
|
|
"commit": {
|
|
"type": "string",
|
|
"description": "Hash of the commit."
|
|
},
|
|
"date": {
|
|
"type": "string",
|
|
"description": "Date of the commit."
|
|
}
|
|
}
|
|
},
|
|
"v1ChangePasswordResponse": {
|
|
"type": "object"
|
|
},
|
|
"v1CreateWalletResponse": {
|
|
"type": "object"
|
|
},
|
|
"v1GenSeedResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"mnemonic": {
|
|
"type": "string",
|
|
"description": "A mnemonic from where deriving signing and blinding key pairs."
|
|
}
|
|
}
|
|
},
|
|
"v1GetInfoResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"network": {
|
|
"$ref": "#/definitions/GetInfoResponseNetwork",
|
|
"title": "The Liquid network of the wallet"
|
|
},
|
|
"nativeAsset": {
|
|
"type": "string",
|
|
"description": "The Liquid Bitcoin (LBTC) asset hash of the network."
|
|
},
|
|
"rootPath": {
|
|
"type": "string",
|
|
"description": "The root derivation path of the HD wallet."
|
|
},
|
|
"birthdayBlockHash": {
|
|
"type": "string",
|
|
"description": "The hash of the block at wallet creation time."
|
|
},
|
|
"birthdayBlockHeight": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"description": "The height of the block at wallet creation time."
|
|
},
|
|
"accounts": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"$ref": "#/definitions/v1AccountInfo"
|
|
},
|
|
"description": "List containing info about the wallet accounts."
|
|
},
|
|
"buildInfo": {
|
|
"$ref": "#/definitions/v1BuildInfo",
|
|
"description": "Info about the current version of the ocean wallet."
|
|
}
|
|
}
|
|
},
|
|
"v1LockResponse": {
|
|
"type": "object"
|
|
},
|
|
"v1RestoreWalletResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"message": {
|
|
"type": "string",
|
|
"description": "String message returned within the process."
|
|
}
|
|
}
|
|
},
|
|
"v1StatusResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"initialized": {
|
|
"type": "boolean",
|
|
"description": "Whether the wallet is initialized with seeds."
|
|
},
|
|
"synced": {
|
|
"type": "boolean",
|
|
"description": "Whether the wallet is in sync, meaning it's keeping track of every utxo\nof every account."
|
|
},
|
|
"unlocked": {
|
|
"type": "boolean",
|
|
"description": "Whether the wallet is unlocked."
|
|
}
|
|
}
|
|
},
|
|
"v1UnlockResponse": {
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|