{ "id": 0, "name": "blockstack.js 19.2.5 Library Reference", "kind": 0, "flags": {}, "children": [ { "id": 1, "name": "AuthScope", "kind": 4, "kindString": "Enumeration", "flags": { "isExported": true }, "comment": { "shortText": "Non-exhaustive list of common permission scopes." }, "children": [ { "id": 4, "name": "email", "kind": 16, "kindString": "Enumeration member", "flags": { "isExported": true }, "comment": { "shortText": "Request the user's email if available." }, "sources": [ { "fileName": "auth/authConstants.ts", "line": 33, "character": 7 } ], "defaultValue": "\"email\"" }, { "id": 3, "name": "publish_data", "kind": 16, "kindString": "Enumeration member", "flags": { "isExported": true }, "comment": { "shortText": "Publish data so that other users of the app can discover and interact with the user.\nThe user's files stored on Gaia hub are made visible to others via the `apps` property in the\nuser’s `profile.json` file." }, "sources": [ { "fileName": "auth/authConstants.ts", "line": 29, "character": 14 } ], "defaultValue": "\"publish_data\"" }, { "id": 2, "name": "store_write", "kind": 16, "kindString": "Enumeration member", "flags": { "isExported": true }, "comment": { "shortText": "Read and write data to the user's Gaia hub in an app-specific storage bucket.\nThis is the default scope." }, "sources": [ { "fileName": "auth/authConstants.ts", "line": 23, "character": 13 } ], "defaultValue": "\"store_write\"" } ], "groups": [ { "title": "Enumeration members", "kind": 16, "children": [ 4, 3, 2 ] } ], "sources": [ { "fileName": "auth/authConstants.ts", "line": 18, "character": 27 } ] }, { "id": 643, "name": "AppConfig", "kind": 128, "kindString": "Class", "flags": { "isExported": true }, "comment": { "shortText": "Configuration data for the current app.", "text": "On browser platforms, creating an instance of this\nclass without any arguments will use\n`window.location.origin` as the app domain.\nOn non-browser platforms, you need to\nspecify an app domain as the second argument.\n\n" }, "children": [ { "id": 650, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": { "isExported": true }, "comment": {}, "signatures": [ { "id": 651, "name": "new AppConfig", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "comment": {}, "parameters": [ { "id": 652, "name": "scopes", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "permissions this app is requesting" }, "type": { "type": "reference", "name": "Array", "typeArguments": [ { "type": "intrinsic", "name": "string" } ] }, "defaultValue": " DEFAULT_SCOPE.slice()" }, { "id": 653, "name": "appDomain", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "the app domain" }, "type": { "type": "intrinsic", "name": "string" }, "defaultValue": " getGlobalObject('location', { returnEmptyObject: true }).origin" }, { "id": 654, "name": "redirectPath", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "path on app domain to redirect users to after authentication" }, "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "\"\"" }, { "id": 655, "name": "manifestPath", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "path relative to app domain of app's manifest file" }, "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "\"/manifest.json\"" }, { "id": 656, "name": "coreNode", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "override the default or user selected core node" }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "null" } ] }, "defaultValue": " null" }, { "id": 657, "name": "authenticatorURL", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "the web-based fall back authenticator\n([[DEFAULT_BLOCKSTACK_HOST]])\n" }, "type": { "type": "intrinsic", "name": "string" }, "defaultValue": " DEFAULT_BLOCKSTACK_HOST" } ], "type": { "type": "reference", "name": "AppConfig", "id": 643 } } ], "sources": [ { "fileName": "auth/appConfig.ts", "line": 59, "character": 27 } ] }, { "id": 644, "name": "appDomain", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "comment": { "shortText": "Blockstack apps are uniquely identified by their app domain." }, "sources": [ { "fileName": "auth/appConfig.ts", "line": 20, "character": 11 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 649, "name": "authenticatorURL", "kind": 1024, "kindString": "Property", "flags": { "isExported": true, "isOptional": true }, "comment": { "shortText": "The URL of a web-based Blockstack Authenticator to use in the event\nthe user doesn't have Blockstack installed on their machine. If this\nis not specified, the current default in this library will be used." }, "sources": [ { "fileName": "auth/appConfig.ts", "line": 59, "character": 18 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 648, "name": "coreNode", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "comment": { "shortText": "The URL of Blockstack core node to use for this app. If this is\n`null`, the core node specified by the user or default core node\nwill be used." }, "sources": [ { "fileName": "auth/appConfig.ts", "line": 51, "character": 10 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 647, "name": "manifestPath", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "comment": { "shortText": "Path relative to app domain of app's manifest file.", "text": "This file needs to have CORS headers set so that it can be fetched\nfrom any origin. Typically this means return the header `Access-Control-Allow-Origin: *`.\n\n" }, "sources": [ { "fileName": "auth/appConfig.ts", "line": 43, "character": 14 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 646, "name": "redirectPath", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "comment": { "shortText": "Path on app domain to redirect users to after authentication. The\nauthentication response token will be postpended in a query." }, "sources": [ { "fileName": "auth/appConfig.ts", "line": 34, "character": 14 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 645, "name": "scopes", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "comment": { "shortText": "An array of string representing permissions requested by the app." }, "sources": [ { "fileName": "auth/appConfig.ts", "line": 26, "character": 8 } ], "type": { "type": "reference", "name": "Array", "typeArguments": [ { "type": "union", "types": [ { "type": "reference", "name": "AuthScope", "id": 1 }, { "type": "intrinsic", "name": "string" } ] } ] } }, { "id": 660, "name": "manifestURI", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 661, "name": "manifestURI", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "The location of the app's manifest file.", "returns": "- URI\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "sources": [ { "fileName": "auth/appConfig.ts", "line": 103, "character": 13 } ] }, { "id": 658, "name": "redirectURI", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 659, "name": "redirectURI", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "The location to which the authenticator should\nredirect the user.", "returns": "- URI\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "sources": [ { "fileName": "auth/appConfig.ts", "line": 95, "character": 13 } ] } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [ 650 ] }, { "title": "Properties", "kind": 1024, "children": [ 644, 649, 648, 647, 646, 645 ] }, { "title": "Methods", "kind": 2048, "children": [ 660, 658 ] } ], "sources": [ { "fileName": "auth/appConfig.ts", "line": 15, "character": 22 } ] }, { "id": 947, "name": "Facebook", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { "id": 962, "name": "getBaseUrls", "kind": 2048, "kindString": "Method", "flags": { "isStatic": true }, "signatures": [ { "id": 963, "name": "getBaseUrls", "kind": 4096, "kindString": "Call signature", "flags": {}, "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } }, "inheritedFrom": { "type": "reference", "name": "Service.getBaseUrls" } } ], "sources": [ { "fileName": "profiles/services/service.ts", "line": 44, "character": 20 } ], "inheritedFrom": { "type": "reference", "name": "Service.getBaseUrls" } }, { "id": 964, "name": "getProofIdentity", "kind": 2048, "kindString": "Method", "flags": { "isStatic": true }, "signatures": [ { "id": 965, "name": "getProofIdentity", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 966, "name": "searchText", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "name": "Service.getProofIdentity" } } ], "sources": [ { "fileName": "profiles/services/service.ts", "line": 48, "character": 25 } ], "inheritedFrom": { "type": "reference", "name": "Service.getProofIdentity" } }, { "id": 954, "name": "getProofStatement", "kind": 2048, "kindString": "Method", "flags": { "isStatic": true }, "signatures": [ { "id": 955, "name": "getProofStatement", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 956, "name": "searchText", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" }, "overwrites": { "type": "reference", "name": "Service.getProofStatement" } } ], "sources": [ { "fileName": "profiles/services/facebook.ts", "line": 33, "character": 26 } ], "overwrites": { "type": "reference", "name": "Service.getProofStatement" } }, { "id": 948, "name": "getProofUrl", "kind": 2048, "kindString": "Method", "flags": { "isStatic": true }, "signatures": [ { "id": 949, "name": "getProofUrl", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 950, "name": "proof", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "intrinsic", "name": "any" }, "overwrites": { "type": "reference", "name": "Service.getProofUrl" } } ], "sources": [ { "fileName": "profiles/services/facebook.ts", "line": 6, "character": 20 } ], "overwrites": { "type": "reference", "name": "Service.getProofUrl" } }, { "id": 951, "name": "normalizeUrl", "kind": 2048, "kindString": "Method", "flags": { "isStatic": true }, "signatures": [ { "id": 952, "name": "normalizeUrl", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 953, "name": "proof", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "intrinsic", "name": "any" } } ], "sources": [ { "fileName": "profiles/services/facebook.ts", "line": 10, "character": 21 } ] }, { "id": 969, "name": "prefixScheme", "kind": 2048, "kindString": "Method", "flags": { "isStatic": true }, "signatures": [ { "id": 970, "name": "prefixScheme", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 971, "name": "proofUrl", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "name": "Service.prefixScheme" } } ], "sources": [ { "fileName": "profiles/services/service.ts", "line": 60, "character": 21 } ], "inheritedFrom": { "type": "reference", "name": "Service.prefixScheme" } }, { "id": 967, "name": "shouldValidateIdentityInBody", "kind": 2048, "kindString": "Method", "flags": { "isStatic": true }, "signatures": [ { "id": 968, "name": "shouldValidateIdentityInBody", "kind": 4096, "kindString": "Call signature", "flags": {}, "type": { "type": "intrinsic", "name": "boolean" }, "inheritedFrom": { "type": "reference", "name": "Service.shouldValidateIdentityInBody" } } ], "sources": [ { "fileName": "profiles/services/service.ts", "line": 56, "character": 37 } ], "inheritedFrom": { "type": "reference", "name": "Service.shouldValidateIdentityInBody" } }, { "id": 957, "name": "validateProof", "kind": 2048, "kindString": "Method", "flags": { "isStatic": true }, "signatures": [ { "id": 958, "name": "validateProof", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 959, "name": "proof", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "any" } }, { "id": 960, "name": "ownerAddress", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 961, "name": "name", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" }, "defaultValue": " null" } ], "type": { "type": "reference", "name": "Promise", "typeArguments": [ { "type": "intrinsic", "name": "any" } ] }, "inheritedFrom": { "type": "reference", "name": "Service.validateProof" } } ], "sources": [ { "fileName": "profiles/services/service.ts", "line": 10, "character": 22 } ], "inheritedFrom": { "type": "reference", "name": "Service.validateProof" } } ], "groups": [ { "title": "Methods", "kind": 2048, "children": [ 962, 964, 954, 948, 951, 969, 967, 957 ] } ], "sources": [ { "fileName": "profiles/services/facebook.ts", "line": 5, "character": 14 } ], "extendedTypes": [ { "type": "reference", "name": "Service" } ] }, { "id": 972, "name": "Github", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { "id": 973, "name": "getBaseUrls", "kind": 2048, "kindString": "Method", "flags": { "isStatic": true }, "signatures": [ { "id": 974, "name": "getBaseUrls", "kind": 4096, "kindString": "Call signature", "flags": {}, "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } }, "overwrites": { "type": "reference", "name": "Service.getBaseUrls" } } ], "sources": [ { "fileName": "profiles/services/github.ts", "line": 5, "character": 20 } ], "overwrites": { "type": "reference", "name": "Service.getBaseUrls" } }, { "id": 986, "name": "getProofIdentity", "kind": 2048, "kindString": "Method", "flags": { "isStatic": true }, "signatures": [ { "id": 987, "name": "getProofIdentity", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 988, "name": "searchText", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "name": "Service.getProofIdentity" } } ], "sources": [ { "fileName": "profiles/services/service.ts", "line": 48, "character": 25 } ], "inheritedFrom": { "type": "reference", "name": "Service.getProofIdentity" } }, { "id": 989, "name": "getProofStatement", "kind": 2048, "kindString": "Method", "flags": { "isStatic": true }, "signatures": [ { "id": 990, "name": "getProofStatement", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 991, "name": "searchText", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "name": "Service.getProofStatement" } } ], "sources": [ { "fileName": "profiles/services/service.ts", "line": 52, "character": 26 } ], "inheritedFrom": { "type": "reference", "name": "Service.getProofStatement" } }, { "id": 978, "name": "getProofUrl", "kind": 2048, "kindString": "Method", "flags": { "isStatic": true }, "signatures": [ { "id": 979, "name": "getProofUrl", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 980, "name": "proof", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "intrinsic", "name": "string" }, "overwrites": { "type": "reference", "name": "Service.getProofUrl" } } ], "sources": [ { "fileName": "profiles/services/github.ts", "line": 14, "character": 20 } ], "overwrites": { "type": "reference", "name": "Service.getProofUrl" } }, { "id": 975, "name": "normalizeUrl", "kind": 2048, "kindString": "Method", "flags": { "isStatic": true }, "signatures": [ { "id": 976, "name": "normalizeUrl", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 977, "name": "proof", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "intrinsic", "name": "string" } } ], "sources": [ { "fileName": "profiles/services/github.ts", "line": 10, "character": 21 } ] }, { "id": 994, "name": "prefixScheme", "kind": 2048, "kindString": "Method", "flags": { "isStatic": true }, "signatures": [ { "id": 995, "name": "prefixScheme", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 996, "name": "proofUrl", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "name": "Service.prefixScheme" } } ], "sources": [ { "fileName": "profiles/services/service.ts", "line": 60, "character": 21 } ], "inheritedFrom": { "type": "reference", "name": "Service.prefixScheme" } }, { "id": 992, "name": "shouldValidateIdentityInBody", "kind": 2048, "kindString": "Method", "flags": { "isStatic": true }, "signatures": [ { "id": 993, "name": "shouldValidateIdentityInBody", "kind": 4096, "kindString": "Call signature", "flags": {}, "type": { "type": "intrinsic", "name": "boolean" }, "inheritedFrom": { "type": "reference", "name": "Service.shouldValidateIdentityInBody" } } ], "sources": [ { "fileName": "profiles/services/service.ts", "line": 56, "character": 37 } ], "inheritedFrom": { "type": "reference", "name": "Service.shouldValidateIdentityInBody" } }, { "id": 981, "name": "validateProof", "kind": 2048, "kindString": "Method", "flags": { "isStatic": true }, "signatures": [ { "id": 982, "name": "validateProof", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 983, "name": "proof", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "any" } }, { "id": 984, "name": "ownerAddress", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 985, "name": "name", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" }, "defaultValue": " null" } ], "type": { "type": "reference", "name": "Promise", "typeArguments": [ { "type": "intrinsic", "name": "any" } ] }, "inheritedFrom": { "type": "reference", "name": "Service.validateProof" } } ], "sources": [ { "fileName": "profiles/services/service.ts", "line": 10, "character": 22 } ], "inheritedFrom": { "type": "reference", "name": "Service.validateProof" } } ], "groups": [ { "title": "Methods", "kind": 2048, "children": [ 973, 986, 989, 978, 975, 994, 992, 981 ] } ], "sources": [ { "fileName": "profiles/services/github.ts", "line": 4, "character": 12 } ], "extendedTypes": [ { "type": "reference", "name": "Service" } ] }, { "id": 1047, "name": "HackerNews", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { "id": 1048, "name": "getBaseUrls", "kind": 2048, "kindString": "Method", "flags": { "isStatic": true }, "signatures": [ { "id": 1049, "name": "getBaseUrls", "kind": 4096, "kindString": "Call signature", "flags": {}, "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } }, "overwrites": { "type": "reference", "name": "Service.getBaseUrls" } } ], "sources": [ { "fileName": "profiles/services/hackerNews.ts", "line": 6, "character": 20 } ], "overwrites": { "type": "reference", "name": "Service.getBaseUrls" } }, { "id": 1064, "name": "getProofIdentity", "kind": 2048, "kindString": "Method", "flags": { "isStatic": true }, "signatures": [ { "id": 1065, "name": "getProofIdentity", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 1066, "name": "searchText", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "name": "Service.getProofIdentity" } } ], "sources": [ { "fileName": "profiles/services/service.ts", "line": 48, "character": 25 } ], "inheritedFrom": { "type": "reference", "name": "Service.getProofIdentity" } }, { "id": 1056, "name": "getProofStatement", "kind": 2048, "kindString": "Method", "flags": { "isStatic": true }, "signatures": [ { "id": 1057, "name": "getProofStatement", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 1058, "name": "searchText", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" }, "overwrites": { "type": "reference", "name": "Service.getProofStatement" } } ], "sources": [ { "fileName": "profiles/services/hackerNews.ts", "line": 32, "character": 26 } ], "overwrites": { "type": "reference", "name": "Service.getProofStatement" } }, { "id": 1050, "name": "getProofUrl", "kind": 2048, "kindString": "Method", "flags": { "isStatic": true }, "signatures": [ { "id": 1051, "name": "getProofUrl", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 1052, "name": "proof", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "intrinsic", "name": "string" }, "overwrites": { "type": "reference", "name": "Service.getProofUrl" } } ], "sources": [ { "fileName": "profiles/services/hackerNews.ts", "line": 15, "character": 20 } ], "overwrites": { "type": "reference", "name": "Service.getProofUrl" } }, { "id": 1053, "name": "normalizeUrl", "kind": 2048, "kindString": "Method", "flags": { "isStatic": true }, "signatures": [ { "id": 1054, "name": "normalizeUrl", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 1055, "name": "proof", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "intrinsic", "name": "string" } } ], "sources": [ { "fileName": "profiles/services/hackerNews.ts", "line": 28, "character": 21 } ] }, { "id": 1069, "name": "prefixScheme", "kind": 2048, "kindString": "Method", "flags": { "isStatic": true }, "signatures": [ { "id": 1070, "name": "prefixScheme", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 1071, "name": "proofUrl", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "name": "Service.prefixScheme" } } ], "sources": [ { "fileName": "profiles/services/service.ts", "line": 60, "character": 21 } ], "inheritedFrom": { "type": "reference", "name": "Service.prefixScheme" } }, { "id": 1067, "name": "shouldValidateIdentityInBody", "kind": 2048, "kindString": "Method", "flags": { "isStatic": true }, "signatures": [ { "id": 1068, "name": "shouldValidateIdentityInBody", "kind": 4096, "kindString": "Call signature", "flags": {}, "type": { "type": "intrinsic", "name": "boolean" }, "inheritedFrom": { "type": "reference", "name": "Service.shouldValidateIdentityInBody" } } ], "sources": [ { "fileName": "profiles/services/service.ts", "line": 56, "character": 37 } ], "inheritedFrom": { "type": "reference", "name": "Service.shouldValidateIdentityInBody" } }, { "id": 1059, "name": "validateProof", "kind": 2048, "kindString": "Method", "flags": { "isStatic": true }, "signatures": [ { "id": 1060, "name": "validateProof", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 1061, "name": "proof", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "any" } }, { "id": 1062, "name": "ownerAddress", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1063, "name": "name", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" }, "defaultValue": " null" } ], "type": { "type": "reference", "name": "Promise", "typeArguments": [ { "type": "intrinsic", "name": "any" } ] }, "inheritedFrom": { "type": "reference", "name": "Service.validateProof" } } ], "sources": [ { "fileName": "profiles/services/service.ts", "line": 10, "character": 22 } ], "inheritedFrom": { "type": "reference", "name": "Service.validateProof" } } ], "groups": [ { "title": "Methods", "kind": 2048, "children": [ 1048, 1064, 1056, 1050, 1053, 1069, 1067, 1059 ] } ], "sources": [ { "fileName": "profiles/services/hackerNews.ts", "line": 5, "character": 16 } ], "extendedTypes": [ { "type": "reference", "name": "Service" } ] }, { "id": 1022, "name": "Instagram", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { "id": 1023, "name": "getBaseUrls", "kind": 2048, "kindString": "Method", "flags": { "isStatic": true }, "signatures": [ { "id": 1024, "name": "getBaseUrls", "kind": 4096, "kindString": "Call signature", "flags": {}, "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } }, "overwrites": { "type": "reference", "name": "Service.getBaseUrls" } } ], "sources": [ { "fileName": "profiles/services/instagram.ts", "line": 6, "character": 20 } ], "overwrites": { "type": "reference", "name": "Service.getBaseUrls" } }, { "id": 1033, "name": "getProofIdentity", "kind": 2048, "kindString": "Method", "flags": { "isStatic": true }, "signatures": [ { "id": 1034, "name": "getProofIdentity", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 1035, "name": "searchText", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" }, "overwrites": { "type": "reference", "name": "Service.getProofIdentity" } } ], "sources": [ { "fileName": "profiles/services/instagram.ts", "line": 38, "character": 25 } ], "overwrites": { "type": "reference", "name": "Service.getProofIdentity" } }, { "id": 1036, "name": "getProofStatement", "kind": 2048, "kindString": "Method", "flags": { "isStatic": true }, "signatures": [ { "id": 1037, "name": "getProofStatement", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 1038, "name": "searchText", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" }, "overwrites": { "type": "reference", "name": "Service.getProofStatement" } } ], "sources": [ { "fileName": "profiles/services/instagram.ts", "line": 48, "character": 26 } ], "overwrites": { "type": "reference", "name": "Service.getProofStatement" } }, { "id": 1025, "name": "getProofUrl", "kind": 2048, "kindString": "Method", "flags": { "isStatic": true }, "signatures": [ { "id": 1026, "name": "getProofUrl", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 1027, "name": "proof", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "intrinsic", "name": "any" }, "overwrites": { "type": "reference", "name": "Service.getProofUrl" } } ], "sources": [ { "fileName": "profiles/services/instagram.ts", "line": 11, "character": 20 } ], "overwrites": { "type": "reference", "name": "Service.getProofUrl" } }, { "id": 1028, "name": "normalizeUrl", "kind": 2048, "kindString": "Method", "flags": { "isStatic": true }, "signatures": [ { "id": 1029, "name": "normalizeUrl", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 1030, "name": "proof", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "intrinsic", "name": "any" } } ], "sources": [ { "fileName": "profiles/services/instagram.ts", "line": 23, "character": 21 } ] }, { "id": 1044, "name": "prefixScheme", "kind": 2048, "kindString": "Method", "flags": { "isStatic": true }, "signatures": [ { "id": 1045, "name": "prefixScheme", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 1046, "name": "proofUrl", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "name": "Service.prefixScheme" } } ], "sources": [ { "fileName": "profiles/services/service.ts", "line": 60, "character": 21 } ], "inheritedFrom": { "type": "reference", "name": "Service.prefixScheme" } }, { "id": 1031, "name": "shouldValidateIdentityInBody", "kind": 2048, "kindString": "Method", "flags": { "isStatic": true }, "signatures": [ { "id": 1032, "name": "shouldValidateIdentityInBody", "kind": 4096, "kindString": "Call signature", "flags": {}, "type": { "type": "intrinsic", "name": "boolean" }, "overwrites": { "type": "reference", "name": "Service.shouldValidateIdentityInBody" } } ], "sources": [ { "fileName": "profiles/services/instagram.ts", "line": 34, "character": 37 } ], "overwrites": { "type": "reference", "name": "Service.shouldValidateIdentityInBody" } }, { "id": 1039, "name": "validateProof", "kind": 2048, "kindString": "Method", "flags": { "isStatic": true }, "signatures": [ { "id": 1040, "name": "validateProof", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 1041, "name": "proof", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "any" } }, { "id": 1042, "name": "ownerAddress", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1043, "name": "name", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" }, "defaultValue": " null" } ], "type": { "type": "reference", "name": "Promise", "typeArguments": [ { "type": "intrinsic", "name": "any" } ] }, "inheritedFrom": { "type": "reference", "name": "Service.validateProof" } } ], "sources": [ { "fileName": "profiles/services/service.ts", "line": 10, "character": 22 } ], "inheritedFrom": { "type": "reference", "name": "Service.validateProof" } } ], "groups": [ { "title": "Methods", "kind": 2048, "children": [ 1023, 1033, 1036, 1025, 1028, 1044, 1031, 1039 ] } ], "sources": [ { "fileName": "profiles/services/instagram.ts", "line": 5, "character": 15 } ], "extendedTypes": [ { "type": "reference", "name": "Service" } ] }, { "id": 1072, "name": "LinkedIn", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { "id": 1073, "name": "getBaseUrls", "kind": 2048, "kindString": "Method", "flags": { "isStatic": true }, "signatures": [ { "id": 1074, "name": "getBaseUrls", "kind": 4096, "kindString": "Call signature", "flags": {}, "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } }, "overwrites": { "type": "reference", "name": "Service.getBaseUrls" } } ], "sources": [ { "fileName": "profiles/services/linkedIn.ts", "line": 6, "character": 20 } ], "overwrites": { "type": "reference", "name": "Service.getBaseUrls" } }, { "id": 1083, "name": "getProofIdentity", "kind": 2048, "kindString": "Method", "flags": { "isStatic": true }, "signatures": [ { "id": 1084, "name": "getProofIdentity", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 1085, "name": "searchText", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" }, "overwrites": { "type": "reference", "name": "Service.getProofIdentity" } } ], "sources": [ { "fileName": "profiles/services/linkedIn.ts", "line": 37, "character": 25 } ], "overwrites": { "type": "reference", "name": "Service.getProofIdentity" } }, { "id": 1086, "name": "getProofStatement", "kind": 2048, "kindString": "Method", "flags": { "isStatic": true }, "signatures": [ { "id": 1087, "name": "getProofStatement", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 1088, "name": "searchText", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" }, "overwrites": { "type": "reference", "name": "Service.getProofStatement" } } ], "sources": [ { "fileName": "profiles/services/linkedIn.ts", "line": 56, "character": 26 } ], "overwrites": { "type": "reference", "name": "Service.getProofStatement" } }, { "id": 1075, "name": "getProofUrl", "kind": 2048, "kindString": "Method", "flags": { "isStatic": true }, "signatures": [ { "id": 1076, "name": "getProofUrl", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 1077, "name": "proof", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "intrinsic", "name": "any" }, "overwrites": { "type": "reference", "name": "Service.getProofUrl" } } ], "sources": [ { "fileName": "profiles/services/linkedIn.ts", "line": 15, "character": 20 } ], "overwrites": { "type": "reference", "name": "Service.getProofUrl" } }, { "id": 1078, "name": "normalizeUrl", "kind": 2048, "kindString": "Method", "flags": { "isStatic": true }, "signatures": [ { "id": 1079, "name": "normalizeUrl", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 1080, "name": "proof", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "intrinsic", "name": "string" } } ], "sources": [ { "fileName": "profiles/services/linkedIn.ts", "line": 29, "character": 21 } ] }, { "id": 1094, "name": "prefixScheme", "kind": 2048, "kindString": "Method", "flags": { "isStatic": true }, "signatures": [ { "id": 1095, "name": "prefixScheme", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 1096, "name": "proofUrl", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "name": "Service.prefixScheme" } } ], "sources": [ { "fileName": "profiles/services/service.ts", "line": 60, "character": 21 } ], "inheritedFrom": { "type": "reference", "name": "Service.prefixScheme" } }, { "id": 1081, "name": "shouldValidateIdentityInBody", "kind": 2048, "kindString": "Method", "flags": { "isStatic": true }, "signatures": [ { "id": 1082, "name": "shouldValidateIdentityInBody", "kind": 4096, "kindString": "Call signature", "flags": {}, "type": { "type": "intrinsic", "name": "boolean" }, "overwrites": { "type": "reference", "name": "Service.shouldValidateIdentityInBody" } } ], "sources": [ { "fileName": "profiles/services/linkedIn.ts", "line": 33, "character": 37 } ], "overwrites": { "type": "reference", "name": "Service.shouldValidateIdentityInBody" } }, { "id": 1089, "name": "validateProof", "kind": 2048, "kindString": "Method", "flags": { "isStatic": true }, "signatures": [ { "id": 1090, "name": "validateProof", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 1091, "name": "proof", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "any" } }, { "id": 1092, "name": "ownerAddress", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1093, "name": "name", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" }, "defaultValue": " null" } ], "type": { "type": "reference", "name": "Promise", "typeArguments": [ { "type": "intrinsic", "name": "any" } ] }, "inheritedFrom": { "type": "reference", "name": "Service.validateProof" } } ], "sources": [ { "fileName": "profiles/services/service.ts", "line": 10, "character": 22 } ], "inheritedFrom": { "type": "reference", "name": "Service.validateProof" } } ], "groups": [ { "title": "Methods", "kind": 2048, "children": [ 1073, 1083, 1086, 1075, 1078, 1094, 1081, 1089 ] } ], "sources": [ { "fileName": "profiles/services/linkedIn.ts", "line": 5, "character": 14 } ], "extendedTypes": [ { "type": "reference", "name": "Service" } ] }, { "id": 1744, "name": "PasswordError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { "id": 1746, "name": "message", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "/Users/Yukan/Desktop/work/blockstack/blockstack.js/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts", "line": 964, "character": 11 } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "name": "Error.message" } }, { "id": 1745, "name": "name", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "/Users/Yukan/Desktop/work/blockstack/blockstack.js/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts", "line": 963, "character": 8 } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "name": "Error.name" } }, { "id": 1747, "name": "stack", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "/Users/Yukan/Desktop/work/blockstack/blockstack.js/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts", "line": 965, "character": 9 } ], "type": { "type": "intrinsic", "name": "string" }, "overwrites": { "type": "reference", "name": "Error.stack" }, "inheritedFrom": { "type": "reference", "name": "Error.stack" } }, { "id": 1748, "name": "Error", "kind": 1024, "kindString": "Property", "flags": { "isStatic": true }, "sources": [ { "fileName": "/Users/Yukan/Desktop/work/blockstack/blockstack.js/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts", "line": 974, "character": 19 } ], "type": { "type": "reference", "name": "ErrorConstructor" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [ 1746, 1745, 1747, 1748 ] } ], "sources": [ { "fileName": "encryption/wallet.ts", "line": 48, "character": 19 } ], "extendedTypes": [ { "type": "reference", "name": "Error" } ] }, { "id": 1127, "name": "Profile", "kind": 128, "kindString": "Class", "flags": { "isExported": true }, "comment": { "shortText": "Represents a user profile" }, "children": [ { "id": 1132, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": { "isExported": true }, "signatures": [ { "id": 1133, "name": "new Profile", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { "id": 1134, "name": "profile", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 1135, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {} } }, "defaultValue": " {}" } ], "type": { "type": "reference", "name": "Profile", "id": 1127 } } ], "sources": [ { "fileName": "profiles/profile.ts", "line": 21, "character": 32 } ] }, { "id": 1128, "name": "_profile", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "profiles/profile.ts", "line": 21, "character": 10 } ], "type": { "type": "reflection", "declaration": { "id": 1129, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": [ { "id": 1130, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 1131, "name": "key", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } ], "sources": [ { "fileName": "profiles/profile.ts", "line": 21, "character": 11 } ] } } }, { "id": 1136, "name": "toJSON", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 1137, "name": "toJSON", "kind": 4096, "kindString": "Call signature", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 1138, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": [ { "id": 1139, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 1140, "name": "key", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } ] } } } ], "sources": [ { "fileName": "profiles/profile.ts", "line": 29, "character": 8 } ] }, { "id": 1141, "name": "toToken", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 1142, "name": "toToken", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 1143, "name": "privateKey", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } ], "sources": [ { "fileName": "profiles/profile.ts", "line": 33, "character": 9 } ] }, { "id": 1148, "name": "fromToken", "kind": 2048, "kindString": "Method", "flags": { "isStatic": true, "isExported": true }, "signatures": [ { "id": 1149, "name": "fromToken", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 1150, "name": "token", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1151, "name": "publicKeyOrAddress", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "null" } ] }, "defaultValue": " null" } ], "type": { "type": "reference", "name": "Profile", "id": 1127 } } ], "sources": [ { "fileName": "profiles/profile.ts", "line": 42, "character": 18 } ] }, { "id": 1152, "name": "makeZoneFile", "kind": 2048, "kindString": "Method", "flags": { "isStatic": true, "isExported": true }, "signatures": [ { "id": 1153, "name": "makeZoneFile", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 1154, "name": "domainName", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1155, "name": "tokenFileURL", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } ], "sources": [ { "fileName": "profiles/profile.ts", "line": 47, "character": 21 } ] }, { "id": 1156, "name": "validateProofs", "kind": 2048, "kindString": "Method", "flags": { "isStatic": true, "isExported": true }, "signatures": [ { "id": 1157, "name": "validateProofs", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 1158, "name": "domainName", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "name": "Promise", "typeArguments": [ { "type": "array", "elementType": { "type": "intrinsic", "name": "any" } } ] } } ], "sources": [ { "fileName": "profiles/profile.ts", "line": 51, "character": 23 } ] }, { "id": 1144, "name": "validateSchema", "kind": 2048, "kindString": "Method", "flags": { "isStatic": true, "isExported": true }, "signatures": [ { "id": 1145, "name": "validateSchema", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 1146, "name": "profile", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "any" } }, { "id": 1147, "name": "strict", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "false" } ], "type": { "type": "intrinsic", "name": "any" } } ], "sources": [ { "fileName": "profiles/profile.ts", "line": 37, "character": 23 } ] } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [ 1132 ] }, { "title": "Properties", "kind": 1024, "children": [ 1128 ] }, { "title": "Methods", "kind": 2048, "children": [ 1136, 1141, 1148, 1152, 1156, 1144 ] } ], "sources": [ { "fileName": "profiles/profile.ts", "line": 20, "character": 20 } ] }, { "id": 858, "name": "SessionDataStore", "kind": 128, "kindString": "Class", "flags": { "isExported": true }, "comment": { "shortText": "An abstract class representing the SessionDataStore interface." }, "children": [ { "id": 859, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": { "isExported": true }, "signatures": [ { "id": 860, "name": "new SessionDataStore", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { "id": 861, "name": "sessionOptions", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "name": "SessionOptions", "id": 823 } } ], "type": { "type": "reference", "name": "SessionDataStore", "id": 858 } } ], "sources": [ { "fileName": "auth/sessionStore.ts", "line": 14, "character": 31 } ] }, { "id": 867, "name": "deleteSessionData", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 868, "name": "deleteSessionData", "kind": 4096, "kindString": "Call signature", "flags": {}, "type": { "type": "intrinsic", "name": "boolean" } } ], "sources": [ { "fileName": "auth/sessionStore.ts", "line": 31, "character": 19 } ] }, { "id": 862, "name": "getSessionData", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 863, "name": "getSessionData", "kind": 4096, "kindString": "Call signature", "flags": {}, "type": { "type": "reference", "name": "SessionData" } } ], "sources": [ { "fileName": "auth/sessionStore.ts", "line": 22, "character": 16 } ] }, { "id": 864, "name": "setSessionData", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 865, "name": "setSessionData", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 866, "name": "session", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "name": "SessionData" } } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "sources": [ { "fileName": "auth/sessionStore.ts", "line": 27, "character": 16 } ] } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [ 859 ] }, { "title": "Methods", "kind": 2048, "children": [ 867, 862, 864 ] } ], "sources": [ { "fileName": "auth/sessionStore.ts", "line": 14, "character": 29 } ] }, { "id": 997, "name": "Twitter", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { "id": 998, "name": "getBaseUrls", "kind": 2048, "kindString": "Method", "flags": { "isStatic": true }, "signatures": [ { "id": 999, "name": "getBaseUrls", "kind": 4096, "kindString": "Call signature", "flags": {}, "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } }, "overwrites": { "type": "reference", "name": "Service.getBaseUrls" } } ], "sources": [ { "fileName": "profiles/services/twitter.ts", "line": 6, "character": 20 } ], "overwrites": { "type": "reference", "name": "Service.getBaseUrls" } }, { "id": 1011, "name": "getProofIdentity", "kind": 2048, "kindString": "Method", "flags": { "isStatic": true }, "signatures": [ { "id": 1012, "name": "getProofIdentity", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 1013, "name": "searchText", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "name": "Service.getProofIdentity" } } ], "sources": [ { "fileName": "profiles/services/service.ts", "line": 48, "character": 25 } ], "inheritedFrom": { "type": "reference", "name": "Service.getProofIdentity" } }, { "id": 1003, "name": "getProofStatement", "kind": 2048, "kindString": "Method", "flags": { "isStatic": true }, "signatures": [ { "id": 1004, "name": "getProofStatement", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 1005, "name": "searchText", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" }, "overwrites": { "type": "reference", "name": "Service.getProofStatement" } } ], "sources": [ { "fileName": "profiles/services/twitter.ts", "line": 19, "character": 26 } ], "overwrites": { "type": "reference", "name": "Service.getProofStatement" } }, { "id": 1019, "name": "getProofUrl", "kind": 2048, "kindString": "Method", "flags": { "isStatic": true }, "signatures": [ { "id": 1020, "name": "getProofUrl", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 1021, "name": "proof", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "name": "Service.getProofUrl" } } ], "sources": [ { "fileName": "profiles/services/service.ts", "line": 70, "character": 20 } ], "inheritedFrom": { "type": "reference", "name": "Service.getProofUrl" } }, { "id": 1000, "name": "normalizeUrl", "kind": 2048, "kindString": "Method", "flags": { "isStatic": true }, "signatures": [ { "id": 1001, "name": "normalizeUrl", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 1002, "name": "proof", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "intrinsic", "name": "string" } } ], "sources": [ { "fileName": "profiles/services/twitter.ts", "line": 15, "character": 21 } ] }, { "id": 1016, "name": "prefixScheme", "kind": 2048, "kindString": "Method", "flags": { "isStatic": true }, "signatures": [ { "id": 1017, "name": "prefixScheme", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 1018, "name": "proofUrl", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "name": "Service.prefixScheme" } } ], "sources": [ { "fileName": "profiles/services/service.ts", "line": 60, "character": 21 } ], "inheritedFrom": { "type": "reference", "name": "Service.prefixScheme" } }, { "id": 1014, "name": "shouldValidateIdentityInBody", "kind": 2048, "kindString": "Method", "flags": { "isStatic": true }, "signatures": [ { "id": 1015, "name": "shouldValidateIdentityInBody", "kind": 4096, "kindString": "Call signature", "flags": {}, "type": { "type": "intrinsic", "name": "boolean" }, "inheritedFrom": { "type": "reference", "name": "Service.shouldValidateIdentityInBody" } } ], "sources": [ { "fileName": "profiles/services/service.ts", "line": 56, "character": 37 } ], "inheritedFrom": { "type": "reference", "name": "Service.shouldValidateIdentityInBody" } }, { "id": 1006, "name": "validateProof", "kind": 2048, "kindString": "Method", "flags": { "isStatic": true }, "signatures": [ { "id": 1007, "name": "validateProof", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 1008, "name": "proof", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "any" } }, { "id": 1009, "name": "ownerAddress", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1010, "name": "name", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" }, "defaultValue": " null" } ], "type": { "type": "reference", "name": "Promise", "typeArguments": [ { "type": "intrinsic", "name": "any" } ] }, "inheritedFrom": { "type": "reference", "name": "Service.validateProof" } } ], "sources": [ { "fileName": "profiles/services/service.ts", "line": 10, "character": 22 } ], "inheritedFrom": { "type": "reference", "name": "Service.validateProof" } } ], "groups": [ { "title": "Methods", "kind": 2048, "children": [ 998, 1011, 1003, 1019, 1000, 1016, 1014, 1006 ] } ], "sources": [ { "fileName": "profiles/services/twitter.ts", "line": 5, "character": 13 } ], "extendedTypes": [ { "type": "reference", "name": "Service" } ] }, { "id": 1544, "name": "UserSession", "kind": 128, "kindString": "Class", "flags": { "isExported": true }, "comment": { "shortText": "Represents an instance of a signed in user for a particular app.", "text": "A signed in user has access to two major pieces of information\nabout the user, the user's private key for that app and the location\nof the user's gaia storage bucket for the app.\n\nA user can be signed in either directly through the interactive\nsign in process or by directly providing the app private key.\n\n\n\n" }, "children": [ { "id": 1547, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": { "isExported": true }, "comment": { "shortText": "Creates a UserSession object" }, "signatures": [ { "id": 1548, "name": "new UserSession", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "comment": { "shortText": "Creates a UserSession object" }, "parameters": [ { "id": 1549, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "shortText": "\n" }, "type": { "type": "reflection", "declaration": { "id": 1550, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 1551, "name": "appConfig", "kind": 32, "kindString": "Variable", "flags": { "isOptional": true }, "sources": [ { "fileName": "auth/userSession.ts", "line": 50, "character": 13 } ], "type": { "type": "reference", "name": "AppConfig", "id": 643 } }, { "id": 1553, "name": "sessionOptions", "kind": 32, "kindString": "Variable", "flags": { "isOptional": true }, "sources": [ { "fileName": "auth/userSession.ts", "line": 52, "character": 18 } ], "type": { "type": "reference", "name": "SessionOptions", "id": 823 } }, { "id": 1552, "name": "sessionStore", "kind": 32, "kindString": "Variable", "flags": { "isOptional": true }, "sources": [ { "fileName": "auth/userSession.ts", "line": 51, "character": 16 } ], "type": { "type": "reference", "name": "SessionDataStore", "id": 858 } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 1551, 1553, 1552 ] } ], "sources": [ { "fileName": "auth/userSession.ts", "line": 49, "character": 23 } ] } } } ], "type": { "type": "reference", "name": "UserSession", "id": 1544 } } ], "sources": [ { "fileName": "auth/userSession.ts", "line": 42, "character": 25 } ] }, { "id": 1545, "name": "appConfig", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "auth/userSession.ts", "line": 40, "character": 11 } ], "type": { "type": "reference", "name": "AppConfig", "id": 643 } }, { "id": 1546, "name": "store", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "auth/userSession.ts", "line": 42, "character": 7 } ], "type": { "type": "reference", "name": "SessionDataStore", "id": 858 } }, { "id": 1594, "name": "decryptContent", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 1595, "name": "decryptContent", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Decrypts data encrypted with `encryptContent` with the\ntransit private key.", "returns": "decrypted content.\n" }, "parameters": [ { "id": 1596, "name": "content", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "encrypted content." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1597, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reflection", "declaration": { "id": 1598, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 1599, "name": "privateKey", "kind": 32, "kindString": "Variable", "flags": { "isOptional": true }, "comment": { "text": "The hex string of the ECDSA private\nkey to use for decryption. If not provided, will use user's appPrivateKey." }, "sources": [ { "fileName": "auth/userSession.ts", "line": 284, "character": 55 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 1599 ] } ], "sources": [ { "fileName": "auth/userSession.ts", "line": 284, "character": 43 } ] } } } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "name": "Buffer" } ] } } ], "sources": [ { "fileName": "auth/userSession.ts", "line": 284, "character": 16 } ] }, { "id": 1619, "name": "deleteFile", "kind": 2048, "kindString": "Method", "flags": { "isPublic": true, "isExported": true }, "signatures": [ { "id": 1620, "name": "deleteFile", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Deletes the specified file from the app's data store.", "returns": "Resolves when the file has been removed or rejects with an error.\n" }, "parameters": [ { "id": 1621, "name": "path", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "The path to the file to delete." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1622, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "text": "Optional options object." }, "type": { "type": "reflection", "declaration": { "id": 1623, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 1624, "name": "wasSigned", "kind": 32, "kindString": "Variable", "flags": { "isOptional": true }, "comment": { "text": "Set to true if the file was originally signed\nin order for the corresponding signature file to also be deleted." }, "sources": [ { "fileName": "auth/userSession.ts", "line": 345, "character": 55 } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 1624 ] } ], "sources": [ { "fileName": "auth/userSession.ts", "line": 345, "character": 43 } ] } } } ], "type": { "type": "reference", "name": "Promise", "typeArguments": [ { "type": "intrinsic", "name": "void" } ] } } ], "sources": [ { "fileName": "auth/userSession.ts", "line": 345, "character": 19 } ] }, { "id": 1588, "name": "encryptContent", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 1589, "name": "encryptContent", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Encrypts the data provided with the app public key.", "returns": "Stringified ciphertext object\n" }, "parameters": [ { "id": 1590, "name": "content", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the data to encrypt" }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "name": "Buffer" } ] } }, { "id": 1591, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reflection", "declaration": { "id": 1592, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 1593, "name": "publicKey", "kind": 32, "kindString": "Variable", "flags": { "isOptional": true }, "comment": { "text": "the hex string of the ECDSA public\nkey to use for encryption. If not provided, will use user's appPrivateKey.\n" }, "sources": [ { "fileName": "auth/userSession.ts", "line": 271, "character": 24 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 1593 ] } ], "sources": [ { "fileName": "auth/userSession.ts", "line": 271, "character": 13 } ] } } } ], "type": { "type": "intrinsic", "name": "string" } } ], "sources": [ { "fileName": "auth/userSession.ts", "line": 269, "character": 16 } ] }, { "id": 1572, "name": "generateAndStoreTransitKey", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 1573, "name": "generateAndStoreTransitKey", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Generates a ECDSA keypair to\nuse as the ephemeral app transit private key\nand store in the session.", "returns": "the hex encoded private key\n\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "sources": [ { "fileName": "auth/userSession.ts", "line": 189, "character": 28 } ] }, { "id": 1574, "name": "getAuthResponseToken", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 1575, "name": "getAuthResponseToken", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Retrieve the authentication token from the URL query.", "returns": "the authentication token if it exists otherwise `null`\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "sources": [ { "fileName": "auth/userSession.ts", "line": 202, "character": 22 } ] }, { "id": 1605, "name": "getFile", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 1606, "name": "getFile", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Retrieves the specified file from the app's data store.", "returns": "that resolves to the raw data in the file\nor rejects with an error\n" }, "parameters": [ { "id": 1607, "name": "path", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the path to the file to read" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1608, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "text": "a [[GetFileOptions]] object\n" }, "type": { "type": "reference", "name": "GetFileOptions", "id": 1434 } } ], "type": { "type": "reference", "name": "Promise", "typeArguments": [ { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "name": "ArrayBuffer" } ] } ] } } ], "sources": [ { "fileName": "auth/userSession.ts", "line": 310, "character": 9 } ] }, { "id": 1609, "name": "getFileUrl", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 1610, "name": "getFileUrl", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Get the URL for reading a file from an app's data store.", "returns": "that resolves to the URL or rejects with an error\n" }, "parameters": [ { "id": 1611, "name": "path", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the path to the file to read\n" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1612, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "name": "GetFileUrlOptions", "id": 1430 } } ], "type": { "type": "reference", "name": "Promise", "typeArguments": [ { "type": "intrinsic", "name": "string" } ] } } ], "sources": [ { "fileName": "auth/userSession.ts", "line": 321, "character": 12 } ] }, { "id": 1625, "name": "getOrSetLocalGaiaHubConnection", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 1626, "name": "getOrSetLocalGaiaHubConnection", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": " @ignore" }, "type": { "type": "reference", "name": "Promise", "typeArguments": [ { "type": "reference", "name": "GaiaHubConfig", "id": 784 } ] } } ], "sources": [ { "fileName": "auth/userSession.ts", "line": 353, "character": 32 } ] }, { "id": 1580, "name": "handlePendingSignIn", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 1581, "name": "handlePendingSignIn", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Try to process any pending sign in request by returning a `Promise` that resolves\nto the user data object if the sign in succeeds.", "returns": "that resolves to the user data object if successful and rejects\nif handling the sign in request fails or there was no pending sign in request.\n" }, "parameters": [ { "id": 1582, "name": "authResponseToken", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the signed authentication response token" }, "type": { "type": "intrinsic", "name": "string" }, "defaultValue": " this.getAuthResponseToken()" } ], "type": { "type": "reference", "name": "Promise", "typeArguments": [ { "type": "reference", "name": "UserData", "id": 1680 } ] } } ], "sources": [ { "fileName": "auth/userSession.ts", "line": 232, "character": 21 } ] }, { "id": 1576, "name": "isSignInPending", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 1577, "name": "isSignInPending", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Check if there is a authentication request that hasn't been handled.", "tags": [ { "tag": "returns{boolean}", "text": "`true` if there is a pending sign in, otherwise `false`\n" } ] }, "type": { "type": "intrinsic", "name": "boolean" } } ], "sources": [ { "fileName": "auth/userSession.ts", "line": 211, "character": 17 } ] }, { "id": 1578, "name": "isUserSignedIn", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 1579, "name": "isUserSignedIn", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Check if a user is currently signed in.", "returns": "`true` if the user is signed in, `false` if not.\n" }, "type": { "type": "intrinsic", "name": "boolean" } } ], "sources": [ { "fileName": "auth/userSession.ts", "line": 220, "character": 16 } ] }, { "id": 1613, "name": "listFiles", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 1614, "name": "listFiles", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "List the set of files in this application's Gaia storage bucket.", "returns": "that resolves to the number of files listed\n" }, "parameters": [ { "id": 1615, "name": "callback", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "a callback to invoke on each named file that\nreturns `true` to continue the listing operation or `false` to end it\n" }, "type": { "type": "reflection", "declaration": { "id": 1616, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 1617, "name": "__call", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 1618, "name": "name", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "sources": [ { "fileName": "auth/userSession.ts", "line": 333, "character": 21 } ] } } } ], "type": { "type": "reference", "name": "Promise", "typeArguments": [ { "type": "intrinsic", "name": "number" } ] } } ], "sources": [ { "fileName": "auth/userSession.ts", "line": 333, "character": 11 } ] }, { "id": 1583, "name": "loadUserData", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 1584, "name": "loadUserData", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Retrieves the user data object. The user's profile is stored in the key [[Profile]].", "returns": "User data object.\n" }, "type": { "type": "reference", "name": "UserData", "id": 1680 } } ], "sources": [ { "fileName": "auth/userSession.ts", "line": 243, "character": 14 } ] }, { "id": 1563, "name": "makeAuthRequest", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 1564, "name": "makeAuthRequest", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Generates an authentication request that can be sent to the Blockstack\nbrowser for the user to approve sign in. This authentication request can\nthen be used for sign in by passing it to the [[redirectToSignInWithAuthRequest]]\nmethod.", "text": "*Note*: This method should only be used if you want to use a customized authentication\nflow. Typically, you'd use [[redirectToSignIn]] which is the default sign in method.\n", "returns": "the authentication request\n" }, "parameters": [ { "id": 1565, "name": "transitKey", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "text": "A HEX encoded transit private key." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1566, "name": "redirectURI", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "text": "Location to redirect the user to after sign in approval." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1567, "name": "manifestURI", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "text": "Location of this app's manifest file." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1568, "name": "scopes", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "text": "The permissions this app is requesting. The default is `store_write`." }, "type": { "type": "reference", "name": "Array", "typeArguments": [ { "type": "union", "types": [ { "type": "reference", "name": "AuthScope", "id": 1 }, { "type": "intrinsic", "name": "string" } ] } ] } }, { "id": 1569, "name": "appDomain", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "text": "The origin of the app." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1570, "name": "expiresAt", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "The time at which this request is no longer valid." }, "type": { "type": "intrinsic", "name": "number" }, "defaultValue": " nextHour().getTime()" }, { "id": 1571, "name": "extraParams", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "Any extra parameters to pass to the authenticator. Use this to\npass options that aren't part of the Blockstack authentication specification,\nbut might be supported by special authenticators.\n" }, "type": { "type": "intrinsic", "name": "any" }, "defaultValue": " {}" } ], "type": { "type": "intrinsic", "name": "string" } } ], "sources": [ { "fileName": "auth/userSession.ts", "line": 158, "character": 17 } ] }, { "id": 1600, "name": "putFile", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 1601, "name": "putFile", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Stores the data provided in the app's data store to to the file specified.", "returns": "that resolves if the operation succeed and rejects\nif it failed\n" }, "parameters": [ { "id": 1602, "name": "path", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the path to store the data in" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1603, "name": "content", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the data to store in the file" }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "name": "Buffer" } ] } }, { "id": 1604, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "text": "a [[PutFileOptions]] object\n" }, "type": { "type": "reference", "name": "PutFileOptions", "id": 1426 } } ], "type": { "type": "reference", "name": "Promise", "typeArguments": [ { "type": "intrinsic", "name": "string" } ] } } ], "sources": [ { "fileName": "auth/userSession.ts", "line": 297, "character": 9 } ] }, { "id": 1554, "name": "redirectToSignIn", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 1555, "name": "redirectToSignIn", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Generates an authentication request and redirects the user to the Blockstack\nbrowser to approve the sign in request.", "text": "Please note that this requires that the web browser properly handles the\n`blockstack:` URL protocol handler.\n\nMost applications should use this\nmethod for sign in unless they require more fine grained control over how the\nauthentication request is generated. If your app falls into this category,\nuse [[generateAndStoreTransitKey]], [[makeAuthRequest]],\nand [[redirectToSignInWithAuthRequest]] to build your own sign in process.\n", "returns": "\n" }, "parameters": [ { "id": 1556, "name": "redirectURI", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "text": "Location of your application." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1557, "name": "manifestURI", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "text": "Location of the manifest.json file" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1558, "name": "scopes", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "text": "Permissions requested by the application. Possible values are\n `store_write` (default) or `publish_data`.\n" }, "type": { "type": "reference", "name": "Array", "typeArguments": [ { "type": "union", "types": [ { "type": "reference", "name": "AuthScope", "id": 1 }, { "type": "intrinsic", "name": "string" } ] } ] } } ], "type": { "type": "intrinsic", "name": "void" } } ], "sources": [ { "fileName": "auth/userSession.ts", "line": 104, "character": 18 } ] }, { "id": 1559, "name": "redirectToSignInWithAuthRequest", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 1560, "name": "redirectToSignInWithAuthRequest", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Redirects the user to the Blockstack browser to approve the sign in request.\nTo construct a request see the [[makeAuthRequest]] function.", "text": "The user is redirected to the authenticator URL specified in the `AppConfig`\nif the `blockstack:` protocol handler is not detected.\nPlease note that the protocol handler detection does not work on all browsers.\n" }, "parameters": [ { "id": 1561, "name": "authRequest", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "text": "A request string built by the [[makeAuthRequest]] function" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1562, "name": "blockstackIDHost", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "text": "The ID of the Blockstack Browser application.\n\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "void" } } ], "sources": [ { "fileName": "auth/userSession.ts", "line": 127, "character": 33 } ] }, { "id": 1627, "name": "setLocalGaiaHubConnection", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true, "isExported": true }, "signatures": [ { "id": 1628, "name": "setLocalGaiaHubConnection", "kind": 4096, "kindString": "Call signature", "flags": { "isPrivate": true }, "comment": { "shortText": "These two functions are app-specific connections to gaia hub,\n they read the user data object for information on setting up\n a hub connection, and store the hub config to localstorage", "returns": "that resolves to the new gaia hub connection\n" }, "type": { "type": "reference", "name": "Promise", "typeArguments": [ { "type": "reference", "name": "GaiaHubConfig", "id": 784 } ] } } ], "sources": [ { "fileName": "auth/userSession.ts", "line": 373, "character": 33 } ] }, { "id": 1585, "name": "signUserOut", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 1586, "name": "signUserOut", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Sign the user out and optionally redirect to given location." }, "parameters": [ { "id": 1587, "name": "redirectURL", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "text": "Location to redirect user to after sign out.\nOnly used in environments with `window` available\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "void" } } ], "sources": [ { "fileName": "auth/userSession.ts", "line": 257, "character": 13 } ] } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [ 1547 ] }, { "title": "Properties", "kind": 1024, "children": [ 1545, 1546 ] }, { "title": "Methods", "kind": 2048, "children": [ 1594, 1619, 1588, 1572, 1574, 1605, 1609, 1625, 1580, 1576, 1578, 1613, 1583, 1563, 1600, 1554, 1559, 1627, 1585 ] } ], "sources": [ { "fileName": "auth/userSession.ts", "line": 39, "character": 24 } ] }, { "id": 784, "name": "GaiaHubConfig", "kind": 256, "kindString": "Interface", "flags": { "isExported": true }, "comment": { "shortText": "The configuration for the user's Gaia storage provider." }, "children": [ { "id": 785, "name": "address", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "storage/hub.ts", "line": 22, "character": 9 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 788, "name": "server", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "storage/hub.ts", "line": 25, "character": 8 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 787, "name": "token", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "storage/hub.ts", "line": 24, "character": 7 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 786, "name": "url_prefix", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "storage/hub.ts", "line": 23, "character": 12 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [ 785, 788, 787, 786 ] } ], "sources": [ { "fileName": "storage/hub.ts", "line": 21, "character": 30 } ] }, { "id": 1434, "name": "GetFileOptions", "kind": 256, "kindString": "Interface", "flags": { "isExported": true }, "comment": { "shortText": "Used to pass options to [[UserSession.getFile]]" }, "children": [ { "id": 1438, "name": "app", "kind": 1024, "kindString": "Property", "flags": { "isExported": true, "isOptional": true }, "comment": { "shortText": "The app to lookup for multi-player storage - defaults to current origin.", "tags": [ { "tag": "default", "text": "`window.location.origin`\nOnly if available in the executing environment, otherwise `undefined`.\n" } ] }, "sources": [ { "fileName": "storage/index.ts", "line": 393, "character": 5 } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "name": "GetFileUrlOptions.app", "id": 1432 } }, { "id": 1435, "name": "decrypt", "kind": 1024, "kindString": "Property", "flags": { "isExported": true, "isOptional": true }, "comment": { "shortText": "Try to decrypt the data with the app private key.", "tags": [ { "tag": "default", "text": "true\n" } ] }, "sources": [ { "fileName": "storage/index.ts", "line": 409, "character": 9 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 1437, "name": "username", "kind": 1024, "kindString": "Property", "flags": { "isExported": true, "isOptional": true }, "comment": { "shortText": "The Blockstack ID to lookup for multi-player storage.\nIf not specified, the currently signed in username is used." }, "sources": [ { "fileName": "storage/index.ts", "line": 387, "character": 10 } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "name": "GetFileUrlOptions.username", "id": 1431 } }, { "id": 1436, "name": "verify", "kind": 1024, "kindString": "Property", "flags": { "isExported": true, "isOptional": true }, "comment": { "shortText": "Whether the content should be verified, only to be used\nwhen [[UserSession.putFile]] was set to `sign = true`.", "tags": [ { "tag": "default", "text": "false\n" } ] }, "sources": [ { "fileName": "storage/index.ts", "line": 415, "character": 8 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 1439, "name": "zoneFileLookupURL", "kind": 1024, "kindString": "Property", "flags": { "isExported": true, "isOptional": true }, "comment": { "shortText": "The URL to use for zonefile lookup. If falsey, this will use\nthe blockstack.js's [[getNameInfo]] function instead." }, "sources": [ { "fileName": "storage/index.ts", "line": 398, "character": 19 } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "name": "GetFileUrlOptions.zoneFileLookupURL", "id": 1433 } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [ 1438, 1435, 1437, 1436, 1439 ] } ], "sources": [ { "fileName": "storage/index.ts", "line": 404, "character": 31 } ], "extendedTypes": [ { "type": "reference", "name": "GetFileUrlOptions", "id": 1430 } ] }, { "id": 1430, "name": "GetFileUrlOptions", "kind": 256, "kindString": "Interface", "flags": { "isExported": true }, "children": [ { "id": 1432, "name": "app", "kind": 1024, "kindString": "Property", "flags": { "isExported": true, "isOptional": true }, "comment": { "shortText": "The app to lookup for multi-player storage - defaults to current origin.", "tags": [ { "tag": "default", "text": "`window.location.origin`\nOnly if available in the executing environment, otherwise `undefined`.\n" } ] }, "sources": [ { "fileName": "storage/index.ts", "line": 393, "character": 5 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1431, "name": "username", "kind": 1024, "kindString": "Property", "flags": { "isExported": true, "isOptional": true }, "comment": { "shortText": "The Blockstack ID to lookup for multi-player storage.\nIf not specified, the currently signed in username is used." }, "sources": [ { "fileName": "storage/index.ts", "line": 387, "character": 10 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1433, "name": "zoneFileLookupURL", "kind": 1024, "kindString": "Property", "flags": { "isExported": true, "isOptional": true }, "comment": { "shortText": "The URL to use for zonefile lookup. If falsey, this will use\nthe blockstack.js's [[getNameInfo]] function instead." }, "sources": [ { "fileName": "storage/index.ts", "line": 398, "character": 19 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [ 1432, 1431, 1433 ] } ], "sources": [ { "fileName": "storage/index.ts", "line": 382, "character": 34 } ], "extendedBy": [ { "type": "reference", "name": "GetFileOptions", "id": 1434 } ] }, { "id": 584, "name": "GetGlobalObjectOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 587, "name": "returnEmptyObject", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "If the object is not found, return an new empty object instead of undefined.\nRequires [[throwIfUnavailable]] to be falsey.", "tags": [ { "tag": "default", "text": "false\n" } ] }, "sources": [ { "fileName": "utils.ts", "line": 244, "character": 19 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 585, "name": "throwIfUnavailable", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Throw an error if the object is not found.", "tags": [ { "tag": "default", "text": "false\n" } ] }, "sources": [ { "fileName": "utils.ts", "line": 234, "character": 20 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 586, "name": "usageDesc", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Additional information to include in an error if thrown." }, "sources": [ { "fileName": "utils.ts", "line": 238, "character": 11 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [ 587, 585, 586 ] } ], "sources": [ { "fileName": "utils.ts", "line": 229, "character": 32 } ] }, { "id": 1426, "name": "PutFileOptions", "kind": 256, "kindString": "Interface", "flags": { "isExported": true }, "comment": { "shortText": "Specify a valid MIME type, encryption, and whether to sign the [[UserSession.putFile]]." }, "children": [ { "id": 1429, "name": "contentType", "kind": 1024, "kindString": "Property", "flags": { "isExported": true, "isOptional": true }, "comment": { "shortText": "Set a Content-Type header for unencrypted data." }, "sources": [ { "fileName": "storage/index.ts", "line": 46, "character": 13 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1427, "name": "encrypt", "kind": 1024, "kindString": "Property", "flags": { "isExported": true, "isOptional": true }, "comment": { "shortText": "Encrypt the data with the app public key.\nIf a string is specified, it is used as the public key.\nIf the boolean `true` is specified then the current user's app public key is used.", "tags": [ { "tag": "default", "text": "true\n" } ] }, "sources": [ { "fileName": "storage/index.ts", "line": 36, "character": 9 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "boolean" }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 1428, "name": "sign", "kind": 1024, "kindString": "Property", "flags": { "isExported": true, "isOptional": true }, "comment": { "shortText": "Sign the data using ECDSA on SHA256 hashes with the user's app private key.\nIf a string is specified, it is used as the private key.", "tags": [ { "tag": "default", "text": "false\n" } ] }, "sources": [ { "fileName": "storage/index.ts", "line": 42, "character": 6 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "boolean" }, { "type": "intrinsic", "name": "string" } ] } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [ 1429, 1427, 1428 ] } ], "sources": [ { "fileName": "storage/index.ts", "line": 29, "character": 31 } ] }, { "id": 823, "name": "SessionOptions", "kind": 256, "kindString": "Interface", "flags": { "isExported": true }, "children": [ { "id": 824, "name": "appPrivateKey", "kind": 1024, "kindString": "Property", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "auth/sessionData.ts", "line": 9, "character": 15 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 827, "name": "coreNode", "kind": 1024, "kindString": "Property", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "auth/sessionData.ts", "line": 12, "character": 10 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 828, "name": "hubUrl", "kind": 1024, "kindString": "Property", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "auth/sessionData.ts", "line": 13, "character": 8 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 826, "name": "identityAddress", "kind": 1024, "kindString": "Property", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "auth/sessionData.ts", "line": 11, "character": 17 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 831, "name": "localStorageKey", "kind": 1024, "kindString": "Property", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "auth/sessionData.ts", "line": 16, "character": 17 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 832, "name": "storeOptions", "kind": 1024, "kindString": "Property", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "auth/sessionData.ts", "line": 17, "character": 14 } ], "type": { "type": "reflection", "declaration": { "id": 833, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 834, "name": "localStorageKey", "kind": 32, "kindString": "Variable", "flags": { "isOptional": true }, "sources": [ { "fileName": "auth/sessionData.ts", "line": 18, "character": 19 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 834 ] } ], "sources": [ { "fileName": "auth/sessionData.ts", "line": 17, "character": 16 } ] } } }, { "id": 830, "name": "transitKey", "kind": 1024, "kindString": "Property", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "auth/sessionData.ts", "line": 15, "character": 12 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 829, "name": "userData", "kind": 1024, "kindString": "Property", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "auth/sessionData.ts", "line": 14, "character": 10 } ], "type": { "type": "reference", "name": "UserData", "id": 1680 } }, { "id": 825, "name": "username", "kind": 1024, "kindString": "Property", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "auth/sessionData.ts", "line": 10, "character": 10 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [ 824, 827, 828, 826, 831, 832, 830, 829, 825 ] } ], "sources": [ { "fileName": "auth/sessionData.ts", "line": 8, "character": 31 } ] }, { "id": 1680, "name": "UserData", "kind": 256, "kindString": "Interface", "flags": { "isExported": true }, "comment": { "shortText": " Returned from the [[UserSession.loadUserData]] function." }, "children": [ { "id": 1685, "name": "appPrivateKey", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "auth/authApp.ts", "line": 53, "character": 15 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1687, "name": "authResponseToken", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "auth/authApp.ts", "line": 58, "character": 19 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1688, "name": "coreSessionToken", "kind": 1024, "kindString": "Property", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "auth/authApp.ts", "line": 60, "character": 18 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1683, "name": "decentralizedID", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "auth/authApp.ts", "line": 46, "character": 17 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1682, "name": "email", "kind": 1024, "kindString": "Property", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "auth/authApp.ts", "line": 43, "character": 7 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1689, "name": "gaiaAssociationToken", "kind": 1024, "kindString": "Property", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "auth/authApp.ts", "line": 62, "character": 22 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1691, "name": "gaiaHubConfig", "kind": 1024, "kindString": "Property", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "auth/authApp.ts", "line": 67, "character": 15 } ], "type": { "type": "reference", "name": "GaiaHubConfig", "id": 784 } }, { "id": 1686, "name": "hubUrl", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "auth/authApp.ts", "line": 56, "character": 8 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1684, "name": "identityAddress", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "auth/authApp.ts", "line": 49, "character": 17 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1690, "name": "profile", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "auth/authApp.ts", "line": 65, "character": 9 } ], "type": { "type": "intrinsic", "name": "any" } }, { "id": 1681, "name": "username", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "auth/authApp.ts", "line": 36, "character": 10 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [ 1685, 1687, 1688, 1683, 1682, 1689, 1691, 1686, 1684, 1690, 1681 ] } ], "sources": [ { "fileName": "auth/authApp.ts", "line": 34, "character": 25 } ] }, { "id": 1097, "name": "ValidateProofService", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 1112, "name": "getProofIdentity", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { "id": 1113, "name": "getProofIdentity", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 1114, "name": "searchText", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } ], "sources": [ { "fileName": "profiles/services/index.ts", "line": 14, "character": 18 } ] }, { "id": 1106, "name": "getProofStatement", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { "id": 1107, "name": "getProofStatement", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 1108, "name": "searchText", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } ], "sources": [ { "fileName": "profiles/services/index.ts", "line": 12, "character": 19 } ] }, { "id": 1103, "name": "getProofUrl", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { "id": 1104, "name": "getProofUrl", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 1105, "name": "proof", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "intrinsic", "name": "string" } } ], "sources": [ { "fileName": "profiles/services/index.ts", "line": 11, "character": 13 } ] }, { "id": 1109, "name": "normalizeUrl", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { "id": 1110, "name": "normalizeUrl", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 1111, "name": "proof", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "intrinsic", "name": "string" } } ], "sources": [ { "fileName": "profiles/services/index.ts", "line": 13, "character": 14 } ] }, { "id": 1098, "name": "validateProof", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { "id": 1099, "name": "validateProof", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 1100, "name": "proof", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "any" } }, { "id": 1101, "name": "ownerAddress", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1102, "name": "name", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "name": "Promise", "typeArguments": [ { "type": "intrinsic", "name": "any" } ] } } ], "sources": [ { "fileName": "profiles/services/index.ts", "line": 10, "character": 15 } ] } ], "groups": [ { "title": "Methods", "kind": 2048, "children": [ 1112, 1106, 1103, 1109, 1098 ] } ], "sources": [ { "fileName": "profiles/services/index.ts", "line": 9, "character": 30 } ] }, { "id": 1963, "name": "AmountType", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "operations/skeletons.ts", "line": 13, "character": 15 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "AmountTypeV1", "id": 1958 }, { "type": "reference", "name": "AmountTypeV2", "id": 1959 } ] } }, { "id": 1958, "name": "AmountTypeV1", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "operations/skeletons.ts", "line": 11, "character": 17 } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 1959, "name": "AmountTypeV2", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "operations/skeletons.ts", "line": 12, "character": 17 } ], "type": { "type": "reflection", "declaration": { "id": 1960, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 1962, "name": "amount", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "operations/skeletons.ts", "line": 12, "character": 43 } ], "type": { "type": "reference", "name": "BN" } }, { "id": 1961, "name": "units", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "operations/skeletons.ts", "line": 12, "character": 27 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 1962, 1961 ] } ], "sources": [ { "fileName": "operations/skeletons.ts", "line": 12, "character": 19 } ] } } }, { "id": 1630, "name": "AuthMetadata", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "auth/authMessages.ts", "line": 17, "character": 17 } ], "type": { "type": "reflection", "declaration": { "id": 1631, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 1632, "name": "email", "kind": 32, "kindString": "Variable", "flags": { "isOptional": true }, "sources": [ { "fileName": "auth/authMessages.ts", "line": 18, "character": 7 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1633, "name": "profileUrl", "kind": 32, "kindString": "Variable", "flags": { "isOptional": true }, "sources": [ { "fileName": "auth/authMessages.ts", "line": 19, "character": 12 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 1632, 1633 ] } ], "sources": [ { "fileName": "auth/authMessages.ts", "line": 17, "character": 19 } ] } } }, { "id": 1874, "name": "txPoint", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "operations/utils.ts", "line": 43, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 1875, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 1876, "name": "script", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "operations/utils.ts", "line": 44, "character": 8 } ], "type": { "type": "reflection", "declaration": { "id": 1877, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 1878, "name": "length", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "operations/utils.ts", "line": 44, "character": 18 } ], "type": { "type": "intrinsic", "name": "number" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 1878 ] } ], "sources": [ { "fileName": "operations/utils.ts", "line": 44, "character": 9 } ] } } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 1876 ] } ], "sources": [ { "fileName": "operations/utils.ts", "line": 43, "character": 14 } ] } } }, { "id": 2378, "name": "APPS_NODE_INDEX", "kind": 32, "kindString": "Variable", "flags": { "isConst": true }, "sources": [ { "fileName": "wallet.ts", "line": 7, "character": 21 } ], "type": { "type": "unknown", "name": "0" }, "defaultValue": "0" }, { "id": 1668, "name": "AUTH_CONTINUATION_PARAM", "kind": 32, "kindString": "Variable", "flags": { "isConst": true }, "sources": [ { "fileName": "auth/protocolEchoDetection.ts", "line": 10, "character": 29 } ], "type": { "type": "stringLiteral", "value": "authContinuation" }, "defaultValue": "\"authContinuation\"" }, { "id": 2383, "name": "BITCOIN_ACCOUNT_INDEX", "kind": 32, "kindString": "Variable", "flags": { "isConst": true }, "sources": [ { "fileName": "wallet.ts", "line": 13, "character": 27 } ], "type": { "type": "unknown", "name": "0" }, "defaultValue": "0" }, { "id": 2381, "name": "BITCOIN_BIP_44_PURPOSE", "kind": 32, "kindString": "Variable", "flags": { "isConst": true }, "sources": [ { "fileName": "wallet.ts", "line": 11, "character": 28 } ], "type": { "type": "unknown", "name": "44" }, "defaultValue": "44" }, { "id": 2382, "name": "BITCOIN_COIN_TYPE", "kind": 32, "kindString": "Variable", "flags": { "isConst": true }, "sources": [ { "fileName": "wallet.ts", "line": 12, "character": 23 } ], "type": { "type": "unknown", "name": "0" }, "defaultValue": "0" }, { "id": 2380, "name": "BLOCKSTACK_ON_BITCOIN", "kind": 32, "kindString": "Variable", "flags": { "isConst": true }, "sources": [ { "fileName": "wallet.ts", "line": 9, "character": 27 } ], "type": { "type": "unknown", "name": "0" }, "defaultValue": "0" }, { "id": 2385, "name": "CHANGE_ADDRESS", "kind": 32, "kindString": "Variable", "flags": { "isConst": true }, "sources": [ { "fileName": "wallet.ts", "line": 16, "character": 20 } ], "type": { "type": "stringLiteral", "value": "CHANGE_ADDRESS" }, "defaultValue": "\"CHANGE_ADDRESS\"" }, { "id": 7, "name": "DEFAULT_BLOCKSTACK_HOST", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isConst": true }, "comment": { "shortText": "This constant is used in the [[redirectToSignInWithAuthRequest]]" }, "sources": [ { "fileName": "auth/authConstants.ts", "line": 13, "character": 36 } ], "type": { "type": "stringLiteral", "value": "https://browser.blockstack.org/auth" }, "defaultValue": "\"https://browser.blockstack.org/auth\"" }, { "id": 1667, "name": "ECHO_REPLY_PARAM", "kind": 32, "kindString": "Variable", "flags": { "isConst": true }, "sources": [ { "fileName": "auth/protocolEchoDetection.ts", "line": 9, "character": 22 } ], "type": { "type": "stringLiteral", "value": "echoReply" }, "defaultValue": "\"echoReply\"" }, { "id": 2384, "name": "EXTERNAL_ADDRESS", "kind": 32, "kindString": "Variable", "flags": { "isConst": true }, "sources": [ { "fileName": "wallet.ts", "line": 15, "character": 22 } ], "type": { "type": "stringLiteral", "value": "EXTERNAL_ADDRESS" }, "defaultValue": "\"EXTERNAL_ADDRESS\"" }, { "id": 1666, "name": "GLOBAL_DETECTION_CACHE_KEY", "kind": 32, "kindString": "Variable", "flags": { "isConst": true }, "comment": { "shortText": "This logic is in a separate file with no dependencies so that it can be\nloaded and executed as soon as possible to fulfill the purpose of the protocol\ndetection technique. The effectiveness of this is obviously subject to how web\napps bundle/consume the blockstack.js lib." }, "sources": [ { "fileName": "auth/protocolEchoDetection.ts", "line": 8, "character": 32 } ], "type": { "type": "stringLiteral", "value": "_blockstackDidCheckEchoReply" }, "defaultValue": "\"_blockstackDidCheckEchoReply\"" }, { "id": 2379, "name": "IDENTITY_KEYCHAIN", "kind": 32, "kindString": "Variable", "flags": { "isConst": true }, "sources": [ { "fileName": "wallet.ts", "line": 8, "character": 23 } ], "type": { "type": "unknown", "name": "888" }, "defaultValue": "888" }, { "id": 563, "name": "SATOSHIS_PER_BTC", "kind": 32, "kindString": "Variable", "flags": { "isConst": true }, "sources": [ { "fileName": "network.ts", "line": 20, "character": 22 } ], "type": { "type": "unknown", "name": "100000000" }, "defaultValue": "100000000" }, { "id": 857, "name": "SESSION_VERSION", "kind": 32, "kindString": "Variable", "flags": { "isConst": true }, "sources": [ { "fileName": "auth/sessionData.ts", "line": 6, "character": 21 } ], "type": { "type": "stringLiteral", "value": "1.0.0" }, "defaultValue": "\"1.0.0\"" }, { "id": 1440, "name": "SIGNATURE_FILE_SUFFIX", "kind": 32, "kindString": "Variable", "flags": { "isConst": true }, "sources": [ { "fileName": "storage/index.ts", "line": 49, "character": 27 } ], "type": { "type": "stringLiteral", "value": ".sig" }, "defaultValue": "\".sig\"" }, { "id": 565, "name": "TX_BROADCAST_SERVICE_REGISTRATION_ENDPOINT", "kind": 32, "kindString": "Variable", "flags": { "isConst": true }, "sources": [ { "fileName": "network.ts", "line": 22, "character": 48 } ], "type": { "type": "stringLiteral", "value": "registration" }, "defaultValue": "\"registration\"" }, { "id": 566, "name": "TX_BROADCAST_SERVICE_TX_ENDPOINT", "kind": 32, "kindString": "Variable", "flags": { "isConst": true }, "sources": [ { "fileName": "network.ts", "line": 23, "character": 38 } ], "type": { "type": "stringLiteral", "value": "transaction" }, "defaultValue": "\"transaction\"" }, { "id": 564, "name": "TX_BROADCAST_SERVICE_ZONE_FILE_ENDPOINT", "kind": 32, "kindString": "Variable", "flags": { "isConst": true }, "sources": [ { "fileName": "network.ts", "line": 21, "character": 45 } ], "type": { "type": "stringLiteral", "value": "zone-file" }, "defaultValue": "\"zone-file\"" }, { "id": 1869, "name": "TX_EMPTY_SIZE", "kind": 32, "kindString": "Variable", "flags": { "isConst": true }, "sources": [ { "fileName": "operations/utils.ts", "line": 37, "character": 19 } ], "type": { "type": "intrinsic", "name": "number" }, "defaultValue": " 4 + 1 + 1 + 4" }, { "id": 1870, "name": "TX_INPUT_BASE", "kind": 32, "kindString": "Variable", "flags": { "isConst": true }, "sources": [ { "fileName": "operations/utils.ts", "line": 38, "character": 19 } ], "type": { "type": "intrinsic", "name": "number" }, "defaultValue": " 32 + 4 + 1 + 4" }, { "id": 1871, "name": "TX_INPUT_PUBKEYHASH", "kind": 32, "kindString": "Variable", "flags": { "isConst": true }, "sources": [ { "fileName": "operations/utils.ts", "line": 39, "character": 25 } ], "type": { "type": "unknown", "name": "107" }, "defaultValue": "107" }, { "id": 1872, "name": "TX_OUTPUT_BASE", "kind": 32, "kindString": "Variable", "flags": { "isConst": true }, "sources": [ { "fileName": "operations/utils.ts", "line": 40, "character": 20 } ], "type": { "type": "intrinsic", "name": "number" }, "defaultValue": " 8 + 1" }, { "id": 1873, "name": "TX_OUTPUT_PUBKEYHASH", "kind": 32, "kindString": "Variable", "flags": { "isConst": true }, "sources": [ { "fileName": "operations/utils.ts", "line": 41, "character": 26 } ], "type": { "type": "unknown", "name": "25" }, "defaultValue": "25" }, { "id": 1629, "name": "VERSION", "kind": 32, "kindString": "Variable", "flags": { "isConst": true }, "sources": [ { "fileName": "auth/authMessages.ts", "line": 15, "character": 13 } ], "type": { "type": "stringLiteral", "value": "1.3.1" }, "defaultValue": "\"1.3.1\"" }, { "id": 2037, "name": "dummyConsensusHash", "kind": 32, "kindString": "Variable", "flags": { "isConst": true }, "sources": [ { "fileName": "operations/txbuild.ts", "line": 24, "character": 24 } ], "type": { "type": "stringLiteral", "value": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" }, "defaultValue": "\"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\"" }, { "id": 2038, "name": "dummyZonefileHash", "kind": 32, "kindString": "Variable", "flags": { "isConst": true }, "sources": [ { "fileName": "operations/txbuild.ts", "line": 25, "character": 23 } ], "type": { "type": "stringLiteral", "value": "ffffffffffffffffffffffffffffffffffffffff" }, "defaultValue": "\"ffffffffffffffffffffffffffffffffffffffff\"" }, { "id": 726, "name": "ecurve", "kind": 32, "kindString": "Variable", "flags": { "isConst": true }, "sources": [ { "fileName": "encryption/ec.ts", "line": 7, "character": 12 } ], "type": { "type": "reference", "name": "ec" }, "defaultValue": " new EllipticCurve('secp256k1')" }, { "id": 191, "name": "intToLevel", "kind": 32, "kindString": "Variable", "flags": { "isConst": true }, "sources": [ { "fileName": "logger.ts", "line": 12, "character": 16 } ], "type": { "type": "reflection", "declaration": { "id": 192, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": [ { "id": 193, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 194, "name": "int", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "number" } } ], "type": { "type": "intrinsic", "name": "string" } } ], "sources": [ { "fileName": "logger.ts", "line": 12, "character": 17 } ] } } }, { "id": 187, "name": "levelToInt", "kind": 32, "kindString": "Variable", "flags": { "isConst": true }, "sources": [ { "fileName": "logger.ts", "line": 11, "character": 16 } ], "type": { "type": "reflection", "declaration": { "id": 188, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": [ { "id": 189, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 190, "name": "level", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "number" } } ], "sources": [ { "fileName": "logger.ts", "line": 11, "character": 17 } ] } } }, { "id": 186, "name": "levels", "kind": 32, "kindString": "Variable", "flags": { "isConst": true }, "sources": [ { "fileName": "logger.ts", "line": 3, "character": 12 } ], "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } }, "defaultValue": " [\n 'debug',\n 'info',\n 'warn',\n 'error',\n 'none'\n]" }, { "id": 1454, "name": "decryptContent", "kind": 64, "kindString": "Function", "flags": { "isExported": true }, "signatures": [ { "id": 1455, "name": "decryptContent", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "returns": "decrypted content.\n", "tags": [ { "tag": "deprecated", "text": "\n#### v19 Use [[UserSession.decryptContent]].\n\nDecrypts data encrypted with `encryptContent` with the\ntransit private key." } ] }, "parameters": [ { "id": 1456, "name": "content", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "encrypted content." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1457, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reflection", "declaration": { "id": 1458, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 1459, "name": "privateKey", "kind": 32, "kindString": "Variable", "flags": { "isOptional": true }, "comment": { "text": "the hex string of the ECDSA private\nkey to use for decryption. If not provided, will use user's appPrivateKey." }, "sources": [ { "fileName": "storage/index.ts", "line": 123, "character": 14 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 1459 ] } ], "sources": [ { "fileName": "storage/index.ts", "line": 122, "character": 11 } ] } } }, { "id": 1460, "name": "caller", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "name": "UserSession", "id": 1544 } } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "name": "Buffer" } ] } } ], "sources": [ { "fileName": "storage/index.ts", "line": 120, "character": 30 } ] }, { "id": 1515, "name": "deleteFile", "kind": 64, "kindString": "Function", "flags": { "isExported": true }, "signatures": [ { "id": 1516, "name": "deleteFile", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Deletes the specified file from the app's data store.", "returns": "Resolves when the file has been removed or rejects with an error.\n" }, "parameters": [ { "id": 1517, "name": "path", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "The path to the file to delete." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1518, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "text": "Optional options object." }, "type": { "type": "reflection", "declaration": { "id": 1519, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 1520, "name": "wasSigned", "kind": 32, "kindString": "Variable", "flags": { "isOptional": true }, "comment": { "text": "Set to true if the file was originally signed\nin order for the corresponding signature file to also be deleted." }, "sources": [ { "fileName": "storage/index.ts", "line": 586, "character": 13 } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 1520 ] } ], "sources": [ { "fileName": "storage/index.ts", "line": 585, "character": 11 } ] } } }, { "id": 1521, "name": "caller", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "name": "UserSession", "id": 1544 } } ], "type": { "type": "reference", "name": "Promise", "typeArguments": [ { "type": "intrinsic", "name": "void" } ] } } ], "sources": [ { "fileName": "storage/index.ts", "line": 583, "character": 32 } ] }, { "id": 796, "name": "deleteFromGaiaHub", "kind": 64, "kindString": "Function", "flags": { "isExported": true }, "signatures": [ { "id": 797, "name": "deleteFromGaiaHub", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 798, "name": "filename", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 799, "name": "hubConfig", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "name": "GaiaHubConfig", "id": 784 } } ], "type": { "type": "reference", "name": "Promise", "typeArguments": [ { "type": "intrinsic", "name": "void" } ] } } ], "sources": [ { "fileName": "storage/hub.ts", "line": 61, "character": 39 } ] }, { "id": 1447, "name": "encryptContent", "kind": 64, "kindString": "Function", "flags": { "isExported": true }, "signatures": [ { "id": 1448, "name": "encryptContent", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "returns": "Stringified ciphertext object\n", "tags": [ { "tag": "deprecated", "text": "\n#### v19 Use [[UserSession.encryptContent]].\n\nEncrypts the data provided with the app public key." } ] }, "parameters": [ { "id": 1449, "name": "content", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "data to encrypt" }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "name": "Buffer" } ] } }, { "id": 1450, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reflection", "declaration": { "id": 1451, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 1452, "name": "publicKey", "kind": 32, "kindString": "Variable", "flags": { "isOptional": true }, "comment": { "text": "the hex string of the ECDSA public\nkey to use for encryption. If not provided, will use user's appPublicKey." }, "sources": [ { "fileName": "storage/index.ts", "line": 94, "character": 13 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 1452 ] } ], "sources": [ { "fileName": "storage/index.ts", "line": 93, "character": 11 } ] } } }, { "id": 1453, "name": "caller", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "name": "UserSession", "id": 1544 } } ], "type": { "type": "intrinsic", "name": "string" } } ], "sources": [ { "fileName": "storage/index.ts", "line": 91, "character": 30 } ] }, { "id": 2125, "name": "estimateAnnounce", "kind": 64, "kindString": "Function", "flags": { "isPrivate": true }, "signatures": [ { "id": 2126, "name": "estimateAnnounce", "kind": 4096, "kindString": "Call signature", "flags": { "isPrivate": true }, "comment": { "shortText": "Estimates the cost of an announce transaction", "returns": "- a promise which resolves to the satoshi cost\n to fund this announce transaction" }, "parameters": [ { "id": 2127, "name": "messageHash", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the hash of the message" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2128, "name": "senderUtxos", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the number of utxos we expect will\n be required from the importer address" }, "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "1" } ], "type": { "type": "reference", "name": "Promise", "typeArguments": [ { "type": "intrinsic", "name": "number" } ] } } ], "sources": [ { "fileName": "operations/txbuild.ts", "line": 432, "character": 25 } ] }, { "id": 2119, "name": "estimateNameImport", "kind": 64, "kindString": "Function", "flags": { "isPrivate": true }, "signatures": [ { "id": 2120, "name": "estimateNameImport", "kind": 4096, "kindString": "Call signature", "flags": { "isPrivate": true }, "comment": { "shortText": "Estimates the cost of a name-import transaction", "returns": "- a promise which resolves to the satoshi cost\n to fund this name-import transaction" }, "parameters": [ { "id": 2121, "name": "name", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the fully-qualified name" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2122, "name": "recipientAddr", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the recipient" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2123, "name": "zonefileHash", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the zone file hash" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2124, "name": "importUtxos", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the number of UTXOs we expect will\n be required from the importer address" }, "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "1" } ], "type": { "type": "reference", "name": "Promise", "typeArguments": [ { "type": "intrinsic", "name": "number" } ] } } ], "sources": [ { "fileName": "operations/txbuild.ts", "line": 407, "character": 27 } ] }, { "id": 2103, "name": "estimateNamespacePreorder", "kind": 64, "kindString": "Function", "flags": { "isPrivate": true }, "signatures": [ { "id": 2104, "name": "estimateNamespacePreorder", "kind": 4096, "kindString": "Call signature", "flags": { "isPrivate": true }, "comment": { "shortText": "Estimates cost of a namespace preorder transaction for a namespace", "returns": "- a promise which resolves to the satoshi cost to fund\n the preorder. This includes a 5500 satoshi dust output for the preorder.\n Even though this is a change output, the payer must supply enough funds\n to generate this output, so we include it in the cost." }, "parameters": [ { "id": 2105, "name": "namespaceID", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the namespace to preorder" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2106, "name": "revealAddress", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the address to receive the namespace (this\n must be passed as the 'revealAddress' in the namespace-reveal transaction)" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2107, "name": "paymentAddress", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the address funding the preorder" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2108, "name": "paymentUtxos", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the number of UTXOs we expect will be required\n from the payment address." }, "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "1" } ], "type": { "type": "reference", "name": "Promise", "typeArguments": [ { "type": "intrinsic", "name": "number" } ] } } ], "sources": [ { "fileName": "operations/txbuild.ts", "line": 320, "character": 34 } ] }, { "id": 2115, "name": "estimateNamespaceReady", "kind": 64, "kindString": "Function", "flags": { "isPrivate": true }, "signatures": [ { "id": 2116, "name": "estimateNamespaceReady", "kind": 4096, "kindString": "Call signature", "flags": { "isPrivate": true }, "comment": { "shortText": "Estimates the cost of a namespace-ready transaction for a namespace", "returns": "- a promise which resolves to the satoshi cost to\n fund this namespacey-ready transaction." }, "parameters": [ { "id": 2117, "name": "namespaceID", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the namespace to ready" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2118, "name": "revealUtxos", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the number of UTXOs we expect will\n be required from the reveal address" }, "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "1" } ], "type": { "type": "reference", "name": "Promise", "typeArguments": [ { "type": "intrinsic", "name": "number" } ] } } ], "sources": [ { "fileName": "operations/txbuild.ts", "line": 382, "character": 31 } ] }, { "id": 2109, "name": "estimateNamespaceReveal", "kind": 64, "kindString": "Function", "flags": { "isPrivate": true }, "signatures": [ { "id": 2110, "name": "estimateNamespaceReveal", "kind": 4096, "kindString": "Call signature", "flags": { "isPrivate": true }, "comment": { "shortText": "Estimates cost of a namesapce reveal transaction for a namespace", "returns": "- a promise which resolves to the satoshi cost to\n fund the reveal. This includes a 5500 satoshi dust output for the\n preorder. Even though this is a change output, the payer must have\n enough funds to generate this output, so we include it in the cost." }, "parameters": [ { "id": 2111, "name": "namespace", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the namespace to reveal" }, "type": { "type": "reference", "name": "BlockstackNamespace" } }, { "id": 2112, "name": "revealAddress", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the address to receive the namespace\n (this must have been passed as 'revealAddress' to a prior namespace\n preorder)" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2113, "name": "paymentAddress", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the address that pays for this transaction" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2114, "name": "paymentUtxos", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the number of UTXOs we expect will be required\n from the payment address" }, "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "1" } ], "type": { "type": "reference", "name": "Promise", "typeArguments": [ { "type": "intrinsic", "name": "number" } ] } } ], "sources": [ { "fileName": "operations/txbuild.ts", "line": 356, "character": 32 } ] }, { "id": 2063, "name": "estimatePreorder", "kind": 64, "kindString": "Function", "flags": { "isPrivate": true }, "signatures": [ { "id": 2064, "name": "estimatePreorder", "kind": 4096, "kindString": "Call signature", "flags": { "isPrivate": true }, "comment": { "shortText": "Estimates cost of a preorder transaction for a domain name.", "returns": "- a promise which resolves to the satoshi cost to fund\n the preorder. This includes a 5500 satoshi dust output for the preorder.\n Even though this is a change output, the payer must supply enough funds\n to generate this output, so we include it in the cost." }, "parameters": [ { "id": 2065, "name": "fullyQualifiedName", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the name to preorder" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2066, "name": "destinationAddress", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the address to receive the name (this\n must be passed as the 'registrationAddress' in the register transaction)" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2067, "name": "paymentAddress", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the address funding the preorder" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2068, "name": "paymentUtxos", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the number of UTXOs we expect will be required\n from the payment address." }, "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "1" } ], "type": { "type": "reference", "name": "Promise", "typeArguments": [ { "type": "intrinsic", "name": "number" } ] } } ], "sources": [ { "fileName": "operations/txbuild.ts", "line": 108, "character": 25 } ] }, { "id": 2069, "name": "estimateRegister", "kind": 64, "kindString": "Function", "flags": { "isPrivate": true }, "signatures": [ { "id": 2070, "name": "estimateRegister", "kind": 4096, "kindString": "Call signature", "flags": { "isPrivate": true }, "comment": { "shortText": "Estimates cost of a register transaction for a domain name.", "returns": "- a promise which resolves to the satoshi cost to fund\n the register." }, "parameters": [ { "id": 2071, "name": "fullyQualifiedName", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the name to register" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2072, "name": "registerAddress", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the address to receive the name" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2073, "name": "paymentAddress", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the address funding the register" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2074, "name": "includingZonefile", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "whether or not we will broadcast\n a zonefile hash as part of the register" }, "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "false" }, { "id": 2075, "name": "paymentUtxos", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the number of UTXOs we expect will be required\n from the payment address." }, "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "1" } ], "type": { "type": "reference", "name": "Promise", "typeArguments": [ { "type": "intrinsic", "name": "number" } ] } } ], "sources": [ { "fileName": "operations/txbuild.ts", "line": 142, "character": 25 } ] }, { "id": 2089, "name": "estimateRenewal", "kind": 64, "kindString": "Function", "flags": { "isPrivate": true }, "signatures": [ { "id": 2090, "name": "estimateRenewal", "kind": 4096, "kindString": "Call signature", "flags": { "isPrivate": true }, "comment": { "shortText": "Estimates cost of an transfer transaction for a domain name.", "returns": "- a promise which resolves to the satoshi cost to fund\n the transfer." }, "parameters": [ { "id": 2091, "name": "fullyQualifiedName", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the name to renew" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2092, "name": "destinationAddress", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the next owner of the name" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2093, "name": "ownerAddress", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the current owner of the name" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2094, "name": "paymentAddress", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the address funding the transfer" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2095, "name": "includingZonefile", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "whether or not we will broadcast a zonefile hash\nin the renewal operation" }, "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "false" }, { "id": 2096, "name": "paymentUtxos", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the number of UTXOs we expect will be required\n from the payment address." }, "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "1" } ], "type": { "type": "reference", "name": "Promise", "typeArguments": [ { "type": "intrinsic", "name": "number" } ] } } ], "sources": [ { "fileName": "operations/txbuild.ts", "line": 247, "character": 24 } ] }, { "id": 2097, "name": "estimateRevoke", "kind": 64, "kindString": "Function", "flags": { "isPrivate": true }, "signatures": [ { "id": 2098, "name": "estimateRevoke", "kind": 4096, "kindString": "Call signature", "flags": { "isPrivate": true }, "comment": { "shortText": "Estimates cost of a revoke transaction for a domain name.", "returns": "- a promise which resolves to the satoshi cost to fund the\n revoke." }, "parameters": [ { "id": 2099, "name": "fullyQualifiedName", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the name to revoke" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2100, "name": "ownerAddress", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the current owner of the name" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2101, "name": "paymentAddress", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the address funding the revoke" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2102, "name": "paymentUtxos", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the number of UTXOs we expect will be required\n from the payment address." }, "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "1" } ], "type": { "type": "reference", "name": "Promise", "typeArguments": [ { "type": "intrinsic", "name": "number" } ] } } ], "sources": [ { "fileName": "operations/txbuild.ts", "line": 288, "character": 23 } ] }, { "id": 2129, "name": "estimateTokenTransfer", "kind": 64, "kindString": "Function", "flags": { "isPrivate": true }, "signatures": [ { "id": 2130, "name": "estimateTokenTransfer", "kind": 4096, "kindString": "Call signature", "flags": { "isPrivate": true }, "comment": { "shortText": "Estimates the cost of a token-transfer transaction", "returns": "- a promise which resolves to the satoshi cost to\n fund this token-transfer transaction" }, "parameters": [ { "id": 2131, "name": "recipientAddress", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the recipient of the tokens" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2132, "name": "tokenType", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the type of token to spend" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2133, "name": "tokenAmount", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "a 64-bit unsigned BigInteger encoding the number of tokens\n to spend" }, "type": { "type": "reference", "name": "BN" } }, { "id": 2134, "name": "scratchArea", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "an arbitrary string to store with the transaction" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2135, "name": "senderUtxos", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the number of utxos we expect will\n be required from the importer address" }, "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "1" }, { "id": 2136, "name": "additionalOutputs", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the number of outputs we expect to add beyond\n just the recipient output (default = 1, if the token owner is also the bitcoin funder)" }, "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "1" } ], "type": { "type": "reference", "name": "Promise", "typeArguments": [ { "type": "intrinsic", "name": "number" } ] } } ], "sources": [ { "fileName": "operations/txbuild.ts", "line": 461, "character": 30 } ] }, { "id": 2082, "name": "estimateTransfer", "kind": 64, "kindString": "Function", "flags": { "isPrivate": true }, "signatures": [ { "id": 2083, "name": "estimateTransfer", "kind": 4096, "kindString": "Call signature", "flags": { "isPrivate": true }, "comment": { "shortText": "Estimates cost of an transfer transaction for a domain name.", "returns": "- a promise which resolves to the satoshi cost to fund\n the transfer." }, "parameters": [ { "id": 2084, "name": "fullyQualifiedName", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the name to transfer" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2085, "name": "destinationAddress", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the next owner of the name" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2086, "name": "ownerAddress", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the current owner of the name" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2087, "name": "paymentAddress", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the address funding the transfer" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2088, "name": "paymentUtxos", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the number of UTXOs we expect will be required\n from the payment address." }, "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "1" } ], "type": { "type": "reference", "name": "Promise", "typeArguments": [ { "type": "intrinsic", "name": "number" } ] } } ], "sources": [ { "fileName": "operations/txbuild.ts", "line": 212, "character": 25 } ] }, { "id": 2076, "name": "estimateUpdate", "kind": 64, "kindString": "Function", "flags": { "isPrivate": true }, "signatures": [ { "id": 2077, "name": "estimateUpdate", "kind": 4096, "kindString": "Call signature", "flags": { "isPrivate": true }, "comment": { "shortText": "Estimates cost of an update transaction for a domain name.", "returns": "- a promise which resolves to the satoshi cost to fund\n the update." }, "parameters": [ { "id": 2078, "name": "fullyQualifiedName", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the name to update" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2079, "name": "ownerAddress", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the owner of the name" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2080, "name": "paymentAddress", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the address funding the update" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2081, "name": "paymentUtxos", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the number of UTXOs we expect will be required\n from the payment address." }, "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "1" } ], "type": { "type": "reference", "name": "Promise", "typeArguments": [ { "type": "intrinsic", "name": "number" } ] } } ], "sources": [ { "fileName": "operations/txbuild.ts", "line": 179, "character": 23 } ] }, { "id": 912, "name": "extractProfile", "kind": 64, "kindString": "Function", "flags": { "isExported": true }, "signatures": [ { "id": 913, "name": "extractProfile", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Extracts a profile from an encoded token and optionally verifies it,\nif `publicKeyOrAddress` is provided.", "returns": "- the profile extracted from the encoded token", "tags": [ { "tag": "throws", "text": "{Error} - if the token isn't signed by the provided `publicKeyOrAddress`\n" } ] }, "parameters": [ { "id": 914, "name": "token", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the token to be extracted" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 915, "name": "publicKeyOrAddress", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the public key or address of the\n keypair that is thought to have signed the token" }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "null" } ] }, "defaultValue": " null" } ], "type": { "type": "reflection", "declaration": { "id": 916, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {} } } } ], "sources": [ { "fileName": "profiles/profileTokens.ts", "line": 142, "character": 30 } ] }, { "id": 620, "name": "getAPIUsageErrorMessage", "kind": 64, "kindString": "Function", "flags": {}, "signatures": [ { "id": 621, "name": "getAPIUsageErrorMessage", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 622, "name": "scopeObject", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "unknown" } }, { "id": 623, "name": "apiName", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 624, "name": "usageDesc", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } ], "sources": [ { "fileName": "utils.ts", "line": 217, "character": 32 } ] }, { "id": 1522, "name": "getAppBucketUrl", "kind": 64, "kindString": "Function", "flags": { "isExported": true }, "signatures": [ { "id": 1523, "name": "getAppBucketUrl", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Get the app storage bucket URL", "returns": "That resolves to the URL of the app index file\nor rejects if it fails\n" }, "parameters": [ { "id": 1524, "name": "gaiaHubUrl", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the gaia hub URL" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1525, "name": "appPrivateKey", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the app private key used to generate the app address" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "name": "Promise", "typeArguments": [ { "type": "intrinsic", "name": "string" } ] } } ], "sources": [ { "fileName": "storage/index.ts", "line": 622, "character": 31 } ] }, { "id": 1704, "name": "getAuthResponseToken", "kind": 64, "kindString": "Function", "flags": { "isExported": true }, "signatures": [ { "id": 1705, "name": "getAuthResponseToken", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "returns": "the authentication token if it exists otherwise `null`\n", "tags": [ { "tag": "deprecated", "text": "\n#### v19 Use [[UserSession.getAuthResponseToken]] instead.\n\nRetrieve the authentication token from the URL query" } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "sources": [ { "fileName": "auth/authApp.ts", "line": 154, "character": 36 } ] }, { "id": 1504, "name": "getFile", "kind": 64, "kindString": "Function", "flags": { "isExported": true }, "signatures": [ { "id": 1505, "name": "getFile", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Retrieves the specified file from the app's data store.", "returns": "that resolves to the raw data in the file\nor rejects with an error\n" }, "parameters": [ { "id": 1506, "name": "path", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the path to the file to read" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1507, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "name": "GetFileOptions", "id": 1434 } }, { "id": 1508, "name": "caller", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "name": "UserSession", "id": 1544 } } ], "type": { "type": "reference", "name": "Promise", "typeArguments": [ { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "name": "ArrayBuffer" } ] } ] } } ], "sources": [ { "fileName": "storage/index.ts", "line": 424, "character": 23 } ] }, { "id": 1483, "name": "getFileContents", "kind": 64, "kindString": "Function", "flags": {}, "signatures": [ { "id": 1484, "name": "getFileContents", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 1485, "name": "path", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1486, "name": "app", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1487, "name": "username", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "undefined" } ] } }, { "id": 1488, "name": "zoneFileLookupURL", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "undefined" } ] } }, { "id": 1489, "name": "forceText", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 1490, "name": "caller", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "name": "UserSession", "id": 1544 } } ], "type": { "type": "reference", "name": "Promise", "typeArguments": [ { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "name": "ArrayBuffer" }, { "type": "intrinsic", "name": "null" } ] } ] } } ], "sources": [ { "fileName": "storage/index.ts", "line": 233, "character": 24 } ] }, { "id": 1491, "name": "getFileSignedUnencrypted", "kind": 64, "kindString": "Function", "flags": {}, "signatures": [ { "id": 1492, "name": "getFileSignedUnencrypted", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 1493, "name": "path", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1494, "name": "opt", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "name": "GetFileOptions", "id": 1434 } }, { "id": 1495, "name": "caller", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "name": "UserSession", "id": 1544 } } ], "type": { "type": "reference", "name": "Promise", "typeArguments": [ { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "name": "ArrayBuffer" } ] } ] } } ], "sources": [ { "fileName": "storage/index.ts", "line": 269, "character": 33 } ] }, { "id": 1478, "name": "getFileUrl", "kind": 64, "kindString": "Function", "flags": { "isExported": true }, "signatures": [ { "id": 1479, "name": "getFileUrl", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "returns": "that resolves to the URL or rejects with an error\n", "tags": [ { "tag": "deprecated", "text": "\n#### v19 Use [[UserSession.getFileUrl]] instead.\n" } ] }, "parameters": [ { "id": 1480, "name": "path", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the path to the file to read" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1481, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "name": "GetFileUrlOptions", "id": 1430 } }, { "id": 1482, "name": "caller", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "name": "UserSession", "id": 1544 } } ], "type": { "type": "reference", "name": "Promise", "typeArguments": [ { "type": "intrinsic", "name": "string" } ] } } ], "sources": [ { "fileName": "storage/index.ts", "line": 206, "character": 32 } ] }, { "id": 1461, "name": "getGaiaAddress", "kind": 64, "kindString": "Function", "flags": {}, "signatures": [ { "id": 1462, "name": "getGaiaAddress", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 1463, "name": "app", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1464, "name": "username", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1465, "name": "zoneFileLookupURL", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1466, "name": "caller", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "name": "UserSession", "id": 1544 } } ], "type": { "type": "reference", "name": "Promise", "typeArguments": [ { "type": "intrinsic", "name": "string" } ] } } ], "sources": [ { "fileName": "storage/index.ts", "line": 150, "character": 29 } ] }, { "id": 618, "name": "getGlobalScope", "kind": 64, "kindString": "Function", "flags": {}, "signatures": [ { "id": 619, "name": "getGlobalScope", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Returns the global scope `Window`, `WorkerGlobalScope`, or `NodeJS.Global` if available in the\ncurrently executing environment.", "tags": [ { "tag": "see", "text": "https://developer.mozilla.org/en-US/docs/Web/API/Window/self" }, { "tag": "see", "text": "https://developer.mozilla.org/en-US/docs/Web/API/WorkerGlobalScope/self" }, { "tag": "see", "text": "https://developer.mozilla.org/en-US/docs/Web/API/WindowOrWorkerGlobalScope\n\nThis could be switched to `globalThis` once it is standardized and widely available." }, { "tag": "see", "text": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/globalThis\n" } ] }, "type": { "type": "reference", "name": "Window" } } ], "sources": [ { "fileName": "utils.ts", "line": 199, "character": 23 } ] }, { "id": 1194, "name": "getName", "kind": 64, "kindString": "Function", "flags": { "isExported": true }, "signatures": [ { "id": 1195, "name": "getName", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 1196, "name": "profile", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "intrinsic", "name": "any" } } ], "sources": [ { "fileName": "profiles/profileSchemas/personUtils.ts", "line": 1, "character": 23 } ] }, { "id": 569, "name": "getNameInfo", "kind": 64, "kindString": "Function", "flags": { "isExported": true }, "signatures": [ { "id": 570, "name": "getNameInfo", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Get WHOIS-like information for a name, including the address that owns it,\nthe block at which it expires, and the zone file anchored to it (if available).", "returns": "a promise that resolves to the WHOIS-like information\n" }, "parameters": [ { "id": 571, "name": "fullyQualifiedName", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the name to query. Can be on-chain of off-chain." }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "name": "Promise", "typeArguments": [ { "type": "intrinsic", "name": "any" } ] } } ], "sources": [ { "fileName": "network.ts", "line": 1253, "character": 27 } ] }, { "id": 1892, "name": "getTransaction", "kind": 64, "kindString": "Function", "flags": {}, "signatures": [ { "id": 1893, "name": "getTransaction", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 1894, "name": "txIn", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "union", "types": [ { "type": "reference", "name": "Transaction" }, { "type": "reference", "name": "TransactionBuilder" } ] } } ], "type": { "type": "reference", "name": "Transaction" } } ], "sources": [ { "fileName": "operations/utils.ts", "line": 77, "character": 23 } ] }, { "id": 1441, "name": "getUserAppFileUrl", "kind": 64, "kindString": "Function", "flags": { "isExported": true }, "signatures": [ { "id": 1442, "name": "getUserAppFileUrl", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Fetch the public read URL of a user file for the specified app.", "returns": "that resolves to the public read URL of the file\nor rejects with an error\n" }, "parameters": [ { "id": 1443, "name": "path", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the path to the file to read" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1444, "name": "username", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "The Blockstack ID of the user to look up" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1445, "name": "appOrigin", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "The app origin" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1446, "name": "zoneFileLookupURL", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "name": "Promise", "typeArguments": [ { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "null" } ] } ] } } ], "sources": [ { "fileName": "storage/index.ts", "line": 62, "character": 39 } ] }, { "id": 1716, "name": "handlePendingSignIn", "kind": 64, "kindString": "Function", "flags": { "isExported": true }, "signatures": [ { "id": 1717, "name": "handlePendingSignIn", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "returns": "that resolves to the user data object if successful and rejects\nif handling the sign in request fails or there was no pending sign in request.\n", "tags": [ { "tag": "deprecated", "text": "\n#### v19 Use [[UserSession.handlePendingSignIn]] instead.\n\nTry to process any pending sign in request by returning a `Promise` that resolves\nto the user data object if the sign in succeeds.\n" } ] }, "parameters": [ { "id": 1718, "name": "nameLookupURL", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the endpoint against which to verify public\nkeys match claimed username" }, "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "\"\"" }, { "id": 1719, "name": "authResponseToken", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the signed authentication response token" }, "type": { "type": "intrinsic", "name": "string" }, "defaultValue": " getAuthResponseToken()" }, { "id": 1720, "name": "transitKey", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "text": "the transit private key that corresponds to the transit public key\nthat was provided in the authentication request" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1721, "name": "caller", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "name": "UserSession", "id": 1544 } } ], "type": { "type": "reference", "name": "Promise", "typeArguments": [ { "type": "reference", "name": "UserData", "id": 1680 } ] } } ], "sources": [ { "fileName": "auth/authApp.ts", "line": 260, "character": 41 } ] }, { "id": 1496, "name": "handleSignedEncryptedContents", "kind": 64, "kindString": "Function", "flags": {}, "signatures": [ { "id": 1497, "name": "handleSignedEncryptedContents", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 1498, "name": "caller", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "name": "UserSession", "id": 1544 } }, { "id": 1499, "name": "path", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1500, "name": "storedContents", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1501, "name": "app", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1502, "name": "username", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1503, "name": "zoneFileLookupURL", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "name": "Promise", "typeArguments": [ { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "name": "Buffer" } ] } ] } } ], "sources": [ { "fileName": "storage/index.ts", "line": 330, "character": 38 } ] }, { "id": 1879, "name": "inputBytes", "kind": 64, "kindString": "Function", "flags": {}, "signatures": [ { "id": 1880, "name": "inputBytes", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 1881, "name": "input", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "union", "types": [ { "type": "reference", "name": "txPoint", "id": 1874 }, { "type": "intrinsic", "name": "null" } ] } } ], "type": { "type": "intrinsic", "name": "number" } } ], "sources": [ { "fileName": "operations/utils.ts", "line": 47, "character": 19 } ] }, { "id": 1702, "name": "isSignInPending", "kind": 64, "kindString": "Function", "flags": { "isExported": true }, "signatures": [ { "id": 1703, "name": "isSignInPending", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "returns": "`true` if there is a pending sign in, otherwise `false`\n", "tags": [ { "tag": "deprecated", "text": "\n#### v19 Use [[UserSession.isSignInPending]] instead.\n\nCheck if there is a authentication request that hasn't been handled.\n\nAlso checks for a protocol echo reply (which if detected then the page\nwill be automatically redirected after this call).\n" } ] }, "type": { "type": "intrinsic", "name": "boolean" } } ], "sources": [ { "fileName": "auth/authApp.ts", "line": 133, "character": 31 } ] }, { "id": 1695, "name": "isUserSignedIn", "kind": 64, "kindString": "Function", "flags": { "isExported": true }, "signatures": [ { "id": 1696, "name": "isUserSignedIn", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "returns": "`true` if the user is signed in, `false` if not.\n", "tags": [ { "tag": "deprecated", "text": "\n#### v19 Use [[UserSession.isUserSignedIn]] instead.\n\nCheck if a user is currently signed in." } ] }, "type": { "type": "intrinsic", "name": "boolean" } } ], "sources": [ { "fileName": "auth/authApp.ts", "line": 77, "character": 30 } ] }, { "id": 1671, "name": "launchCustomProtocol", "kind": 64, "kindString": "Function", "flags": { "isExported": true }, "signatures": [ { "id": 1672, "name": "launchCustomProtocol", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Detects if the native auth-browser is installed and is successfully\nlaunched via a custom protocol URI.", "returns": "\n" }, "parameters": [ { "id": 1673, "name": "authRequest", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "\nThe encoded authRequest to be used as a query param in the custom URI." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1674, "name": "successCallback", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "\nThe callback that is invoked when the protocol handler was detected." }, "type": { "type": "reflection", "declaration": { "id": 1675, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 1676, "name": "__call", "kind": 4096, "kindString": "Call signature", "flags": {}, "type": { "type": "intrinsic", "name": "void" } } ], "sources": [ { "fileName": "auth/protocolLaunch.ts", "line": 17, "character": 18 } ] } } }, { "id": 1677, "name": "failCallback", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "\nThe callback that is invoked when the protocol handler was not detected." }, "type": { "type": "reflection", "declaration": { "id": 1678, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 1679, "name": "__call", "kind": 4096, "kindString": "Call signature", "flags": {}, "type": { "type": "intrinsic", "name": "void" } } ], "sources": [ { "fileName": "auth/protocolLaunch.ts", "line": 18, "character": 15 } ] } } } ], "type": { "type": "intrinsic", "name": "void" } } ], "sources": [ { "fileName": "auth/protocolLaunch.ts", "line": 15, "character": 36 } ] }, { "id": 1537, "name": "listFiles", "kind": 64, "kindString": "Function", "flags": { "isExported": true }, "signatures": [ { "id": 1538, "name": "listFiles", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "List the set of files in this application's Gaia storage bucket.", "returns": "that resolves to the number of files listed\n" }, "parameters": [ { "id": 1539, "name": "callback", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "a callback to invoke on each named file that\nreturns `true` to continue the listing operation or `false` to end it" }, "type": { "type": "reflection", "declaration": { "id": 1540, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 1541, "name": "__call", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 1542, "name": "name", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "sources": [ { "fileName": "storage/index.ts", "line": 714, "character": 11 } ] } } }, { "id": 1543, "name": "caller", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "name": "UserSession", "id": 1544 } } ], "type": { "type": "reference", "name": "Promise", "typeArguments": [ { "type": "intrinsic", "name": "number" } ] } } ], "sources": [ { "fileName": "storage/index.ts", "line": 713, "character": 25 } ] }, { "id": 1706, "name": "loadUserData", "kind": 64, "kindString": "Function", "flags": { "isExported": true }, "signatures": [ { "id": 1707, "name": "loadUserData", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "returns": "User data object.\n", "tags": [ { "tag": "deprecated", "text": "\n#### v19 Use [[UserSession.loadUserData]] instead.\n\nRetrieves the user data object. The user's profile is stored in the key `profile`." } ] }, "type": { "type": "reference", "name": "UserData", "id": 1680 } } ], "sources": [ { "fileName": "auth/authApp.ts", "line": 170, "character": 28 } ] }, { "id": 1422, "name": "lookupProfile", "kind": 64, "kindString": "Function", "flags": { "isExported": true }, "signatures": [ { "id": 1423, "name": "lookupProfile", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Look up a user profile by blockstack ID", "returns": "that resolves to a profile object\n" }, "parameters": [ { "id": 1424, "name": "username", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "The Blockstack ID of the profile to look up" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1425, "name": "zoneFileLookupURL", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "name": "Promise", "typeArguments": [ { "type": "intrinsic", "name": "any" } ] } } ], "sources": [ { "fileName": "profiles/profileLookup.ts", "line": 15, "character": 29 } ] }, { "id": 2206, "name": "makeAnnounce", "kind": 64, "kindString": "Function", "flags": { "isPrivate": true }, "signatures": [ { "id": 2207, "name": "makeAnnounce", "kind": 4096, "kindString": "Call signature", "flags": { "isPrivate": true }, "comment": { "shortText": "Generates an announce transaction", "returns": "- a promise which resolves to the hex-encoded transaction.\nthis function does not perform the requisite safety checks -- please see the\nsafety module for those." }, "parameters": [ { "id": 2208, "name": "messageHash", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the hash of the message to send. Should be\n an already-announced zone file hash" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2209, "name": "senderKeyIn", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the private key\n that pays for the transaction. Should be the key that owns the\n name that the message recipients subscribe to" }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "name": "TransactionSigner" } ] } }, { "id": 2210, "name": "buildIncomplete", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "optional boolean, defaults to false,\nindicating whether the function should attempt to return an unsigned (or not fully signed)\ntransaction. Useful for passing around a TX for multi-sig input signing." }, "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "false" } ], "type": { "type": "reference", "name": "Promise", "typeArguments": [ { "type": "intrinsic", "name": "string" } ] } } ], "sources": [ { "fileName": "operations/txbuild.ts", "line": 1029, "character": 21 } ] }, { "id": 1636, "name": "makeAuthRequest", "kind": 64, "kindString": "Function", "flags": { "isExported": true }, "signatures": [ { "id": 1637, "name": "makeAuthRequest", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Generates an authentication request that can be sent to the Blockstack\nbrowser for the user to approve sign in. This authentication request can\nthen be used for sign in by passing it to the `redirectToSignInWithAuthRequest`\nmethod.", "text": "*Note: This method should only be used if you want to roll your own authentication\nflow. Typically you'd use `redirectToSignIn` which takes care of this\nunder the hood.*\n", "returns": "the authentication request\n" }, "parameters": [ { "id": 1638, "name": "transitPrivateKey", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "text": "hex encoded transit private key" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1639, "name": "redirectURI", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "text": "location to redirect user to after sign in approval" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1640, "name": "manifestURI", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "text": "location of this app's manifest file" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1641, "name": "scopes", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the permissions this app is requesting" }, "type": { "type": "reference", "name": "Array", "typeArguments": [ { "type": "union", "types": [ { "type": "reference", "name": "AuthScope", "id": 1 }, { "type": "intrinsic", "name": "string" } ] } ] }, "defaultValue": " DEFAULT_SCOPE.slice()" }, { "id": 1642, "name": "appDomain", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "text": "the origin of this app" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1643, "name": "expiresAt", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the time at which this request is no longer valid" }, "type": { "type": "intrinsic", "name": "number" }, "defaultValue": " nextMonth().getTime()" }, { "id": 1644, "name": "extraParams", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "Any extra parameters you'd like to pass to the authenticator.\nUse this to pass options that aren't part of the Blockstack auth spec, but might be supported\nby special authenticators." }, "type": { "type": "intrinsic", "name": "any" }, "defaultValue": " {}" } ], "type": { "type": "intrinsic", "name": "string" } } ], "sources": [ { "fileName": "auth/authMessages.ts", "line": 57, "character": 31 } ] }, { "id": 2220, "name": "makeBitcoinSpend", "kind": 64, "kindString": "Function", "flags": { "isPrivate": true }, "signatures": [ { "id": 2221, "name": "makeBitcoinSpend", "kind": 4096, "kindString": "Call signature", "flags": { "isPrivate": true }, "comment": { "shortText": "Generates a bitcoin spend to a specified address. This will fund up to `amount`\n of satoshis from the payer's UTXOs. It will generate a change output if and only\n if the amount of leftover change is *greater* than the additional fees associated\n with the extra output. If the requested amount is not enough to fund the transaction's\n associated fees, then this will reject with a InvalidAmountError", "text": "UTXOs are selected largest to smallest, and UTXOs which cannot fund the fees associated\n with their own input will not be included.\n\nIf you specify an amount > the total balance of the payer address, then this will\n generate a maximum spend transaction\n", "returns": "- a promise which resolves to the hex-encoded transaction." }, "parameters": [ { "id": 2222, "name": "destinationAddress", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the address to receive the bitcoin payment" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2223, "name": "paymentKeyIn", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the private key\n used to fund the bitcoin spend" }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "name": "TransactionSigner" } ] } }, { "id": 2224, "name": "amount", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the amount in satoshis for the payment address to\n spend in this transaction" }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 2225, "name": "buildIncomplete", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "optional boolean, defaults to false,\nindicating whether the function should attempt to return an unsigned (or not fully signed)\ntransaction. Useful for passing around a TX for multi-sig input signing." }, "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "false" } ], "type": { "type": "reference", "name": "Promise", "typeArguments": [ { "type": "intrinsic", "name": "string" } ] } } ], "sources": [ { "fileName": "operations/txbuild.ts", "line": 1136, "character": 25 } ] }, { "id": 2199, "name": "makeNameImport", "kind": 64, "kindString": "Function", "flags": { "isPrivate": true }, "signatures": [ { "id": 2200, "name": "makeNameImport", "kind": 4096, "kindString": "Call signature", "flags": { "isPrivate": true }, "comment": { "shortText": "Generates a name import transaction for a namespace", "returns": "- a promise which resolves to the hex-encoded transaction.\nthis function does not perform the requisite safety checks -- please see\nthe safety module for those." }, "parameters": [ { "id": 2201, "name": "name", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the name to import" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2202, "name": "recipientAddr", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the address to receive the name" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2203, "name": "zonefileHash", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the hash of the zonefile to give this name" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2204, "name": "importerKeyIn", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the private key\nthat pays for the import" }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "name": "TransactionSigner" } ] } }, { "id": 2205, "name": "buildIncomplete", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "optional boolean, defaults to false,\nindicating whether the function should attempt to return an unsigned (or not fully signed)\ntransaction. Useful for passing around a TX for multi-sig input signing." }, "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "false" } ], "type": { "type": "reference", "name": "Promise", "typeArguments": [ { "type": "intrinsic", "name": "string" } ] } } ], "sources": [ { "fileName": "operations/txbuild.ts", "line": 991, "character": 23 } ] }, { "id": 2194, "name": "makeNamespaceReady", "kind": 64, "kindString": "Function", "flags": { "isPrivate": true }, "signatures": [ { "id": 2195, "name": "makeNamespaceReady", "kind": 4096, "kindString": "Call signature", "flags": { "isPrivate": true }, "comment": { "shortText": "Generates a namespace ready transaction for a namespace", "returns": "- a promise which resolves to the hex-encoded transaction.\n this function *does not* perform the requisite safety checks -- please see\n the safety module for those." }, "parameters": [ { "id": 2196, "name": "namespaceID", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the namespace to launch" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2197, "name": "revealKeyIn", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the private key\n of the 'revealAddress' used to reveal the namespace" }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "name": "TransactionSigner" } ] } }, { "id": 2198, "name": "buildIncomplete", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "optional boolean, defaults to false,\n indicating whether the function should attempt to return an unsigned (or not fully signed)\n transaction. Useful for passing around a TX for multi-sig input signing." }, "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "false" } ], "type": { "type": "reference", "name": "Promise", "typeArguments": [ { "type": "intrinsic", "name": "string" } ] } } ], "sources": [ { "fileName": "operations/txbuild.ts", "line": 954, "character": 27 } ] }, { "id": 2188, "name": "makeNamespaceReveal", "kind": 64, "kindString": "Function", "flags": { "isPrivate": true }, "signatures": [ { "id": 2189, "name": "makeNamespaceReveal", "kind": 4096, "kindString": "Call signature", "flags": { "isPrivate": true }, "comment": { "shortText": "Generates a namespace reveal transaction for a namespace", "returns": "- a promise which resolves to the hex-encoded transaction.\n this function *does not* perform the requisite safety checks -- please see\n the safety module for those." }, "parameters": [ { "id": 2190, "name": "namespace", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the namespace to reveal" }, "type": { "type": "reference", "name": "BlockstackNamespace" } }, { "id": 2191, "name": "revealAddress", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the address to receive the namespace (this\n must be passed as the 'revealAddress' in the namespace-reveal transaction)" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2192, "name": "paymentKeyIn", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "a hex string (or\n a TransactionSigner object) of the private key used to fund the\n transaction" }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "name": "TransactionSigner" } ] } }, { "id": 2193, "name": "buildIncomplete", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "optional boolean, defaults to false,\n indicating whether the function should attempt to return an unsigned (or not fully signed)\n transaction. Useful for passing around a TX for multi-sig input signing." }, "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "false" } ], "type": { "type": "reference", "name": "Promise", "typeArguments": [ { "type": "intrinsic", "name": "string" } ] } } ], "sources": [ { "fileName": "operations/txbuild.ts", "line": 911, "character": 28 } ] }, { "id": 2137, "name": "makePreorder", "kind": 64, "kindString": "Function", "flags": { "isPrivate": true }, "signatures": [ { "id": 2138, "name": "makePreorder", "kind": 4096, "kindString": "Call signature", "flags": { "isPrivate": true }, "comment": { "shortText": "Generates a preorder transaction for a domain name.", "returns": "- a promise which resolves to the hex-encoded transaction.\n this function *does not* perform the requisite safety checks -- please see\n the safety module for those." }, "parameters": [ { "id": 2139, "name": "fullyQualifiedName", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the name to pre-order" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2140, "name": "destinationAddress", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the address to receive the name (this\n must be passed as the 'registrationAddress' in the register transaction)" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2141, "name": "paymentKeyIn", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "a hex string of\n the private key used to fund the transaction or a transaction signer object" }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "name": "TransactionSigner" } ] } }, { "id": 2142, "name": "buildIncomplete", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "optional boolean, defaults to false,\nindicating whether the function should attempt to return an unsigned (or not fully signed)\ntransaction. Useful for passing around a TX for multi-sig input signing." }, "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "false" } ], "type": { "type": "reference", "name": "Promise", "typeArguments": [ { "type": "intrinsic", "name": "string" } ] } } ], "sources": [ { "fileName": "operations/txbuild.ts", "line": 495, "character": 21 } ] }, { "id": 2151, "name": "makeRegister", "kind": 64, "kindString": "Function", "flags": { "isPrivate": true }, "signatures": [ { "id": 2152, "name": "makeRegister", "kind": 4096, "kindString": "Call signature", "flags": { "isPrivate": true }, "comment": { "shortText": "Generates a register transaction for a domain name.", "returns": "- a promise which resolves to the hex-encoded transaction.\n this function *does not* perform the requisite safety checks -- please see\n the safety module for those." }, "parameters": [ { "id": 2153, "name": "fullyQualifiedName", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the name to register" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2154, "name": "registerAddress", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the address to receive the name (this\n must have been passed as the 'destinationAddress' in the preorder transaction)\n this address will receive a dust UTXO" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2155, "name": "paymentKeyIn", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "a hex string of\n the private key (or a TransactionSigner object) used to fund the\n transaction (this *must* be the same as the payment address used\n to fund the preorder)" }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "name": "TransactionSigner" } ] } }, { "id": 2156, "name": "zonefile", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the zonefile data to include (this will be hashed\n to include in the transaction), the zonefile itself must be published\n after the UPDATE propagates." }, "type": { "type": "intrinsic", "name": "string" }, "defaultValue": " null" }, { "id": 2157, "name": "valueHash", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the hash of the zone file data to include.\n It will be used instead of zonefile, if given" }, "type": { "type": "intrinsic", "name": "string" }, "defaultValue": " null" }, { "id": 2158, "name": "buildIncomplete", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "optional boolean, defaults to false,\n indicating whether the function should attempt to return an unsigned (or not fully signed)\n transaction. Useful for passing around a TX for multi-sig input signing." }, "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "false" } ], "type": { "type": "reference", "name": "Promise", "typeArguments": [ { "type": "intrinsic", "name": "string" } ] } } ], "sources": [ { "fileName": "operations/txbuild.ts", "line": 626, "character": 21 } ] }, { "id": 2173, "name": "makeRenewal", "kind": 64, "kindString": "Function", "flags": { "isPrivate": true }, "signatures": [ { "id": 2174, "name": "makeRenewal", "kind": 4096, "kindString": "Call signature", "flags": { "isPrivate": true }, "comment": { "shortText": "Generates a renewal transaction for a domain name.", "returns": "- a promise which resolves to the hex-encoded transaction.\n this function *does not* perform the requisite safety checks -- please see\n the safety module for those." }, "parameters": [ { "id": 2175, "name": "fullyQualifiedName", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the name to transfer" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2176, "name": "destinationAddress", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the address to receive the name after renewal\n this address will receive a dust UTXO" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2177, "name": "ownerKeyIn", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "a hex string of\n the current owner's private key (or a TransactionSigner object)" }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "name": "TransactionSigner" } ] } }, { "id": 2178, "name": "paymentKeyIn", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "a hex string of\n the private key used to fund the renewal (or a TransactionSigner\n object)" }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "name": "TransactionSigner" } ] } }, { "id": 2179, "name": "zonefile", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the zonefile data to include, if given (this will be hashed\n to include in the transaction), the zonefile itself must be published\n after the RENEWAL propagates." }, "type": { "type": "intrinsic", "name": "string" }, "defaultValue": " null" }, { "id": 2180, "name": "valueHash", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the raw zone file hash to include (this will be used\n instead of zonefile, if given)." }, "type": { "type": "intrinsic", "name": "string" }, "defaultValue": " null" }, { "id": 2181, "name": "buildIncomplete", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "optional boolean, defaults to false,\n indicating whether the function should attempt to return an unsigned (or not fully signed)\n transaction. Useful for passing around a TX for multi-sig input signing." }, "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "false" } ], "type": { "type": "reference", "name": "Promise", "typeArguments": [ { "type": "intrinsic", "name": "string" } ] } } ], "sources": [ { "fileName": "operations/txbuild.ts", "line": 788, "character": 20 } ] }, { "id": 2167, "name": "makeRevoke", "kind": 64, "kindString": "Function", "flags": { "isPrivate": true }, "signatures": [ { "id": 2168, "name": "makeRevoke", "kind": 4096, "kindString": "Call signature", "flags": { "isPrivate": true }, "comment": { "shortText": "Generates a revoke transaction for a domain name.", "returns": "- a promise which resolves to the hex-encoded transaction.\n this function *does not* perform the requisite safety checks -- please see\n the safety module for those." }, "parameters": [ { "id": 2169, "name": "fullyQualifiedName", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the name to revoke" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2170, "name": "ownerKeyIn", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "a hex string of\n the current owner's private key (or a TransactionSigner object)" }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "name": "TransactionSigner" } ] } }, { "id": 2171, "name": "paymentKeyIn", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "a hex string of\n the private key used to fund the transaction (or a\n TransactionSigner object)" }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "name": "TransactionSigner" } ] } }, { "id": 2172, "name": "buildIncomplete", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "optional boolean, defaults to false,\n indicating whether the function should attempt to return an unsigned (or not fully signed)\n transaction. Useful for passing around a TX for multi-sig input signing." }, "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "false" } ], "type": { "type": "reference", "name": "Promise", "typeArguments": [ { "type": "intrinsic", "name": "string" } ] } } ], "sources": [ { "fileName": "operations/txbuild.ts", "line": 736, "character": 19 } ] }, { "id": 2211, "name": "makeTokenTransfer", "kind": 64, "kindString": "Function", "flags": { "isPrivate": true }, "signatures": [ { "id": 2212, "name": "makeTokenTransfer", "kind": 4096, "kindString": "Call signature", "flags": { "isPrivate": true }, "comment": { "shortText": "Generates a token-transfer transaction", "returns": "- a promise which resolves to the hex-encoded transaction.\nThis function does not perform the requisite safety checks -- please see the\nsafety module for those." }, "parameters": [ { "id": 2213, "name": "recipientAddress", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the address to receive the tokens" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2214, "name": "tokenType", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the type of tokens to send" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2215, "name": "tokenAmount", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the BigInteger encoding of an unsigned 64-bit number of\n tokens to send" }, "type": { "type": "reference", "name": "BN" } }, { "id": 2216, "name": "scratchArea", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "an arbitrary string to include with the transaction" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2217, "name": "senderKeyIn", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the hex-encoded private key to send\n the tokens" }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "name": "TransactionSigner" } ] } }, { "id": 2218, "name": "btcFunderKeyIn", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "text": "the hex-encoded private key to fund\n the bitcoin fees for the transaction. Optional -- if not passed, will attempt to\n fund with sender key." }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "name": "TransactionSigner" } ] } }, { "id": 2219, "name": "buildIncomplete", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "optional boolean, defaults to false,\n indicating whether the function should attempt to return an unsigned (or not fully signed)\n transaction. Useful for passing around a TX for multi-sig input signing." }, "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "false" } ], "type": { "type": "reference", "name": "Promise", "typeArguments": [ { "type": "intrinsic", "name": "string" } ] } } ], "sources": [ { "fileName": "operations/txbuild.ts", "line": 1070, "character": 26 } ] }, { "id": 2159, "name": "makeTransfer", "kind": 64, "kindString": "Function", "flags": { "isPrivate": true }, "signatures": [ { "id": 2160, "name": "makeTransfer", "kind": 4096, "kindString": "Call signature", "flags": { "isPrivate": true }, "comment": { "shortText": "Generates a transfer transaction for a domain name.", "returns": "- a promise which resolves to the hex-encoded transaction.\n this function *does not* perform the requisite safety checks -- please see\n the safety module for those." }, "parameters": [ { "id": 2161, "name": "fullyQualifiedName", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the name to transfer" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2162, "name": "destinationAddress", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the address to receive the name.\n this address will receive a dust UTXO" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2163, "name": "ownerKeyIn", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "a hex string of\n the current owner's private key (or a TransactionSigner object)" }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "name": "TransactionSigner" } ] } }, { "id": 2164, "name": "paymentKeyIn", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "a hex string of\n the private key used to fund the transaction (or a\n TransactionSigner object)" }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "name": "TransactionSigner" } ] } }, { "id": 2165, "name": "keepZonefile", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "if true, then preserve the name's zone file" }, "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "false" }, { "id": 2166, "name": "buildIncomplete", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "optional boolean, defaults to false,\n indicating whether the function should attempt to return an unsigned (or not fully signed)\n transaction. Useful for passing around a TX for multi-sig input signing." }, "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "false" } ], "type": { "type": "reference", "name": "Promise", "typeArguments": [ { "type": "intrinsic", "name": "string" } ] } } ], "sources": [ { "fileName": "operations/txbuild.ts", "line": 682, "character": 21 } ] }, { "id": 2143, "name": "makeUpdate", "kind": 64, "kindString": "Function", "flags": { "isPrivate": true }, "signatures": [ { "id": 2144, "name": "makeUpdate", "kind": 4096, "kindString": "Call signature", "flags": { "isPrivate": true }, "comment": { "shortText": "Generates an update transaction for a domain name.", "returns": "- a promise which resolves to the hex-encoded transaction.\n this function *does not* perform the requisite safety checks -- please see\n the safety module for those." }, "parameters": [ { "id": 2145, "name": "fullyQualifiedName", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the name to update" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2146, "name": "ownerKeyIn", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "a hex string of the\n owner key, or a transaction signer object. This will provide one\n UTXO input, and also recieve a dust output." }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "name": "TransactionSigner" } ] } }, { "id": 2147, "name": "paymentKeyIn", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "a hex string, or a\n transaction signer object, of the private key used to fund the\n transaction's txfees" }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "name": "TransactionSigner" } ] } }, { "id": 2148, "name": "zonefile", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the zonefile data to update (this will be hashed\n to include in the transaction), the zonefile itself must be published\n after the UPDATE propagates." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2149, "name": "valueHash", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "if given, this is the hash to store (instead of\n zonefile). zonefile will be ignored if this is given." }, "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "\"\"" }, { "id": 2150, "name": "buildIncomplete", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "optional boolean, defaults to false,\n indicating whether the function should attempt to return an unsigned (or not fully signed)\n transaction. Useful for passing around a TX for multi-sig input signing." }, "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "false" } ], "type": { "type": "reference", "name": "Promise", "typeArguments": [ { "type": "intrinsic", "name": "string" } ] } } ], "sources": [ { "fileName": "operations/txbuild.ts", "line": 551, "character": 19 } ] }, { "id": 1882, "name": "outputBytes", "kind": 64, "kindString": "Function", "flags": {}, "signatures": [ { "id": 1883, "name": "outputBytes", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 1884, "name": "output", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "union", "types": [ { "type": "reference", "name": "txPoint", "id": 1874 }, { "type": "intrinsic", "name": "null" } ] } } ], "type": { "type": "intrinsic", "name": "number" } } ], "sources": [ { "fileName": "operations/utils.ts", "line": 55, "character": 20 } ] }, { "id": 1509, "name": "putFile", "kind": 64, "kindString": "Function", "flags": { "isExported": true }, "signatures": [ { "id": 1510, "name": "putFile", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Stores the data provided in the app's data store to to the file specified.", "returns": "that resolves if the operation succeed and rejects\nif it failed\n" }, "parameters": [ { "id": 1511, "name": "path", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the path to store the data in" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1512, "name": "content", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the data to store in the file" }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "name": "Buffer" } ] } }, { "id": 1513, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "name": "PutFileOptions", "id": 1426 } }, { "id": 1514, "name": "caller", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "name": "UserSession", "id": 1544 } } ], "type": { "type": "reference", "name": "Promise", "typeArguments": [ { "type": "intrinsic", "name": "string" } ] } } ], "sources": [ { "fileName": "storage/index.ts", "line": 478, "character": 29 } ] }, { "id": 1697, "name": "redirectToSignIn", "kind": 64, "kindString": "Function", "flags": { "isExported": true }, "signatures": [ { "id": 1698, "name": "redirectToSignIn", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "returns": "\n", "tags": [ { "tag": "deprecated", "text": "\n#### v19 Use [[UserSession.isUserSignedIn]] instead.\n\nGenerates an authentication request and redirects the user to the Blockstack\nbrowser to approve the sign in request.\n\nPlease note that this requires that the web browser properly handles the\n`blockstack:` URL protocol handler.\n\nMost applications should use this\nmethod for sign in unless they require more fine grained control over how the\nauthentication request is generated. If your app falls into this category,\nuse `makeAuthRequest` and `redirectToSignInWithAuthRequest` to build your own sign in process.\n" } ] }, "parameters": [ { "id": 1699, "name": "redirectURI", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1700, "name": "manifestURI", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1701, "name": "scopes", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "name": "Array", "typeArguments": [ { "type": "union", "types": [ { "type": "reference", "name": "AuthScope", "id": 1 }, { "type": "intrinsic", "name": "string" } ] } ] } } ], "type": { "type": "intrinsic", "name": "void" } } ], "sources": [ { "fileName": "auth/authApp.ts", "line": 112, "character": 32 } ] }, { "id": 1712, "name": "redirectToSignInWithAuthRequest", "kind": 64, "kindString": "Function", "flags": { "isExported": true }, "signatures": [ { "id": 1713, "name": "redirectToSignInWithAuthRequest", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "returns": "\n", "tags": [ { "tag": "deprecated", "text": "\n#### v19 Use [[UserSession.redirectToSignInWithAuthRequest]] instead.\n\nRedirects the user to the Blockstack browser to approve the sign in request\ngiven.\n\nThe user is redirected to the `blockstackIDHost` if the `blockstack:`\nprotocol handler is not detected. Please note that the protocol handler detection\ndoes not work on all browsers." } ] }, "parameters": [ { "id": 1714, "name": "authRequest", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "text": "the authentication request generated by `makeAuthRequest`" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1715, "name": "blockstackIDHost", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the URL to redirect the user to if the blockstack\n protocol handler is not detected" }, "type": { "type": "intrinsic", "name": "string" }, "defaultValue": " DEFAULT_BLOCKSTACK_HOST" } ], "type": { "type": "intrinsic", "name": "void" } } ], "sources": [ { "fileName": "auth/authApp.ts", "line": 213, "character": 47 } ] }, { "id": 1913, "name": "signInputs", "kind": 64, "kindString": "Function", "flags": { "isExported": true }, "signatures": [ { "id": 1914, "name": "signInputs", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 1915, "name": "txB", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "name": "TransactionBuilder" } }, { "id": 1916, "name": "defaultSigner", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "name": "TransactionSigner" } }, { "id": 1917, "name": "otherSigners", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "name": "Array", "typeArguments": [ { "type": "reflection", "declaration": { "id": 1918, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 1919, "name": "index", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "operations/utils.ts", "line": 212, "character": 54 } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 1920, "name": "signer", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "operations/utils.ts", "line": 212, "character": 70 } ], "type": { "type": "reference", "name": "TransactionSigner" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 1919, 1920 ] } ], "sources": [ { "fileName": "operations/utils.ts", "line": 212, "character": 48 } ] } } ] } } ], "type": { "type": "reference", "name": "Promise", "typeArguments": [ { "type": "reference", "name": "TransactionBuilder" } ] } } ], "sources": [ { "fileName": "operations/utils.ts", "line": 210, "character": 26 } ] }, { "id": 893, "name": "signProfileToken", "kind": 64, "kindString": "Function", "flags": { "isExported": true }, "signatures": [ { "id": 894, "name": "signProfileToken", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Signs a profile token", "returns": "- the signed profile token\n\n" }, "parameters": [ { "id": 895, "name": "profile", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the JSON of the profile to be signed" }, "type": { "type": "intrinsic", "name": "any" } }, { "id": 896, "name": "privateKey", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the signing private key" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 897, "name": "subject", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "text": "the entity that the information is about" }, "type": { "type": "intrinsic", "name": "any" } }, { "id": 898, "name": "issuer", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "text": "the entity that is issuing the token" }, "type": { "type": "intrinsic", "name": "any" } }, { "id": 899, "name": "signingAlgorithm", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the signing algorithm to use" }, "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "\"ES256K\"" }, { "id": 900, "name": "issuedAt", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the time of issuance of the token" }, "type": { "type": "reference", "name": "Date" }, "defaultValue": " new Date()" }, { "id": 901, "name": "expiresAt", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the time of expiration of the token" }, "type": { "type": "reference", "name": "Date" }, "defaultValue": " nextYear()" } ], "type": { "type": "intrinsic", "name": "any" } } ], "sources": [ { "fileName": "profiles/profileTokens.ts", "line": 20, "character": 32 } ] }, { "id": 1708, "name": "signUserOut", "kind": 64, "kindString": "Function", "flags": { "isExported": true }, "signatures": [ { "id": 1709, "name": "signUserOut", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "tags": [ { "tag": "deprecated", "text": "\n#### v19 Use [[UserSession.signUserOut]] instead.\n\nSign the user out and optionally redirect to given location." } ] }, "parameters": [ { "id": 1710, "name": "redirectURL", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "text": "\nLocation to redirect user to after sign out.\nOnly used in environments with `window` available\n" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1711, "name": "caller", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "name": "UserSession", "id": 1544 } } ], "type": { "type": "intrinsic", "name": "void" } } ], "sources": [ { "fileName": "auth/authApp.ts", "line": 187, "character": 27 } ] }, { "id": 1885, "name": "transactionBytes", "kind": 64, "kindString": "Function", "flags": {}, "signatures": [ { "id": 1886, "name": "transactionBytes", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 1887, "name": "inputs", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "name": "Array", "typeArguments": [ { "type": "union", "types": [ { "type": "reference", "name": "txPoint", "id": 1874 }, { "type": "intrinsic", "name": "null" } ] } ] } }, { "id": 1888, "name": "outputs", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "name": "Array", "typeArguments": [ { "type": "union", "types": [ { "type": "reference", "name": "txPoint", "id": 1874 }, { "type": "intrinsic", "name": "null" } ] } ] } } ], "type": { "type": "intrinsic", "name": "number" } } ], "sources": [ { "fileName": "operations/utils.ts", "line": 63, "character": 25 } ] }, { "id": 1122, "name": "validateProofs", "kind": 64, "kindString": "Function", "flags": { "isExported": true }, "signatures": [ { "id": 1123, "name": "validateProofs", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Validates the social proofs in a user's profile. Currently supports validation of\nFacebook, Twitter, GitHub, Instagram, LinkedIn and HackerNews accounts.", "returns": "that resolves to an array of validated proof objects\n" }, "parameters": [ { "id": 1124, "name": "profile", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "The JSON of the profile to be validated" }, "type": { "type": "intrinsic", "name": "any" } }, { "id": 1125, "name": "ownerAddress", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "The owner bitcoin address to be validated" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1126, "name": "name", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" }, "defaultValue": " null" } ], "type": { "type": "reference", "name": "Promise", "typeArguments": [ { "type": "array", "elementType": { "type": "intrinsic", "name": "any" } } ] } } ], "sources": [ { "fileName": "profiles/profileProofs.ts", "line": 12, "character": 30 } ] }, { "id": 908, "name": "verifyProfileToken", "kind": 64, "kindString": "Function", "flags": { "isExported": true }, "signatures": [ { "id": 909, "name": "verifyProfileToken", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Verifies a profile token", "returns": "- the verified, decoded profile token", "tags": [ { "tag": "throws", "text": "{Error} - throws an error if token verification fails\n" } ] }, "parameters": [ { "id": 910, "name": "token", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the token to be verified" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 911, "name": "publicKeyOrAddress", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the public key or address of the\n keypair that is thought to have signed the token" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } ], "sources": [ { "fileName": "profiles/profileTokens.ts", "line": 75, "character": 34 } ] }, { "id": 902, "name": "wrapProfileToken", "kind": 64, "kindString": "Function", "flags": { "isExported": true }, "signatures": [ { "id": 903, "name": "wrapProfileToken", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Wraps a token for a profile token file", "returns": "- including `token` and `decodedToken`\n" }, "parameters": [ { "id": 904, "name": "token", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "the token to be wrapped" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reflection", "declaration": { "id": 905, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 907, "name": "decodedToken", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profileTokens.ts", "line": 63, "character": 16 } ], "type": { "type": "intrinsic", "name": "any" }, "defaultValue": " decodeToken(token)" }, { "id": 906, "name": "token", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profileTokens.ts", "line": 62, "character": 9 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 907, 906 ] } ] } } } ], "sources": [ { "fileName": "profiles/profileTokens.ts", "line": 60, "character": 32 } ] }, { "id": 1692, "name": "DEFAULT_PROFILE", "kind": 2097152, "kindString": "Object literal", "flags": { "isConst": true }, "children": [ { "id": 1694, "name": "@context", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "auth/authApp.ts", "line": 28, "character": 12 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "\"http://schema.org\"" }, { "id": 1693, "name": "@type", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "auth/authApp.ts", "line": 27, "character": 9 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "\"Person\"" } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 1694, 1693 ] } ], "sources": [ { "fileName": "auth/authApp.ts", "line": 26, "character": 21 } ], "type": { "type": "intrinsic", "name": "object" } }, { "id": 1159, "name": "schemaDefinition", "kind": 2097152, "kindString": "Object literal", "flags": { "isConst": true }, "children": [ { "id": 1298, "name": "strict", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 15, "character": 8 } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "false" }, { "id": 1160, "name": "type", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profile.ts", "line": 9, "character": 6 }, { "fileName": "profiles/profileSchemas/person.ts", "line": 14, "character": 6 }, { "fileName": "profiles/profileSchemas/organization.ts", "line": 9, "character": 6 }, { "fileName": "profiles/profileSchemas/creativework.ts", "line": 7, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "\"object\"" }, { "id": 1161, "name": "properties", "kind": 2097152, "kindString": "Object literal", "flags": {}, "children": [ { "id": 1162, "name": "@context", "kind": 2097152, "kindString": "Object literal", "flags": {}, "children": [ { "id": 1164, "name": "optional", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profile.ts", "line": 11, "character": 42 }, { "fileName": "profiles/profileSchemas/person.ts", "line": 17, "character": 42 }, { "fileName": "profiles/profileSchemas/organization.ts", "line": 11, "character": 42 }, { "fileName": "profiles/profileSchemas/creativework.ts", "line": 9, "character": 42 } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "true" }, { "id": 1163, "name": "type", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profile.ts", "line": 11, "character": 22 }, { "fileName": "profiles/profileSchemas/person.ts", "line": 17, "character": 22 }, { "fileName": "profiles/profileSchemas/organization.ts", "line": 11, "character": 22 }, { "fileName": "profiles/profileSchemas/creativework.ts", "line": 9, "character": 22 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "\"string\"" } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 1164, 1163 ] } ], "sources": [ { "fileName": "profiles/profile.ts", "line": 11, "character": 14 }, { "fileName": "profiles/profileSchemas/person.ts", "line": 17, "character": 14 }, { "fileName": "profiles/profileSchemas/organization.ts", "line": 11, "character": 14 }, { "fileName": "profiles/profileSchemas/creativework.ts", "line": 9, "character": 14 } ], "type": { "type": "intrinsic", "name": "object" } }, { "id": 1299, "name": "@id", "kind": 2097152, "kindString": "Object literal", "flags": {}, "children": [ { "id": 1301, "name": "optional", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 19, "character": 37 }, { "fileName": "profiles/profileSchemas/organization.ts", "line": 13, "character": 37 }, { "fileName": "profiles/profileSchemas/creativework.ts", "line": 11, "character": 37 } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "true" }, { "id": 1300, "name": "type", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 19, "character": 17 }, { "fileName": "profiles/profileSchemas/organization.ts", "line": 13, "character": 17 }, { "fileName": "profiles/profileSchemas/creativework.ts", "line": 11, "character": 17 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "\"string\"" } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 1301, 1300 ] } ], "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 19, "character": 9 }, { "fileName": "profiles/profileSchemas/organization.ts", "line": 13, "character": 9 }, { "fileName": "profiles/profileSchemas/creativework.ts", "line": 11, "character": 9 } ], "type": { "type": "intrinsic", "name": "object" } }, { "id": 1165, "name": "@type", "kind": 2097152, "kindString": "Object literal", "flags": {}, "children": [ { "id": 1166, "name": "type", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profile.ts", "line": 12, "character": 19 }, { "fileName": "profiles/profileSchemas/person.ts", "line": 18, "character": 19 }, { "fileName": "profiles/profileSchemas/organization.ts", "line": 12, "character": 19 }, { "fileName": "profiles/profileSchemas/creativework.ts", "line": 10, "character": 19 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "\"string\"" } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 1166 ] } ], "sources": [ { "fileName": "profiles/profile.ts", "line": 12, "character": 11 }, { "fileName": "profiles/profileSchemas/person.ts", "line": 18, "character": 11 }, { "fileName": "profiles/profileSchemas/organization.ts", "line": 12, "character": 11 }, { "fileName": "profiles/profileSchemas/creativework.ts", "line": 10, "character": 11 } ], "type": { "type": "intrinsic", "name": "object" } }, { "id": 1339, "name": "account", "kind": 2097152, "kindString": "Object literal", "flags": {}, "children": [ { "id": 1341, "name": "optional", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 49, "character": 14 } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "true" }, { "id": 1340, "name": "type", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 48, "character": 10 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "\"array\"" }, { "id": 1342, "name": "items", "kind": 2097152, "kindString": "Object literal", "flags": {}, "children": [ { "id": 1343, "name": "type", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 51, "character": 12 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "\"object\"" }, { "id": 1344, "name": "properties", "kind": 2097152, "kindString": "Object literal", "flags": {}, "children": [ { "id": 1345, "name": "@type", "kind": 2097152, "kindString": "Object literal", "flags": {}, "children": [ { "id": 1346, "name": "type", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 53, "character": 25 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "\"string\"" } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 1346 ] } ], "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 53, "character": 17 } ], "type": { "type": "intrinsic", "name": "object" } }, { "id": 1350, "name": "identifier", "kind": 2097152, "kindString": "Object literal", "flags": {}, "children": [ { "id": 1352, "name": "optional", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 55, "character": 48 } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "true" }, { "id": 1351, "name": "type", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 55, "character": 28 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "\"string\"" } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 1352, 1351 ] } ], "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 55, "character": 20 } ], "type": { "type": "intrinsic", "name": "object" } }, { "id": 1359, "name": "proofMessage", "kind": 2097152, "kindString": "Object literal", "flags": {}, "children": [ { "id": 1361, "name": "optional", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 58, "character": 50 } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "true" }, { "id": 1360, "name": "type", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 58, "character": 30 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "\"string\"" } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 1361, 1360 ] } ], "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 58, "character": 22 } ], "type": { "type": "intrinsic", "name": "object" } }, { "id": 1362, "name": "proofSignature", "kind": 2097152, "kindString": "Object literal", "flags": {}, "children": [ { "id": 1364, "name": "optional", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 59, "character": 52 } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "true" }, { "id": 1363, "name": "type", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 59, "character": 32 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "\"string\"" } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 1364, 1363 ] } ], "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 59, "character": 24 } ], "type": { "type": "intrinsic", "name": "object" } }, { "id": 1353, "name": "proofType", "kind": 2097152, "kindString": "Object literal", "flags": {}, "children": [ { "id": 1355, "name": "optional", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 56, "character": 47 } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "true" }, { "id": 1354, "name": "type", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 56, "character": 27 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "\"string\"" } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 1355, 1354 ] } ], "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 56, "character": 19 } ], "type": { "type": "intrinsic", "name": "object" } }, { "id": 1356, "name": "proofUrl", "kind": 2097152, "kindString": "Object literal", "flags": {}, "children": [ { "id": 1358, "name": "optional", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 57, "character": 46 } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "true" }, { "id": 1357, "name": "type", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 57, "character": 26 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "\"string\"" } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 1358, 1357 ] } ], "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 57, "character": 18 } ], "type": { "type": "intrinsic", "name": "object" } }, { "id": 1347, "name": "service", "kind": 2097152, "kindString": "Object literal", "flags": {}, "children": [ { "id": 1349, "name": "optional", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 54, "character": 45 } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "true" }, { "id": 1348, "name": "type", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 54, "character": 25 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "\"string\"" } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 1349, 1348 ] } ], "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 54, "character": 17 } ], "type": { "type": "intrinsic", "name": "object" } } ], "groups": [ { "title": "Object literals", "kind": 2097152, "children": [ 1345, 1350, 1359, 1362, 1353, 1356, 1347 ] } ], "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 52, "character": 18 } ], "type": { "type": "intrinsic", "name": "object" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 1343 ] }, { "title": "Object literals", "kind": 2097152, "children": [ 1344 ] } ], "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 50, "character": 11 } ], "type": { "type": "intrinsic", "name": "object" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 1341, 1340 ] }, { "title": "Object literals", "kind": 2097152, "children": [ 1342 ] } ], "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 47, "character": 11 } ], "type": { "type": "intrinsic", "name": "object" } }, { "id": 1387, "name": "address", "kind": 2097152, "kindString": "Object literal", "flags": {}, "children": [ { "id": 1389, "name": "optional", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 87, "character": 14 } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "true" }, { "id": 1388, "name": "type", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 86, "character": 10 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "\"object\"" }, { "id": 1390, "name": "properties", "kind": 2097152, "kindString": "Object literal", "flags": {}, "children": [ { "id": 1391, "name": "@type", "kind": 2097152, "kindString": "Object literal", "flags": {}, "children": [ { "id": 1392, "name": "type", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 89, "character": 23 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "\"string\"" } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 1392 ] } ], "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 89, "character": 15 } ], "type": { "type": "intrinsic", "name": "object" } }, { "id": 1402, "name": "addressCountry", "kind": 2097152, "kindString": "Object literal", "flags": {}, "children": [ { "id": 1404, "name": "optional", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 93, "character": 50 } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "true" }, { "id": 1403, "name": "type", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 93, "character": 30 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "\"string\"" } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 1404, 1403 ] } ], "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 93, "character": 22 } ], "type": { "type": "intrinsic", "name": "object" } }, { "id": 1396, "name": "addressLocality", "kind": 2097152, "kindString": "Object literal", "flags": {}, "children": [ { "id": 1398, "name": "optional", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 91, "character": 51 } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "true" }, { "id": 1397, "name": "type", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 91, "character": 31 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "\"string\"" } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 1398, 1397 ] } ], "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 91, "character": 23 } ], "type": { "type": "intrinsic", "name": "object" } }, { "id": 1399, "name": "postalCode", "kind": 2097152, "kindString": "Object literal", "flags": {}, "children": [ { "id": 1401, "name": "optional", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 92, "character": 46 } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "true" }, { "id": 1400, "name": "type", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 92, "character": 26 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "\"string\"" } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 1401, 1400 ] } ], "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 92, "character": 18 } ], "type": { "type": "intrinsic", "name": "object" } }, { "id": 1393, "name": "streetAddress", "kind": 2097152, "kindString": "Object literal", "flags": {}, "children": [ { "id": 1395, "name": "optional", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 90, "character": 49 } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "true" }, { "id": 1394, "name": "type", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 90, "character": 29 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "\"string\"" } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 1395, 1394 ] } ], "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 90, "character": 21 } ], "type": { "type": "intrinsic", "name": "object" } } ], "groups": [ { "title": "Object literals", "kind": 2097152, "children": [ 1391, 1402, 1396, 1399, 1393 ] } ], "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 88, "character": 16 } ], "type": { "type": "intrinsic", "name": "object" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 1389, 1388 ] }, { "title": "Object literals", "kind": 2097152, "children": [ 1390 ] } ], "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 85, "character": 11 } ], "type": { "type": "intrinsic", "name": "object" } }, { "id": 1405, "name": "birthDate", "kind": 2097152, "kindString": "Object literal", "flags": {}, "children": [ { "id": 1407, "name": "optional", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 96, "character": 41 } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "true" }, { "id": 1406, "name": "type", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 96, "character": 21 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "\"string\"" } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 1407, 1406 ] } ], "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 96, "character": 13 } ], "type": { "type": "intrinsic", "name": "object" } }, { "id": 1311, "name": "description", "kind": 2097152, "kindString": "Object literal", "flags": {}, "children": [ { "id": 1313, "name": "optional", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 23, "character": 43 } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "true" }, { "id": 1312, "name": "type", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 23, "character": 23 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "\"string\"" } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 1313, 1312 ] } ], "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 23, "character": 15 } ], "type": { "type": "intrinsic", "name": "object" } }, { "id": 1308, "name": "familyName", "kind": 2097152, "kindString": "Object literal", "flags": {}, "children": [ { "id": 1310, "name": "optional", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 22, "character": 42 } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "true" }, { "id": 1309, "name": "type", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 22, "character": 22 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "\"string\"" } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 1310, 1309 ] } ], "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 22, "character": 14 } ], "type": { "type": "intrinsic", "name": "object" } }, { "id": 1305, "name": "givenName", "kind": 2097152, "kindString": "Object literal", "flags": {}, "children": [ { "id": 1307, "name": "optional", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 21, "character": 41 } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "true" }, { "id": 1306, "name": "type", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 21, "character": 21 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "\"string\"" } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 1307, 1306 ] } ], "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 21, "character": 13 } ], "type": { "type": "intrinsic", "name": "object" } }, { "id": 1314, "name": "image", "kind": 2097152, "kindString": "Object literal", "flags": {}, "children": [ { "id": 1316, "name": "optional", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 26, "character": 14 } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "true" }, { "id": 1315, "name": "type", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 25, "character": 10 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "\"array\"" }, { "id": 1317, "name": "items", "kind": 2097152, "kindString": "Object literal", "flags": {}, "children": [ { "id": 1318, "name": "type", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 28, "character": 12 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "\"object\"" }, { "id": 1319, "name": "properties", "kind": 2097152, "kindString": "Object literal", "flags": {}, "children": [ { "id": 1320, "name": "@type", "kind": 2097152, "kindString": "Object literal", "flags": {}, "children": [ { "id": 1321, "name": "type", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 30, "character": 25 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "\"string\"" } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 1321 ] } ], "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 30, "character": 17 } ], "type": { "type": "intrinsic", "name": "object" } }, { "id": 1325, "name": "contentUrl", "kind": 2097152, "kindString": "Object literal", "flags": {}, "children": [ { "id": 1327, "name": "optional", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 32, "character": 48 } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "true" }, { "id": 1326, "name": "type", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 32, "character": 28 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "\"string\"" } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 1327, 1326 ] } ], "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 32, "character": 20 } ], "type": { "type": "intrinsic", "name": "object" } }, { "id": 1322, "name": "name", "kind": 2097152, "kindString": "Object literal", "flags": {}, "children": [ { "id": 1324, "name": "optional", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 31, "character": 42 } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "true" }, { "id": 1323, "name": "type", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 31, "character": 22 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "\"string\"" } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 1324, 1323 ] } ], "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 31, "character": 14 } ], "type": { "type": "intrinsic", "name": "object" } } ], "groups": [ { "title": "Object literals", "kind": 2097152, "children": [ 1320, 1325, 1322 ] } ], "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 29, "character": 18 } ], "type": { "type": "intrinsic", "name": "object" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 1318 ] }, { "title": "Object literals", "kind": 2097152, "children": [ 1319 ] } ], "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 27, "character": 11 } ], "type": { "type": "intrinsic", "name": "object" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 1316, 1315 ] }, { "title": "Object literals", "kind": 2097152, "children": [ 1317 ] } ], "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 24, "character": 9 } ], "type": { "type": "intrinsic", "name": "object" } }, { "id": 1376, "name": "knows", "kind": 2097152, "kindString": "Object literal", "flags": {}, "children": [ { "id": 1378, "name": "optional", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 76, "character": 14 } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "true" }, { "id": 1377, "name": "type", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 75, "character": 10 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "\"array\"" }, { "id": 1379, "name": "items", "kind": 2097152, "kindString": "Object literal", "flags": {}, "children": [ { "id": 1380, "name": "type", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 78, "character": 12 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "\"object\"" }, { "id": 1381, "name": "properties", "kind": 2097152, "kindString": "Object literal", "flags": {}, "children": [ { "id": 1384, "name": "@id", "kind": 2097152, "kindString": "Object literal", "flags": {}, "children": [ { "id": 1386, "name": "optional", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 81, "character": 43 } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "true" }, { "id": 1385, "name": "type", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 81, "character": 23 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "\"string\"" } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 1386, 1385 ] } ], "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 81, "character": 15 } ], "type": { "type": "intrinsic", "name": "object" } }, { "id": 1382, "name": "@type", "kind": 2097152, "kindString": "Object literal", "flags": {}, "children": [ { "id": 1383, "name": "type", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 80, "character": 25 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "\"string\"" } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 1383 ] } ], "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 80, "character": 17 } ], "type": { "type": "intrinsic", "name": "object" } } ], "groups": [ { "title": "Object literals", "kind": 2097152, "children": [ 1384, 1382 ] } ], "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 79, "character": 18 } ], "type": { "type": "intrinsic", "name": "object" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 1380 ] }, { "title": "Object literals", "kind": 2097152, "children": [ 1381 ] } ], "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 77, "character": 11 } ], "type": { "type": "intrinsic", "name": "object" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 1378, 1377 ] }, { "title": "Object literals", "kind": 2097152, "children": [ 1379 ] } ], "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 74, "character": 9 } ], "type": { "type": "intrinsic", "name": "object" } }, { "id": 1302, "name": "name", "kind": 2097152, "kindString": "Object literal", "flags": {}, "children": [ { "id": 1304, "name": "optional", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 20, "character": 36 } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "true" }, { "id": 1303, "name": "type", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 20, "character": 16 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "\"string\"" } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 1304, 1303 ] } ], "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 20, "character": 8 } ], "type": { "type": "intrinsic", "name": "object" } }, { "id": 1408, "name": "taxID", "kind": 2097152, "kindString": "Object literal", "flags": {}, "children": [ { "id": 1410, "name": "optional", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 97, "character": 37 } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "true" }, { "id": 1409, "name": "type", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 97, "character": 17 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "\"string\"" } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 1410, 1409 ] } ], "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 97, "character": 9 } ], "type": { "type": "intrinsic", "name": "object" } }, { "id": 1328, "name": "website", "kind": 2097152, "kindString": "Object literal", "flags": {}, "children": [ { "id": 1330, "name": "optional", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 38, "character": 14 } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "true" }, { "id": 1329, "name": "type", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 37, "character": 10 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "\"array\"" }, { "id": 1331, "name": "items", "kind": 2097152, "kindString": "Object literal", "flags": {}, "children": [ { "id": 1332, "name": "type", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 40, "character": 12 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "\"object\"" }, { "id": 1333, "name": "properties", "kind": 2097152, "kindString": "Object literal", "flags": {}, "children": [ { "id": 1334, "name": "@type", "kind": 2097152, "kindString": "Object literal", "flags": {}, "children": [ { "id": 1335, "name": "type", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 42, "character": 25 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "\"string\"" } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 1335 ] } ], "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 42, "character": 17 } ], "type": { "type": "intrinsic", "name": "object" } }, { "id": 1336, "name": "url", "kind": 2097152, "kindString": "Object literal", "flags": {}, "children": [ { "id": 1338, "name": "optional", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 43, "character": 41 } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "true" }, { "id": 1337, "name": "type", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 43, "character": 21 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "\"string\"" } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 1338, 1337 ] } ], "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 43, "character": 13 } ], "type": { "type": "intrinsic", "name": "object" } } ], "groups": [ { "title": "Object literals", "kind": 2097152, "children": [ 1334, 1336 ] } ], "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 41, "character": 18 } ], "type": { "type": "intrinsic", "name": "object" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 1332 ] }, { "title": "Object literals", "kind": 2097152, "children": [ 1333 ] } ], "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 39, "character": 11 } ], "type": { "type": "intrinsic", "name": "object" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 1330, 1329 ] }, { "title": "Object literals", "kind": 2097152, "children": [ 1331 ] } ], "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 36, "character": 11 } ], "type": { "type": "intrinsic", "name": "object" } }, { "id": 1365, "name": "worksFor", "kind": 2097152, "kindString": "Object literal", "flags": {}, "children": [ { "id": 1367, "name": "optional", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 65, "character": 14 } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "true" }, { "id": 1366, "name": "type", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 64, "character": 10 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "\"array\"" }, { "id": 1368, "name": "items", "kind": 2097152, "kindString": "Object literal", "flags": {}, "children": [ { "id": 1369, "name": "type", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 67, "character": 12 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "\"object\"" }, { "id": 1370, "name": "properties", "kind": 2097152, "kindString": "Object literal", "flags": {}, "children": [ { "id": 1373, "name": "@id", "kind": 2097152, "kindString": "Object literal", "flags": {}, "children": [ { "id": 1375, "name": "optional", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 70, "character": 43 } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "true" }, { "id": 1374, "name": "type", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 70, "character": 23 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "\"string\"" } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 1375, 1374 ] } ], "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 70, "character": 15 } ], "type": { "type": "intrinsic", "name": "object" } }, { "id": 1371, "name": "@type", "kind": 2097152, "kindString": "Object literal", "flags": {}, "children": [ { "id": 1372, "name": "type", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 69, "character": 25 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "\"string\"" } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 1372 ] } ], "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 69, "character": 17 } ], "type": { "type": "intrinsic", "name": "object" } } ], "groups": [ { "title": "Object literals", "kind": 2097152, "children": [ 1373, 1371 ] } ], "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 68, "character": 18 } ], "type": { "type": "intrinsic", "name": "object" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 1369 ] }, { "title": "Object literals", "kind": 2097152, "children": [ 1370 ] } ], "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 66, "character": 11 } ], "type": { "type": "intrinsic", "name": "object" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 1367, 1366 ] }, { "title": "Object literals", "kind": 2097152, "children": [ 1368 ] } ], "sources": [ { "fileName": "profiles/profileSchemas/person.ts", "line": 63, "character": 12 } ], "type": { "type": "intrinsic", "name": "object" } } ], "groups": [ { "title": "Object literals", "kind": 2097152, "children": [ 1162, 1299, 1165, 1339, 1387, 1405, 1311, 1308, 1305, 1314, 1376, 1302, 1408, 1328, 1365 ] } ], "sources": [ { "fileName": "profiles/profile.ts", "line": 10, "character": 12 }, { "fileName": "profiles/profileSchemas/person.ts", "line": 16, "character": 12 }, { "fileName": "profiles/profileSchemas/organization.ts", "line": 10, "character": 12 }, { "fileName": "profiles/profileSchemas/creativework.ts", "line": 8, "character": 12 } ], "type": { "type": "intrinsic", "name": "object" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 1298, 1160 ] }, { "title": "Object literals", "kind": 2097152, "children": [ 1161 ] } ], "sources": [ { "fileName": "profiles/profile.ts", "line": 8, "character": 22 }, { "fileName": "profiles/profileSchemas/person.ts", "line": 13, "character": 22 }, { "fileName": "profiles/profileSchemas/organization.ts", "line": 8, "character": 22 }, { "fileName": "profiles/profileSchemas/creativework.ts", "line": 6, "character": 22 } ], "type": { "type": "intrinsic", "name": "object" } }, { "id": 2226, "name": "transactions", "kind": 2097152, "kindString": "Object literal", "flags": { "isExported": true, "isConst": true }, "children": [ { "id": 2240, "name": "BlockstackNamespace", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "operations/txbuild.ts", "line": 1211, "character": 21 } ], "type": { "type": "reference", "name": "BlockstackNamespace" } }, { "id": 2251, "name": "estimateAnnounce", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "operations/txbuild.ts", "line": 1222, "character": 18 } ], "type": { "type": "reference", "name": "estimateAnnounce", "id": 2125 } }, { "id": 2250, "name": "estimateNameImport", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "operations/txbuild.ts", "line": 1221, "character": 20 } ], "type": { "type": "reference", "name": "estimateNameImport", "id": 2119 } }, { "id": 2247, "name": "estimateNamespacePreorder", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "operations/txbuild.ts", "line": 1218, "character": 27 } ], "type": { "type": "reference", "name": "estimateNamespacePreorder", "id": 2103 } }, { "id": 2249, "name": "estimateNamespaceReady", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "operations/txbuild.ts", "line": 1220, "character": 24 } ], "type": { "type": "reference", "name": "estimateNamespaceReady", "id": 2115 } }, { "id": 2248, "name": "estimateNamespaceReveal", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "operations/txbuild.ts", "line": 1219, "character": 25 } ], "type": { "type": "reference", "name": "estimateNamespaceReveal", "id": 2109 } }, { "id": 2241, "name": "estimatePreorder", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "operations/txbuild.ts", "line": 1212, "character": 18 } ], "type": { "type": "reference", "name": "estimatePreorder", "id": 2063 } }, { "id": 2242, "name": "estimateRegister", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "operations/txbuild.ts", "line": 1213, "character": 18 } ], "type": { "type": "reference", "name": "estimateRegister", "id": 2069 } }, { "id": 2245, "name": "estimateRenewal", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "operations/txbuild.ts", "line": 1216, "character": 17 } ], "type": { "type": "reference", "name": "estimateRenewal", "id": 2089 } }, { "id": 2246, "name": "estimateRevoke", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "operations/txbuild.ts", "line": 1217, "character": 16 } ], "type": { "type": "reference", "name": "estimateRevoke", "id": 2097 } }, { "id": 2252, "name": "estimateTokenTransfer", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "operations/txbuild.ts", "line": 1223, "character": 23 } ], "type": { "type": "reference", "name": "estimateTokenTransfer", "id": 2129 } }, { "id": 2243, "name": "estimateTransfer", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "operations/txbuild.ts", "line": 1214, "character": 18 } ], "type": { "type": "reference", "name": "estimateTransfer", "id": 2082 } }, { "id": 2244, "name": "estimateUpdate", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "operations/txbuild.ts", "line": 1215, "character": 16 } ], "type": { "type": "reference", "name": "estimateUpdate", "id": 2076 } }, { "id": 2238, "name": "makeAnnounce", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "operations/txbuild.ts", "line": 1209, "character": 14 } ], "type": { "type": "reference", "name": "makeAnnounce", "id": 2206 } }, { "id": 2236, "name": "makeBitcoinSpend", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "operations/txbuild.ts", "line": 1207, "character": 18 } ], "type": { "type": "reference", "name": "makeBitcoinSpend", "id": 2220 } }, { "id": 2237, "name": "makeNameImport", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "operations/txbuild.ts", "line": 1208, "character": 16 } ], "type": { "type": "reference", "name": "makeNameImport", "id": 2199 } }, { "id": 2233, "name": "makeNamespacePreorder", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "operations/txbuild.ts", "line": 1204, "character": 23 } ], "type": { "type": "reference", "name": "makeNamespacePreorder" } }, { "id": 2235, "name": "makeNamespaceReady", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "operations/txbuild.ts", "line": 1206, "character": 20 } ], "type": { "type": "reference", "name": "makeNamespaceReady", "id": 2194 } }, { "id": 2234, "name": "makeNamespaceReveal", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "operations/txbuild.ts", "line": 1205, "character": 21 } ], "type": { "type": "reference", "name": "makeNamespaceReveal", "id": 2188 } }, { "id": 2229, "name": "makePreorder", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "operations/txbuild.ts", "line": 1200, "character": 14 } ], "type": { "type": "reference", "name": "makePreorder", "id": 2137 } }, { "id": 2230, "name": "makeRegister", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "operations/txbuild.ts", "line": 1201, "character": 14 } ], "type": { "type": "reference", "name": "makeRegister", "id": 2151 } }, { "id": 2227, "name": "makeRenewal", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "operations/txbuild.ts", "line": 1198, "character": 13 } ], "type": { "type": "reference", "name": "makeRenewal", "id": 2173 } }, { "id": 2232, "name": "makeRevoke", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "operations/txbuild.ts", "line": 1203, "character": 12 } ], "type": { "type": "reference", "name": "makeRevoke", "id": 2167 } }, { "id": 2239, "name": "makeTokenTransfer", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "operations/txbuild.ts", "line": 1210, "character": 19 } ], "type": { "type": "reference", "name": "makeTokenTransfer", "id": 2211 } }, { "id": 2231, "name": "makeTransfer", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "operations/txbuild.ts", "line": 1202, "character": 14 } ], "type": { "type": "reference", "name": "makeTransfer", "id": 2159 } }, { "id": 2228, "name": "makeUpdate", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "operations/txbuild.ts", "line": 1199, "character": 12 } ], "type": { "type": "reference", "name": "makeUpdate", "id": 2143 } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 2240, 2251, 2250, 2247, 2249, 2248, 2241, 2242, 2245, 2246, 2252, 2243, 2244, 2238, 2236, 2237, 2233, 2235, 2234, 2229, 2230, 2227, 2232, 2239, 2231, 2228 ] } ], "sources": [ { "fileName": "operations/txbuild.ts", "line": 1197, "character": 25 } ], "type": { "type": "intrinsic", "name": "object" } } ], "groups": [ { "title": "Enumerations", "kind": 4, "children": [ 1 ] }, { "title": "Classes", "kind": 128, "children": [ 643, 947, 972, 1047, 1022, 1072, 1744, 1127, 858, 997, 1544 ] }, { "title": "Interfaces", "kind": 256, "children": [ 784, 1434, 1430, 584, 1426, 823, 1680, 1097 ] }, { "title": "Type aliases", "kind": 4194304, "children": [ 1963, 1958, 1959, 1630, 1874 ] }, { "title": "Variables", "kind": 32, "children": [ 2378, 1668, 2383, 2381, 2382, 2380, 2385, 7, 1667, 2384, 1666, 2379, 563, 857, 1440, 565, 566, 564, 1869, 1870, 1871, 1872, 1873, 1629, 2037, 2038, 726, 191, 187, 186 ] }, { "title": "Functions", "kind": 64, "children": [ 1454, 1515, 796, 1447, 2125, 2119, 2103, 2115, 2109, 2063, 2069, 2089, 2097, 2129, 2082, 2076, 912, 620, 1522, 1704, 1504, 1483, 1491, 1478, 1461, 618, 1194, 569, 1892, 1441, 1716, 1496, 1879, 1702, 1695, 1671, 1537, 1706, 1422, 2206, 1636, 2220, 2199, 2194, 2188, 2137, 2151, 2173, 2167, 2211, 2159, 2143, 1882, 1509, 1697, 1712, 1913, 893, 1708, 1885, 1122, 908, 902 ] }, { "title": "Object literals", "kind": 2097152, "children": [ 1692, 1159, 2226 ] } ] }