@xyo-network/bip39 2.63.7

package/dist/docs.json

@@ -0,0 +1,755 @@
+{
+	"id": 0,
+	"name": "@xyo-network/bip39",
+	"variant": "project",
+	"kind": 1,
+	"flags": {},
+	"children": [
+		{
+			"id": 9,
+			"name": "entropyToMnemonic",
+			"variant": "declaration",
+			"kind": 64,
+			"flags": {},
+			"sources": [
+				{
+					"fileName": "index.ts",
+					"line": 97,
+					"character": 16,
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/af1027fcabba/packages/protocol/packages/bip39/src/index.ts#L97"
+				}
+			],
+			"signatures": [
+				{
+					"id": 10,
+					"name": "entropyToMnemonic",
+					"variant": "signature",
+					"kind": 4096,
+					"flags": {},
+					"comment": {
+						"summary": [
+							{
+								"kind": "text",
+								"text": "Reversible: Converts raw entropy in form of byte array to mnemonic string."
+							}
+						],
+						"blockTags": [
+							{
+								"tag": "@returns",
+								"content": [
+									{
+										"kind": "text",
+										"text": "12-24 words"
+									}
+								]
+							},
+							{
+								"tag": "@example",
+								"content": [
+									{
+										"kind": "code",
+										"text": "```ts\nconst ent = new Uint8Array([\n  0x7f, 0x7f, 0x7f, 0x7f, 0x7f, 0x7f, 0x7f, 0x7f,\n  0x7f, 0x7f, 0x7f, 0x7f, 0x7f, 0x7f, 0x7f, 0x7f\n]);\nentropyToMnemonic(ent, wordlist);\n// 'legal winner thank year wave sausage worth useful legal winner thank yellow'\n```"
+									}
+								]
+							}
+						]
+					},
+					"sources": [
+						{
+							"fileName": "index.ts",
+							"line": 97,
+							"character": 0,
+							"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/af1027fcabba/packages/protocol/packages/bip39/src/index.ts#L97"
+						}
+					],
+					"parameters": [
+						{
+							"id": 11,
+							"name": "entropy",
+							"variant": "param",
+							"kind": 32768,
+							"flags": {},
+							"comment": {
+								"summary": [
+									{
+										"kind": "text",
+										"text": "byte array"
+									}
+								]
+							},
+							"type": {
+								"type": "reference",
+								"target": {
+									"sourceFileName": "../../../../node_modules/typescript/lib/lib.es5.d.ts",
+									"qualifiedName": "Uint8Array"
+								},
+								"name": "Uint8Array",
+								"package": "typescript"
+							}
+						},
+						{
+							"id": 12,
+							"name": "wordlist",
+							"variant": "param",
+							"kind": 32768,
+							"flags": {},
+							"comment": {
+								"summary": [
+									{
+										"kind": "text",
+										"text": "imported wordlist for specific language"
+									}
+								]
+							},
+							"type": {
+								"type": "array",
+								"elementType": {
+									"type": "intrinsic",
+									"name": "string"
+								}
+							}
+						}
+					],
+					"type": {
+						"type": "intrinsic",
+						"name": "string"
+					}
+				}
+			]
+		},
+		{
+			"id": 1,
+			"name": "generateMnemonic",
+			"variant": "declaration",
+			"kind": 64,
+			"flags": {},
+			"sources": [
+				{
+					"fileName": "index.ts",
+					"line": 41,
+					"character": 16,
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/af1027fcabba/packages/protocol/packages/bip39/src/index.ts#L41"
+				}
+			],
+			"signatures": [
+				{
+					"id": 2,
+					"name": "generateMnemonic",
+					"variant": "signature",
+					"kind": 4096,
+					"flags": {},
+					"comment": {
+						"summary": [
+							{
+								"kind": "text",
+								"text": "Generate x random words. Uses Cryptographically-Secure Random Number Generator."
+							}
+						],
+						"blockTags": [
+							{
+								"tag": "@example",
+								"content": [
+									{
+										"kind": "code",
+										"text": "```ts\ngenerateMnemonic(wordlist, 128)\n// 'legal winner thank year wave sausage worth useful legal winner thank yellow'\n```"
+									}
+								]
+							}
+						]
+					},
+					"sources": [
+						{
+							"fileName": "index.ts",
+							"line": 41,
+							"character": 0,
+							"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/af1027fcabba/packages/protocol/packages/bip39/src/index.ts#L41"
+						}
+					],
+					"parameters": [
+						{
+							"id": 3,
+							"name": "wordlist",
+							"variant": "param",
+							"kind": 32768,
+							"flags": {},
+							"comment": {
+								"summary": [
+									{
+										"kind": "text",
+										"text": "imported wordlist for specific language"
+									}
+								]
+							},
+							"type": {
+								"type": "array",
+								"elementType": {
+									"type": "intrinsic",
+									"name": "string"
+								}
+							}
+						},
+						{
+							"id": 4,
+							"name": "strength",
+							"variant": "param",
+							"kind": 32768,
+							"flags": {},
+							"comment": {
+								"summary": [
+									{
+										"kind": "text",
+										"text": "mnemonic strength 128-256 bits"
+									}
+								]
+							},
+							"type": {
+								"type": "intrinsic",
+								"name": "number"
+							},
+							"defaultValue": "128"
+						}
+					],
+					"type": {
+						"type": "intrinsic",
+						"name": "string"
+					}
+				}
+			]
+		},
+		{
+			"id": 5,
+			"name": "mnemonicToEntropy",
+			"variant": "declaration",
+			"kind": 64,
+			"flags": {},
+			"sources": [
+				{
+					"fileName": "index.ts",
+					"line": 77,
+					"character": 16,
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/af1027fcabba/packages/protocol/packages/bip39/src/index.ts#L77"
+				}
+			],
+			"signatures": [
+				{
+					"id": 6,
+					"name": "mnemonicToEntropy",
+					"variant": "signature",
+					"kind": 4096,
+					"flags": {},
+					"comment": {
+						"summary": [
+							{
+								"kind": "text",
+								"text": "Reversible: Converts mnemonic string to raw entropy in form of byte array."
+							}
+						],
+						"blockTags": [
+							{
+								"tag": "@example",
+								"content": [
+									{
+										"kind": "code",
+										"text": "```ts\nconst mnem = 'legal winner thank year wave sausage worth useful legal winner thank yellow';\nmnemonicToEntropy(mnem, wordlist)\n// Produces\nnew Uint8Array([\n  0x7f, 0x7f, 0x7f, 0x7f, 0x7f, 0x7f, 0x7f, 0x7f,\n  0x7f, 0x7f, 0x7f, 0x7f, 0x7f, 0x7f, 0x7f, 0x7f\n])\n```"
+									}
+								]
+							}
+						]
+					},
+					"sources": [
+						{
+							"fileName": "index.ts",
+							"line": 77,
+							"character": 0,
+							"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/af1027fcabba/packages/protocol/packages/bip39/src/index.ts#L77"
+						}
+					],
+					"parameters": [
+						{
+							"id": 7,
+							"name": "mnemonic",
+							"variant": "param",
+							"kind": 32768,
+							"flags": {},
+							"comment": {
+								"summary": [
+									{
+										"kind": "text",
+										"text": "12-24 words"
+									}
+								]
+							},
+							"type": {
+								"type": "intrinsic",
+								"name": "string"
+							}
+						},
+						{
+							"id": 8,
+							"name": "wordlist",
+							"variant": "param",
+							"kind": 32768,
+							"flags": {},
+							"comment": {
+								"summary": [
+									{
+										"kind": "text",
+										"text": "imported wordlist for specific language"
+									}
+								]
+							},
+							"type": {
+								"type": "array",
+								"elementType": {
+									"type": "intrinsic",
+									"name": "string"
+								}
+							}
+						}
+					],
+					"type": {
+						"type": "reference",
+						"target": {
+							"sourceFileName": "../../../../node_modules/typescript/lib/lib.es5.d.ts",
+							"qualifiedName": "Uint8Array"
+						},
+						"name": "Uint8Array",
+						"package": "typescript"
+					}
+				}
+			]
+		},
+		{
+			"id": 17,
+			"name": "mnemonicToSeed",
+			"variant": "declaration",
+			"kind": 64,
+			"flags": {},
+			"sources": [
+				{
+					"fileName": "index.ts",
+					"line": 127,
+					"character": 16,
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/af1027fcabba/packages/protocol/packages/bip39/src/index.ts#L127"
+				}
+			],
+			"signatures": [
+				{
+					"id": 18,
+					"name": "mnemonicToSeed",
+					"variant": "signature",
+					"kind": 4096,
+					"flags": {},
+					"comment": {
+						"summary": [
+							{
+								"kind": "text",
+								"text": "Irreversible: Uses KDF to derive 64 bytes of key data from mnemonic + optional password."
+							}
+						],
+						"blockTags": [
+							{
+								"tag": "@returns",
+								"content": [
+									{
+										"kind": "text",
+										"text": "64 bytes of key data"
+									}
+								]
+							},
+							{
+								"tag": "@example",
+								"content": [
+									{
+										"kind": "code",
+										"text": "```ts\nconst mnem = 'legal winner thank year wave sausage worth useful legal winner thank yellow';\nawait mnemonicToSeed(mnem, 'password');\n// new Uint8Array([...64 bytes])\n```"
+									}
+								]
+							}
+						]
+					},
+					"sources": [
+						{
+							"fileName": "index.ts",
+							"line": 127,
+							"character": 0,
+							"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/af1027fcabba/packages/protocol/packages/bip39/src/index.ts#L127"
+						}
+					],
+					"parameters": [
+						{
+							"id": 19,
+							"name": "mnemonic",
+							"variant": "param",
+							"kind": 32768,
+							"flags": {},
+							"comment": {
+								"summary": [
+									{
+										"kind": "text",
+										"text": "12-24 words"
+									}
+								]
+							},
+							"type": {
+								"type": "intrinsic",
+								"name": "string"
+							}
+						},
+						{
+							"id": 20,
+							"name": "passphrase",
+							"variant": "param",
+							"kind": 32768,
+							"flags": {},
+							"comment": {
+								"summary": [
+									{
+										"kind": "text",
+										"text": "string that will additionally protect the key"
+									}
+								]
+							},
+							"type": {
+								"type": "intrinsic",
+								"name": "string"
+							},
+							"defaultValue": "''"
+						}
+					],
+					"type": {
+						"type": "reference",
+						"target": {
+							"sourceFileName": "../../../../node_modules/typescript/lib/lib.es5.d.ts",
+							"qualifiedName": "Promise"
+						},
+						"typeArguments": [
+							{
+								"type": "reference",
+								"target": {
+									"sourceFileName": "../../../../node_modules/typescript/lib/lib.es5.d.ts",
+									"qualifiedName": "Uint8Array"
+								},
+								"name": "Uint8Array",
+								"package": "typescript"
+							}
+						],
+						"name": "Promise",
+						"package": "typescript"
+					}
+				}
+			]
+		},
+		{
+			"id": 21,
+			"name": "mnemonicToSeedSync",
+			"variant": "declaration",
+			"kind": 64,
+			"flags": {},
+			"sources": [
+				{
+					"fileName": "index.ts",
+					"line": 141,
+					"character": 16,
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/af1027fcabba/packages/protocol/packages/bip39/src/index.ts#L141"
+				}
+			],
+			"signatures": [
+				{
+					"id": 22,
+					"name": "mnemonicToSeedSync",
+					"variant": "signature",
+					"kind": 4096,
+					"flags": {},
+					"comment": {
+						"summary": [
+							{
+								"kind": "text",
+								"text": "Irreversible: Uses KDF to derive 64 bytes of key data from mnemonic + optional password."
+							}
+						],
+						"blockTags": [
+							{
+								"tag": "@returns",
+								"content": [
+									{
+										"kind": "text",
+										"text": "64 bytes of key data"
+									}
+								]
+							},
+							{
+								"tag": "@example",
+								"content": [
+									{
+										"kind": "code",
+										"text": "```ts\nconst mnem = 'legal winner thank year wave sausage worth useful legal winner thank yellow';\nmnemonicToSeedSync(mnem, 'password');\n// new Uint8Array([...64 bytes])\n```"
+									}
+								]
+							}
+						]
+					},
+					"sources": [
+						{
+							"fileName": "index.ts",
+							"line": 141,
+							"character": 0,
+							"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/af1027fcabba/packages/protocol/packages/bip39/src/index.ts#L141"
+						}
+					],
+					"parameters": [
+						{
+							"id": 23,
+							"name": "mnemonic",
+							"variant": "param",
+							"kind": 32768,
+							"flags": {},
+							"comment": {
+								"summary": [
+									{
+										"kind": "text",
+										"text": "12-24 words"
+									}
+								]
+							},
+							"type": {
+								"type": "intrinsic",
+								"name": "string"
+							}
+						},
+						{
+							"id": 24,
+							"name": "passphrase",
+							"variant": "param",
+							"kind": 32768,
+							"flags": {},
+							"comment": {
+								"summary": [
+									{
+										"kind": "text",
+										"text": "string that will additionally protect the key"
+									}
+								]
+							},
+							"type": {
+								"type": "intrinsic",
+								"name": "string"
+							},
+							"defaultValue": "''"
+						}
+					],
+					"type": {
+						"type": "reference",
+						"target": {
+							"sourceFileName": "../../../../node_modules/typescript/lib/lib.es5.d.ts",
+							"qualifiedName": "Uint8Array"
+						},
+						"name": "Uint8Array",
+						"package": "typescript"
+					}
+				}
+			]
+		},
+		{
+			"id": 13,
+			"name": "validateMnemonic",
+			"variant": "declaration",
+			"kind": 64,
+			"flags": {},
+			"sources": [
+				{
+					"fileName": "index.ts",
+					"line": 106,
+					"character": 16,
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/af1027fcabba/packages/protocol/packages/bip39/src/index.ts#L106"
+				}
+			],
+			"signatures": [
+				{
+					"id": 14,
+					"name": "validateMnemonic",
+					"variant": "signature",
+					"kind": 4096,
+					"flags": {},
+					"comment": {
+						"summary": [
+							{
+								"kind": "text",
+								"text": "Validates mnemonic for being 12-24 words contained in "
+							},
+							{
+								"kind": "code",
+								"text": "`wordlist`"
+							},
+							{
+								"kind": "text",
+								"text": "."
+							}
+						]
+					},
+					"sources": [
+						{
+							"fileName": "index.ts",
+							"line": 106,
+							"character": 0,
+							"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/af1027fcabba/packages/protocol/packages/bip39/src/index.ts#L106"
+						}
+					],
+					"parameters": [
+						{
+							"id": 15,
+							"name": "mnemonic",
+							"variant": "param",
+							"kind": 32768,
+							"flags": {},
+							"type": {
+								"type": "intrinsic",
+								"name": "string"
+							}
+						},
+						{
+							"id": 16,
+							"name": "wordlist",
+							"variant": "param",
+							"kind": 32768,
+							"flags": {},
+							"type": {
+								"type": "array",
+								"elementType": {
+									"type": "intrinsic",
+									"name": "string"
+								}
+							}
+						}
+					],
+					"type": {
+						"type": "intrinsic",
+						"name": "boolean"
+					}
+				}
+			]
+		}
+	],
+	"groups": [
+		{
+			"title": "Functions",
+			"children": [
+				9,
+				1,
+				5,
+				17,
+				21,
+				13
+			]
+		}
+	],
+	"packageName": "@xyo-network/bip39",
+	"readme": [
+		{
+			"kind": "text",
+			"text": "[![logo][]](https://xyo.network)\n\nPart of [sdk-xyo-clint-js](https://www.npmjs.com/package/@xyo-network/sdk-xyo-client-js)\n\n## License\n\n> See the [LICENSE](LICENSE) file for license details\n\n## Credits\n\n[Made with 🔥 and ❄️ by XYO](https://xyo.network)\n\n[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png"
+		}
+	],
+	"symbolIdMap": {
+		"0": {
+			"sourceFileName": "src/index.ts",
+			"qualifiedName": ""
+		},
+		"1": {
+			"sourceFileName": "src/index.ts",
+			"qualifiedName": "generateMnemonic"
+		},
+		"2": {
+			"sourceFileName": "src/index.ts",
+			"qualifiedName": "generateMnemonic"
+		},
+		"3": {
+			"sourceFileName": "src/index.ts",
+			"qualifiedName": "wordlist"
+		},
+		"4": {
+			"sourceFileName": "src/index.ts",
+			"qualifiedName": "strength"
+		},
+		"5": {
+			"sourceFileName": "src/index.ts",
+			"qualifiedName": "mnemonicToEntropy"
+		},
+		"6": {
+			"sourceFileName": "src/index.ts",
+			"qualifiedName": "mnemonicToEntropy"
+		},
+		"7": {
+			"sourceFileName": "src/index.ts",
+			"qualifiedName": "mnemonic"
+		},
+		"8": {
+			"sourceFileName": "src/index.ts",
+			"qualifiedName": "wordlist"
+		},
+		"9": {
+			"sourceFileName": "src/index.ts",
+			"qualifiedName": "entropyToMnemonic"
+		},
+		"10": {
+			"sourceFileName": "src/index.ts",
+			"qualifiedName": "entropyToMnemonic"
+		},
+		"11": {
+			"sourceFileName": "src/index.ts",
+			"qualifiedName": "entropy"
+		},
+		"12": {
+			"sourceFileName": "src/index.ts",
+			"qualifiedName": "wordlist"
+		},
+		"13": {
+			"sourceFileName": "src/index.ts",
+			"qualifiedName": "validateMnemonic"
+		},
+		"14": {
+			"sourceFileName": "src/index.ts",
+			"qualifiedName": "validateMnemonic"
+		},
+		"15": {
+			"sourceFileName": "src/index.ts",
+			"qualifiedName": "mnemonic"
+		},
+		"16": {
+			"sourceFileName": "src/index.ts",
+			"qualifiedName": "wordlist"
+		},
+		"17": {
+			"sourceFileName": "src/index.ts",
+			"qualifiedName": "mnemonicToSeed"
+		},
+		"18": {
+			"sourceFileName": "src/index.ts",
+			"qualifiedName": "mnemonicToSeed"
+		},
+		"19": {
+			"sourceFileName": "src/index.ts",
+			"qualifiedName": "mnemonic"
+		},
+		"20": {
+			"sourceFileName": "src/index.ts",
+			"qualifiedName": "passphrase"
+		},
+		"21": {
+			"sourceFileName": "src/index.ts",
+			"qualifiedName": "mnemonicToSeedSync"
+		},
+		"22": {
+			"sourceFileName": "src/index.ts",
+			"qualifiedName": "mnemonicToSeedSync"
+		},
+		"23": {
+			"sourceFileName": "src/index.ts",
+			"qualifiedName": "mnemonic"
+		},
+		"24": {
+			"sourceFileName": "src/index.ts",
+			"qualifiedName": "passphrase"
+		}
+	}
+}