@simbachain/libsimba-js
Version:
libsimba-js is a library simplifying the use of SIMBAChain APIs. We aim to abstract away the various blockchain concepts, reducing the necessary time needed to get to working code.
1,484 lines • 207 kB
JSON
[
{
"__docId__": 1,
"kind": "external",
"name": "Infinity",
"externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Infinity",
"memberof": "src/.external-ecmascript.js",
"static": true,
"longname": "src/.external-ecmascript.js~Infinity",
"access": "public",
"description": "",
"builtinExternal": true
},
{
"__docId__": 2,
"kind": "external",
"name": "NaN",
"externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/NaN",
"memberof": "src/.external-ecmascript.js",
"static": true,
"longname": "src/.external-ecmascript.js~NaN",
"access": "public",
"description": "",
"builtinExternal": true
},
{
"__docId__": 3,
"kind": "external",
"name": "undefined",
"externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined",
"memberof": "src/.external-ecmascript.js",
"static": true,
"longname": "src/.external-ecmascript.js~undefined",
"access": "public",
"description": "",
"builtinExternal": true
},
{
"__docId__": 4,
"kind": "external",
"name": "null",
"externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/null",
"memberof": "src/.external-ecmascript.js",
"static": true,
"longname": "src/.external-ecmascript.js~null",
"access": "public",
"description": "",
"builtinExternal": true
},
{
"__docId__": 5,
"kind": "external",
"name": "Object",
"externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object",
"memberof": "src/.external-ecmascript.js",
"static": true,
"longname": "src/.external-ecmascript.js~Object",
"access": "public",
"description": "",
"builtinExternal": true
},
{
"__docId__": 6,
"kind": "external",
"name": "object",
"externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object",
"memberof": "src/.external-ecmascript.js",
"static": true,
"longname": "src/.external-ecmascript.js~object",
"access": "public",
"description": "",
"builtinExternal": true
},
{
"__docId__": 7,
"kind": "external",
"name": "Function",
"externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function",
"memberof": "src/.external-ecmascript.js",
"static": true,
"longname": "src/.external-ecmascript.js~Function",
"access": "public",
"description": "",
"builtinExternal": true
},
{
"__docId__": 8,
"kind": "external",
"name": "function",
"externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function",
"memberof": "src/.external-ecmascript.js",
"static": true,
"longname": "src/.external-ecmascript.js~function",
"access": "public",
"description": "",
"builtinExternal": true
},
{
"__docId__": 9,
"kind": "external",
"name": "Boolean",
"externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean",
"memberof": "src/.external-ecmascript.js",
"static": true,
"longname": "src/.external-ecmascript.js~Boolean",
"access": "public",
"description": "",
"builtinExternal": true
},
{
"__docId__": 10,
"kind": "external",
"name": "boolean",
"externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean",
"memberof": "src/.external-ecmascript.js",
"static": true,
"longname": "src/.external-ecmascript.js~boolean",
"access": "public",
"description": "",
"builtinExternal": true
},
{
"__docId__": 11,
"kind": "external",
"name": "Symbol",
"externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol",
"memberof": "src/.external-ecmascript.js",
"static": true,
"longname": "src/.external-ecmascript.js~Symbol",
"access": "public",
"description": "",
"builtinExternal": true
},
{
"__docId__": 12,
"kind": "external",
"name": "Error",
"externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error",
"memberof": "src/.external-ecmascript.js",
"static": true,
"longname": "src/.external-ecmascript.js~Error",
"access": "public",
"description": "",
"builtinExternal": true
},
{
"__docId__": 13,
"kind": "external",
"name": "EvalError",
"externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/EvalError",
"memberof": "src/.external-ecmascript.js",
"static": true,
"longname": "src/.external-ecmascript.js~EvalError",
"access": "public",
"description": "",
"builtinExternal": true
},
{
"__docId__": 14,
"kind": "external",
"name": "InternalError",
"externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/InternalError",
"memberof": "src/.external-ecmascript.js",
"static": true,
"longname": "src/.external-ecmascript.js~InternalError",
"access": "public",
"description": "",
"builtinExternal": true
},
{
"__docId__": 15,
"kind": "external",
"name": "RangeError",
"externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RangeError",
"memberof": "src/.external-ecmascript.js",
"static": true,
"longname": "src/.external-ecmascript.js~RangeError",
"access": "public",
"description": "",
"builtinExternal": true
},
{
"__docId__": 16,
"kind": "external",
"name": "ReferenceError",
"externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ReferenceError",
"memberof": "src/.external-ecmascript.js",
"static": true,
"longname": "src/.external-ecmascript.js~ReferenceError",
"access": "public",
"description": "",
"builtinExternal": true
},
{
"__docId__": 17,
"kind": "external",
"name": "SyntaxError",
"externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SyntaxError",
"memberof": "src/.external-ecmascript.js",
"static": true,
"longname": "src/.external-ecmascript.js~SyntaxError",
"access": "public",
"description": "",
"builtinExternal": true
},
{
"__docId__": 18,
"kind": "external",
"name": "TypeError",
"externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypeError",
"memberof": "src/.external-ecmascript.js",
"static": true,
"longname": "src/.external-ecmascript.js~TypeError",
"access": "public",
"description": "",
"builtinExternal": true
},
{
"__docId__": 19,
"kind": "external",
"name": "URIError",
"externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/URIError",
"memberof": "src/.external-ecmascript.js",
"static": true,
"longname": "src/.external-ecmascript.js~URIError",
"access": "public",
"description": "",
"builtinExternal": true
},
{
"__docId__": 20,
"kind": "external",
"name": "Number",
"externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number",
"memberof": "src/.external-ecmascript.js",
"static": true,
"longname": "src/.external-ecmascript.js~Number",
"access": "public",
"description": "",
"builtinExternal": true
},
{
"__docId__": 21,
"kind": "external",
"name": "number",
"externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number",
"memberof": "src/.external-ecmascript.js",
"static": true,
"longname": "src/.external-ecmascript.js~number",
"access": "public",
"description": "",
"builtinExternal": true
},
{
"__docId__": 22,
"kind": "external",
"name": "Date",
"externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date",
"memberof": "src/.external-ecmascript.js",
"static": true,
"longname": "src/.external-ecmascript.js~Date",
"access": "public",
"description": "",
"builtinExternal": true
},
{
"__docId__": 23,
"kind": "external",
"name": "String",
"externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String",
"memberof": "src/.external-ecmascript.js",
"static": true,
"longname": "src/.external-ecmascript.js~String",
"access": "public",
"description": "",
"builtinExternal": true
},
{
"__docId__": 24,
"kind": "external",
"name": "string",
"externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String",
"memberof": "src/.external-ecmascript.js",
"static": true,
"longname": "src/.external-ecmascript.js~string",
"access": "public",
"description": "",
"builtinExternal": true
},
{
"__docId__": 25,
"kind": "external",
"name": "RegExp",
"externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp",
"memberof": "src/.external-ecmascript.js",
"static": true,
"longname": "src/.external-ecmascript.js~RegExp",
"access": "public",
"description": "",
"builtinExternal": true
},
{
"__docId__": 26,
"kind": "external",
"name": "Array",
"externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array",
"memberof": "src/.external-ecmascript.js",
"static": true,
"longname": "src/.external-ecmascript.js~Array",
"access": "public",
"description": "",
"builtinExternal": true
},
{
"__docId__": 27,
"kind": "external",
"name": "Int8Array",
"externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Int8Array",
"memberof": "src/.external-ecmascript.js",
"static": true,
"longname": "src/.external-ecmascript.js~Int8Array",
"access": "public",
"description": "",
"builtinExternal": true
},
{
"__docId__": 28,
"kind": "external",
"name": "Uint8Array",
"externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array",
"memberof": "src/.external-ecmascript.js",
"static": true,
"longname": "src/.external-ecmascript.js~Uint8Array",
"access": "public",
"description": "",
"builtinExternal": true
},
{
"__docId__": 29,
"kind": "external",
"name": "Uint8ClampedArray",
"externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8ClampedArray",
"memberof": "src/.external-ecmascript.js",
"static": true,
"longname": "src/.external-ecmascript.js~Uint8ClampedArray",
"access": "public",
"description": "",
"builtinExternal": true
},
{
"__docId__": 30,
"kind": "external",
"name": "Int16Array",
"externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Int16Array",
"memberof": "src/.external-ecmascript.js",
"static": true,
"longname": "src/.external-ecmascript.js~Int16Array",
"access": "public",
"description": "",
"builtinExternal": true
},
{
"__docId__": 31,
"kind": "external",
"name": "Uint16Array",
"externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint16Array",
"memberof": "src/.external-ecmascript.js",
"static": true,
"longname": "src/.external-ecmascript.js~Uint16Array",
"access": "public",
"description": "",
"builtinExternal": true
},
{
"__docId__": 32,
"kind": "external",
"name": "Int32Array",
"externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Int32Array",
"memberof": "src/.external-ecmascript.js",
"static": true,
"longname": "src/.external-ecmascript.js~Int32Array",
"access": "public",
"description": "",
"builtinExternal": true
},
{
"__docId__": 33,
"kind": "external",
"name": "Uint32Array",
"externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint32Array",
"memberof": "src/.external-ecmascript.js",
"static": true,
"longname": "src/.external-ecmascript.js~Uint32Array",
"access": "public",
"description": "",
"builtinExternal": true
},
{
"__docId__": 34,
"kind": "external",
"name": "Float32Array",
"externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Float32Array",
"memberof": "src/.external-ecmascript.js",
"static": true,
"longname": "src/.external-ecmascript.js~Float32Array",
"access": "public",
"description": "",
"builtinExternal": true
},
{
"__docId__": 35,
"kind": "external",
"name": "Float64Array",
"externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Float64Array",
"memberof": "src/.external-ecmascript.js",
"static": true,
"longname": "src/.external-ecmascript.js~Float64Array",
"access": "public",
"description": "",
"builtinExternal": true
},
{
"__docId__": 36,
"kind": "external",
"name": "Map",
"externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map",
"memberof": "src/.external-ecmascript.js",
"static": true,
"longname": "src/.external-ecmascript.js~Map",
"access": "public",
"description": "",
"builtinExternal": true
},
{
"__docId__": 37,
"kind": "external",
"name": "Set",
"externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set",
"memberof": "src/.external-ecmascript.js",
"static": true,
"longname": "src/.external-ecmascript.js~Set",
"access": "public",
"description": "",
"builtinExternal": true
},
{
"__docId__": 38,
"kind": "external",
"name": "WeakMap",
"externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WeakMap",
"memberof": "src/.external-ecmascript.js",
"static": true,
"longname": "src/.external-ecmascript.js~WeakMap",
"access": "public",
"description": "",
"builtinExternal": true
},
{
"__docId__": 39,
"kind": "external",
"name": "WeakSet",
"externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WeakSet",
"memberof": "src/.external-ecmascript.js",
"static": true,
"longname": "src/.external-ecmascript.js~WeakSet",
"access": "public",
"description": "",
"builtinExternal": true
},
{
"__docId__": 40,
"kind": "external",
"name": "ArrayBuffer",
"externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer",
"memberof": "src/.external-ecmascript.js",
"static": true,
"longname": "src/.external-ecmascript.js~ArrayBuffer",
"access": "public",
"description": "",
"builtinExternal": true
},
{
"__docId__": 41,
"kind": "external",
"name": "DataView",
"externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView",
"memberof": "src/.external-ecmascript.js",
"static": true,
"longname": "src/.external-ecmascript.js~DataView",
"access": "public",
"description": "",
"builtinExternal": true
},
{
"__docId__": 42,
"kind": "external",
"name": "JSON",
"externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON",
"memberof": "src/.external-ecmascript.js",
"static": true,
"longname": "src/.external-ecmascript.js~JSON",
"access": "public",
"description": "",
"builtinExternal": true
},
{
"__docId__": 43,
"kind": "external",
"name": "Promise",
"externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise",
"memberof": "src/.external-ecmascript.js",
"static": true,
"longname": "src/.external-ecmascript.js~Promise",
"access": "public",
"description": "",
"builtinExternal": true
},
{
"__docId__": 44,
"kind": "external",
"name": "Generator",
"externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Generator",
"memberof": "src/.external-ecmascript.js",
"static": true,
"longname": "src/.external-ecmascript.js~Generator",
"access": "public",
"description": "",
"builtinExternal": true
},
{
"__docId__": 45,
"kind": "external",
"name": "GeneratorFunction",
"externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/GeneratorFunction",
"memberof": "src/.external-ecmascript.js",
"static": true,
"longname": "src/.external-ecmascript.js~GeneratorFunction",
"access": "public",
"description": "",
"builtinExternal": true
},
{
"__docId__": 46,
"kind": "external",
"name": "Reflect",
"externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Reflect",
"memberof": "src/.external-ecmascript.js",
"static": true,
"longname": "src/.external-ecmascript.js~Reflect",
"access": "public",
"description": "",
"builtinExternal": true
},
{
"__docId__": 47,
"kind": "external",
"name": "Proxy",
"externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Proxy",
"memberof": "src/.external-ecmascript.js",
"static": true,
"longname": "src/.external-ecmascript.js~Proxy",
"access": "public",
"description": "",
"builtinExternal": true
},
{
"__docId__": 48,
"kind": "file",
"name": "src/exceptions.js",
"content": "/**\n * Base exception that all libsimba Exceptions extend\n */\nexport class BaseException extends Error{\n /**\n * Base exception that all libsimba Exceptions extend\n * @param {string} message - the error message\n * @param {Error|string} [cause] - (Optional) wrap an existing error\n */\n constructor(message, cause){\n super();\n this.name = 'BaseException';\n this.message = message;\n this.cause = cause;\n\n // Maintains proper stack trace for where our error was thrown (only available on V8)\n if (Error.captureStackTrace) {\n Error.captureStackTrace(this, this.constructor);\n }\n }\n}\n\n/**\n * Thrown when a method that should be implemented is not\n */\nexport class NotImplementedException extends BaseException{\n constructor(...args){\n super(...args);\n this.name = 'NotImplementedException';\n }\n}\n\n/**\n * Thrown when a method on a class inheriting [SimbaBase]{@link SimbaBase} is called before\n * metadata is retrieved.\n */\nexport class MissingMetadataException extends BaseException{\n constructor(...args){\n super(...args);\n this.name = 'MissingMetadataException';\n }\n}\n\n/**\n * Thrown when metadata doesn't have something it should have\n */\nexport class BadMetadataException extends BaseException{\n constructor(...args){\n super(...args);\n this.name = 'BadMetadataException';\n }\n}\n\n/**\n * Thrown when a method call isn't valid\n */\nexport class MethodCallValidationMetadataException extends BaseException{\n constructor(...args){\n super(...args);\n this.name = 'MethodCallValidationMetadataException';\n }\n}\n\n/**\n * Thrown when the server fails to generate the transaction for signing\n */\nexport class GenerateTransactionException extends BaseException{\n constructor(...args){\n super(...args);\n this.name = 'GenerateTransactionException';\n }\n}\n\n/**\n * Thrown when the server returns an error after submitting a signed transaction\n */\nexport class SubmitTransactionException extends BaseException{\n constructor(...args){\n super(...args);\n this.name = 'SubmitTransactionException';\n }\n}\n\n/**\n * Thrown when the server returns an error when querying transactions\n */\nexport class GetRequestException extends BaseException{\n constructor(...args){\n super(...args);\n this.name = 'GetRequestException';\n }\n}\n\n/**\n * Thrown when the server returns an error when querying transactions\n */\nexport class GetTransactionsException extends GetRequestException{\n constructor(...args){\n super(...args);\n this.name = 'GetTransactionsException';\n }\n}\n\n/**\n * Thrown when an error occurs checking a transactions status\n */\nexport class TransactionStatusCheckException extends BaseException{\n constructor(...args){\n super(...args);\n this.name = 'TransactionStatusCheckException';\n }\n}\n\n/**\n * Thrown when there's an error signing a transaction\n */\nexport class SigningException extends BaseException{\n constructor(...args){\n super(...args);\n this.name = 'SigningException';\n }\n}\n\n/**\n * Thrown when a LocalWallet is created in a non browser environment\n */\nexport class NotInBrowserException extends BaseException{\n constructor(...args){\n super(...args);\n this.name = 'NotInBrowserException';\n }\n}\n\n/**\n * Thrown when the user rejects the request to sign\n */\nexport class UserRejectedSigningException extends SigningException{\n constructor(...args){\n super(...args);\n this.name = 'UserRejectedSigningException';\n }\n}\n\n/**\n * Thrown when a method on a class inheriting [SimbaBase]{@link SimbaBase} is called that requires\n * a [Wallet]{@link Wallet} to be set, and it isn't.\n */\nexport class WalletNotFoundException extends SigningException{\n constructor(...args){\n super(...args);\n this.name = 'WalletNotFoundException';\n }\n}\n\n/**\n * Thrown when a method on a class inheriting [SimbaBase]{@link SimbaBase} is called that requires\n * a [Wallet]{@link Wallet} to be unlocked, and it isn't.\n */\nexport class WalletLockedException extends SigningException{\n constructor(...args){\n super(...args);\n this.name = 'WalletLockedException';\n }\n}\n\n/**\n * Thrown when a method call exceeds the max retries\n */\nexport class RetriesExceededException extends SigningException{\n constructor(...args){\n super(...args);\n this.name = 'RetriesExceededException';\n }\n}\n\n",
"static": true,
"longname": "C:/Users/Kieran David Evans/Code/libsimba-js/src/exceptions.js",
"access": "public",
"description": null,
"lineNumber": 1
},
{
"__docId__": 49,
"kind": "class",
"name": "BaseException",
"memberof": "src/exceptions.js",
"static": true,
"longname": "src/exceptions.js~BaseException",
"access": "public",
"export": true,
"importPath": "@simbachain/libsimba-js/src/exceptions.js",
"importStyle": "{BaseException}",
"description": "Base exception that all libsimba Exceptions extend",
"lineNumber": 4,
"interface": false,
"extends": [
"Error"
]
},
{
"__docId__": 50,
"kind": "constructor",
"name": "constructor",
"memberof": "src/exceptions.js~BaseException",
"generator": false,
"async": false,
"static": false,
"longname": "src/exceptions.js~BaseException#constructor",
"access": "public",
"description": "Base exception that all libsimba Exceptions extend",
"lineNumber": 10,
"params": [
{
"nullable": null,
"types": [
"string"
],
"spread": false,
"optional": false,
"name": "message",
"description": "the error message"
},
{
"nullable": null,
"types": [
"Error",
"string"
],
"spread": false,
"optional": true,
"name": "cause",
"description": "(Optional) wrap an existing error"
}
]
},
{
"__docId__": 51,
"kind": "member",
"name": "name",
"memberof": "src/exceptions.js~BaseException",
"static": false,
"longname": "src/exceptions.js~BaseException#name",
"access": "public",
"description": null,
"lineNumber": 12,
"undocument": true,
"type": {
"types": [
"string"
]
}
},
{
"__docId__": 52,
"kind": "member",
"name": "message",
"memberof": "src/exceptions.js~BaseException",
"static": false,
"longname": "src/exceptions.js~BaseException#message",
"access": "public",
"description": null,
"lineNumber": 13,
"undocument": true,
"type": {
"types": [
"*"
]
}
},
{
"__docId__": 53,
"kind": "member",
"name": "cause",
"memberof": "src/exceptions.js~BaseException",
"static": false,
"longname": "src/exceptions.js~BaseException#cause",
"access": "public",
"description": null,
"lineNumber": 14,
"undocument": true,
"type": {
"types": [
"*"
]
}
},
{
"__docId__": 54,
"kind": "class",
"name": "NotImplementedException",
"memberof": "src/exceptions.js",
"static": true,
"longname": "src/exceptions.js~NotImplementedException",
"access": "public",
"export": true,
"importPath": "@simbachain/libsimba-js/src/exceptions.js",
"importStyle": "{NotImplementedException}",
"description": "Thrown when a method that should be implemented is not",
"lineNumber": 26,
"interface": false,
"extends": [
"BaseException"
]
},
{
"__docId__": 55,
"kind": "constructor",
"name": "constructor",
"memberof": "src/exceptions.js~NotImplementedException",
"generator": false,
"async": false,
"static": false,
"longname": "src/exceptions.js~NotImplementedException#constructor",
"access": "public",
"description": null,
"lineNumber": 27,
"undocument": true
},
{
"__docId__": 56,
"kind": "member",
"name": "name",
"memberof": "src/exceptions.js~NotImplementedException",
"static": false,
"longname": "src/exceptions.js~NotImplementedException#name",
"access": "public",
"description": null,
"lineNumber": 29,
"undocument": true,
"type": {
"types": [
"string"
]
}
},
{
"__docId__": 57,
"kind": "class",
"name": "MissingMetadataException",
"memberof": "src/exceptions.js",
"static": true,
"longname": "src/exceptions.js~MissingMetadataException",
"access": "public",
"export": true,
"importPath": "@simbachain/libsimba-js/src/exceptions.js",
"importStyle": "{MissingMetadataException}",
"description": "Thrown when a method on a class inheriting [SimbaBase]{@link SimbaBase} is called before\nmetadata is retrieved.",
"lineNumber": 37,
"interface": false,
"extends": [
"BaseException"
]
},
{
"__docId__": 58,
"kind": "constructor",
"name": "constructor",
"memberof": "src/exceptions.js~MissingMetadataException",
"generator": false,
"async": false,
"static": false,
"longname": "src/exceptions.js~MissingMetadataException#constructor",
"access": "public",
"description": null,
"lineNumber": 38,
"undocument": true
},
{
"__docId__": 59,
"kind": "member",
"name": "name",
"memberof": "src/exceptions.js~MissingMetadataException",
"static": false,
"longname": "src/exceptions.js~MissingMetadataException#name",
"access": "public",
"description": null,
"lineNumber": 40,
"undocument": true,
"type": {
"types": [
"string"
]
}
},
{
"__docId__": 60,
"kind": "class",
"name": "BadMetadataException",
"memberof": "src/exceptions.js",
"static": true,
"longname": "src/exceptions.js~BadMetadataException",
"access": "public",
"export": true,
"importPath": "@simbachain/libsimba-js/src/exceptions.js",
"importStyle": "{BadMetadataException}",
"description": "Thrown when metadata doesn't have something it should have",
"lineNumber": 47,
"interface": false,
"extends": [
"BaseException"
]
},
{
"__docId__": 61,
"kind": "constructor",
"name": "constructor",
"memberof": "src/exceptions.js~BadMetadataException",
"generator": false,
"async": false,
"static": false,
"longname": "src/exceptions.js~BadMetadataException#constructor",
"access": "public",
"description": null,
"lineNumber": 48,
"undocument": true
},
{
"__docId__": 62,
"kind": "member",
"name": "name",
"memberof": "src/exceptions.js~BadMetadataException",
"static": false,
"longname": "src/exceptions.js~BadMetadataException#name",
"access": "public",
"description": null,
"lineNumber": 50,
"undocument": true,
"type": {
"types": [
"string"
]
}
},
{
"__docId__": 63,
"kind": "class",
"name": "MethodCallValidationMetadataException",
"memberof": "src/exceptions.js",
"static": true,
"longname": "src/exceptions.js~MethodCallValidationMetadataException",
"access": "public",
"export": true,
"importPath": "@simbachain/libsimba-js/src/exceptions.js",
"importStyle": "{MethodCallValidationMetadataException}",
"description": "Thrown when a method call isn't valid",
"lineNumber": 57,
"interface": false,
"extends": [
"BaseException"
]
},
{
"__docId__": 64,
"kind": "constructor",
"name": "constructor",
"memberof": "src/exceptions.js~MethodCallValidationMetadataException",
"generator": false,
"async": false,
"static": false,
"longname": "src/exceptions.js~MethodCallValidationMetadataException#constructor",
"access": "public",
"description": null,
"lineNumber": 58,
"undocument": true
},
{
"__docId__": 65,
"kind": "member",
"name": "name",
"memberof": "src/exceptions.js~MethodCallValidationMetadataException",
"static": false,
"longname": "src/exceptions.js~MethodCallValidationMetadataException#name",
"access": "public",
"description": null,
"lineNumber": 60,
"undocument": true,
"type": {
"types": [
"string"
]
}
},
{
"__docId__": 66,
"kind": "class",
"name": "GenerateTransactionException",
"memberof": "src/exceptions.js",
"static": true,
"longname": "src/exceptions.js~GenerateTransactionException",
"access": "public",
"export": true,
"importPath": "@simbachain/libsimba-js/src/exceptions.js",
"importStyle": "{GenerateTransactionException}",
"description": "Thrown when the server fails to generate the transaction for signing",
"lineNumber": 67,
"interface": false,
"extends": [
"BaseException"
]
},
{
"__docId__": 67,
"kind": "constructor",
"name": "constructor",
"memberof": "src/exceptions.js~GenerateTransactionException",
"generator": false,
"async": false,
"static": false,
"longname": "src/exceptions.js~GenerateTransactionException#constructor",
"access": "public",
"description": null,
"lineNumber": 68,
"undocument": true
},
{
"__docId__": 68,
"kind": "member",
"name": "name",
"memberof": "src/exceptions.js~GenerateTransactionException",
"static": false,
"longname": "src/exceptions.js~GenerateTransactionException#name",
"access": "public",
"description": null,
"lineNumber": 70,
"undocument": true,
"type": {
"types": [
"string"
]
}
},
{
"__docId__": 69,
"kind": "class",
"name": "SubmitTransactionException",
"memberof": "src/exceptions.js",
"static": true,
"longname": "src/exceptions.js~SubmitTransactionException",
"access": "public",
"export": true,
"importPath": "@simbachain/libsimba-js/src/exceptions.js",
"importStyle": "{SubmitTransactionException}",
"description": "Thrown when the server returns an error after submitting a signed transaction",
"lineNumber": 77,
"interface": false,
"extends": [
"BaseException"
]
},
{
"__docId__": 70,
"kind": "constructor",
"name": "constructor",
"memberof": "src/exceptions.js~SubmitTransactionException",
"generator": false,
"async": false,
"static": false,
"longname": "src/exceptions.js~SubmitTransactionException#constructor",
"access": "public",
"description": null,
"lineNumber": 78,
"undocument": true
},
{
"__docId__": 71,
"kind": "member",
"name": "name",
"memberof": "src/exceptions.js~SubmitTransactionException",
"static": false,
"longname": "src/exceptions.js~SubmitTransactionException#name",
"access": "public",
"description": null,
"lineNumber": 80,
"undocument": true,
"type": {
"types": [
"string"
]
}
},
{
"__docId__": 72,
"kind": "class",
"name": "GetRequestException",
"memberof": "src/exceptions.js",
"static": true,
"longname": "src/exceptions.js~GetRequestException",
"access": "public",
"export": true,
"importPath": "@simbachain/libsimba-js/src/exceptions.js",
"importStyle": "{GetRequestException}",
"description": "Thrown when the server returns an error when querying transactions",
"lineNumber": 87,
"interface": false,
"extends": [
"BaseException"
]
},
{
"__docId__": 73,
"kind": "constructor",
"name": "constructor",
"memberof": "src/exceptions.js~GetRequestException",
"generator": false,
"async": false,
"static": false,
"longname": "src/exceptions.js~GetRequestException#constructor",
"access": "public",
"description": null,
"lineNumber": 88,
"undocument": true
},
{
"__docId__": 74,
"kind": "member",
"name": "name",
"memberof": "src/exceptions.js~GetRequestException",
"static": false,
"longname": "src/exceptions.js~GetRequestException#name",
"access": "public",
"description": null,
"lineNumber": 90,
"undocument": true,
"type": {
"types": [
"string"
]
}
},
{
"__docId__": 75,
"kind": "class",
"name": "GetTransactionsException",
"memberof": "src/exceptions.js",
"static": true,
"longname": "src/exceptions.js~GetTransactionsException",
"access": "public",
"export": true,
"importPath": "@simbachain/libsimba-js/src/exceptions.js",
"importStyle": "{GetTransactionsException}",
"description": "Thrown when the server returns an error when querying transactions",
"lineNumber": 97,
"interface": false,
"extends": [
"GetRequestException"
]
},
{
"__docId__": 76,
"kind": "constructor",
"name": "constructor",
"memberof": "src/exceptions.js~GetTransactionsException",
"generator": false,
"async": false,
"static": false,
"longname": "src/exceptions.js~GetTransactionsException#constructor",
"access": "public",
"description": null,
"lineNumber": 98,
"undocument": true
},
{
"__docId__": 77,
"kind": "member",
"name": "name",
"memberof": "src/exceptions.js~GetTransactionsException",
"static": false,
"longname": "src/exceptions.js~GetTransactionsException#name",
"access": "public",
"description": null,
"lineNumber": 100,
"undocument": true,
"type": {
"types": [
"string"
]
}
},
{
"__docId__": 78,
"kind": "class",
"name": "TransactionStatusCheckException",
"memberof": "src/exceptions.js",
"static": true,
"longname": "src/exceptions.js~TransactionStatusCheckException",
"access": "public",
"export": true,
"importPath": "@simbachain/libsimba-js/src/exceptions.js",
"importStyle": "{TransactionStatusCheckException}",
"description": "Thrown when an error occurs checking a transactions status",
"lineNumber": 107,
"interface": false,
"extends": [
"BaseException"
]
},
{
"__docId__": 79,
"kind": "constructor",
"name": "constructor",
"memberof": "src/exceptions.js~TransactionStatusCheckException",
"generator": false,
"async": false,
"static": false,
"longname": "src/exceptions.js~TransactionStatusCheckException#constructor",
"access": "public",
"description": null,
"lineNumber": 108,
"undocument": true
},
{
"__docId__": 80,
"kind": "member",
"name": "name",
"memberof": "src/exceptions.js~TransactionStatusCheckException",
"static": false,
"longname": "src/exceptions.js~TransactionStatusCheckException#name",
"access": "public",
"description": null,
"lineNumber": 110,
"undocument": true,
"type": {
"types": [
"string"
]
}
},
{
"__docId__": 81,
"kind": "class",
"name": "SigningException",
"memberof": "src/exceptions.js",
"static": true,
"longname": "src/exceptions.js~SigningException",
"access": "public",
"export": true,
"importPath": "@simbachain/libsimba-js/src/exceptions.js",
"importStyle": "{SigningException}",
"description": "Thrown when there's an error signing a transaction",
"lineNumber": 117,
"interface": false,
"extends": [
"BaseException"
]
},
{
"__docId__": 82,
"kind": "constructor",
"name": "constructor",
"memberof": "src/exceptions.js~SigningException",
"generator": false,
"async": false,
"static": false,
"longname": "src/exceptions.js~SigningException#constructor",
"access": "public",
"description": null,
"lineNumber": 118,
"undocument": true
},
{
"__docId__": 83,
"kind": "member",
"name": "name",
"memberof": "src/exceptions.js~SigningException",
"static": false,
"longname": "src/exceptions.js~SigningException#name",
"access": "public",
"description": null,
"lineNumber": 120,
"undocument": true,
"type": {
"types": [
"string"
]
}
},
{
"__docId__": 84,
"kind": "class",
"name": "NotInBrowserException",
"memberof": "src/exceptions.js",
"static": true,
"longname": "src/exceptions.js~NotInBrowserException",
"access": "public",
"export": true,
"importPath": "@simbachain/libsimba-js/src/exceptions.js",
"importStyle": "{NotInBrowserException}",
"description": "Thrown when a LocalWallet is created in a non browser environment",
"lineNumber": 127,
"interface": false,
"extends": [
"BaseException"
]
},
{
"__docId__": 85,
"kind": "constructor",
"name": "constructor",
"memberof": "src/exceptions.js~NotInBrowserException",
"generator": false,
"async": false,
"static": false,
"longname": "src/exceptions.js~NotInBrowserException#constructor",
"access": "public",
"description": null,
"lineNumber": 128,
"undocument": true
},
{
"__docId__": 86,
"kind": "member",
"name": "name",
"memberof": "src/exceptions.js~NotInBrowserException",
"static": false,
"longname": "src/exceptions.js~NotInBrowserException#name",
"access": "public",
"description": null,
"lineNumber": 130,
"undocument": true,
"type": {
"types": [
"string"
]
}
},
{
"__docId__": 87,
"kind": "class",
"name": "UserRejectedSigningException",
"memberof": "src/exceptions.js",
"static": true,
"longname": "src/exceptions.js~UserRejectedSigningException",
"access": "public",
"export": true,
"importPath": "@simbachain/libsimba-js/src/exceptions.js",
"importStyle": "{UserRejectedSigningException}",
"description": "Thrown when the user rejects the request to sign",
"lineNumber": 137,
"interface": false,
"extends": [
"SigningException"
]
},
{
"__docId__": 88,
"kind": "constructor",
"name": "constructor",
"memberof": "src/exceptions.js~UserRejectedSigningException",
"generator": false,
"async": false,
"static": false,
"longname": "src/exceptions.js~UserRejectedSigningException#constructor",
"access": "public",
"description": null,
"lineNumber": 138,
"undocument": true
},
{
"__docId__": 89,
"kind": "member",
"name": "name",
"memberof": "src/exceptions.js~UserRejectedSigningException",
"static": false,
"longname": "src/exceptions.js~UserRejectedSigningException#name",
"access": "public",
"description": null,
"lineNumber": 140,
"undocument": true,
"type": {
"types": [
"string"
]
}
},
{
"__docId__": 90,
"kind": "class",
"name": "WalletNotFoundException",
"memberof": "src/exceptions.js",
"static": true,
"longname": "src/exceptions.js~WalletNotFoundException",
"access": "public",
"export": true,
"importPath": "@simbachain/libsimba-js/src/exceptions.js",
"importStyle": "{WalletNotFoundException}",
"description": "Thrown when a method on a class inheriting [SimbaBase]{@link SimbaBase} is called that requires\na [Wallet]{@link Wallet} to be set, and it isn't.",
"lineNumber": 148,
"interface": false,
"extends": [
"SigningException"
]
},
{
"__docId__": 91,
"kind": "constructor",
"name": "constructor",
"memberof": "src/exceptions.js~WalletNotFoundException",
"generator": false,
"async": false,
"static": false,
"longname": "src/exceptions.js~WalletNotFoundException#constructor",
"access": "public",
"description": null,
"lineNumber": 149,
"undocument": true
},
{
"__docId__": 92,
"kind": "member",
"name": "name",
"memberof": "src/exceptions.js~WalletNotFoundException",
"static": false,
"longname": "src/exceptions.js~WalletNotFoundException#name",
"access": "public",
"description": null,
"lineNumber": 151,
"undocument": true,
"type": {
"types": [
"string"
]
}
},
{
"__docId__": 93,
"kind": "class",
"name": "WalletLockedException",
"memberof": "src/exceptions.js",
"static": true,
"longname": "src/exceptions.js~WalletLockedException",
"access": "public",
"export": true,
"importPath": "@simbachain/libsimba-js/src/exceptions.js",
"importStyle": "{WalletLockedException}",
"description": "Thrown when a method on a class inheriting [SimbaBase]{@link SimbaBase} is called that requires\na [Wallet]{@link Wallet} to be unlocked, and it isn't.",
"lineNumber": 159,
"interface": false,
"extends": [
"SigningException"
]
},
{
"__docId__": 94,
"kind": "constructor",
"name": "constructor",
"memberof": "src/exceptions.js~WalletLockedException",
"generator": false,
"async": false,
"static": false,
"longname": "src/exceptions.js~WalletLockedException#constructor",
"access": "public",
"description": null,
"lineNumber": 160,
"undocument": true
},
{
"__docId__": 95,
"kind": "member",
"name": "name",
"memberof": "src/exceptions.js~WalletLockedException",
"static": false,
"longname": "src/exceptions.js~WalletLockedException#name",
"access": "public",
"description": null,
"lineNumber": 162,
"undocument": true,
"type": {
"types": [
"string"
]
}
},
{
"__docId__": 96,
"kind": "class",
"name": "RetriesExceededException",
"memberof": "src/exceptions.js",
"static": true,
"longname": "src/exceptions.js~RetriesExceededException",
"access": "public",
"export": true,
"importPath": "@simbachain/libsimba-js/src/exceptions.js",
"importStyle": "{RetriesExceededException}",
"description": "Thrown when a method call exceeds the max retries",
"lineNumber": 169,
"interface": false,
"extends": [
"SigningException"
]
},
{
"__docId__": 97,
"kind": "constructor",
"name": "constructor",
"memberof": "src/exceptions.js~RetriesExceededException",
"generator": false,
"async": false,
"static": false,
"longname": "src/exceptions.js~RetriesExceededException#constructor",
"access": "public",
"description": null,
"lineNumber": 170,
"undocument": true
},
{
"__docId__": 98,
"kind": "member",
"name": "name",
"memberof": "src/exceptions.js~RetriesExceededException",
"static": false,
"longname": "src/exceptions.js~RetriesExceededException#name",
"access": "public",
"description": null,
"lineNumber": 172,
"undocument": true,
"type": {
"types": [
"string"
]
}
},
{
"__docId__": 99,
"kind": "file",
"name": "src/index.js",
"content": "import {SimbaBase, Simbachain} from './simba';\nimport {Wallet, LocalWallet, PKWallet} from './wallet';\nimport {NotImplementedException} from './exceptions';\n\n/**\n * Create an instance of a Simbachain API interaction class\n * Automatically takes care of choosing the correct implementation and running asynchronous initialisation.\n * @param {string} url - The API URL\n * @param {Wallet} wallet - The Wallet to use\n * @param {string} [apiKey] - (Optional) The API key\n * @param {string} [managementKey] - (Optional) The Management API key\n * @returns {Promise<Simbachain>} - An initialised instance of the API interaction class\n */\nconst getSimbaInstance = async (url, wallet, apiKey, managementKey) => {\n if(url.startsWith('https://api.simbachain.com')){\n //.com\n let simba = new Simbachain(url, wallet);\n\n if(apiKey){\n simba.setApiKey(apiKey)\n }\n\n if(managementKey){\n simba.setManagementKey(managementKey)\n }\n\n await simba.initialize();\n\n return simba;\n }else{\n //scaas\n throw new NotImplementedException(\"SCaaS Support not yet implemented, sorry.\")\n }\n};\n\nexport {\n SimbaBase,\n Simbachain,\n Wallet,\n LocalWallet,\n PKWallet,\n getSimbaInstance\n}\n",
"static": true,
"longname": "C:/Users/Kieran David Evans/Code/libsimba-js/src/index.js",
"access": "public",
"description": null,
"lineNumber": 1
},
{
"__docId__": 100,
"kind": "function",
"name": "getSimbaInstance",
"memberof": "src/index.js",
"generator": false,
"async": true,
"static": true,
"longname": "src/index.js~getSimbaInstance",
"access": "public",
"export": true,
"importPath": "@simbachain/libsimba-js/src/index.js",
"importStyle": "{getSimbaInstance}",
"description": "Create an instance of a Simbachain API interaction class\nAutomatically takes care of choosing the correct implementation and running asynchronous initialisation.",
"lineNumber": 14,
"unknown": [
{
"tagName": "@returns",
"tagValue": "{Promise<Simbachain>} - An initialised instance of the API interaction class"
}
],
"params": [
{
"nullable": null,
"types": [
"string"
],
"spread": false,
"optional": false,
"name": "url",
"description": "The API URL"
},
{
"nullable": null,
"types": [
"Wallet"
],
"spread": false,
"optional": false,
"name": "wallet",
"description": "The Wallet to use"
},
{
"nullable": null,
"types": [
"string"
],
"spread": false,
"optional": true,
"name": "apiKey",
"description": "(Optional) The API key"
},
{
"nullable": null,
"types": [
"string"
]