"use strict";
Object.defineProperty(exports, "__esModule", {
value: true
});
exports.FederationServer = exports.FEDERATION_RESPONSE_MAX_SIZE = void 0;
var _stellarBase = require("@stellar/stellar-base");
var _urijs = _interopRequireDefault(require("urijs"));
var _config = require("../config");
var _errors = require("../errors");
var _stellartoml = require("../stellartoml");
var _httpClient = require("../http-client");
function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
/* eslint-disable require-await */
/** @module Federation */
/**
* The maximum size of response from a federation server
* @default 102400
*/
const FEDERATION_RESPONSE_MAX_SIZE = exports.FEDERATION_RESPONSE_MAX_SIZE = 100 * 1024;
/**
* Federation.Server handles a network connection to a
* [federation server](https://developers.stellar.org/docs/learn/encyclopedia/federation)
* instance and exposes an interface for requests to that instance.
*
* @alias module:Federation.Server
* @memberof module:Federation
* @param {string} serverURL The federation server URL (ex. `https://acme.com/federation`).
* @param {string} domain Domain this server represents
* @param {Api.Options} [opts] Options object
* @returns {void}
*/
class FederationServer {
/**
* The federation server URL (ex. `https://acme.com/federation`).
*/
// TODO: public or private? readonly?
/**
* Domain this server represents.
*/
// TODO: public or private? readonly?
/**
* Allow a timeout, default: 0. Allows user to avoid nasty lag due to TOML resolve issue.
*/
// TODO: public or private? readonly?
/**
* A helper method for handling user inputs that contain `destination` value.
* It accepts two types of values:
*
* * For Stellar address (ex. `bob*stellar.org`) it splits Stellar address and then tries to find information about
* federation server in `stellar.toml` file for a given domain. It returns a `Promise` which resolves if federation
* server exists and user has been found and rejects in all other cases.
* * For Account ID (ex. `GB5XVAABEQMY63WTHDQ5RXADGYF345VWMNPTN2GFUDZT57D57ZQTJ7PS`) it returns a `Promise` which
* resolves if Account ID is valid and rejects in all other cases. Please note that this method does not check
* if the account actually exists in a ledger.
*
* @example
* StellarSdk.FederationServer.resolve('bob*stellar.org')
* .then(federationRecord => {
* // {
* // account_id: 'GB5XVAABEQMY63WTHDQ5RXADGYF345VWMNPTN2GFUDZT57D57ZQTJ7PS',
* // memo_type: 'id',
* // memo: 100
* // }
* });
*
* @see <a href="https://developers.stellar.org/docs/learn/encyclopedia/federation" target="_blank">Federation doc</a>
* @see <a href="https://developers.stellar.org/docs/issuing-assets/publishing-asset-info" target="_blank">Stellar.toml doc</a>
* @param {string} value Stellar Address (ex. `bob*stellar.org`)
* @param {object} [opts] Options object
* @returns {Promise<module:Federation.Api.Record>} A promise that resolves to the federation record
* @throws Will throw an error if the provided account ID is not a valid Ed25519 public key.
*/
static async resolve(value, opts = {}) {
// Check if `value` is in account ID format
if (value.indexOf("*") < 0) {
if (!_stellarBase.StrKey.isValidEd25519PublicKey(value)) {
return Promise.reject(new Error("Invalid Account ID"));
}
return Promise.resolve({
account_id: value
});
}
const addressParts = value.split("*");
const [, domain] = addressParts;
if (addressParts.length !== 2 || !domain) {
return Promise.reject(new Error("Invalid Stellar address"));
}
const federationServer = await FederationServer.createForDomain(domain, opts);
return federationServer.resolveAddress(value);
}
/**
* Creates a `FederationServer` instance based on information from
* [stellar.toml](https://developers.stellar.org/docs/issuing-assets/publishing-asset-info)
* file for a given domain.
*
* If `stellar.toml` file does not exist for a given domain or it does not
* contain information about a federation server Promise will reject.
*
* @example
* StellarSdk.FederationServer.createForDomain('acme.com')
* .then(federationServer => {
* // federationServer.resolveAddress('bob').then(...)
* })
* .catch(error => {
* // stellar.toml does not exist or it does not contain information about federation server.
* });
*
* @see <a href="https://developers.stellar.org/docs/issuing-assets/publishing-asset-info" target="_blank">Stellar.toml doc</a>
* @param {string} domain Domain to get federation server for
* @param {module:Federation.Api.Options} [opts] Options object
* @returns {Promise<module:Federation.Api.Record>} A promise that resolves to the federation record
* @throws Will throw an error if the domain's stellar.toml file does not contain a federation server field.
*/
static async createForDomain(domain, opts = {}) {
const tomlObject = await _stellartoml.Resolver.resolve(domain, opts);
if (!tomlObject.FEDERATION_SERVER) {
return Promise.reject(new Error("stellar.toml does not contain FEDERATION_SERVER field"));
}
return new FederationServer(tomlObject.FEDERATION_SERVER, domain, opts);
}
constructor(serverURL, domain, opts = {}) {
// TODO `domain` regexp
this.serverURL = (0, _urijs.default)(serverURL);
this.domain = domain;
const allowHttp = typeof opts.allowHttp === "undefined" ? _config.Config.isAllowHttp() : opts.allowHttp;
this.timeout = typeof opts.timeout === "undefined" ? _config.Config.getTimeout() : opts.timeout;
if (this.serverURL.protocol() !== "https" && !allowHttp) {
throw new Error("Cannot connect to insecure federation server");
}
}
/**
* Get the federation record if the user was found for a given Stellar address
* @see <a href="https://developers.stellar.org/docs/encyclopedia/federation" target="_blank">Federation doc</a>
* @param {string} address Stellar address (ex. `bob*stellar.org`). If `FederationServer` was instantiated with `domain` param only username (ex. `bob`) can be passed.
* @returns {Promise<module:Federation.Api.Record>} A promise that resolves to the federation record
* @throws Will throw an error if the federated address does not contain a domain, or if the server object was not instantiated with a `domain` parameter
*/
async resolveAddress(address) {
let stellarAddress = address;
if (address.indexOf("*") < 0) {
if (!this.domain) {
return Promise.reject(new Error("Unknown domain. Make sure `address` contains a domain (ex. `bob*stellar.org`) or pass `domain` parameter when instantiating the server object."));
}
stellarAddress = `${address}*${this.domain}`;
}
const url = this.serverURL.query({
type: "name",
q: stellarAddress
});
return this._sendRequest(url);
}
/**
* Given an account ID, get their federation record if the user was found
* @see <a href="https://developers.stellar.org/docs/encyclopedia/federation" target="_blank">Federation doc</a>
* @param {string} accountId Account ID (ex. `GBYNR2QJXLBCBTRN44MRORCMI4YO7FZPFBCNOKTOBCAAFC7KC3LNPRYS`)
* @returns {Promise<module:Federation.Api.Record>} A promise that resolves to the federation record
* @throws Will throw an error if the federation server returns an invalid memo value.
* @throws Will throw an error if the federation server's response exceeds the allowed maximum size.
* @throws {BadResponseError} Will throw an error if the server query fails with an improper response.
*/
async resolveAccountId(accountId) {
const url = this.serverURL.query({
type: "id",
q: accountId
});
return this._sendRequest(url);
}
/**
* Given a transactionId, get the federation record if the sender of the transaction was found
* @see <a href="https://developers.stellar.org/docs/glossary/federation/" target="_blank">Federation doc</a>
* @param {string} transactionId Transaction ID (ex. `3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889`)
* @returns {Promise<module:Federation.Api.Record>} A promise that resolves to the federation record
* @throws Will throw an error if the federation server returns an invalid memo value.
* @throws Will throw an error if the federation server's response exceeds the allowed maximum size.
* @throws {BadResponseError} Will throw an error if the server query fails with an improper response.
*/
async resolveTransactionId(transactionId) {
const url = this.serverURL.query({
type: "txid",
q: transactionId
});
return this._sendRequest(url);
}
async _sendRequest(url) {
const timeout = this.timeout;
return _httpClient.httpClient.get(url.toString(), {
maxContentLength: FEDERATION_RESPONSE_MAX_SIZE,
timeout
}).then(response => {
if (typeof response.data.memo !== "undefined" && typeof response.data.memo !== "string") {
throw new Error("memo value should be of type string");
}
return response.data;
}).catch(response => {
if (response instanceof Error) {
if (response.message.match(/^maxContentLength size/)) {
throw new Error(`federation response exceeds allowed size of ${FEDERATION_RESPONSE_MAX_SIZE}`);
} else {
return Promise.reject(response);
}
} else {
return Promise.reject(new _errors.BadResponseError(`Server query failed. Server responded: ${response.status} ${response.statusText}`, response.data));
}
});
}
}
exports.FederationServer = FederationServer;Source