# Utility

## Calculate max loan amount

> \- Calculate max loan amount of a pool, based on collateral amount and health factor

```json
{"openapi":"3.0.1","info":{"title":"Danogo Lending Public","version":"v1.0.0"},"tags":[{"name":"Utility"}],"servers":[{"url":"https://danogo-lending.preview.tekoapis.net","description":"Preview"},{"url":"https://danogo-lending.tekoapis.com","description":"Mainnet"}],"paths":{"/api/v1/calculate-max-loan-amount":{"post":{"tags":["Utility"],"summary":"Calculate max loan amount","description":"- Calculate max loan amount of a pool, based on collateral amount and health factor","operationId":"calculateMaxLoanAmount","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["loanToken","healthFactor","collateralTokens"],"properties":{"loanToken":{"type":"string","format":"{policyId}.{assetName}","nullable":false,"description":"Token id of loan token"},"healthFactor":{"type":"number","format":"double","nullable":false,"description":"Health factor of this loan"},"collateralTokens":{"type":"array","minItems":1,"maxItems":50,"description":"List of collaterals used by Loan","items":{"type":"object","required":["collateralToken","collateralAmount","liquidationThreshold"],"properties":{"collateralToken":{"type":"string","format":"{policyId}.{assetName}","nullable":false,"description":"Token id of Collateral token"},"collateralAmount":{"type":"string","format":"bigint","nullable":false,"description":"Amount of Collateral token"},"liquidationThreshold":{"type":"integer","nullable":false,"description":"Liquidation threshold of collateral token in basis points"}}}},"borrowRate":{"type":"integer","nullable":true,"description":"Borrow rate of this Pool in bais point, used for calculating max loan amount of Fixed Pool"},"loanDuration":{"type":"integer","nullable":true,"description":"Loan duration in days, used for calculating max loan amount of Fixed Pool"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"title":"generic message response","type":"object","properties":{"code":{"type":"integer","description":"response code, 200 is success, other code is not success"},"traceId":{"type":"string","description":"Trace ID of the request (required when request is error).\nTrace ID is used to trace the root cause of the error quickly.\n- Why we need it?, please refer TDD: https://confluence.teko.vn/pages/viewpage.action?pageId=368467363\n- Distributed tracing guideline: https://confluence.teko.vn/display/PLAT/Code+example++Golang%2C+Python++for+distributed+tracing+with+Jaeger\n- Service mesh guideline: https://confluence.teko.vn/display/PLAT/Expose+metrics+for+kubernetes+services+by+service+mesh"},"message":{"type":"string","description":"response message"}}},{"type":"object","properties":{"data":{"type":"object","required":["maxBorrowAmount","maxLoanAmount"],"properties":{"maxBorrowAmount":{"type":"string","format":"bigint","nullable":false,"description":"Max borrow amount user can borrow, in base unit"},"maxLoanAmount":{"type":"string","format":"bigint","nullable":false,"description":"Max loan amount user need to paid when repaying loan, in base unit"}}}}}]}}}},"default":{"description":"An unexpected error response","content":{"application/json":{"schema":{"title":"runtimeError","allOf":[{"title":"generic message response","type":"object","properties":{"code":{"type":"integer","description":"response code, 200 is success, other code is not success"},"traceId":{"type":"string","description":"Trace ID of the request (required when request is error).\nTrace ID is used to trace the root cause of the error quickly.\n- Why we need it?, please refer TDD: https://confluence.teko.vn/pages/viewpage.action?pageId=368467363\n- Distributed tracing guideline: https://confluence.teko.vn/display/PLAT/Code+example++Golang%2C+Python++for+distributed+tracing+with+Jaeger\n- Service mesh guideline: https://confluence.teko.vn/display/PLAT/Expose+metrics+for+kubernetes+services+by+service+mesh"},"message":{"type":"string","description":"response message"}}},{"type":"object","properties":{"error":{"type":"string","deprecated":true,"description":"do NOT use this field anymore! Use code & message instead!"},"details":{"type":"array","items":{"title":"protobufAny","type":"object","properties":{"typeUrl":{"type":"string","description":"A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n  value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n  URL, or have them precompiled into a binary to avoid any\n  lookup. Therefore, binary compatibility needs to be preserved\n  on changes to types. (Use versioned type names to manage\n  breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics."},"value":{"pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$","type":"string","description":"Must be a valid serialized protocol buffer of the above specified type.","format":"byte"}},"description":"`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n    Foo foo = ...;\n    Any any;\n    any.PackFrom(foo);\n    ...\n    if (any.UnpackTo(&foo)) {\n      ...\n    }\n\nExample 2: Pack and unpack a message in Java.\n\n    Foo foo = ...;\n    Any any = Any.pack(foo);\n    ...\n    if (any.is(Foo.class)) {\n      foo = any.unpack(Foo.class);\n    }\n\n  Example 3: Pack and unpack a message in Python.\n\n    foo = Foo(...)\n    any = Any()\n    any.Pack(foo)\n    ...\n    if any.Is(Foo.DESCRIPTOR):\n      any.Unpack(foo)\n      ...\n\n  Example 4: Pack and unpack a message in Go\n\n      foo := &pb.Foo{...}\n      any, err := ptypes.MarshalAny(foo)\n      ...\n      foo := &pb.Foo{}\n      if err := ptypes.UnmarshalAny(any, foo); err != nil {\n        ...\n      }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n    package google.profile;\n    message Person {\n      string first_name = 1;\n      string last_name = 2;\n    }\n\n    {\n      \"@type\": \"type.googleapis.com/google.profile.Person\",\n      \"firstName\": <string>,\n      \"lastName\": <string>\n    }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n    {\n      \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n      \"value\": \"1.212s\"\n    }"}}}}]}}}}}}}}}
```

## Calculate health factor

> \- Calculate health factor of a loan, based on loan amount and collateral amount

```json
{"openapi":"3.0.1","info":{"title":"Danogo Lending Public","version":"v1.0.0"},"tags":[{"name":"Utility"}],"servers":[{"url":"https://danogo-lending.preview.tekoapis.net","description":"Preview"},{"url":"https://danogo-lending.tekoapis.com","description":"Mainnet"}],"paths":{"/api/v1/calculate-health-factor":{"post":{"tags":["Utility"],"summary":"Calculate health factor","description":"- Calculate health factor of a loan, based on loan amount and collateral amount","operationId":"calculateHealthFactor","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["loanToken","loanAmount","collateralTokens"],"properties":{"loanToken":{"type":"string","format":"{policyId}.{assetName}","nullable":false,"description":"Token id of loan token"},"loanAmount":{"type":"string","format":"bigint","nullable":false,"description":"Loan amount"},"collateralTokens":{"type":"array","minItems":1,"maxItems":50,"description":"List of collaterals used by Loan","items":{"type":"object","required":["collateralToken","collateralAmount","liquidationThreshold"],"properties":{"collateralToken":{"type":"string","format":"{policyId}.{assetName}","nullable":false,"description":"Token id of Collateral token"},"collateralAmount":{"type":"string","format":"bigint","nullable":false,"description":"Amount of Collateral token"},"liquidationThreshold":{"type":"integer","nullable":false,"description":"Liquidation threshold of collateral token in basis points"}}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"title":"generic message response","type":"object","properties":{"code":{"type":"integer","description":"response code, 200 is success, other code is not success"},"traceId":{"type":"string","description":"Trace ID of the request (required when request is error).\nTrace ID is used to trace the root cause of the error quickly.\n- Why we need it?, please refer TDD: https://confluence.teko.vn/pages/viewpage.action?pageId=368467363\n- Distributed tracing guideline: https://confluence.teko.vn/display/PLAT/Code+example++Golang%2C+Python++for+distributed+tracing+with+Jaeger\n- Service mesh guideline: https://confluence.teko.vn/display/PLAT/Expose+metrics+for+kubernetes+services+by+service+mesh"},"message":{"type":"string","description":"response message"}}},{"type":"object","properties":{"data":{"type":"object","required":["healthFactor","totalCollateralAmount"],"properties":{"healthFactor":{"type":"number","format":"double","nullable":false,"description":"Health factor collateraled based on borrow amount and collateral amount"},"totalCollateralAmount":{"type":"string","format":"bigint","nullable":false,"description":"Total collateral amount in base unit"}}}}}]}}}},"default":{"description":"An unexpected error response","content":{"application/json":{"schema":{"title":"runtimeError","allOf":[{"title":"generic message response","type":"object","properties":{"code":{"type":"integer","description":"response code, 200 is success, other code is not success"},"traceId":{"type":"string","description":"Trace ID of the request (required when request is error).\nTrace ID is used to trace the root cause of the error quickly.\n- Why we need it?, please refer TDD: https://confluence.teko.vn/pages/viewpage.action?pageId=368467363\n- Distributed tracing guideline: https://confluence.teko.vn/display/PLAT/Code+example++Golang%2C+Python++for+distributed+tracing+with+Jaeger\n- Service mesh guideline: https://confluence.teko.vn/display/PLAT/Expose+metrics+for+kubernetes+services+by+service+mesh"},"message":{"type":"string","description":"response message"}}},{"type":"object","properties":{"error":{"type":"string","deprecated":true,"description":"do NOT use this field anymore! Use code & message instead!"},"details":{"type":"array","items":{"title":"protobufAny","type":"object","properties":{"typeUrl":{"type":"string","description":"A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n  value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n  URL, or have them precompiled into a binary to avoid any\n  lookup. Therefore, binary compatibility needs to be preserved\n  on changes to types. (Use versioned type names to manage\n  breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics."},"value":{"pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$","type":"string","description":"Must be a valid serialized protocol buffer of the above specified type.","format":"byte"}},"description":"`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n    Foo foo = ...;\n    Any any;\n    any.PackFrom(foo);\n    ...\n    if (any.UnpackTo(&foo)) {\n      ...\n    }\n\nExample 2: Pack and unpack a message in Java.\n\n    Foo foo = ...;\n    Any any = Any.pack(foo);\n    ...\n    if (any.is(Foo.class)) {\n      foo = any.unpack(Foo.class);\n    }\n\n  Example 3: Pack and unpack a message in Python.\n\n    foo = Foo(...)\n    any = Any()\n    any.Pack(foo)\n    ...\n    if any.Is(Foo.DESCRIPTOR):\n      any.Unpack(foo)\n      ...\n\n  Example 4: Pack and unpack a message in Go\n\n      foo := &pb.Foo{...}\n      any, err := ptypes.MarshalAny(foo)\n      ...\n      foo := &pb.Foo{}\n      if err := ptypes.UnmarshalAny(any, foo); err != nil {\n        ...\n      }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n    package google.profile;\n    message Person {\n      string first_name = 1;\n      string last_name = 2;\n    }\n\n    {\n      \"@type\": \"type.googleapis.com/google.profile.Person\",\n      \"firstName\": <string>,\n      \"lastName\": <string>\n    }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n    {\n      \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n      \"value\": \"1.212s\"\n    }"}}}}]}}}}}}}}}
```