import { trimEnd } from './util/util';
import xdr from './xdr';
import { Keypair } from './keypair';
import { StrKey } from './strkey';
import { hash } from './hashing';
/**
* Asset class represents an asset, either the native asset (`XLM`)
* or an asset code / issuer account ID pair.
*
* An asset code describes an asset code and issuer pair. In the case of the native
* asset XLM, the issuer will be null.
*
* @constructor
* @param {string} code - The asset code.
* @param {string} issuer - The account ID of the issuer.
*/
export class Asset {
constructor(code, issuer) {
if (!/^[a-zA-Z0-9]{1,12}$/.test(code)) {
throw new Error(
'Asset code is invalid (maximum alphanumeric, 12 characters at max)'
);
}
if (String(code).toLowerCase() !== 'xlm' && !issuer) {
throw new Error('Issuer cannot be null');
}
if (issuer && !StrKey.isValidEd25519PublicKey(issuer)) {
throw new Error('Issuer is invalid');
}
if (String(code).toLowerCase() === 'xlm') {
// transform all xLM, Xlm, etc. variants -> XLM
this.code = 'XLM';
} else {
this.code = code;
}
this.issuer = issuer;
}
/**
* Returns an asset object for the native asset.
* @Return {Asset}
*/
static native() {
return new Asset('XLM');
}
/**
* Returns an asset object from its XDR object representation.
* @param {xdr.Asset} assetXdr - The asset xdr object.
* @returns {Asset}
*/
static fromOperation(assetXdr) {
let anum;
let code;
let issuer;
switch (assetXdr.switch()) {
case xdr.AssetType.assetTypeNative():
return this.native();
case xdr.AssetType.assetTypeCreditAlphanum4():
anum = assetXdr.alphaNum4();
/* falls through */
case xdr.AssetType.assetTypeCreditAlphanum12():
anum = anum || assetXdr.alphaNum12();
issuer = StrKey.encodeEd25519PublicKey(anum.issuer().ed25519());
code = trimEnd(anum.assetCode(), '\0');
return new this(code, issuer);
default:
throw new Error(`Invalid asset type: ${assetXdr.switch().name}`);
}
}
/**
* Returns the xdr.Asset object for this asset.
* @returns {xdr.Asset} XDR asset object
*/
toXDRObject() {
return this._toXDRObject(xdr.Asset);
}
/**
* Returns the xdr.ChangeTrustAsset object for this asset.
* @returns {xdr.ChangeTrustAsset} XDR asset object
*/
toChangeTrustXDRObject() {
return this._toXDRObject(xdr.ChangeTrustAsset);
}
/**
* Returns the xdr.TrustLineAsset object for this asset.
* @returns {xdr.TrustLineAsset} XDR asset object
*/
toTrustLineXDRObject() {
return this._toXDRObject(xdr.TrustLineAsset);
}
/**
* Returns the would-be contract ID (`C...` format) for this asset on a given
* network.
*
* @param {string} networkPassphrase indicates which network the contract
* ID should refer to, since every network will have a unique ID for the
* same contract (see {@link Networks} for options)
*
* @returns {string} the strkey-encoded (`C...`) contract ID for this asset
*
* @warning This makes no guarantee that this contract actually *exists*.
*/
contractId(networkPassphrase) {
const networkId = hash(Buffer.from(networkPassphrase));
const preimage = xdr.HashIdPreimage.envelopeTypeContractId(
new xdr.HashIdPreimageContractId({
networkId,
contractIdPreimage: xdr.ContractIdPreimage.contractIdPreimageFromAsset(
this.toXDRObject()
)
})
);
return StrKey.encodeContract(hash(preimage.toXDR()));
}
/**
* Returns the xdr object for this asset.
* @param {xdr.Asset | xdr.ChangeTrustAsset} xdrAsset - The asset xdr object.
* @returns {xdr.Asset | xdr.ChangeTrustAsset | xdr.TrustLineAsset} XDR Asset object
*/
_toXDRObject(xdrAsset = xdr.Asset) {
if (this.isNative()) {
return xdrAsset.assetTypeNative();
}
let xdrType;
let xdrTypeString;
if (this.code.length <= 4) {
xdrType = xdr.AlphaNum4;
xdrTypeString = 'assetTypeCreditAlphanum4';
} else {
xdrType = xdr.AlphaNum12;
xdrTypeString = 'assetTypeCreditAlphanum12';
}
// pad code with null bytes if necessary
const padLength = this.code.length <= 4 ? 4 : 12;
const paddedCode = this.code.padEnd(padLength, '\0');
// eslint-disable-next-line new-cap
const assetType = new xdrType({
assetCode: paddedCode,
issuer: Keypair.fromPublicKey(this.issuer).xdrAccountId()
});
return new xdrAsset(xdrTypeString, assetType);
}
/**
* @returns {string} Asset code
*/
getCode() {
if (this.code === undefined) {
return undefined;
}
return String(this.code);
}
/**
* @returns {string} Asset issuer
*/
getIssuer() {
if (this.issuer === undefined) {
return undefined;
}
return String(this.issuer);
}
/**
* @see [Assets concept](https://developers.stellar.org/docs/glossary/assets/)
* @returns {string} Asset type. Can be one of following types:
*
* - `native`,
* - `credit_alphanum4`,
* - `credit_alphanum12`, or
* - `unknown` as the error case (which should never occur)
*/
getAssetType() {
switch (this.getRawAssetType()) {
case xdr.AssetType.assetTypeNative():
return 'native';
case xdr.AssetType.assetTypeCreditAlphanum4():
return 'credit_alphanum4';
case xdr.AssetType.assetTypeCreditAlphanum12():
return 'credit_alphanum12';
default:
return 'unknown';
}
}
/**
* @returns {xdr.AssetType} the raw XDR representation of the asset type
*/
getRawAssetType() {
if (this.isNative()) {
return xdr.AssetType.assetTypeNative();
}
if (this.code.length <= 4) {
return xdr.AssetType.assetTypeCreditAlphanum4();
}
return xdr.AssetType.assetTypeCreditAlphanum12();
}
/**
* @returns {boolean} true if this asset object is the native asset.
*/
isNative() {
return !this.issuer;
}
/**
* @param {Asset} asset Asset to compare
* @returns {boolean} true if this asset equals the given asset.
*/
equals(asset) {
return this.code === asset.getCode() && this.issuer === asset.getIssuer();
}
toString() {
if (this.isNative()) {
return 'native';
}
return `${this.getCode()}:${this.getIssuer()}`;
}
/**
* Compares two assets according to the criteria:
*
* 1. First compare the type (native < alphanum4 < alphanum12).
* 2. If the types are equal, compare the assets codes.
* 3. If the asset codes are equal, compare the issuers.
*
* @param {Asset} assetA - the first asset
* @param {Asset} assetB - the second asset
* @returns {number} `-1` if assetA < assetB, `0` if assetA == assetB, `1` if assetA > assetB.
*
* @static
* @memberof Asset
*/
static compare(assetA, assetB) {
if (!assetA || !(assetA instanceof Asset)) {
throw new Error('assetA is invalid');
}
if (!assetB || !(assetB instanceof Asset)) {
throw new Error('assetB is invalid');
}
if (assetA.equals(assetB)) {
return 0;
}
// Compare asset types.
const xdrAtype = assetA.getRawAssetType().value;
const xdrBtype = assetB.getRawAssetType().value;
if (xdrAtype !== xdrBtype) {
return xdrAtype < xdrBtype ? -1 : 1;
}
// Compare asset codes.
const result = asciiCompare(assetA.getCode(), assetB.getCode());
if (result !== 0) {
return result;
}
// Compare asset issuers.
return asciiCompare(assetA.getIssuer(), assetB.getIssuer());
}
}
/**
* Compares two ASCII strings in lexographic order with uppercase precedence.
*
* @param {string} a - the first string to compare
* @param {string} b - the second
* @returns {number} like all `compare()`s:
* -1 if `a < b`, 0 if `a == b`, and 1 if `a > b`
*
* @warning No type-checks are done on the parameters
*/
function asciiCompare(a, b) {
return Buffer.compare(Buffer.from(a, 'ascii'), Buffer.from(b, 'ascii'));
}