"use strict";
Object.defineProperty(exports, "__esModule", {
value: true
});
exports.ContractSpec = void 0;
var _2 = require(".");
var _rust_types = require("./rust_types");
function readObj(args, input) {
let inputName = input.name().toString();
let entry = Object.entries(args).find(([name, _]) => name === inputName);
if (!entry) {
throw new Error(`Missing field ${inputName}`);
}
return entry[1];
}
/**
* Provides a ContractSpec class which can contains the XDR types defined by the contract.
* This allows the class to be used to convert between native and raw `xdr.ScVal`s.
*
* @example
* ```js
* const specEntries = [...]; // XDR spec entries of a smart contract
* const contractSpec = new ContractSpec(specEntries);
*
* // Convert native value to ScVal
* const args = {
* arg1: 'value1',
* arg2: 1234
* };
* const scArgs = contractSpec.funcArgsToScVals('funcName', args);
*
* // Call contract
* const resultScv = await callContract(contractId, 'funcName', scArgs);
*
* // Convert result ScVal back to native value
* const result = contractSpec.funcResToNative('funcName', resultScv);
*
* console.log(result); // {success: true}
* ```
*/
class ContractSpec {
entries = [];
/**
* Constructs a new ContractSpec from an array of XDR spec entries.
*
* @param {xdr.ScSpecEntry[] | string[]} entries the XDR spec entries
*
* @throws {Error} if entries is invalid
*/
constructor(entries) {
if (entries.length == 0) {
throw new Error("Contract spec must have at least one entry");
}
let entry = entries[0];
if (typeof entry === "string") {
this.entries = entries.map(s => _2.xdr.ScSpecEntry.fromXDR(s, "base64"));
} else {
this.entries = entries;
}
}
/**
* Gets the XDR functions from the spec.
*
* @returns {xdr.ScSpecFunctionV0[]} all contract functions
*
*/
funcs() {
return this.entries.filter(entry => entry.switch().value === _2.xdr.ScSpecEntryKind.scSpecEntryFunctionV0().value).map(entry => entry.functionV0());
}
/**
* Gets the XDR function spec for the given function name.
*
* @param {string} name the name of the function
* @returns {xdr.ScSpecFunctionV0} the function spec
*
* @throws {Error} if no function with the given name exists
*/
getFunc(name) {
let entry = this.findEntry(name);
if (entry.switch().value !== _2.xdr.ScSpecEntryKind.scSpecEntryFunctionV0().value) {
throw new Error(`${name} is not a function`);
}
return entry.functionV0();
}
/**
* Converts native JS arguments to ScVals for calling a contract function.
*
* @param {string} name the name of the function
* @param {Object} args the arguments object
* @returns {xdr.ScVal[]} the converted arguments
*
* @throws {Error} if argument is missing or incorrect type
*
* @example
* ```js
* const args = {
* arg1: 'value1',
* arg2: 1234
* };
* const scArgs = contractSpec.funcArgsToScVals('funcName', args);
* ```
*/
funcArgsToScVals(name, args) {
let fn = this.getFunc(name);
return fn.inputs().map(input => this.nativeToScVal(readObj(args, input), input.type()));
}
/**
* Converts the result ScVal of a function call to a native JS value.
*
* @param {string} name the name of the function
* @param {xdr.ScVal | string} val_or_base64 the result ScVal or base64 encoded string
* @returns {any} the converted native value
*
* @throws {Error} if return type mismatch or invalid input
*
* @example
* ```js
* const resultScv = 'AAA=='; // Base64 encoded ScVal
* const result = contractSpec.funcResToNative('funcName', resultScv);
* ```
*/
funcResToNative(name, val_or_base64) {
let val = typeof val_or_base64 === "string" ? _2.xdr.ScVal.fromXDR(val_or_base64, "base64") : val_or_base64;
let func = this.getFunc(name);
let outputs = func.outputs();
if (outputs.length === 0) {
let type = val.switch();
if (type.value !== _2.xdr.ScValType.scvVoid().value) {
throw new Error(`Expected void, got ${type.name}`);
}
return null;
}
if (outputs.length > 1) {
throw new Error(`Multiple outputs not supported`);
}
let output = outputs[0];
if (output.switch().value === _2.xdr.ScSpecType.scSpecTypeResult().value) {
return new _rust_types.Ok(this.scValToNative(val, output.result().okType()));
}
return this.scValToNative(val, output);
}
/**
* Finds the XDR spec entry for the given name.
*
* @param {string} name the name to find
* @returns {xdr.ScSpecEntry} the entry
*
* @throws {Error} if no entry with the given name exists
*/
findEntry(name) {
let entry = this.entries.find(entry => entry.value().name().toString() === name);
if (!entry) {
throw new Error(`no such entry: ${name}`);
}
return entry;
}
/**
* Converts a native JS value to an ScVal based on the given type.
*
* @param {any} val the native JS value
* @param {xdr.ScSpecTypeDef} [ty] the expected type
* @returns {xdr.ScVal} the converted ScVal
*
* @throws {Error} if value cannot be converted to the given type
*/
nativeToScVal(val, ty) {
let t = ty.switch();
let value = t.value;
if (t.value === _2.xdr.ScSpecType.scSpecTypeUdt().value) {
let udt = ty.udt();
return this.nativeToUdt(val, udt.name().toString());
}
if (value === _2.xdr.ScSpecType.scSpecTypeOption().value) {
let opt = ty.option();
if (val === undefined) {
return _2.xdr.ScVal.scvVoid();
}
return this.nativeToScVal(val, opt.valueType());
}
switch (typeof val) {
case "object":
{
if (val === null) {
switch (value) {
case _2.xdr.ScSpecType.scSpecTypeVoid().value:
return _2.xdr.ScVal.scvVoid();
default:
throw new TypeError(`Type ${ty} was not void, but value was null`);
}
}
if (val instanceof _2.xdr.ScVal) {
return val; // should we copy?
}
if (val instanceof _2.Address) {
if (ty.switch().value !== _2.xdr.ScSpecType.scSpecTypeAddress().value) {
throw new TypeError(`Type ${ty} was not address, but value was Address`);
}
return val.toScVal();
}
if (val instanceof _2.Contract) {
if (ty.switch().value !== _2.xdr.ScSpecType.scSpecTypeAddress().value) {
throw new TypeError(`Type ${ty} was not address, but value was Address`);
}
return val.address().toScVal();
}
if (val instanceof Uint8Array || Buffer.isBuffer(val)) {
const copy = Uint8Array.from(val);
switch (value) {
case _2.xdr.ScSpecType.scSpecTypeBytesN().value:
{
let bytes_n = ty.bytesN();
if (copy.length !== bytes_n.n()) {
throw new TypeError(`expected ${bytes_n.n()} bytes, but got ${copy.length}`);
}
//@ts-ignore
return _2.xdr.ScVal.scvBytes(copy);
}
case _2.xdr.ScSpecType.scSpecTypeBytes().value:
//@ts-ignore
return _2.xdr.ScVal.scvBytes(copy);
default:
throw new TypeError(`invalid type (${ty}) specified for Bytes and BytesN`);
}
}
if (Array.isArray(val)) {
switch (value) {
case _2.xdr.ScSpecType.scSpecTypeVec().value:
{
let vec = ty.vec();
let elementType = vec.elementType();
return _2.xdr.ScVal.scvVec(val.map(v => this.nativeToScVal(v, elementType)));
}
case _2.xdr.ScSpecType.scSpecTypeTuple().value:
{
let tup = ty.tuple();
let valTypes = tup.valueTypes();
if (val.length !== valTypes.length) {
throw new TypeError(`Tuple expects ${valTypes.length} values, but ${val.length} were provided`);
}
return _2.xdr.ScVal.scvVec(val.map((v, i) => this.nativeToScVal(v, valTypes[i])));
}
case _2.xdr.ScSpecType.scSpecTypeMap().value:
{
let map = ty.map();
let keyType = map.keyType();
let valueType = map.valueType();
return _2.xdr.ScVal.scvMap(val.map(entry => {
let key = this.nativeToScVal(entry[0], keyType);
let val = this.nativeToScVal(entry[1], valueType);
return new _2.xdr.ScMapEntry({
key,
val
});
}));
}
default:
throw new TypeError(`Type ${ty} was not vec, but value was Array`);
}
}
if (val.constructor === Map) {
if (value !== _2.xdr.ScSpecType.scSpecTypeMap().value) {
throw new TypeError(`Type ${ty} was not map, but value was Map`);
}
let scMap = ty.map();
let map = val;
let entries = [];
let values = map.entries();
let res = values.next();
while (!res.done) {
let [k, v] = res.value;
let key = this.nativeToScVal(k, scMap.keyType());
let val = this.nativeToScVal(v, scMap.valueType());
entries.push(new _2.xdr.ScMapEntry({
key,
val
}));
res = values.next();
}
return _2.xdr.ScVal.scvMap(entries);
}
if ((val.constructor?.name ?? "") !== "Object") {
throw new TypeError(`cannot interpret ${val.constructor?.name} value as ScVal (${JSON.stringify(val)})`);
}
throw new TypeError(`Received object ${val} did not match the provided type ${ty}`);
}
case "number":
case "bigint":
{
switch (value) {
case _2.xdr.ScSpecType.scSpecTypeU32().value:
return _2.xdr.ScVal.scvU32(val);
case _2.xdr.ScSpecType.scSpecTypeI32().value:
return _2.xdr.ScVal.scvI32(val);
case _2.xdr.ScSpecType.scSpecTypeU64().value:
case _2.xdr.ScSpecType.scSpecTypeI64().value:
case _2.xdr.ScSpecType.scSpecTypeU128().value:
case _2.xdr.ScSpecType.scSpecTypeI128().value:
case _2.xdr.ScSpecType.scSpecTypeU256().value:
case _2.xdr.ScSpecType.scSpecTypeI256().value:
{
const intType = t.name.substring(10).toLowerCase();
return new _2.XdrLargeInt(intType, val).toScVal();
}
default:
throw new TypeError(`invalid type (${ty}) specified for integer`);
}
}
case "string":
return stringToScVal(val, t);
case "boolean":
{
if (value !== _2.xdr.ScSpecType.scSpecTypeBool().value) {
throw TypeError(`Type ${ty} was not bool, but value was bool`);
}
return _2.xdr.ScVal.scvBool(val);
}
case "undefined":
{
if (!ty) {
return _2.xdr.ScVal.scvVoid();
}
switch (value) {
case _2.xdr.ScSpecType.scSpecTypeVoid().value:
case _2.xdr.ScSpecType.scSpecTypeOption().value:
return _2.xdr.ScVal.scvVoid();
default:
throw new TypeError(`Type ${ty} was not void, but value was undefined`);
}
}
case "function":
// FIXME: Is this too helpful?
return this.nativeToScVal(val(), ty);
default:
throw new TypeError(`failed to convert typeof ${typeof val} (${val})`);
}
}
nativeToUdt(val, name) {
let entry = this.findEntry(name);
switch (entry.switch()) {
case _2.xdr.ScSpecEntryKind.scSpecEntryUdtEnumV0():
if (typeof val !== "number") {
throw new TypeError(`expected number for enum ${name}, but got ${typeof val}`);
}
return this.nativeToEnum(val, entry.udtEnumV0());
case _2.xdr.ScSpecEntryKind.scSpecEntryUdtStructV0():
return this.nativeToStruct(val, entry.udtStructV0());
case _2.xdr.ScSpecEntryKind.scSpecEntryUdtUnionV0():
return this.nativeToUnion(val, entry.udtUnionV0());
default:
throw new Error(`failed to parse udt ${name}`);
}
}
nativeToUnion(val, union_) {
let entry_name = val.tag;
let case_ = union_.cases().find(entry => {
let case_ = entry.value().name().toString();
return case_ === entry_name;
});
if (!case_) {
throw new TypeError(`no such enum entry: ${entry_name} in ${union_}`);
}
let key = _2.xdr.ScVal.scvSymbol(entry_name);
switch (case_.switch()) {
case _2.xdr.ScSpecUdtUnionCaseV0Kind.scSpecUdtUnionCaseVoidV0():
{
return _2.xdr.ScVal.scvVec([key]);
}
case _2.xdr.ScSpecUdtUnionCaseV0Kind.scSpecUdtUnionCaseTupleV0():
{
let types = case_.tupleCase().type();
if (Array.isArray(val.values)) {
if (val.values.length != types.length) {
throw new TypeError(`union ${union_} expects ${types.length} values, but got ${val.values.length}`);
}
let scvals = val.values.map((v, i) => this.nativeToScVal(v, types[i]));
scvals.unshift(key);
return _2.xdr.ScVal.scvVec(scvals);
}
throw new Error(`failed to parse union case ${case_} with ${val}`);
}
default:
throw new Error(`failed to parse union ${union_} with ${val}`);
}
}
nativeToStruct(val, struct) {
let fields = struct.fields();
if (fields.some(isNumeric)) {
if (!fields.every(isNumeric)) {
throw new Error("mixed numeric and non-numeric field names are not allowed");
}
return _2.xdr.ScVal.scvVec(fields.map((_, i) => this.nativeToScVal(val[i], fields[i].type())));
}
return _2.xdr.ScVal.scvMap(fields.map(field => {
let name = field.name().toString();
return new _2.xdr.ScMapEntry({
key: this.nativeToScVal(name, _2.xdr.ScSpecTypeDef.scSpecTypeSymbol()),
val: this.nativeToScVal(val[name], field.type())
});
}));
}
nativeToEnum(val, enum_) {
if (enum_.cases().some(entry => entry.value() === val)) {
return _2.xdr.ScVal.scvU32(val);
}
throw new TypeError(`no such enum entry: ${val} in ${enum_}`);
}
/**
* Converts an base64 encoded ScVal back to a native JS value based on the given type.
*
* @param {string} scv the base64 encoded ScVal
* @param {xdr.ScSpecTypeDef} typeDef the expected type
* @returns {any} the converted native JS value
*
* @throws {Error} if ScVal cannot be converted to the given type
*/
scValStrToNative(scv, typeDef) {
return this.scValToNative(_2.xdr.ScVal.fromXDR(scv, "base64"), typeDef);
}
/**
* Converts an ScVal back to a native JS value based on the given type.
*
* @param {xdr.ScVal} scv the ScVal
* @param {xdr.ScSpecTypeDef} typeDef the expected type
* @returns {any} the converted native JS value
*
* @throws {Error} if ScVal cannot be converted to the given type
*/
scValToNative(scv, typeDef) {
let t = typeDef.switch();
let value = t.value;
if (value === _2.xdr.ScSpecType.scSpecTypeUdt().value) {
return this.scValUdtToNative(scv, typeDef.udt());
}
// we use the verbose xdr.ScValType.<type>.value form here because it's faster
// than string comparisons and the underlying constants never need to be
// updated
switch (scv.switch().value) {
case _2.xdr.ScValType.scvVoid().value:
return void 0;
// these can be converted to bigints directly
case _2.xdr.ScValType.scvU64().value:
case _2.xdr.ScValType.scvI64().value:
// these can be parsed by internal abstractions note that this can also
// handle the above two cases, but it's not as efficient (another
// type-check, parsing, etc.)
case _2.xdr.ScValType.scvU128().value:
case _2.xdr.ScValType.scvI128().value:
case _2.xdr.ScValType.scvU256().value:
case _2.xdr.ScValType.scvI256().value:
return (0, _2.scValToBigInt)(scv);
case _2.xdr.ScValType.scvVec().value:
{
if (value == _2.xdr.ScSpecType.scSpecTypeVec().value) {
let vec = typeDef.vec();
return (scv.vec() ?? []).map(elm => this.scValToNative(elm, vec.elementType()));
} else if (value == _2.xdr.ScSpecType.scSpecTypeTuple().value) {
let tuple = typeDef.tuple();
let valTypes = tuple.valueTypes();
return (scv.vec() ?? []).map((elm, i) => this.scValToNative(elm, valTypes[i]));
}
throw new TypeError(`Type ${typeDef} was not vec, but ${scv} is`);
}
case _2.xdr.ScValType.scvAddress().value:
return _2.Address.fromScVal(scv).toString();
case _2.xdr.ScValType.scvMap().value:
{
let map = scv.map() ?? [];
if (value == _2.xdr.ScSpecType.scSpecTypeMap().value) {
let type_ = typeDef.map();
let keyType = type_.keyType();
let valueType = type_.valueType();
let res = map.map(entry => [this.scValToNative(entry.key(), keyType), this.scValToNative(entry.val(), valueType)]);
return res;
}
throw new TypeError(`ScSpecType ${t.name} was not map, but ${JSON.stringify(scv, null, 2)} is`);
}
// these return the primitive type directly
case _2.xdr.ScValType.scvBool().value:
case _2.xdr.ScValType.scvU32().value:
case _2.xdr.ScValType.scvI32().value:
case _2.xdr.ScValType.scvBytes().value:
return scv.value();
case _2.xdr.ScValType.scvString().value:
case _2.xdr.ScValType.scvSymbol().value:
{
if (value !== _2.xdr.ScSpecType.scSpecTypeString().value && value !== _2.xdr.ScSpecType.scSpecTypeSymbol().value) {
throw new Error(`ScSpecType ${t.name} was not string or symbol, but ${JSON.stringify(scv, null, 2)} is`);
}
return scv.value()?.toString();
}
// these can be converted to bigint
case _2.xdr.ScValType.scvTimepoint().value:
case _2.xdr.ScValType.scvDuration().value:
return (0, _2.scValToBigInt)(_2.xdr.ScVal.scvU64(scv.u64()));
// in the fallthrough case, just return the underlying value directly
default:
throw new TypeError(`failed to convert ${JSON.stringify(scv, null, 2)} to native type from type ${t.name}`);
}
}
scValUdtToNative(scv, udt) {
let entry = this.findEntry(udt.name().toString());
switch (entry.switch()) {
case _2.xdr.ScSpecEntryKind.scSpecEntryUdtEnumV0():
return this.enumToNative(scv);
case _2.xdr.ScSpecEntryKind.scSpecEntryUdtStructV0():
return this.structToNative(scv, entry.udtStructV0());
case _2.xdr.ScSpecEntryKind.scSpecEntryUdtUnionV0():
return this.unionToNative(scv, entry.udtUnionV0());
default:
throw new Error(`failed to parse udt ${udt.name().toString()}: ${entry}`);
}
}
unionToNative(val, udt) {
let vec = val.vec();
if (!vec) {
throw new Error(`${JSON.stringify(val, null, 2)} is not a vec`);
}
if (vec.length === 0 && udt.cases.length !== 0) {
throw new Error(`${val} has length 0, but the there are at least one case in the union`);
}
let name = vec[0].sym().toString();
if (vec[0].switch().value != _2.xdr.ScValType.scvSymbol().value) {
throw new Error(`{vec[0]} is not a symbol`);
}
let entry = udt.cases().find(findCase(name));
if (!entry) {
throw new Error(`failed to find entry ${name} in union {udt.name().toString()}`);
}
let res = {
tag: name
};
if (entry.switch().value === _2.xdr.ScSpecUdtUnionCaseV0Kind.scSpecUdtUnionCaseTupleV0().value) {
let tuple = entry.tupleCase();
let ty = tuple.type();
let values = ty.map((entry, i) => this.scValToNative(vec[i + 1], entry));
res.values = values;
}
return res;
}
structToNative(val, udt) {
let res = {};
let fields = udt.fields();
if (fields.some(isNumeric)) {
let r = val.vec()?.map((entry, i) => this.scValToNative(entry, fields[i].type()));
return r;
}
val.map()?.forEach((entry, i) => {
let field = fields[i];
res[field.name().toString()] = this.scValToNative(entry.val(), field.type());
});
return res;
}
enumToNative(scv) {
if (scv.switch().value !== _2.xdr.ScValType.scvU32().value) {
throw new Error(`Enum must have a u32 value`);
}
let num = scv.u32();
return num;
}
/**
* Gets the XDR error cases from the spec.
*
* @returns {xdr.ScSpecFunctionV0[]} all contract functions
*
*/
errorCases() {
return this.entries.filter(entry => entry.switch().value === _2.xdr.ScSpecEntryKind.scSpecEntryUdtErrorEnumV0().value).flatMap(entry => entry.value().cases());
}
/**
* Converts the contract spec to a JSON schema.
*
* If `funcName` is provided, the schema will be a reference to the function schema.
*
* @param {string} [funcName] the name of the function to convert
* @returns {JSONSchema7} the converted JSON schema
*
* @throws {Error} if the contract spec is invalid
*/
jsonSchema(funcName) {
let definitions = {};
for (let entry of this.entries) {
switch (entry.switch().value) {
case _2.xdr.ScSpecEntryKind.scSpecEntryUdtEnumV0().value:
{
let udt = entry.udtEnumV0();
definitions[udt.name().toString()] = enumToJsonSchema(udt);
break;
}
case _2.xdr.ScSpecEntryKind.scSpecEntryUdtStructV0().value:
{
let udt = entry.udtStructV0();
definitions[udt.name().toString()] = structToJsonSchema(udt);
break;
}
case _2.xdr.ScSpecEntryKind.scSpecEntryUdtUnionV0().value:
let udt = entry.udtUnionV0();
definitions[udt.name().toString()] = unionToJsonSchema(udt);
break;
case _2.xdr.ScSpecEntryKind.scSpecEntryFunctionV0().value:
{
let fn = entry.functionV0();
let fnName = fn.name().toString();
let {
input
} = functionToJsonSchema(fn);
// @ts-ignore
definitions[fnName] = input;
break;
}
case _2.xdr.ScSpecEntryKind.scSpecEntryUdtErrorEnumV0().value:
{
// console.debug("Error enums not supported yet");
}
}
}
let res = {
$schema: "http://json-schema.org/draft-07/schema#",
definitions: {
...PRIMITIVE_DEFINITONS,
...definitions
}
};
if (funcName) {
res["$ref"] = `#/definitions/${funcName}`;
}
return res;
}
}
exports.ContractSpec = ContractSpec;
function stringToScVal(str, ty) {
switch (ty.value) {
case _2.xdr.ScSpecType.scSpecTypeString().value:
return _2.xdr.ScVal.scvString(str);
case _2.xdr.ScSpecType.scSpecTypeSymbol().value:
return _2.xdr.ScVal.scvSymbol(str);
case _2.xdr.ScSpecType.scSpecTypeAddress().value:
{
let addr = _2.Address.fromString(str);
return _2.xdr.ScVal.scvAddress(addr.toScAddress());
}
case _2.xdr.ScSpecType.scSpecTypeU64().value:
return new _2.XdrLargeInt("u64", str).toScVal();
case _2.xdr.ScSpecType.scSpecTypeI64().value:
return new _2.XdrLargeInt("i64", str).toScVal();
case _2.xdr.ScSpecType.scSpecTypeU128().value:
return new _2.XdrLargeInt("u128", str).toScVal();
case _2.xdr.ScSpecType.scSpecTypeI128().value:
return new _2.XdrLargeInt("i128", str).toScVal();
case _2.xdr.ScSpecType.scSpecTypeU256().value:
return new _2.XdrLargeInt("u256", str).toScVal();
case _2.xdr.ScSpecType.scSpecTypeI256().value:
return new _2.XdrLargeInt("i256", str).toScVal();
case _2.xdr.ScSpecType.scSpecTypeBytes().value:
case _2.xdr.ScSpecType.scSpecTypeBytesN().value:
return _2.xdr.ScVal.scvBytes(Buffer.from(str, "base64"));
default:
throw new TypeError(`invalid type ${ty.name} specified for string value`);
}
}
function isNumeric(field) {
return /^\d+$/.test(field.name().toString());
}
function findCase(name) {
return function matches(entry) {
switch (entry.switch().value) {
case _2.xdr.ScSpecUdtUnionCaseV0Kind.scSpecUdtUnionCaseTupleV0().value:
{
let tuple = entry.tupleCase();
return tuple.name().toString() === name;
}
case _2.xdr.ScSpecUdtUnionCaseV0Kind.scSpecUdtUnionCaseVoidV0().value:
{
let void_case = entry.voidCase();
return void_case.name().toString() === name;
}
default:
return false;
}
};
}
const PRIMITIVE_DEFINITONS = {
U32: {
type: "integer",
minimum: 0,
maximum: 4294967295
},
I32: {
type: "integer",
minimum: -2147483648,
maximum: 2147483647
},
U64: {
type: "string",
pattern: "^([1-9][0-9]*|0)$",
minLength: 1,
maxLength: 20 // 64-bit max value has 20 digits
},
I64: {
type: "string",
pattern: "^(-?[1-9][0-9]*|0)$",
minLength: 1,
maxLength: 21 // Includes additional digit for the potential '-'
},
U128: {
type: "string",
pattern: "^([1-9][0-9]*|0)$",
minLength: 1,
maxLength: 39 // 128-bit max value has 39 digits
},
I128: {
type: "string",
pattern: "^(-?[1-9][0-9]*|0)$",
minLength: 1,
maxLength: 40 // Includes additional digit for the potential '-'
},
U256: {
type: "string",
pattern: "^([1-9][0-9]*|0)$",
minLength: 1,
maxLength: 78 // 256-bit max value has 78 digits
},
I256: {
type: "string",
pattern: "^(-?[1-9][0-9]*|0)$",
minLength: 1,
maxLength: 79 // Includes additional digit for the potential '-'
},
Address: {
type: "string",
format: "address",
description: "Address can be a public key or contract id"
},
ScString: {
type: "string",
description: "ScString is a string"
},
ScSymbol: {
type: "string",
description: "ScString is a string"
},
DataUrl: {
type: "string",
pattern: "^(?:[A-Za-z0-9+\\/]{4})*(?:[A-Za-z0-9+\\/]{2}==|[A-Za-z0-9+\\/]{3}=)?$"
}
};
/**
* @param typeDef type to convert to json schema reference
* @returns {JSONSchema7} a schema describing the type
*/
function typeRef(typeDef) {
let t = typeDef.switch();
let value = t.value;
let ref;
switch (value) {
case _2.xdr.ScSpecType.scSpecTypeVal().value:
{
ref = "Val";
break;
}
case _2.xdr.ScSpecType.scSpecTypeBool().value:
{
return {
type: "boolean"
};
}
case _2.xdr.ScSpecType.scSpecTypeVoid().value:
{
return {
type: "null"
};
}
case _2.xdr.ScSpecType.scSpecTypeError().value:
{
ref = "Error";
break;
}
case _2.xdr.ScSpecType.scSpecTypeU32().value:
{
ref = "U32";
break;
}
case _2.xdr.ScSpecType.scSpecTypeI32().value:
{
ref = "I32";
break;
}
case _2.xdr.ScSpecType.scSpecTypeU64().value:
{
ref = "U64";
break;
}
case _2.xdr.ScSpecType.scSpecTypeI64().value:
{
ref = "I64";
break;
}
case _2.xdr.ScSpecType.scSpecTypeTimepoint().value:
{
throw new Error("Timepoint type not supported");
ref = "Timepoint";
break;
}
case _2.xdr.ScSpecType.scSpecTypeDuration().value:
{
throw new Error("Duration not supported");
ref = "Duration";
break;
}
case _2.xdr.ScSpecType.scSpecTypeU128().value:
{
ref = "U128";
break;
}
case _2.xdr.ScSpecType.scSpecTypeI128().value:
{
ref = "I128";
break;
}
case _2.xdr.ScSpecType.scSpecTypeU256().value:
{
ref = "U256";
break;
}
case _2.xdr.ScSpecType.scSpecTypeI256().value:
{
ref = "I256";
break;
}
case _2.xdr.ScSpecType.scSpecTypeBytes().value:
{
ref = "DataUrl";
break;
}
case _2.xdr.ScSpecType.scSpecTypeString().value:
{
ref = "ScString";
break;
}
case _2.xdr.ScSpecType.scSpecTypeSymbol().value:
{
ref = "ScSymbol";
break;
}
case _2.xdr.ScSpecType.scSpecTypeAddress().value:
{
ref = "Address";
break;
}
case _2.xdr.ScSpecType.scSpecTypeOption().value:
{
let opt = typeDef.option();
return typeRef(opt.valueType());
}
case _2.xdr.ScSpecType.scSpecTypeResult().value:
{
// throw new Error('Result type not supported');
break;
}
case _2.xdr.ScSpecType.scSpecTypeVec().value:
{
let arr = typeDef.vec();
let ref = typeRef(arr.elementType());
return {
type: "array",
items: ref
};
}
case _2.xdr.ScSpecType.scSpecTypeMap().value:
{
let map = typeDef.map();
let items = [typeRef(map.keyType()), typeRef(map.valueType())];
return {
type: "array",
items: {
type: "array",
items,
minItems: 2,
maxItems: 2
}
};
}
case _2.xdr.ScSpecType.scSpecTypeTuple().value:
{
let tuple = typeDef.tuple();
let minItems = tuple.valueTypes().length;
let maxItems = minItems;
let items = tuple.valueTypes().map(typeRef);
return {
type: "array",
items,
minItems,
maxItems
};
}
case _2.xdr.ScSpecType.scSpecTypeBytesN().value:
{
let arr = typeDef.bytesN();
return {
$ref: "#/definitions/DataUrl",
maxLength: arr.n()
};
}
case _2.xdr.ScSpecType.scSpecTypeUdt().value:
{
let udt = typeDef.udt();
ref = udt.name().toString();
break;
}
}
return {
$ref: `#/definitions/${ref}`
};
}
function isRequired(typeDef) {
return typeDef.switch().value != _2.xdr.ScSpecType.scSpecTypeOption().value;
}
function structToJsonSchema(udt) {
let fields = udt.fields();
if (fields.some(isNumeric)) {
if (!fields.every(isNumeric)) {
throw new Error("mixed numeric and non-numeric field names are not allowed");
}
let items = fields.map((_, i) => typeRef(fields[i].type()));
return {
type: "array",
items,
minItems: fields.length,
maxItems: fields.length
};
}
let description = udt.doc().toString();
let {
properties,
required
} = args_and_required(fields);
properties["additionalProperties"] = false;
return {
description,
properties,
required,
type: "object"
};
}
function args_and_required(input) {
let properties = {};
let required = [];
for (let arg of input) {
let type_ = arg.type();
let name = arg.name().toString();
properties[name] = typeRef(type_);
if (isRequired(type_)) {
required.push(name);
}
}
let res = {
properties
};
if (required.length > 0) {
res.required = required;
}
return res;
}
function functionToJsonSchema(func) {
let {
properties,
required
} = args_and_required(func.inputs());
let args = {
additionalProperties: false,
properties,
type: "object"
};
if (required?.length > 0) {
args.required = required;
}
let input = {
properties: {
args
}
};
let outputs = func.outputs();
let output = outputs.length > 0 ? typeRef(outputs[0]) : typeRef(_2.xdr.ScSpecTypeDef.scSpecTypeVoid());
let description = func.doc().toString();
if (description.length > 0) {
input.description = description;
}
input.additionalProperties = false;
output.additionalProperties = false;
return {
input,
output
};
}
function unionToJsonSchema(udt) {
let description = udt.doc().toString();
let cases = udt.cases();
let oneOf = [];
for (let case_ of cases) {
switch (case_.switch().value) {
case _2.xdr.ScSpecUdtUnionCaseV0Kind.scSpecUdtUnionCaseVoidV0().value:
{
let c = case_.voidCase();
let title = c.name().toString();
oneOf.push({
type: "object",
title,
properties: {
tag: title
},
additionalProperties: false,
required: ["tag"]
});
break;
}
case _2.xdr.ScSpecUdtUnionCaseV0Kind.scSpecUdtUnionCaseTupleV0().value:
{
let c = case_.tupleCase();
let title = c.name().toString();
oneOf.push({
type: "object",
title,
properties: {
tag: title,
values: {
type: "array",
items: c.type().map(typeRef)
}
},
required: ["tag", "values"],
additionalProperties: false
});
}
}
}
let res = {
oneOf
};
if (description.length > 0) {
res.description = description;
}
return res;
}
function enumToJsonSchema(udt) {
let description = udt.doc().toString();
let cases = udt.cases();
let oneOf = [];
for (let case_ of cases) {
let title = case_.name().toString();
let description = case_.doc().toString();
oneOf.push({
description,
title,
enum: [case_.value()],
type: "number"
});
}
let res = {
oneOf
};
if (description.length > 0) {
res.description = description;
}
return res;
}