diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 2b618fb70..a29ab7bcb 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -25,4 +25,4 @@ jobs: - name: Lint run: npm run lint - name: Build - run: npm run build:mesh && npm run build:docs && npm run build:apps && npm run build:scripts + run: npm run build:mesh && npm run build:docs && npm run build:docs:markdown && npm run build:apps && npm run build:scripts diff --git a/docs/markdown/mesh-common/README.md b/docs/markdown/mesh-common/README.md new file mode 100644 index 000000000..aa7f173dd --- /dev/null +++ b/docs/markdown/mesh-common/README.md @@ -0,0 +1,9 @@ +**@meshsdk/common** + +*** + +# mesh-common + +Contains constants, types and interfaces used across the SDK and different serialization libraries + +[meshjs.dev](https://meshjs.dev/) diff --git a/docs/markdown/mesh-common/classes/AssetFingerprint.md b/docs/markdown/mesh-common/classes/AssetFingerprint.md new file mode 100644 index 000000000..937f66f95 --- /dev/null +++ b/docs/markdown/mesh-common/classes/AssetFingerprint.md @@ -0,0 +1,123 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / AssetFingerprint + +# Class: AssetFingerprint + +Defined in: utils/asset-fingerprint.ts:15 + +## Properties + +### hashBuf + +> `readonly` **hashBuf**: `Uint8Array` + +Defined in: utils/asset-fingerprint.ts:16 + +## Methods + +### checksum() + +> **checksum**(): `string` + +Defined in: utils/asset-fingerprint.ts:62 + +#### Returns + +`string` + +*** + +### fingerprint() + +> **fingerprint**(): `string` + +Defined in: utils/asset-fingerprint.ts:48 + +#### Returns + +`string` + +*** + +### hash() + +> **hash**(): `string` + +Defined in: utils/asset-fingerprint.ts:53 + +#### Returns + +`string` + +*** + +### prefix() + +> **prefix**(): `string` + +Defined in: utils/asset-fingerprint.ts:57 + +#### Returns + +`string` + +*** + +### fromBech32() + +> `static` **fromBech32**(`fingerprint`): `AssetFingerprint` + +Defined in: utils/asset-fingerprint.ts:38 + +#### Parameters + +##### fingerprint + +`string` + +#### Returns + +`AssetFingerprint` + +*** + +### fromHash() + +> `static` **fromHash**(`hash`): `AssetFingerprint` + +Defined in: utils/asset-fingerprint.ts:22 + +#### Parameters + +##### hash + +`Uint8Array` + +#### Returns + +`AssetFingerprint` + +*** + +### fromParts() + +> `static` **fromParts**(`policyId`, `assetName`): `AssetFingerprint` + +Defined in: utils/asset-fingerprint.ts:26 + +#### Parameters + +##### policyId + +`Uint8Array` + +##### assetName + +`Uint8Array` + +#### Returns + +`AssetFingerprint` diff --git a/docs/markdown/mesh-common/classes/BigNum.md b/docs/markdown/mesh-common/classes/BigNum.md new file mode 100644 index 000000000..e8bd3743a --- /dev/null +++ b/docs/markdown/mesh-common/classes/BigNum.md @@ -0,0 +1,191 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / BigNum + +# Class: BigNum + +Defined in: utils/big-num.ts:1 + +## Constructors + +### Constructor + +> **new BigNum**(`value?`): `BigNum` + +Defined in: utils/big-num.ts:4 + +#### Parameters + +##### value? + +`string` | `number` | `bigint` + +#### Returns + +`BigNum` + +## Properties + +### value + +> **value**: `bigint` + +Defined in: utils/big-num.ts:2 + +## Methods + +### checkedAdd() + +> **checkedAdd**(`other`): `BigNum` + +Defined in: utils/big-num.ts:31 + +#### Parameters + +##### other + +`BigNum` + +#### Returns + +`BigNum` + +*** + +### checkedMul() + +> **checkedMul**(`other`): `BigNum` + +Defined in: utils/big-num.ts:26 + +#### Parameters + +##### other + +`BigNum` + +#### Returns + +`BigNum` + +*** + +### checkedSub() + +> **checkedSub**(`other`): `BigNum` + +Defined in: utils/big-num.ts:36 + +#### Parameters + +##### other + +`BigNum` + +#### Returns + +`BigNum` + +*** + +### clampedSub() + +> **clampedSub**(`other`): `BigNum` + +Defined in: utils/big-num.ts:41 + +#### Parameters + +##### other + +`BigNum` + +#### Returns + +`BigNum` + +*** + +### compare() + +> **compare**(`other`): `-1` \| `0` \| `1` + +Defined in: utils/big-num.ts:53 + +#### Parameters + +##### other + +`BigNum` + +#### Returns + +`-1` \| `0` \| `1` + +*** + +### divFloor() + +> **divFloor**(`other`): `BigNum` + +Defined in: utils/big-num.ts:21 + +#### Parameters + +##### other + +`BigNum` + +#### Returns + +`BigNum` + +*** + +### lessThan() + +> **lessThan**(`other`): `boolean` + +Defined in: utils/big-num.ts:49 + +#### Parameters + +##### other + +`BigNum` + +#### Returns + +`boolean` + +*** + +### toString() + +> **toString**(): `string` + +Defined in: utils/big-num.ts:65 + +#### Returns + +`string` + +*** + +### new() + +> `static` **new**(`value`): `BigNum` + +Defined in: utils/big-num.ts:12 + +#### Parameters + +##### value + +`undefined` | `string` | `number` | `bigint` + +#### Returns + +`BigNum` diff --git a/docs/markdown/mesh-common/classes/MeshValue.md b/docs/markdown/mesh-common/classes/MeshValue.md new file mode 100644 index 000000000..555c8cd3b --- /dev/null +++ b/docs/markdown/mesh-common/classes/MeshValue.md @@ -0,0 +1,497 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / MeshValue + +# Class: MeshValue + +Defined in: data/value.ts:56 + +MeshValue provide utility to handle the Cardano value manipulation. It offers certain axioms: +1. No duplication of asset - adding assets with same asset name will increase the quantity of the asset in the same record. +2. No zero and negative entry - the quantity of the asset should not be zero or negative. +3. Sanitization of lovelace asset name - the class handle back and forth conversion of lovelace asset name to empty string. +4. Easy convertion to Cardano data - offer utility to convert into either Mesh Data type and JSON type for its Cardano data representation. + +## Constructors + +### Constructor + +> **new MeshValue**(`value`): `MeshValue` + +Defined in: data/value.ts:59 + +#### Parameters + +##### value + +`Record`\<`string`, `bigint`\> = `{}` + +#### Returns + +`MeshValue` + +## Properties + +### value + +> **value**: `Record`\<`string`, `bigint`\> + +Defined in: data/value.ts:57 + +## Methods + +### addAsset() + +> **addAsset**(`asset`): `this` + +Defined in: data/value.ts:101 + +Add an asset to the Value class's value record. + +#### Parameters + +##### asset + +[`Asset`](../type-aliases/Asset.md) + +The asset to add + +#### Returns + +`this` + +The updated MeshValue object + +*** + +### addAssets() + +> **addAssets**(`assets`): `this` + +Defined in: data/value.ts:118 + +Add an array of assets to the Value class's value record. + +#### Parameters + +##### assets + +[`Asset`](../type-aliases/Asset.md)[] + +The assets to add + +#### Returns + +`this` + +The updated MeshValue object + +*** + +### eq() + +> **eq**(`other`): `boolean` + +Defined in: data/value.ts:241 + +Check if the value is equal to another value + +#### Parameters + +##### other + +`MeshValue` + +The value to compare against + +#### Returns + +`boolean` + +boolean + +*** + +### eqUnit() + +> **eqUnit**(`unit`, `other`): `boolean` + +Defined in: data/value.ts:251 + +Check if the specific unit of value is equal to that unit of another value + +#### Parameters + +##### unit + +`string` + +The unit to compare + +##### other + +`MeshValue` + +The value to compare against + +#### Returns + +`boolean` + +boolean + +*** + +### geq() + +> **geq**(`other`): `boolean` + +Defined in: data/value.ts:197 + +Check if the value is greater than or equal to another value + +#### Parameters + +##### other + +`MeshValue` + +The value to compare against + +#### Returns + +`boolean` + +boolean + +*** + +### geqUnit() + +> **geqUnit**(`unit`, `other`): `boolean` + +Defined in: data/value.ts:207 + +Check if the specific unit of value is greater than or equal to that unit of another value + +#### Parameters + +##### unit + +`string` + +The unit to compare + +##### other + +`MeshValue` + +The value to compare against + +#### Returns + +`boolean` + +boolean + +*** + +### get() + +> **get**(`unit`): `bigint` + +Defined in: data/value.ts:160 + +Get the quantity of asset object per unit + +#### Parameters + +##### unit + +`string` + +The unit to get the quantity of + +#### Returns + +`bigint` + +The quantity of the asset + +*** + +### getPolicyAssets() + +> **getPolicyAssets**(`policyId`): [`Asset`](../type-aliases/Asset.md)[] + +Defined in: data/value.ts:169 + +Get all assets that belong to a specific policy ID + +#### Parameters + +##### policyId + +`string` + +The policy ID to filter by + +#### Returns + +[`Asset`](../type-aliases/Asset.md)[] + +Array of assets that match the policy ID + +*** + +### isEmpty() + +> **isEmpty**(): `boolean` + +Defined in: data/value.ts:261 + +Check if the value is empty + +#### Returns + +`boolean` + +boolean + +*** + +### leq() + +> **leq**(`other`): `boolean` + +Defined in: data/value.ts:219 + +Check if the value is less than or equal to another value + +#### Parameters + +##### other + +`MeshValue` + +The value to compare against + +#### Returns + +`boolean` + +boolean + +*** + +### leqUnit() + +> **leqUnit**(`unit`, `other`): `boolean` + +Defined in: data/value.ts:229 + +Check if the specific unit of value is less than or equal to that unit of another value + +#### Parameters + +##### unit + +`string` + +The unit to compare + +##### other + +`MeshValue` + +The value to compare against + +#### Returns + +`boolean` + +boolean + +*** + +### merge() + +> **merge**(`values`): `this` + +Defined in: data/value.ts:270 + +Merge the given values + +#### Parameters + +##### values + +The other values to merge + +`MeshValue` | `MeshValue`[] + +#### Returns + +`this` + +this + +*** + +### negateAsset() + +> **negateAsset**(`asset`): `this` + +Defined in: data/value.ts:130 + +Substract an asset from the Value class's value record. + +#### Parameters + +##### asset + +[`Asset`](../type-aliases/Asset.md) + +The asset to subtract + +#### Returns + +`this` + +The updated MeshValue object + +*** + +### negateAssets() + +> **negateAssets**(`assets`): `this` + +Defined in: data/value.ts:148 + +Subtract an array of assets from the Value class's value record. + +#### Parameters + +##### assets + +[`Asset`](../type-aliases/Asset.md)[] + +The assets to subtract + +#### Returns + +`this` + +The updated MeshValue object + +*** + +### toAssets() + +> **toAssets**(): [`Asset`](../type-aliases/Asset.md)[] + +Defined in: data/value.ts:289 + +Convert the MeshValue object into an array of Asset + +#### Returns + +[`Asset`](../type-aliases/Asset.md)[] + +The array of Asset + +*** + +### toData() + +> **toData**(): [`MValue`](../type-aliases/MValue.md) + +Defined in: data/value.ts:300 + +Convert the MeshValue object into Cardano data Value in Mesh Data type + +#### Returns + +[`MValue`](../type-aliases/MValue.md) + +*** + +### toJSON() + +> **toJSON**(): [`Value`](../type-aliases/Value.md) + +Defined in: data/value.ts:327 + +Convert the MeshValue object into a JSON representation of Cardano data Value + +#### Returns + +[`Value`](../type-aliases/Value.md) + +Cardano data Value in JSON + +*** + +### units() + +> **units**(): `string`[] + +Defined in: data/value.ts:188 + +Get all asset units + +#### Returns + +`string`[] + +The asset units + +*** + +### fromAssets() + +> `static` **fromAssets**(`assets`): `MeshValue` + +Defined in: data/value.ts:68 + +Converting assets into MeshValue + +#### Parameters + +##### assets + +[`Asset`](../type-aliases/Asset.md)[] + +The assets to convert + +#### Returns + +`MeshValue` + +MeshValue + +*** + +### fromValue() + +> `static` **fromValue**(`plutusValue`): `MeshValue` + +Defined in: data/value.ts:79 + +Converting Value (the JSON representation of Cardano data Value) into MeshValue + +#### Parameters + +##### plutusValue + +[`Value`](../type-aliases/Value.md) + +The Value to convert + +#### Returns + +`MeshValue` + +MeshValue diff --git a/docs/markdown/mesh-common/classes/TxTester.md b/docs/markdown/mesh-common/classes/TxTester.md new file mode 100644 index 000000000..eadb69a88 --- /dev/null +++ b/docs/markdown/mesh-common/classes/TxTester.md @@ -0,0 +1,748 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / TxTester + +# Class: TxTester + +Defined in: tx-tester/index.ts:15 + +TxTester class for evaluating transactions + +## Constructors + +### Constructor + +> **new TxTester**(`txBody`): `TxTester` + +Defined in: tx-tester/index.ts:25 + +Create a new TxTester instance + +#### Parameters + +##### txBody + +[`MeshTxBuilderBody`](../type-aliases/MeshTxBuilderBody.md) + +The transaction builder body + +#### Returns + +`TxTester` + +## Properties + +### inputsEvaluating + +> **inputsEvaluating**: [`TxIn`](../type-aliases/TxIn.md)[] + +Defined in: tx-tester/index.ts:17 + +*** + +### outputsEvaluating + +> **outputsEvaluating**: [`Output`](../type-aliases/Output.md)[] + +Defined in: tx-tester/index.ts:18 + +*** + +### traces + +> **traces**: `string`[] + +Defined in: tx-tester/index.ts:19 + +*** + +### txBody + +> **txBody**: [`MeshTxBuilderBody`](../type-aliases/MeshTxBuilderBody.md) + +Defined in: tx-tester/index.ts:16 + +## Methods + +### addTrace() + +> **addTrace**(`funcName`, `message`): `void` + +Defined in: tx-tester/index.ts:37 + +Add a trace to the TxTester + +#### Parameters + +##### funcName + +`string` + +The function name where the error occurred + +##### message + +`string` + +The error message + +#### Returns + +`void` + +*** + +### allInputs() + +> **allInputs**(): `this` + +Defined in: tx-tester/index.ts:300 + +Not apply filter to inputs + +#### Returns + +`this` + +The TxTester instance for chaining + +*** + +### allKeysSigned() + +> **allKeysSigned**(`keyHashes`): `this` + +Defined in: tx-tester/index.ts:148 + +Checks if all specified keys are signed in the transaction. + +#### Parameters + +##### keyHashes + +`string`[] + +The array of key hashes to check + +#### Returns + +`this` + +The TxTester instance for chaining + +*** + +### allOutputs() + +> **allOutputs**(): `this` + +Defined in: tx-tester/index.ts:434 + +Not apply filter to outputs + +#### Returns + +`this` + +The TxTester instance for chaining + +*** + +### checkPolicyOnlyBurn() + +> **checkPolicyOnlyBurn**(`policyId`): `boolean` + +Defined in: tx-tester/index.ts:284 + +Checks if a specific policy ID is burned in the transaction, ensuring that it is the only minting (i.e. burning item). + +#### Parameters + +##### policyId + +`string` + +The policy ID to check + +#### Returns + +`boolean` + +true if the policy is the only burn, false otherwise + +*** + +### errors() + +> **errors**(): `string` + +Defined in: tx-tester/index.ts:54 + +Get the error messages if any + +#### Returns + +`string` + +A string representation of the errors or "No errors" if there are none + +*** + +### inputsAt() + +> **inputsAt**(`address`): `this` + +Defined in: tx-tester/index.ts:310 + +Filter inputs by address + +#### Parameters + +##### address + +`string` + +The address to filter by + +#### Returns + +`this` + +The TxTester instance for chaining + +*** + +### inputsAtWith() + +> **inputsAtWith**(`address`, `unit`): `this` + +Defined in: tx-tester/index.ts:375 + +Filter inputs by address and unit + +#### Parameters + +##### address + +`string` + +The address to filter by + +##### unit + +`string` + +The unit to filter by + +#### Returns + +`this` + +The TxTester instance for chaining + +*** + +### inputsAtWithPolicy() + +> **inputsAtWithPolicy**(`address`, `policyId`): `this` + +Defined in: tx-tester/index.ts:358 + +Filter inputs by address and policy ID + +#### Parameters + +##### address + +`string` + +The address to filter by + +##### policyId + +`string` + +The policy ID to filter by + +#### Returns + +`this` + +The TxTester instance for chaining + +*** + +### inputsValue() + +> **inputsValue**(`expectedValue`): `this` + +Defined in: tx-tester/index.ts:392 + +Check if inputs contain the expected value. +*Reminder - It must be called after filtering methods for inputs* + +#### Parameters + +##### expectedValue + +`any` + +The expected value + +#### Returns + +`this` + +The TxTester instance for chaining + +*** + +### inputsWith() + +> **inputsWith**(`unit`): `this` + +Defined in: tx-tester/index.ts:323 + +Filter inputs by unit + +#### Parameters + +##### unit + +`string` + +The unit to filter by + +#### Returns + +`this` + +The TxTester instance for chaining + +*** + +### inputsWithPolicy() + +> **inputsWithPolicy**(`policyId`): `this` + +Defined in: tx-tester/index.ts:340 + +Filter inputs by policy ID + +#### Parameters + +##### policyId + +`string` + +The policy ID to filter by + +#### Returns + +`this` + +The TxTester instance for chaining + +*** + +### keySigned() + +> **keySigned**(`keyHash`): `this` + +Defined in: tx-tester/index.ts:116 + +Checks if a specific key is signed in the transaction. + +#### Parameters + +##### keyHash + +`string` + +The key hash to check + +#### Returns + +`this` + +The TxTester instance for chaining + +*** + +### oneOfKeysSigned() + +> **oneOfKeysSigned**(`keyHashes`): `this` + +Defined in: tx-tester/index.ts:129 + +Checks if any one of the specified keys is signed in the transaction. + +#### Parameters + +##### keyHashes + +`string`[] + +The array of key hashes to check + +#### Returns + +`this` + +The TxTester instance for chaining + +*** + +### onlyTokenMinted() + +> **onlyTokenMinted**(`policyId`, `assetName`, `quantity`): `this` + +Defined in: tx-tester/index.ts:207 + +Checks if a specific token is minted in the transaction and that it is the only mint. + +#### Parameters + +##### policyId + +`string` + +The policy ID of the token + +##### assetName + +`string` + +The asset name of the token + +##### quantity + +`number` + +The quantity of the token + +#### Returns + +`this` + +The TxTester instance for chaining + +*** + +### outputsAt() + +> **outputsAt**(`address`): `this` + +Defined in: tx-tester/index.ts:444 + +Filter outputs by address + +#### Parameters + +##### address + +`string` + +The address to filter by + +#### Returns + +`this` + +The TxTester instance for chaining + +*** + +### outputsAtWith() + +> **outputsAtWith**(`address`, `unit`): `this` + +Defined in: tx-tester/index.ts:503 + +Filter outputs by address and unit + +#### Parameters + +##### address + +`string` + +The address to filter by + +##### unit + +`string` + +The unit to filter by + +#### Returns + +`this` + +The TxTester instance for chaining + +*** + +### outputsAtWithPolicy() + +> **outputsAtWithPolicy**(`address`, `policyId`): `this` + +Defined in: tx-tester/index.ts:487 + +Filter outputs by address and policy ID + +#### Parameters + +##### address + +`string` + +The address to filter by + +##### policyId + +`string` + +The policy ID to filter by + +#### Returns + +`this` + +The TxTester instance for chaining + +*** + +### outputsInlineDatumExist() + +> **outputsInlineDatumExist**(`datumCbor`): `this` + +Defined in: tx-tester/index.ts:541 + +Check if outputs contain a specific inline datum. +*Reminder - It must be called after filtering methods for outputs* + +#### Parameters + +##### datumCbor + +`string` + +The datum CBOR to check + +#### Returns + +`this` + +The TxTester instance for chaining + +*** + +### outputsValue() + +> **outputsValue**(`expectedValue`): `this` + +Defined in: tx-tester/index.ts:519 + +Check if outputs contain the expected value. +*Reminder - It must be called after filtering methods for outputs* + +#### Parameters + +##### expectedValue + +[`MeshValue`](MeshValue.md) + +The expected value + +#### Returns + +`this` + +The TxTester instance for chaining + +*** + +### outputsWith() + +> **outputsWith**(`unit`): `this` + +Defined in: tx-tester/index.ts:455 + +Filter outputs by unit + +#### Parameters + +##### unit + +`string` + +The unit to filter by + +#### Returns + +`this` + +The TxTester instance for chaining + +*** + +### outputsWithPolicy() + +> **outputsWithPolicy**(`policyId`): `this` + +Defined in: tx-tester/index.ts:471 + +Filter outputs by policy ID + +#### Parameters + +##### policyId + +`string` + +The policy ID to filter by + +#### Returns + +`this` + +The TxTester instance for chaining + +*** + +### policyOnlyMintedToken() + +> **policyOnlyMintedToken**(`policyId`, `assetName`, `quantity`): `this` + +Defined in: tx-tester/index.ts:244 + +Checks if a specific token is minted in the transaction, ensuring that it is the only mint for the given policy ID. + +#### Parameters + +##### policyId + +`string` + +The policy ID of the token + +##### assetName + +`string` + +The asset name of the token + +##### quantity + +`number` + +The quantity of the token + +#### Returns + +`this` + +The TxTester instance for chaining + +*** + +### success() + +> **success**(): `boolean` + +Defined in: tx-tester/index.ts:46 + +Check if the transaction evaluation was successful + +#### Returns + +`boolean` + +true if there are no errors, false otherwise + +*** + +### tokenMinted() + +> **tokenMinted**(`policyId`, `assetName`, `quantity`): `this` + +Defined in: tx-tester/index.ts:178 + +Checks if a specific token is minted in the transaction. + +#### Parameters + +##### policyId + +`string` + +The policy ID of the token + +##### assetName + +`string` + +The asset name of the token + +##### quantity + +`number` + +The quantity of the token + +#### Returns + +`this` + +The TxTester instance for chaining + +*** + +### validAfter() + +> **validAfter**(`requiredTimestamp`): `this` + +Defined in: tx-tester/index.ts:67 + +Checks if the transaction is valid after a specified timestamp. + +#### Parameters + +##### requiredTimestamp + +`number` + +The timestamp after which the transaction should be valid + +#### Returns + +`this` + +The TxTester instance for chaining + +*** + +### validBefore() + +> **validBefore**(`requiredTimestamp`): `this` + +Defined in: tx-tester/index.ts:90 + +Checks if the transaction is valid before a specified timestamp. + +#### Parameters + +##### requiredTimestamp + +`number` + +The timestamp before which the transaction should be valid + +#### Returns + +`this` + +The TxTester instance for chaining diff --git a/docs/markdown/mesh-common/classes/UtxoSelection.md b/docs/markdown/mesh-common/classes/UtxoSelection.md new file mode 100644 index 000000000..f40343f9f --- /dev/null +++ b/docs/markdown/mesh-common/classes/UtxoSelection.md @@ -0,0 +1,131 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / UtxoSelection + +# Class: UtxoSelection + +Defined in: utxo-selection/index.ts:27 + +All UTxO selection algorithms follows below's interface + +Supported algorithms: +- largestFirst - CIP2 suggested algorithm +- largestFirstMultiAsset - CIP2 suggested algorithm +- keepRelevant - CIP2 suggested algorithm +- experimental - The always evolving algorithm according to the latest research + +## Param + +## Param + +## Constructors + +### Constructor + +> **new UtxoSelection**(`threshold`, `includeTxFees`): `UtxoSelection` + +Defined in: utxo-selection/index.ts:31 + +#### Parameters + +##### threshold + +`string` = `"5000000"` + +##### includeTxFees + +`boolean` = `true` + +#### Returns + +`UtxoSelection` + +## Methods + +### experimental() + +> **experimental**(`requiredAssets`, `inputs`): [`UTxO`](../type-aliases/UTxO.md)[] + +Defined in: utxo-selection/index.ts:60 + +#### Parameters + +##### requiredAssets + +`Map`\<`string`, `string`\> + +##### inputs + +[`UTxO`](../type-aliases/UTxO.md)[] + +#### Returns + +[`UTxO`](../type-aliases/UTxO.md)[] + +*** + +### keepRelevant() + +> **keepRelevant**(`requiredAssets`, `inputs`): [`UTxO`](../type-aliases/UTxO.md)[] + +Defined in: utxo-selection/index.ts:47 + +#### Parameters + +##### requiredAssets + +`Map`\<`string`, `string`\> + +##### inputs + +[`UTxO`](../type-aliases/UTxO.md)[] + +#### Returns + +[`UTxO`](../type-aliases/UTxO.md)[] + +*** + +### largestFirst() + +> **largestFirst**(`requiredAssets`, `inputs`): [`UTxO`](../type-aliases/UTxO.md)[] + +Defined in: utxo-selection/index.ts:36 + +#### Parameters + +##### requiredAssets + +`Map`\<`string`, `string`\> + +##### inputs + +[`UTxO`](../type-aliases/UTxO.md)[] + +#### Returns + +[`UTxO`](../type-aliases/UTxO.md)[] + +*** + +### largestFirstMultiAsset() + +> **largestFirstMultiAsset**(`requiredAssets`, `inputs`): [`UTxO`](../type-aliases/UTxO.md)[] + +Defined in: utxo-selection/index.ts:51 + +#### Parameters + +##### requiredAssets + +`Map`\<`string`, `string`\> + +##### inputs + +[`UTxO`](../type-aliases/UTxO.md)[] + +#### Returns + +[`UTxO`](../type-aliases/UTxO.md)[] diff --git a/docs/markdown/mesh-common/functions/CIP68_100.md b/docs/markdown/mesh-common/functions/CIP68_100.md new file mode 100644 index 000000000..7891c656d --- /dev/null +++ b/docs/markdown/mesh-common/functions/CIP68_100.md @@ -0,0 +1,27 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / CIP68\_100 + +# Function: CIP68\_100() + +> **CIP68\_100**(`tokenNameHex`): `string` + +Defined in: constants/index.ts:85 + +The utility function to append the bytes for CIP-68 100 token in front of the token hex + +## Parameters + +### tokenNameHex + +`string` + +The hex of the token name + +## Returns + +`string` + +The hex of the token name with the CIP-68 100 bytes appended diff --git a/docs/markdown/mesh-common/functions/CIP68_222.md b/docs/markdown/mesh-common/functions/CIP68_222.md new file mode 100644 index 000000000..1a4f16b42 --- /dev/null +++ b/docs/markdown/mesh-common/functions/CIP68_222.md @@ -0,0 +1,27 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / CIP68\_222 + +# Function: CIP68\_222() + +> **CIP68\_222**(`tokenNameHex`): `string` + +Defined in: constants/index.ts:94 + +The utility function to append the bytes for CIP-68 222 token in front of the token hex + +## Parameters + +### tokenNameHex + +`string` + +The hex of the token name + +## Returns + +`string` + +The hex of the token name with the CIP-68 222 bytes appended diff --git a/docs/markdown/mesh-common/functions/assetClass.md b/docs/markdown/mesh-common/functions/assetClass.md new file mode 100644 index 000000000..4b03a4719 --- /dev/null +++ b/docs/markdown/mesh-common/functions/assetClass.md @@ -0,0 +1,33 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / assetClass + +# Function: assetClass() + +> **assetClass**(`currencySymbolHex`, `tokenNameHex`): [`AssetClass`](../type-aliases/AssetClass.md) + +Defined in: data/json/aliases.ts:182 + +The utility function to create a Plutus Data asset class in JSON + +## Parameters + +### currencySymbolHex + +`string` + +The currency symbol in hex + +### tokenNameHex + +`string` + +The token name in hex + +## Returns + +[`AssetClass`](../type-aliases/AssetClass.md) + +The Plutus Data asset class object diff --git a/docs/markdown/mesh-common/functions/assetName.md b/docs/markdown/mesh-common/functions/assetName.md new file mode 100644 index 000000000..6d18fd988 --- /dev/null +++ b/docs/markdown/mesh-common/functions/assetName.md @@ -0,0 +1,27 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / assetName + +# Function: assetName() + +> **assetName**(`bytes`): [`ByteString`](../type-aliases/ByteString.md) + +Defined in: data/json/aliases.ts:160 + +The utility function to create a Plutus Data asset name in JSON + +## Parameters + +### bytes + +`string` + +The asset name in hex + +## Returns + +[`ByteString`](../type-aliases/ByteString.md) + +The Plutus Data asset name object diff --git a/docs/markdown/mesh-common/functions/assocMap.md b/docs/markdown/mesh-common/functions/assocMap.md new file mode 100644 index 000000000..b0fa6da90 --- /dev/null +++ b/docs/markdown/mesh-common/functions/assocMap.md @@ -0,0 +1,43 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / assocMap + +# Function: assocMap() + +> **assocMap**\<`K`, `V`\>(`mapItems`, `validation`): [`AssocMap`](../type-aliases/AssocMap.md)\<`K`, `V`\> + +Defined in: data/json/primitives.ts:153 + +The utility function to create a Plutus Data association map in JSON + +## Type Parameters + +### K + +`K` + +### V + +`V` + +## Parameters + +### mapItems + +\[`K`, `V`\][] + +The items map in array + +### validation + +`boolean` = `true` + +Default true - If current data construction would perform validation (introducing this flag due to possible performance issue in loop validation) + +## Returns + +[`AssocMap`](../type-aliases/AssocMap.md)\<`K`, `V`\> + +The Plutus Data association map object diff --git a/docs/markdown/mesh-common/functions/bool.md b/docs/markdown/mesh-common/functions/bool.md new file mode 100644 index 000000000..933b96943 --- /dev/null +++ b/docs/markdown/mesh-common/functions/bool.md @@ -0,0 +1,27 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / bool + +# Function: bool() + +> **bool**(`b`): [`Bool`](../type-aliases/Bool.md) + +Defined in: data/json/primitives.ts:58 + +The utility function to create a Plutus Data boolean in JSON + +## Parameters + +### b + +`boolean` + +boolean value + +## Returns + +[`Bool`](../type-aliases/Bool.md) + +The Plutus Data boolean object diff --git a/docs/markdown/mesh-common/functions/builtinByteString.md b/docs/markdown/mesh-common/functions/builtinByteString.md new file mode 100644 index 000000000..ae23bcc6a --- /dev/null +++ b/docs/markdown/mesh-common/functions/builtinByteString.md @@ -0,0 +1,27 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / builtinByteString + +# Function: builtinByteString() + +> **builtinByteString**(`bytes`): [`BuiltinByteString`](../type-aliases/BuiltinByteString.md) + +Defined in: data/json/primitives.ts:66 + +The utility function to create a Plutus Data byte string in JSON + +## Parameters + +### bytes + +`string` + +The byte string in hex + +## Returns + +[`BuiltinByteString`](../type-aliases/BuiltinByteString.md) + +The Plutus Data byte string object diff --git a/docs/markdown/mesh-common/functions/byteString.md b/docs/markdown/mesh-common/functions/byteString.md new file mode 100644 index 000000000..4799eab5b --- /dev/null +++ b/docs/markdown/mesh-common/functions/byteString.md @@ -0,0 +1,27 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / byteString + +# Function: byteString() + +> **byteString**(`bytes`): [`ByteString`](../type-aliases/ByteString.md) + +Defined in: data/json/primitives.ts:75 + +The utility function to create a Plutus Data byte string in JSON + +## Parameters + +### bytes + +`string` + +The byte string in hex + +## Returns + +[`ByteString`](../type-aliases/ByteString.md) + +The Plutus Data byte string object diff --git a/docs/markdown/mesh-common/functions/bytesToHex.md b/docs/markdown/mesh-common/functions/bytesToHex.md new file mode 100644 index 000000000..e7e7c1747 --- /dev/null +++ b/docs/markdown/mesh-common/functions/bytesToHex.md @@ -0,0 +1,27 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / bytesToHex + +# Function: bytesToHex() + +> **bytesToHex**(`bytes`): `string` + +Defined in: data/parser.ts:8 + +Converting bytes to hex string + +## Parameters + +### bytes + +`ArrayBuffer` + +The bytes to be converted + +## Returns + +`string` + +The hex string diff --git a/docs/markdown/mesh-common/functions/castProtocol.md b/docs/markdown/mesh-common/functions/castProtocol.md new file mode 100644 index 000000000..91c237b44 --- /dev/null +++ b/docs/markdown/mesh-common/functions/castProtocol.md @@ -0,0 +1,21 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / castProtocol + +# Function: castProtocol() + +> **castProtocol**(`data`): [`Protocol`](../type-aliases/Protocol.md) + +Defined in: types/protocol.ts:27 + +## Parameters + +### data + +`Partial`\<`Record`\\> + +## Returns + +[`Protocol`](../type-aliases/Protocol.md) diff --git a/docs/markdown/mesh-common/functions/cloneTxBuilderBody.md b/docs/markdown/mesh-common/functions/cloneTxBuilderBody.md new file mode 100644 index 000000000..d9e9b5719 --- /dev/null +++ b/docs/markdown/mesh-common/functions/cloneTxBuilderBody.md @@ -0,0 +1,21 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / cloneTxBuilderBody + +# Function: cloneTxBuilderBody() + +> **cloneTxBuilderBody**(`body`): [`MeshTxBuilderBody`](../type-aliases/MeshTxBuilderBody.md) + +Defined in: types/transaction-builder/index.ts:79 + +## Parameters + +### body + +[`MeshTxBuilderBody`](../type-aliases/MeshTxBuilderBody.md) + +## Returns + +[`MeshTxBuilderBody`](../type-aliases/MeshTxBuilderBody.md) diff --git a/docs/markdown/mesh-common/functions/conStr.md b/docs/markdown/mesh-common/functions/conStr.md new file mode 100644 index 000000000..8aba8547a --- /dev/null +++ b/docs/markdown/mesh-common/functions/conStr.md @@ -0,0 +1,43 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / conStr + +# Function: conStr() + +> **conStr**\<`N`, `T`\>(`constructor`, `fields`): [`ConStr`](../type-aliases/ConStr.md)\<`N`, `T`\> + +Defined in: data/json/constructors.ts:32 + +The utility function to create a Plutus Data constructor object, representing custom data type in JSON + +## Type Parameters + +### N + +`N` *extends* `number` + +### T + +`T` + +## Parameters + +### constructor + +`N` + +The constructor index number + +### fields + +`T` + +The items in array + +## Returns + +[`ConStr`](../type-aliases/ConStr.md)\<`N`, `T`\> + +The Plutus Data constructor object diff --git a/docs/markdown/mesh-common/functions/conStr0.md b/docs/markdown/mesh-common/functions/conStr0.md new file mode 100644 index 000000000..400c70103 --- /dev/null +++ b/docs/markdown/mesh-common/functions/conStr0.md @@ -0,0 +1,33 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / conStr0 + +# Function: conStr0() + +> **conStr0**\<`T`\>(`fields`): [`ConStr0`](../type-aliases/ConStr0.md)\<`T`\> + +Defined in: data/json/constructors.ts:50 + +The utility function to create a Plutus Data index 0 constructor object, representing custom data type in JSON + +## Type Parameters + +### T + +`T` + +## Parameters + +### fields + +`T` + +The items of in array + +## Returns + +[`ConStr0`](../type-aliases/ConStr0.md)\<`T`\> + +The Plutus Data constructor object diff --git a/docs/markdown/mesh-common/functions/conStr1.md b/docs/markdown/mesh-common/functions/conStr1.md new file mode 100644 index 000000000..4a504c92b --- /dev/null +++ b/docs/markdown/mesh-common/functions/conStr1.md @@ -0,0 +1,33 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / conStr1 + +# Function: conStr1() + +> **conStr1**\<`T`\>(`fields`): [`ConStr1`](../type-aliases/ConStr1.md)\<`T`\> + +Defined in: data/json/constructors.ts:57 + +The utility function to create a Plutus Data index 1 constructor object, representing custom data type in JSON + +## Type Parameters + +### T + +`T` + +## Parameters + +### fields + +`T` + +The items of in array + +## Returns + +[`ConStr1`](../type-aliases/ConStr1.md)\<`T`\> + +The Plutus Data constructor object diff --git a/docs/markdown/mesh-common/functions/conStr2.md b/docs/markdown/mesh-common/functions/conStr2.md new file mode 100644 index 000000000..16d2df173 --- /dev/null +++ b/docs/markdown/mesh-common/functions/conStr2.md @@ -0,0 +1,33 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / conStr2 + +# Function: conStr2() + +> **conStr2**\<`T`\>(`fields`): [`ConStr2`](../type-aliases/ConStr2.md)\<`T`\> + +Defined in: data/json/constructors.ts:64 + +The utility function to create a Plutus Data index 2 constructor object, representing custom data type in JSON + +## Type Parameters + +### T + +`T` + +## Parameters + +### fields + +`T` + +The items of in array + +## Returns + +[`ConStr2`](../type-aliases/ConStr2.md)\<`T`\> + +The Plutus Data constructor object diff --git a/docs/markdown/mesh-common/functions/conStr3.md b/docs/markdown/mesh-common/functions/conStr3.md new file mode 100644 index 000000000..b29a277bd --- /dev/null +++ b/docs/markdown/mesh-common/functions/conStr3.md @@ -0,0 +1,33 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / conStr3 + +# Function: conStr3() + +> **conStr3**\<`T`\>(`fields`): [`ConStr3`](../type-aliases/ConStr3.md)\<`T`\> + +Defined in: data/json/constructors.ts:71 + +The utility function to create a Plutus Data index 3 constructor object, representing custom data type in JSON + +## Type Parameters + +### T + +`T` + +## Parameters + +### fields + +`T` + +The items of in array + +## Returns + +[`ConStr3`](../type-aliases/ConStr3.md)\<`T`\> + +The Plutus Data constructor object diff --git a/docs/markdown/mesh-common/functions/credential.md b/docs/markdown/mesh-common/functions/credential.md new file mode 100644 index 000000000..bc3fac89b --- /dev/null +++ b/docs/markdown/mesh-common/functions/credential.md @@ -0,0 +1,33 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / credential + +# Function: credential() + +> **credential**(`hash`, `isScriptCredential`): [`Credential`](../type-aliases/Credential.md) + +Defined in: data/json/credentials.ts:115 + +The utility function to create a Plutus Data credential in JSON + +## Parameters + +### hash + +`string` + +The pub key hash or script hash + +### isScriptCredential + +`boolean` = `false` + +Indicate if the credential is script hash (false for pub key hash) + +## Returns + +[`Credential`](../type-aliases/Credential.md) + +Plutus Data credential object diff --git a/docs/markdown/mesh-common/functions/currencySymbol.md b/docs/markdown/mesh-common/functions/currencySymbol.md new file mode 100644 index 000000000..d87c42fd3 --- /dev/null +++ b/docs/markdown/mesh-common/functions/currencySymbol.md @@ -0,0 +1,27 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / currencySymbol + +# Function: currencySymbol() + +> **currencySymbol**(`bytes`): [`ByteString`](../type-aliases/ByteString.md) + +Defined in: data/json/aliases.ts:152 + +The utility function to create a Plutus Data currency symbol in JSON + +## Parameters + +### bytes + +`string` + +The policy id in hex + +## Returns + +[`ByteString`](../type-aliases/ByteString.md) + +The Plutus Data policy id object diff --git a/docs/markdown/mesh-common/functions/dict.md b/docs/markdown/mesh-common/functions/dict.md new file mode 100644 index 000000000..fef3e3053 --- /dev/null +++ b/docs/markdown/mesh-common/functions/dict.md @@ -0,0 +1,33 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / dict + +# Function: dict() + +> **dict**\<`V`\>(`itemsMap`): [`Dict`](../type-aliases/Dict.md)\<`V`\> + +Defined in: data/json/aliases.ts:231 + +The utility function to create a Plutus Data dictionary in JSON + +## Type Parameters + +### V + +`V` + +## Parameters + +### itemsMap + +\[[`ByteString`](../type-aliases/ByteString.md), `V`\][] + +The items map in array + +## Returns + +[`Dict`](../type-aliases/Dict.md)\<`V`\> + +The Plutus Data dictionary object diff --git a/docs/markdown/mesh-common/functions/emptyTxBuilderBody.md b/docs/markdown/mesh-common/functions/emptyTxBuilderBody.md new file mode 100644 index 000000000..32f9d8dcf --- /dev/null +++ b/docs/markdown/mesh-common/functions/emptyTxBuilderBody.md @@ -0,0 +1,15 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / emptyTxBuilderBody + +# Function: emptyTxBuilderBody() + +> **emptyTxBuilderBody**(): [`MeshTxBuilderBody`](../type-aliases/MeshTxBuilderBody.md) + +Defined in: types/transaction-builder/index.ts:51 + +## Returns + +[`MeshTxBuilderBody`](../type-aliases/MeshTxBuilderBody.md) diff --git a/docs/markdown/mesh-common/functions/experimentalSelectUtxos.md b/docs/markdown/mesh-common/functions/experimentalSelectUtxos.md new file mode 100644 index 000000000..c26a5fb0a --- /dev/null +++ b/docs/markdown/mesh-common/functions/experimentalSelectUtxos.md @@ -0,0 +1,29 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / experimentalSelectUtxos + +# Function: experimentalSelectUtxos() + +> **experimentalSelectUtxos**(`requiredAssets`, `inputs`, `threshold`): [`UTxO`](../type-aliases/UTxO.md)[] + +Defined in: utxo-selection/experimental.ts:3 + +## Parameters + +### requiredAssets + +`Map`\<`string`, `string`\> + +### inputs + +[`UTxO`](../type-aliases/UTxO.md)[] + +### threshold + +`string` + +## Returns + +[`UTxO`](../type-aliases/UTxO.md)[] diff --git a/docs/markdown/mesh-common/functions/fromUTF8.md b/docs/markdown/mesh-common/functions/fromUTF8.md new file mode 100644 index 000000000..d793d6087 --- /dev/null +++ b/docs/markdown/mesh-common/functions/fromUTF8.md @@ -0,0 +1,27 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / fromUTF8 + +# Function: fromUTF8() + +> **fromUTF8**(`utf8`): `string` + +Defined in: data/parser.ts:58 + +Converting utf8 string to hex string + +## Parameters + +### utf8 + +`string` + +The utf8 string to be converted + +## Returns + +`string` + +The hex string diff --git a/docs/markdown/mesh-common/functions/getFile.md b/docs/markdown/mesh-common/functions/getFile.md new file mode 100644 index 000000000..9261563bd --- /dev/null +++ b/docs/markdown/mesh-common/functions/getFile.md @@ -0,0 +1,21 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / getFile + +# Function: getFile() + +> **getFile**(`url`): `string` + +Defined in: utils/file.ts:1 + +## Parameters + +### url + +`string` + +## Returns + +`string` diff --git a/docs/markdown/mesh-common/functions/hashByteString.md b/docs/markdown/mesh-common/functions/hashByteString.md new file mode 100644 index 000000000..2be6fef0b --- /dev/null +++ b/docs/markdown/mesh-common/functions/hashByteString.md @@ -0,0 +1,27 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / hashByteString + +# Function: hashByteString() + +> **hashByteString**(`bytes`): [`ByteString`](../type-aliases/ByteString.md) + +Defined in: data/json/aliases.ts:110 + +Internal utility function to create a Plutus Data byte string in JSON, checking correct length + +## Parameters + +### bytes + +`string` + +The byte string in hex + +## Returns + +[`ByteString`](../type-aliases/ByteString.md) + +The Plutus Data byte string object diff --git a/docs/markdown/mesh-common/functions/hashDrepAnchor.md b/docs/markdown/mesh-common/functions/hashDrepAnchor.md new file mode 100644 index 000000000..e305a2948 --- /dev/null +++ b/docs/markdown/mesh-common/functions/hashDrepAnchor.md @@ -0,0 +1,21 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / hashDrepAnchor + +# Function: hashDrepAnchor() + +> **hashDrepAnchor**(`jsonLD`): `string` + +Defined in: utils/data-hash.ts:3 + +## Parameters + +### jsonLD + +`object` + +## Returns + +`string` diff --git a/docs/markdown/mesh-common/functions/hexToBytes.md b/docs/markdown/mesh-common/functions/hexToBytes.md new file mode 100644 index 000000000..09a16ba17 --- /dev/null +++ b/docs/markdown/mesh-common/functions/hexToBytes.md @@ -0,0 +1,27 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / hexToBytes + +# Function: hexToBytes() + +> **hexToBytes**(`hex`): `Buffer` + +Defined in: data/parser.ts:16 + +Converting hex string to bytes + +## Parameters + +### hex + +`string` + +The hex string to be converted + +## Returns + +`Buffer` + +The bytes diff --git a/docs/markdown/mesh-common/functions/hexToString.md b/docs/markdown/mesh-common/functions/hexToString.md new file mode 100644 index 000000000..3384670c1 --- /dev/null +++ b/docs/markdown/mesh-common/functions/hexToString.md @@ -0,0 +1,27 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / hexToString + +# Function: hexToString() + +> **hexToString**(`hex`): `string` + +Defined in: data/parser.ts:38 + +Converting hex string to utf8 string + +## Parameters + +### hex + +`string` + +The hex string to be converted + +## Returns + +`string` + +The utf8 string diff --git a/docs/markdown/mesh-common/functions/integer.md b/docs/markdown/mesh-common/functions/integer.md new file mode 100644 index 000000000..50b959079 --- /dev/null +++ b/docs/markdown/mesh-common/functions/integer.md @@ -0,0 +1,27 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / integer + +# Function: integer() + +> **integer**(`int`): [`Integer`](../type-aliases/Integer.md) + +Defined in: data/json/primitives.ts:93 + +The utility function to create a Plutus Data integer in JSON + +## Parameters + +### int + +The integer value + +`number` | `bigint` + +## Returns + +[`Integer`](../type-aliases/Integer.md) + +The Plutus Data integer object diff --git a/docs/markdown/mesh-common/functions/isHexString.md b/docs/markdown/mesh-common/functions/isHexString.md new file mode 100644 index 000000000..654446653 --- /dev/null +++ b/docs/markdown/mesh-common/functions/isHexString.md @@ -0,0 +1,27 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / isHexString + +# Function: isHexString() + +> **isHexString**(`hex`): `boolean` + +Defined in: data/parser.ts:31 + +Checking if the string is a hex string + +## Parameters + +### hex + +`string` + +The string to be checked + +## Returns + +`boolean` + +True if the string is a hex string, false otherwise diff --git a/docs/markdown/mesh-common/functions/isNetwork.md b/docs/markdown/mesh-common/functions/isNetwork.md new file mode 100644 index 000000000..ea854965d --- /dev/null +++ b/docs/markdown/mesh-common/functions/isNetwork.md @@ -0,0 +1,21 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / isNetwork + +# Function: isNetwork() + +> **isNetwork**(`value`): value is "testnet" \| "preview" \| "preprod" \| "mainnet" + +Defined in: types/network.ts:5 + +## Parameters + +### value + +`unknown` + +## Returns + +value is "testnet" \| "preview" \| "preprod" \| "mainnet" diff --git a/docs/markdown/mesh-common/functions/jsonProofToPlutusData.md b/docs/markdown/mesh-common/functions/jsonProofToPlutusData.md new file mode 100644 index 000000000..9bbf51e44 --- /dev/null +++ b/docs/markdown/mesh-common/functions/jsonProofToPlutusData.md @@ -0,0 +1,27 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / jsonProofToPlutusData + +# Function: jsonProofToPlutusData() + +> **jsonProofToPlutusData**(`proof`): [`ProofStep`](../type-aliases/ProofStep.md)[] + +Defined in: data/json/mpf.ts:44 + +The utility function to transform a JSON proof from Aiken TS offchain library to Mesh JSON Data type + +## Parameters + +### proof + +`object` + +The proof object from Aiken TS offchain library + +## Returns + +[`ProofStep`](../type-aliases/ProofStep.md)[] + +The proof object in Mesh JSON Data type diff --git a/docs/markdown/mesh-common/functions/keepRelevant.md b/docs/markdown/mesh-common/functions/keepRelevant.md new file mode 100644 index 000000000..750915a6b --- /dev/null +++ b/docs/markdown/mesh-common/functions/keepRelevant.md @@ -0,0 +1,29 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / keepRelevant + +# Function: keepRelevant() + +> **keepRelevant**(`requiredAssets`, `inputs`, `threshold`): [`UTxO`](../type-aliases/UTxO.md)[] + +Defined in: utxo-selection/keepRelevant.ts:4 + +## Parameters + +### requiredAssets + +`Map`\<`string`, `string`\> + +### inputs + +[`UTxO`](../type-aliases/UTxO.md)[] + +### threshold + +`string` = `"5000000"` + +## Returns + +[`UTxO`](../type-aliases/UTxO.md)[] diff --git a/docs/markdown/mesh-common/functions/keySignedLogic.md b/docs/markdown/mesh-common/functions/keySignedLogic.md new file mode 100644 index 000000000..3ba68b58c --- /dev/null +++ b/docs/markdown/mesh-common/functions/keySignedLogic.md @@ -0,0 +1,33 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / keySignedLogic + +# Function: keySignedLogic() + +> **keySignedLogic**(`requiredSignatures`, `keyHash`): `boolean` + +Defined in: tx-tester/index.ts:565 + +Internal logic to check if a key is signed + +## Parameters + +### requiredSignatures + +`string`[] + +The required signatures of the tx builder body + +### keyHash + +`string` + +The key hash to check + +## Returns + +`boolean` + +true if the key is signed, false otherwise diff --git a/docs/markdown/mesh-common/functions/largestFirst.md b/docs/markdown/mesh-common/functions/largestFirst.md new file mode 100644 index 000000000..12b60805a --- /dev/null +++ b/docs/markdown/mesh-common/functions/largestFirst.md @@ -0,0 +1,33 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / largestFirst + +# Function: largestFirst() + +> **largestFirst**(`lovelace`, `initialUTxOSet`, `includeTxFees`, `__namedParameters`): [`UTxO`](../type-aliases/UTxO.md)[] + +Defined in: utxo-selection/largestFirst.ts:11 + +## Parameters + +### lovelace + +`string` + +### initialUTxOSet + +[`UTxO`](../type-aliases/UTxO.md)[] + +### includeTxFees + +`boolean` = `false` + +### \_\_namedParameters + +[`Protocol`](../type-aliases/Protocol.md) = `DEFAULT_PROTOCOL_PARAMETERS` + +## Returns + +[`UTxO`](../type-aliases/UTxO.md)[] diff --git a/docs/markdown/mesh-common/functions/largestFirstMultiAsset.md b/docs/markdown/mesh-common/functions/largestFirstMultiAsset.md new file mode 100644 index 000000000..6181f0683 --- /dev/null +++ b/docs/markdown/mesh-common/functions/largestFirstMultiAsset.md @@ -0,0 +1,33 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / largestFirstMultiAsset + +# Function: largestFirstMultiAsset() + +> **largestFirstMultiAsset**(`requestedOutputSet`, `initialUTxOSet`, `includeTxFees`, `parameters`): [`UTxO`](../type-aliases/UTxO.md)[] + +Defined in: utxo-selection/largestFirstMultiAsset.ts:9 + +## Parameters + +### requestedOutputSet + +`Map`\<`string`, `string`\> + +### initialUTxOSet + +[`UTxO`](../type-aliases/UTxO.md)[] + +### includeTxFees + +`boolean` = `false` + +### parameters + +[`Protocol`](../type-aliases/Protocol.md) = `DEFAULT_PROTOCOL_PARAMETERS` + +## Returns + +[`UTxO`](../type-aliases/UTxO.md)[] diff --git a/docs/markdown/mesh-common/functions/list.md b/docs/markdown/mesh-common/functions/list.md new file mode 100644 index 000000000..0536c4301 --- /dev/null +++ b/docs/markdown/mesh-common/functions/list.md @@ -0,0 +1,39 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / list + +# Function: list() + +> **list**\<`T`\>(`pList`, `validation`): [`List`](../type-aliases/List.md)\<`T`\> + +Defined in: data/json/primitives.ts:101 + +The utility function to create a Plutus Data list in JSON + +## Type Parameters + +### T + +`T` = [`PlutusData`](../type-aliases/PlutusData.md) + +## Parameters + +### pList + +`T`[] + +The list of Plutus Data + +### validation + +`boolean` = `true` + +Default true - If current data construction would perform validation (introducing this flag due to possible performance issue in loop validation) + +## Returns + +[`List`](../type-aliases/List.md)\<`T`\> + +The Plutus Data list object diff --git a/docs/markdown/mesh-common/functions/mAssetClass.md b/docs/markdown/mesh-common/functions/mAssetClass.md new file mode 100644 index 000000000..b37938e6c --- /dev/null +++ b/docs/markdown/mesh-common/functions/mAssetClass.md @@ -0,0 +1,33 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / mAssetClass + +# Function: mAssetClass() + +> **mAssetClass**(`currencySymbolHex`, `tokenNameHex`): [`MAssetClass`](../type-aliases/MAssetClass.md) + +Defined in: data/mesh/aliases.ts:53 + +The utility function to create a Mesh Data asset class + +## Parameters + +### currencySymbolHex + +`string` + +The currency symbol in hex + +### tokenNameHex + +`string` + +The token name in hex + +## Returns + +[`MAssetClass`](../type-aliases/MAssetClass.md) + +The Mesh Data asset class object diff --git a/docs/markdown/mesh-common/functions/mBool.md b/docs/markdown/mesh-common/functions/mBool.md new file mode 100644 index 000000000..9dc65fc16 --- /dev/null +++ b/docs/markdown/mesh-common/functions/mBool.md @@ -0,0 +1,27 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / mBool + +# Function: mBool() + +> **mBool**(`b`): [`MBool`](../type-aliases/MBool.md) + +Defined in: data/mesh/primitives.ts:13 + +The utility function to create a Mesh Data boolean + +## Parameters + +### b + +`boolean` + +boolean value + +## Returns + +[`MBool`](../type-aliases/MBool.md) + +The Mesh Data boolean object diff --git a/docs/markdown/mesh-common/functions/mConStr.md b/docs/markdown/mesh-common/functions/mConStr.md new file mode 100644 index 000000000..1f4632239 --- /dev/null +++ b/docs/markdown/mesh-common/functions/mConStr.md @@ -0,0 +1,43 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / mConStr + +# Function: mConStr() + +> **mConStr**\<`N`, `T`\>(`alternative`, `fields`): [`MConStr`](../type-aliases/MConStr.md)\<`N`, `T`\> + +Defined in: data/mesh/constructors.ts:34 + +The utility function to create a Mesh Data constructor object, representing custom data type + +## Type Parameters + +### N + +`N` *extends* `number` + +### T + +`T` *extends* [`Data`](../type-aliases/Data.md)[] + +## Parameters + +### alternative + +`N` + +The constructor index number + +### fields + +`T` + +The items in array + +## Returns + +[`MConStr`](../type-aliases/MConStr.md)\<`N`, `T`\> + +The Mesh Data constructor object diff --git a/docs/markdown/mesh-common/functions/mConStr0.md b/docs/markdown/mesh-common/functions/mConStr0.md new file mode 100644 index 000000000..290119e3e --- /dev/null +++ b/docs/markdown/mesh-common/functions/mConStr0.md @@ -0,0 +1,33 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / mConStr0 + +# Function: mConStr0() + +> **mConStr0**\<`T`\>(`fields`): [`MConStr0`](../type-aliases/MConStr0.md)\<`T`\> + +Defined in: data/mesh/constructors.ts:47 + +The utility function to create a Mesh Data index 0 constructor object, representing custom data type + +## Type Parameters + +### T + +`T` *extends* [`Data`](../type-aliases/Data.md)[] + +## Parameters + +### fields + +`T` + +The items in array + +## Returns + +[`MConStr0`](../type-aliases/MConStr0.md)\<`T`\> + +The Mesh Data constructor object diff --git a/docs/markdown/mesh-common/functions/mConStr1.md b/docs/markdown/mesh-common/functions/mConStr1.md new file mode 100644 index 000000000..24af0ab6c --- /dev/null +++ b/docs/markdown/mesh-common/functions/mConStr1.md @@ -0,0 +1,33 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / mConStr1 + +# Function: mConStr1() + +> **mConStr1**\<`T`\>(`fields`): [`MConStr1`](../type-aliases/MConStr1.md)\<`T`\> + +Defined in: data/mesh/constructors.ts:57 + +The utility function to create a Mesh Data index 1 constructor object, representing custom data type + +## Type Parameters + +### T + +`T` *extends* [`Data`](../type-aliases/Data.md)[] + +## Parameters + +### fields + +`T` + +The items in array + +## Returns + +[`MConStr1`](../type-aliases/MConStr1.md)\<`T`\> + +The Mesh Data constructor object diff --git a/docs/markdown/mesh-common/functions/mConStr2.md b/docs/markdown/mesh-common/functions/mConStr2.md new file mode 100644 index 000000000..180e16811 --- /dev/null +++ b/docs/markdown/mesh-common/functions/mConStr2.md @@ -0,0 +1,33 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / mConStr2 + +# Function: mConStr2() + +> **mConStr2**\<`T`\>(`fields`): [`MConStr2`](../type-aliases/MConStr2.md)\<`T`\> + +Defined in: data/mesh/constructors.ts:67 + +The utility function to create a Mesh Data index 2 constructor object, representing custom data type + +## Type Parameters + +### T + +`T` *extends* [`Data`](../type-aliases/Data.md)[] + +## Parameters + +### fields + +`T` + +The items in array + +## Returns + +[`MConStr2`](../type-aliases/MConStr2.md)\<`T`\> + +The Mesh Data constructor object diff --git a/docs/markdown/mesh-common/functions/mConStr3.md b/docs/markdown/mesh-common/functions/mConStr3.md new file mode 100644 index 000000000..45dde63ec --- /dev/null +++ b/docs/markdown/mesh-common/functions/mConStr3.md @@ -0,0 +1,33 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / mConStr3 + +# Function: mConStr3() + +> **mConStr3**\<`T`\>(`fields`): [`MConStr3`](../type-aliases/MConStr3.md)\<`T`\> + +Defined in: data/mesh/constructors.ts:77 + +The utility function to create a Mesh Data index 3 constructor object, representing custom data type + +## Type Parameters + +### T + +`T` *extends* [`Data`](../type-aliases/Data.md)[] + +## Parameters + +### fields + +`T` + +The items in array + +## Returns + +[`MConStr3`](../type-aliases/MConStr3.md)\<`T`\> + +The Mesh Data constructor object diff --git a/docs/markdown/mesh-common/functions/mCredential.md b/docs/markdown/mesh-common/functions/mCredential.md new file mode 100644 index 000000000..ed04dbb2d --- /dev/null +++ b/docs/markdown/mesh-common/functions/mCredential.md @@ -0,0 +1,33 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / mCredential + +# Function: mCredential() + +> **mCredential**(`hash`, `isScriptCredential`): [`MCredential`](../type-aliases/MCredential.md) + +Defined in: data/mesh/credentials.ts:114 + +The utility function to create a Mesh Data credential + +## Parameters + +### hash + +`string` + +The pub key hash or script hash + +### isScriptCredential + +`boolean` = `false` + +Indicate if the credential is script hash (false for pub key hash) + +## Returns + +[`MCredential`](../type-aliases/MCredential.md) + +Mesh Data credential object diff --git a/docs/markdown/mesh-common/functions/mMaybeStakingHash.md b/docs/markdown/mesh-common/functions/mMaybeStakingHash.md new file mode 100644 index 000000000..70e6a5701 --- /dev/null +++ b/docs/markdown/mesh-common/functions/mMaybeStakingHash.md @@ -0,0 +1,33 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / mMaybeStakingHash + +# Function: mMaybeStakingHash() + +> **mMaybeStakingHash**(`stakeCredential`, `isStakeScriptCredential`): [`MMaybeStakingHash`](../type-aliases/MMaybeStakingHash.md) + +Defined in: data/mesh/credentials.ts:57 + +The utility function to create a Mesh Data staking hash + +## Parameters + +### stakeCredential + +`string` + +The staking credential in hex + +### isStakeScriptCredential + +`boolean` = `false` + +The flag to indicate if the credential is a script credential + +## Returns + +[`MMaybeStakingHash`](../type-aliases/MMaybeStakingHash.md) + +The Mesh Data staking hash object diff --git a/docs/markdown/mesh-common/functions/mNone.md b/docs/markdown/mesh-common/functions/mNone.md new file mode 100644 index 000000000..23d217909 --- /dev/null +++ b/docs/markdown/mesh-common/functions/mNone.md @@ -0,0 +1,19 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / mNone + +# Function: mNone() + +> **mNone**(): [`MNone`](../type-aliases/MNone.md) + +Defined in: data/mesh/aliases.ts:132 + +The utility function to create a Mesh Data Option - None type in Mesh Data type + +## Returns + +[`MNone`](../type-aliases/MNone.md) + +The Mesh Data Option - None object diff --git a/docs/markdown/mesh-common/functions/mOption.md b/docs/markdown/mesh-common/functions/mOption.md new file mode 100644 index 000000000..427c9e29d --- /dev/null +++ b/docs/markdown/mesh-common/functions/mOption.md @@ -0,0 +1,33 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / mOption + +# Function: mOption() + +> **mOption**\<`T`\>(`value?`): [`MOption`](../type-aliases/MOption.md)\<`T`\> + +Defined in: data/mesh/aliases.ts:113 + +The utility function to create a Mesh Data Option type in Mesh Data type + +## Type Parameters + +### T + +`T` *extends* [`Data`](../type-aliases/Data.md) + +## Parameters + +### value? + +`T` + +The value of the option + +## Returns + +[`MOption`](../type-aliases/MOption.md)\<`T`\> + +The Mesh Data Option object diff --git a/docs/markdown/mesh-common/functions/mOutputReference.md b/docs/markdown/mesh-common/functions/mOutputReference.md new file mode 100644 index 000000000..11f45b83a --- /dev/null +++ b/docs/markdown/mesh-common/functions/mOutputReference.md @@ -0,0 +1,33 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / mOutputReference + +# Function: mOutputReference() + +> **mOutputReference**(`txHash`, `index`): [`MOutputReference`](../type-aliases/MOutputReference.md) + +Defined in: data/mesh/aliases.ts:78 + +The utility function to create a Mesh Data output reference in Mesh Data type + +## Parameters + +### txHash + +`string` + +The transaction hash + +### index + +`number` + +The index of the output + +## Returns + +[`MOutputReference`](../type-aliases/MOutputReference.md) + +The Mesh Data output reference object diff --git a/docs/markdown/mesh-common/functions/mPlutusBSArrayToString.md b/docs/markdown/mesh-common/functions/mPlutusBSArrayToString.md new file mode 100644 index 000000000..56ba0cb95 --- /dev/null +++ b/docs/markdown/mesh-common/functions/mPlutusBSArrayToString.md @@ -0,0 +1,27 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / mPlutusBSArrayToString + +# Function: mPlutusBSArrayToString() + +> **mPlutusBSArrayToString**(`bsArray`): `string` + +Defined in: data/mesh/primitives.ts:35 + +Converting BuiltinByteString Array into a single string + +## Parameters + +### bsArray + +`string`[] + +The BuiltinByteString Array to be converted into a single string + +## Returns + +`string` + +The string representation of the BuiltinByteString Array diff --git a/docs/markdown/mesh-common/functions/mPubKeyAddress.md b/docs/markdown/mesh-common/functions/mPubKeyAddress.md new file mode 100644 index 000000000..cdacd1536 --- /dev/null +++ b/docs/markdown/mesh-common/functions/mPubKeyAddress.md @@ -0,0 +1,39 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / mPubKeyAddress + +# Function: mPubKeyAddress() + +> **mPubKeyAddress**(`bytes`, `stakeCredential?`, `isStakeScriptCredential?`): [`MPubKeyAddress`](../type-aliases/MPubKeyAddress.md) + +Defined in: data/mesh/credentials.ts:81 + +The utility function to create a Mesh Data public key address + +## Parameters + +### bytes + +`string` + +The public key hash in hex + +### stakeCredential? + +`string` + +The staking credential in hex + +### isStakeScriptCredential? + +`boolean` = `false` + +The flag to indicate if the credential is a script credential + +## Returns + +[`MPubKeyAddress`](../type-aliases/MPubKeyAddress.md) + +The Mesh Data public key address object diff --git a/docs/markdown/mesh-common/functions/mScript.md b/docs/markdown/mesh-common/functions/mScript.md new file mode 100644 index 000000000..f9e6f57ac --- /dev/null +++ b/docs/markdown/mesh-common/functions/mScript.md @@ -0,0 +1,27 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / mScript + +# Function: mScript() + +> **mScript**(`bytes`): [`MScript`](../type-aliases/MScript.md) + +Defined in: data/mesh/credentials.ts:49 + +The utility function to create a Mesh Data script key + +## Parameters + +### bytes + +`string` + +The script hash in hex + +## Returns + +[`MScript`](../type-aliases/MScript.md) + +The Mesh Data script key object diff --git a/docs/markdown/mesh-common/functions/mScriptAddress.md b/docs/markdown/mesh-common/functions/mScriptAddress.md new file mode 100644 index 000000000..f82db00a9 --- /dev/null +++ b/docs/markdown/mesh-common/functions/mScriptAddress.md @@ -0,0 +1,39 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / mScriptAddress + +# Function: mScriptAddress() + +> **mScriptAddress**(`bytes`, `stakeCredential?`, `isStakeScriptCredential?`): [`MScriptAddress`](../type-aliases/MScriptAddress.md) + +Defined in: data/mesh/credentials.ts:98 + +The utility function to create a Mesh Data script address + +## Parameters + +### bytes + +`string` + +The validator hash in hex + +### stakeCredential? + +`string` + +The staking credential in hex + +### isStakeScriptCredential? + +`boolean` = `false` + +The flag to indicate if the credential is a script credential + +## Returns + +[`MScriptAddress`](../type-aliases/MScriptAddress.md) + +The Mesh Data script address object diff --git a/docs/markdown/mesh-common/functions/mSome.md b/docs/markdown/mesh-common/functions/mSome.md new file mode 100644 index 000000000..847fce579 --- /dev/null +++ b/docs/markdown/mesh-common/functions/mSome.md @@ -0,0 +1,33 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / mSome + +# Function: mSome() + +> **mSome**\<`T`\>(`value`): [`MSome`](../type-aliases/MSome.md)\<`T`\> + +Defined in: data/mesh/aliases.ts:125 + +The utility function to create a Mesh Data Option type in Mesh Data type + +## Type Parameters + +### T + +`T` *extends* [`Data`](../type-aliases/Data.md) + +## Parameters + +### value + +`T` + +The value of the option + +## Returns + +[`MSome`](../type-aliases/MSome.md)\<`T`\> + +The Mesh Data Option object diff --git a/docs/markdown/mesh-common/functions/mStringToPlutusBSArray.md b/docs/markdown/mesh-common/functions/mStringToPlutusBSArray.md new file mode 100644 index 000000000..6e11108c5 --- /dev/null +++ b/docs/markdown/mesh-common/functions/mStringToPlutusBSArray.md @@ -0,0 +1,27 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / mStringToPlutusBSArray + +# Function: mStringToPlutusBSArray() + +> **mStringToPlutusBSArray**(`hexString`): `string`[] + +Defined in: data/mesh/primitives.ts:21 + +Converting a hex string into a BuiltinByteString Array, with max 32 bytes on each items + +## Parameters + +### hexString + +`string` + +The hex string to be converted into BuiltinByteString Array + +## Returns + +`string`[] + +The BuiltinByteString Array representation of the hex string diff --git a/docs/markdown/mesh-common/functions/mTuple.md b/docs/markdown/mesh-common/functions/mTuple.md new file mode 100644 index 000000000..2f598c1a1 --- /dev/null +++ b/docs/markdown/mesh-common/functions/mTuple.md @@ -0,0 +1,33 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / mTuple + +# Function: mTuple() + +> **mTuple**\<`T`\>(...`args`): [`MTuple`](../type-aliases/MTuple.md)\<`T`\> + +Defined in: data/mesh/aliases.ts:106 + +The utility function to create a Mesh Data tuple in Mesh Data type + +## Type Parameters + +### T + +`T` *extends* `any`[] + +## Parameters + +### args + +...`T` + +The arguments of the tuple + +## Returns + +[`MTuple`](../type-aliases/MTuple.md)\<`T`\> + +The Mesh Data tuple object diff --git a/docs/markdown/mesh-common/functions/mTxOutRef.md b/docs/markdown/mesh-common/functions/mTxOutRef.md new file mode 100644 index 000000000..682f57df1 --- /dev/null +++ b/docs/markdown/mesh-common/functions/mTxOutRef.md @@ -0,0 +1,33 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / mTxOutRef + +# Function: mTxOutRef() + +> **mTxOutRef**(`txHash`, `index`): [`MTxOutRef`](../type-aliases/MTxOutRef.md) + +Defined in: data/mesh/aliases.ts:94 + +The utility function to create a Mesh Data TxOutRef in Mesh Data type + +## Parameters + +### txHash + +`string` + +The transaction hash + +### index + +`number` + +The index of the output + +## Returns + +[`MTxOutRef`](../type-aliases/MTxOutRef.md) + +The Mesh Data TxOutRef object diff --git a/docs/markdown/mesh-common/functions/mValue.md b/docs/markdown/mesh-common/functions/mValue.md new file mode 100644 index 000000000..358cc0c99 --- /dev/null +++ b/docs/markdown/mesh-common/functions/mValue.md @@ -0,0 +1,27 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / mValue + +# Function: mValue() + +> **mValue**(`assets`): [`MValue`](../type-aliases/MValue.md) + +Defined in: data/value.ts:45 + +The utility function to convert assets into Cardano data Value in Mesh Data type + +## Parameters + +### assets + +[`Asset`](../type-aliases/Asset.md)[] + +The assets to convert + +## Returns + +[`MValue`](../type-aliases/MValue.md) + +The Cardano data Value in Mesh Data type diff --git a/docs/markdown/mesh-common/functions/mVerificationKey.md b/docs/markdown/mesh-common/functions/mVerificationKey.md new file mode 100644 index 000000000..95df69a3c --- /dev/null +++ b/docs/markdown/mesh-common/functions/mVerificationKey.md @@ -0,0 +1,27 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / mVerificationKey + +# Function: mVerificationKey() + +> **mVerificationKey**(`bytes`): [`MVerificationKey`](../type-aliases/MVerificationKey.md) + +Defined in: data/mesh/credentials.ts:41 + +The utility function to create a Mesh Data verification key + +## Parameters + +### bytes + +`string` + +The public key hash in hex + +## Returns + +[`MVerificationKey`](../type-aliases/MVerificationKey.md) + +The Mesh Data verification key object diff --git a/docs/markdown/mesh-common/functions/maybeStakingHash.md b/docs/markdown/mesh-common/functions/maybeStakingHash.md new file mode 100644 index 000000000..158d62814 --- /dev/null +++ b/docs/markdown/mesh-common/functions/maybeStakingHash.md @@ -0,0 +1,33 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / maybeStakingHash + +# Function: maybeStakingHash() + +> **maybeStakingHash**(`stakeCredential`, `isStakeScriptCredential`): [`MaybeStakingHash`](../type-aliases/MaybeStakingHash.md) + +Defined in: data/json/credentials.ts:58 + +The utility function to create a Plutus Data staking hash in JSON + +## Parameters + +### stakeCredential + +`string` + +The staking credential in hex + +### isStakeScriptCredential + +`boolean` = `false` + +The flag to indicate if the credential is a script credential + +## Returns + +[`MaybeStakingHash`](../type-aliases/MaybeStakingHash.md) + +The Plutus Data staking hash object diff --git a/docs/markdown/mesh-common/functions/mergeAssets.md b/docs/markdown/mesh-common/functions/mergeAssets.md new file mode 100644 index 000000000..f1bfc5141 --- /dev/null +++ b/docs/markdown/mesh-common/functions/mergeAssets.md @@ -0,0 +1,21 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / mergeAssets + +# Function: mergeAssets() + +> **mergeAssets**(`assets`): [`Asset`](../type-aliases/Asset.md)[] + +Defined in: types/asset.ts:10 + +## Parameters + +### assets + +[`Asset`](../type-aliases/Asset.md)[] + +## Returns + +[`Asset`](../type-aliases/Asset.md)[] diff --git a/docs/markdown/mesh-common/functions/metadataToCip68.md b/docs/markdown/mesh-common/functions/metadataToCip68.md new file mode 100644 index 000000000..e2f19f24a --- /dev/null +++ b/docs/markdown/mesh-common/functions/metadataToCip68.md @@ -0,0 +1,27 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / metadataToCip68 + +# Function: metadataToCip68() + +> **metadataToCip68**(`metadata`): [`Data`](../type-aliases/Data.md) + +Defined in: types/asset-metadata.ts:77 + +Transform the metadata into the format needed in CIP68 inline datum (in Mesh Data type) + +## Parameters + +### metadata + +`any` + +The metadata body without outer wrapper of policy id & token name + +## Returns + +[`Data`](../type-aliases/Data.md) + +The metadata in Mesh Data type, ready to be attached as inline datum diff --git a/docs/markdown/mesh-common/functions/none.md b/docs/markdown/mesh-common/functions/none.md new file mode 100644 index 000000000..0dfd5c505 --- /dev/null +++ b/docs/markdown/mesh-common/functions/none.md @@ -0,0 +1,19 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / none + +# Function: none() + +> **none**(): [`None`](../type-aliases/None.md) + +Defined in: data/json/aliases.ts:267 + +The utility function to create a Plutus Data Option - None in JSON + +## Returns + +[`None`](../type-aliases/None.md) + +The Plutus Data Option - None object diff --git a/docs/markdown/mesh-common/functions/option.md b/docs/markdown/mesh-common/functions/option.md new file mode 100644 index 000000000..b31157983 --- /dev/null +++ b/docs/markdown/mesh-common/functions/option.md @@ -0,0 +1,33 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / option + +# Function: option() + +> **option**\<`T`\>(`value?`): [`Option`](../type-aliases/Option.md)\<`T`\> + +Defined in: data/json/aliases.ts:249 + +The utility function to create a Plutus Data Option in JSON + +## Type Parameters + +### T + +`T` + +## Parameters + +### value? + +`T` + +The optional value of the option + +## Returns + +[`Option`](../type-aliases/Option.md)\<`T`\> + +Return None constructor if the value is not provided, otherwise return Some constructor with the value diff --git a/docs/markdown/mesh-common/functions/outputReference.md b/docs/markdown/mesh-common/functions/outputReference.md new file mode 100644 index 000000000..9d073b8d1 --- /dev/null +++ b/docs/markdown/mesh-common/functions/outputReference.md @@ -0,0 +1,35 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / outputReference + +# Function: outputReference() + +> **outputReference**(`txHash`, `index`): [`OutputReference`](../type-aliases/OutputReference.md) + +Defined in: data/json/aliases.ts:196 + +The utility function to create a Plutus Data output reference in JSON. +Note that it is updated since aiken version v1.1.0. +If you want to build the type before Chang, please use txOutRef instead. + +## Parameters + +### txHash + +`string` + +The transaction hash + +### index + +`number` + +The index of the output + +## Returns + +[`OutputReference`](../type-aliases/OutputReference.md) + +The Plutus Data output reference object diff --git a/docs/markdown/mesh-common/functions/pairs.md b/docs/markdown/mesh-common/functions/pairs.md new file mode 100644 index 000000000..e71f12271 --- /dev/null +++ b/docs/markdown/mesh-common/functions/pairs.md @@ -0,0 +1,43 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / pairs + +# Function: pairs() + +> **pairs**\<`K`, `V`\>(`mapItems`, `validation`): [`Pairs`](../type-aliases/Pairs.md)\<`K`, `V`\> + +Defined in: data/json/primitives.ts:175 + +The utility function to create a Plutus Data Pairs in JSON + +## Type Parameters + +### K + +`K` + +### V + +`V` + +## Parameters + +### mapItems + +\[`K`, `V`\][] + +The items map in array + +### validation + +`boolean` = `true` + +Default true - If current data construction would perform validation (introducing this flag due to possible performance issue in loop validation) + +## Returns + +[`Pairs`](../type-aliases/Pairs.md)\<`K`, `V`\> + +The Plutus Data Pairs object diff --git a/docs/markdown/mesh-common/functions/parseAssetUnit.md b/docs/markdown/mesh-common/functions/parseAssetUnit.md new file mode 100644 index 000000000..b29b23d0c --- /dev/null +++ b/docs/markdown/mesh-common/functions/parseAssetUnit.md @@ -0,0 +1,35 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / parseAssetUnit + +# Function: parseAssetUnit() + +> **parseAssetUnit**(`unit`): `object` + +Defined in: data/parser.ts:76 + +Parse asset unit into an object with policyId and assetName + +## Parameters + +### unit + +`string` + +The asset unit to be parsed + +## Returns + +`object` + +The object with policyId and assetName + +### assetName + +> **assetName**: `string` + +### policyId + +> **policyId**: `string` diff --git a/docs/markdown/mesh-common/functions/plutusBSArrayToString.md b/docs/markdown/mesh-common/functions/plutusBSArrayToString.md new file mode 100644 index 000000000..100fa2b7d --- /dev/null +++ b/docs/markdown/mesh-common/functions/plutusBSArrayToString.md @@ -0,0 +1,27 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / plutusBSArrayToString + +# Function: plutusBSArrayToString() + +> **plutusBSArrayToString**(`bsArray`): `string` + +Defined in: data/json/primitives.ts:143 + +Converting ByteString Array into a single string + +## Parameters + +### bsArray + +[`List`](../type-aliases/List.md)\<[`ByteString`](../type-aliases/ByteString.md)\> + +The ByteString Array to be converted into a single string + +## Returns + +`string` + +The string representation of the ByteString Array diff --git a/docs/markdown/mesh-common/functions/policyId.md b/docs/markdown/mesh-common/functions/policyId.md new file mode 100644 index 000000000..ee392aa22 --- /dev/null +++ b/docs/markdown/mesh-common/functions/policyId.md @@ -0,0 +1,27 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / policyId + +# Function: policyId() + +> **policyId**(`bytes`): [`ByteString`](../type-aliases/ByteString.md) + +Defined in: data/json/aliases.ts:138 + +The utility function to create a Plutus Data policy id in JSON + +## Parameters + +### bytes + +`string` + +The policy id in hex + +## Returns + +[`ByteString`](../type-aliases/ByteString.md) + +The Plutus Data policy id object diff --git a/docs/markdown/mesh-common/functions/posixTime.md b/docs/markdown/mesh-common/functions/posixTime.md new file mode 100644 index 000000000..b387911f1 --- /dev/null +++ b/docs/markdown/mesh-common/functions/posixTime.md @@ -0,0 +1,27 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / posixTime + +# Function: posixTime() + +> **posixTime**(`int`): [`Integer`](../type-aliases/Integer.md) + +Defined in: data/json/aliases.ts:224 + +The utility function to create a Plutus Data POSIX time in JSON + +## Parameters + +### int + +`number` + +The integer value of the POSIX time + +## Returns + +[`Integer`](../type-aliases/Integer.md) + +The Plutus Data POSIX time object diff --git a/docs/markdown/mesh-common/functions/pubKeyAddress.md b/docs/markdown/mesh-common/functions/pubKeyAddress.md new file mode 100644 index 000000000..f07cc4c58 --- /dev/null +++ b/docs/markdown/mesh-common/functions/pubKeyAddress.md @@ -0,0 +1,39 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / pubKeyAddress + +# Function: pubKeyAddress() + +> **pubKeyAddress**(`bytes`, `stakeCredential?`, `isStakeScriptCredential?`): [`PubKeyAddress`](../type-aliases/PubKeyAddress.md) + +Defined in: data/json/credentials.ts:82 + +The utility function to create a Plutus Data public key address in JSON + +## Parameters + +### bytes + +`string` + +The public key hash in hex + +### stakeCredential? + +`string` + +The staking credential in hex + +### isStakeScriptCredential? + +`boolean` = `false` + +The flag to indicate if the credential is a script credential + +## Returns + +[`PubKeyAddress`](../type-aliases/PubKeyAddress.md) + +The Plutus Data public key address object diff --git a/docs/markdown/mesh-common/functions/pubKeyHash.md b/docs/markdown/mesh-common/functions/pubKeyHash.md new file mode 100644 index 000000000..0c60a0248 --- /dev/null +++ b/docs/markdown/mesh-common/functions/pubKeyHash.md @@ -0,0 +1,27 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / pubKeyHash + +# Function: pubKeyHash() + +> **pubKeyHash**(`bytes`): [`ByteString`](../type-aliases/ByteString.md) + +Defined in: data/json/aliases.ts:131 + +The utility function to create a Plutus Data pub key hash in JSON + +## Parameters + +### bytes + +`string` + +The script hash in hex + +## Returns + +[`ByteString`](../type-aliases/ByteString.md) + +The Plutus Data script hash object diff --git a/docs/markdown/mesh-common/functions/resolveEpochNo.md b/docs/markdown/mesh-common/functions/resolveEpochNo.md new file mode 100644 index 000000000..6d17ae6ef --- /dev/null +++ b/docs/markdown/mesh-common/functions/resolveEpochNo.md @@ -0,0 +1,33 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / resolveEpochNo + +# Function: resolveEpochNo() + +> **resolveEpochNo**(`network`, `milliseconds`): `number` + +Defined in: data/time.ts:98 + +Resolve epoch number based on timestamp in milliseconds. + +## Parameters + +### network + +Network: mainnet | preprod | preview. + +`"testnet"` | `"preview"` | `"preprod"` | `"mainnet"` + +### milliseconds + +`number` = `...` + +Timestamp in milliseconds + +## Returns + +`number` + +Epoch number diff --git a/docs/markdown/mesh-common/functions/resolveFingerprint.md b/docs/markdown/mesh-common/functions/resolveFingerprint.md new file mode 100644 index 000000000..c4a119c1c --- /dev/null +++ b/docs/markdown/mesh-common/functions/resolveFingerprint.md @@ -0,0 +1,25 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / resolveFingerprint + +# Function: resolveFingerprint() + +> **resolveFingerprint**(`policyId`, `assetName`): `string` + +Defined in: utils/asset-fingerprint.ts:6 + +## Parameters + +### policyId + +`string` + +### assetName + +`string` + +## Returns + +`string` diff --git a/docs/markdown/mesh-common/functions/resolveLanguageView.md b/docs/markdown/mesh-common/functions/resolveLanguageView.md new file mode 100644 index 000000000..f6affecae --- /dev/null +++ b/docs/markdown/mesh-common/functions/resolveLanguageView.md @@ -0,0 +1,25 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / resolveLanguageView + +# Function: resolveLanguageView() + +> **resolveLanguageView**(`era`, `version`): `undefined` \| `string` + +Defined in: constants/language-views.ts:17 + +## Parameters + +### era + +[`Era`](../type-aliases/Era.md) + +### version + +`"V1"` | `"V2"` | `"V3"` + +## Returns + +`undefined` \| `string` diff --git a/docs/markdown/mesh-common/functions/resolveSlotNo.md b/docs/markdown/mesh-common/functions/resolveSlotNo.md new file mode 100644 index 000000000..f5a55b444 --- /dev/null +++ b/docs/markdown/mesh-common/functions/resolveSlotNo.md @@ -0,0 +1,33 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / resolveSlotNo + +# Function: resolveSlotNo() + +> **resolveSlotNo**(`network`, `milliseconds`): `string` + +Defined in: data/time.ts:82 + +Resolve slot number based on timestamp in milliseconds. + +## Parameters + +### network + +Network: mainnet | preprod | preview. + +`"testnet"` | `"preview"` | `"preprod"` | `"mainnet"` + +### milliseconds + +`number` = `...` + +Timestamp in milliseconds + +## Returns + +`string` + +Slot number diff --git a/docs/markdown/mesh-common/functions/resolveTxFees.md b/docs/markdown/mesh-common/functions/resolveTxFees.md new file mode 100644 index 000000000..e555645d2 --- /dev/null +++ b/docs/markdown/mesh-common/functions/resolveTxFees.md @@ -0,0 +1,29 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / resolveTxFees + +# Function: resolveTxFees() + +> **resolveTxFees**(`txSize`, `minFeeA`, `minFeeB`): `string` + +Defined in: constants/protocol-parameters.ts:29 + +## Parameters + +### txSize + +`number` + +### minFeeA + +`number` = `DEFAULT_PROTOCOL_PARAMETERS.minFeeA` + +### minFeeB + +`number` = `DEFAULT_PROTOCOL_PARAMETERS.minFeeB` + +## Returns + +`string` diff --git a/docs/markdown/mesh-common/functions/script.md b/docs/markdown/mesh-common/functions/script.md new file mode 100644 index 000000000..28e3dce60 --- /dev/null +++ b/docs/markdown/mesh-common/functions/script.md @@ -0,0 +1,27 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / script + +# Function: script() + +> **script**(`bytes`): [`Script`](../type-aliases/Script.md) + +Defined in: data/json/credentials.ts:50 + +The utility function to create a Plutus Data script key in JSON + +## Parameters + +### bytes + +`string` + +The script hash in hex + +## Returns + +[`Script`](../type-aliases/Script.md) + +The Plutus Data script key object diff --git a/docs/markdown/mesh-common/functions/scriptAddress.md b/docs/markdown/mesh-common/functions/scriptAddress.md new file mode 100644 index 000000000..35e6e53ff --- /dev/null +++ b/docs/markdown/mesh-common/functions/scriptAddress.md @@ -0,0 +1,39 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / scriptAddress + +# Function: scriptAddress() + +> **scriptAddress**(`bytes`, `stakeCredential?`, `isStakeScriptCredential?`): [`ScriptAddress`](../type-aliases/ScriptAddress.md) + +Defined in: data/json/credentials.ts:99 + +The utility function to create a Plutus Data script address in JSON + +## Parameters + +### bytes + +`string` + +The validator hash in hex + +### stakeCredential? + +`string` + +The staking credential in hex + +### isStakeScriptCredential? + +`boolean` = `false` + +The flag to indicate if the stake credential is a script credential + +## Returns + +[`ScriptAddress`](../type-aliases/ScriptAddress.md) + +The Plutus Data script address object diff --git a/docs/markdown/mesh-common/functions/scriptHash.md b/docs/markdown/mesh-common/functions/scriptHash.md new file mode 100644 index 000000000..9f665bb89 --- /dev/null +++ b/docs/markdown/mesh-common/functions/scriptHash.md @@ -0,0 +1,27 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / scriptHash + +# Function: scriptHash() + +> **scriptHash**(`bytes`): [`ByteString`](../type-aliases/ByteString.md) + +Defined in: data/json/aliases.ts:124 + +The utility function to create a Plutus Data script hash in JSON + +## Parameters + +### bytes + +`string` + +The script hash in hex + +## Returns + +[`ByteString`](../type-aliases/ByteString.md) + +The Plutus Data script hash object diff --git a/docs/markdown/mesh-common/functions/slotToBeginUnixTime.md b/docs/markdown/mesh-common/functions/slotToBeginUnixTime.md new file mode 100644 index 000000000..3e84bc583 --- /dev/null +++ b/docs/markdown/mesh-common/functions/slotToBeginUnixTime.md @@ -0,0 +1,25 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / slotToBeginUnixTime + +# Function: slotToBeginUnixTime() + +> **slotToBeginUnixTime**(`slot`, `slotConfig`): `number` + +Defined in: data/time.ts:53 + +## Parameters + +### slot + +`number` + +### slotConfig + +[`SlotConfig`](../type-aliases/SlotConfig.md) + +## Returns + +`number` diff --git a/docs/markdown/mesh-common/functions/some.md b/docs/markdown/mesh-common/functions/some.md new file mode 100644 index 000000000..f855bfa68 --- /dev/null +++ b/docs/markdown/mesh-common/functions/some.md @@ -0,0 +1,33 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / some + +# Function: some() + +> **some**\<`T`\>(`value`): [`Some`](../type-aliases/Some.md)\<`T`\> + +Defined in: data/json/aliases.ts:261 + +The utility function to create a Plutus Data Option - Some in JSON + +## Type Parameters + +### T + +`T` + +## Parameters + +### value + +`T` + +The value of the option + +## Returns + +[`Some`](../type-aliases/Some.md)\<`T`\> + +The Plutus Data Option - Some object diff --git a/docs/markdown/mesh-common/functions/stringToBSArray.md b/docs/markdown/mesh-common/functions/stringToBSArray.md new file mode 100644 index 000000000..c2a7e29d3 --- /dev/null +++ b/docs/markdown/mesh-common/functions/stringToBSArray.md @@ -0,0 +1,27 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / stringToBSArray + +# Function: stringToBSArray() + +> **stringToBSArray**(`hexString`): [`List`](../type-aliases/List.md)\<[`ByteString`](../type-aliases/ByteString.md)\> + +Defined in: data/json/primitives.ts:123 + +Converting a hex string into a ByteString Array, with max 32 bytes on each items + +## Parameters + +### hexString + +`string` + +The hex string to be converted into ByteString Array + +## Returns + +[`List`](../type-aliases/List.md)\<[`ByteString`](../type-aliases/ByteString.md)\> + +The ByteString Array representation of the hex string diff --git a/docs/markdown/mesh-common/functions/stringToHex.md b/docs/markdown/mesh-common/functions/stringToHex.md new file mode 100644 index 000000000..061e29f45 --- /dev/null +++ b/docs/markdown/mesh-common/functions/stringToHex.md @@ -0,0 +1,27 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / stringToHex + +# Function: stringToHex() + +> **stringToHex**(`str`): `string` + +Defined in: data/parser.ts:23 + +Converting utf8 string to hex string + +## Parameters + +### str + +`string` + +The utf8 string to be converted + +## Returns + +`string` + +The hex string diff --git a/docs/markdown/mesh-common/functions/toBytes.md b/docs/markdown/mesh-common/functions/toBytes.md new file mode 100644 index 000000000..8120e3ac7 --- /dev/null +++ b/docs/markdown/mesh-common/functions/toBytes.md @@ -0,0 +1,27 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / toBytes + +# Function: toBytes() + +> **toBytes**(`hex`): `Uint8Array` + +Defined in: data/parser.ts:46 + +Converting either hex string or utf8 string to bytes + +## Parameters + +### hex + +`string` + +The hex or utf8 string to be converted + +## Returns + +`Uint8Array` + +The bytes diff --git a/docs/markdown/mesh-common/functions/toUTF8.md b/docs/markdown/mesh-common/functions/toUTF8.md new file mode 100644 index 000000000..a9088ed0b --- /dev/null +++ b/docs/markdown/mesh-common/functions/toUTF8.md @@ -0,0 +1,27 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / toUTF8 + +# Function: toUTF8() + +> **toUTF8**(`hex`): `string` + +Defined in: data/parser.ts:68 + +Converting hex string to utf8 string + +## Parameters + +### hex + +`string` + +The hex string to be converted + +## Returns + +`string` + +The utf8 string diff --git a/docs/markdown/mesh-common/functions/tokenMintedLogic.md b/docs/markdown/mesh-common/functions/tokenMintedLogic.md new file mode 100644 index 000000000..7acdaa33b --- /dev/null +++ b/docs/markdown/mesh-common/functions/tokenMintedLogic.md @@ -0,0 +1,45 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / tokenMintedLogic + +# Function: tokenMintedLogic() + +> **tokenMintedLogic**(`mints`, `policyId`, `assetName`, `quantity`): `boolean` + +Defined in: tx-tester/index.ts:583 + +Internal logic to check if a token is minted + +## Parameters + +### mints + +[`MintParam`](../type-aliases/MintParam.md)[] + +The mints info of the tx builder body + +### policyId + +`string` + +The policy ID of the token + +### assetName + +`string` + +The asset name of the token + +### quantity + +`number` + +The quantity of the token + +## Returns + +`boolean` + +true if the token is minted, false otherwise diff --git a/docs/markdown/mesh-common/functions/tokenName.md b/docs/markdown/mesh-common/functions/tokenName.md new file mode 100644 index 000000000..77950b096 --- /dev/null +++ b/docs/markdown/mesh-common/functions/tokenName.md @@ -0,0 +1,27 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / tokenName + +# Function: tokenName() + +> **tokenName**(`bytes`): [`ByteString`](../type-aliases/ByteString.md) + +Defined in: data/json/aliases.ts:174 + +The utility function to create a Plutus Data token name in JSON + +## Parameters + +### bytes + +`string` + +The token name in hex + +## Returns + +[`ByteString`](../type-aliases/ByteString.md) + +The Plutus Data token name object diff --git a/docs/markdown/mesh-common/functions/tuple.md b/docs/markdown/mesh-common/functions/tuple.md new file mode 100644 index 000000000..d3915c4ce --- /dev/null +++ b/docs/markdown/mesh-common/functions/tuple.md @@ -0,0 +1,33 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / tuple + +# Function: tuple() + +> **tuple**\<`T`\>(...`args`): [`Tuple`](../type-aliases/Tuple.md)\<`T`\> + +Defined in: data/json/aliases.ts:240 + +The utility function to create a Plutus Data tuple in JSON + +## Type Parameters + +### T + +`T` *extends* [`PlutusData`](../type-aliases/PlutusData.md)[] + +## Parameters + +### args + +...`T` + +The arguments of the tuple + +## Returns + +[`Tuple`](../type-aliases/Tuple.md)\<`T`\> + +The Plutus Data tuple object diff --git a/docs/markdown/mesh-common/functions/txInToUtxo.md b/docs/markdown/mesh-common/functions/txInToUtxo.md new file mode 100644 index 000000000..dcf43eecf --- /dev/null +++ b/docs/markdown/mesh-common/functions/txInToUtxo.md @@ -0,0 +1,21 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / txInToUtxo + +# Function: txInToUtxo() + +> **txInToUtxo**(`txIn`): [`UTxO`](../type-aliases/UTxO.md) + +Defined in: types/transaction-builder/txin.ts:42 + +## Parameters + +### txIn + +[`TxInParameter`](../type-aliases/TxInParameter.md) + +## Returns + +[`UTxO`](../type-aliases/UTxO.md) diff --git a/docs/markdown/mesh-common/functions/txOutRef.md b/docs/markdown/mesh-common/functions/txOutRef.md new file mode 100644 index 000000000..977d31b76 --- /dev/null +++ b/docs/markdown/mesh-common/functions/txOutRef.md @@ -0,0 +1,33 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / txOutRef + +# Function: txOutRef() + +> **txOutRef**(`txHash`, `index`): [`TxOutRef`](../type-aliases/TxOutRef.md) + +Defined in: data/json/aliases.ts:212 + +The utility function to create a Plutus Data TxOutRef in JSON + +## Parameters + +### txHash + +`string` + +The transaction hash + +### index + +`number` + +The index of the output + +## Returns + +[`TxOutRef`](../type-aliases/TxOutRef.md) + +The Plutus Data TxOutRef object diff --git a/docs/markdown/mesh-common/functions/unixTimeToEnclosingSlot.md b/docs/markdown/mesh-common/functions/unixTimeToEnclosingSlot.md new file mode 100644 index 000000000..ae141b0a0 --- /dev/null +++ b/docs/markdown/mesh-common/functions/unixTimeToEnclosingSlot.md @@ -0,0 +1,33 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / unixTimeToEnclosingSlot + +# Function: unixTimeToEnclosingSlot() + +> **unixTimeToEnclosingSlot**(`unixTime`, `slotConfig`): `number` + +Defined in: data/time.ts:67 + +Eqivalent to `slotToBeginUnixTime` but option to provide optional config + +## Parameters + +### unixTime + +`number` + +Timestamp in milliseconds + +### slotConfig + +[`SlotConfig`](../type-aliases/SlotConfig.md) + +Slot configuration for calculation + +## Returns + +`number` + +Slot number diff --git a/docs/markdown/mesh-common/functions/validityRangeFromObj.md b/docs/markdown/mesh-common/functions/validityRangeFromObj.md new file mode 100644 index 000000000..a5f450e9a --- /dev/null +++ b/docs/markdown/mesh-common/functions/validityRangeFromObj.md @@ -0,0 +1,21 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / validityRangeFromObj + +# Function: validityRangeFromObj() + +> **validityRangeFromObj**(`obj`): [`ValidityRange`](../type-aliases/ValidityRange.md) + +Defined in: types/transaction-builder/index.ts:126 + +## Parameters + +### obj + +`any` + +## Returns + +[`ValidityRange`](../type-aliases/ValidityRange.md) diff --git a/docs/markdown/mesh-common/functions/validityRangeToObj.md b/docs/markdown/mesh-common/functions/validityRangeToObj.md new file mode 100644 index 000000000..c404762d5 --- /dev/null +++ b/docs/markdown/mesh-common/functions/validityRangeToObj.md @@ -0,0 +1,21 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / validityRangeToObj + +# Function: validityRangeToObj() + +> **validityRangeToObj**(`validityRange`): `object` + +Defined in: types/transaction-builder/index.ts:119 + +## Parameters + +### validityRange + +[`ValidityRange`](../type-aliases/ValidityRange.md) + +## Returns + +`object` diff --git a/docs/markdown/mesh-common/functions/value.md b/docs/markdown/mesh-common/functions/value.md new file mode 100644 index 000000000..f723db333 --- /dev/null +++ b/docs/markdown/mesh-common/functions/value.md @@ -0,0 +1,27 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / value + +# Function: value() + +> **value**(`assets`): [`Value`](../type-aliases/Value.md) + +Defined in: data/value.ts:36 + +The utility function to convert assets into Cardano data Value in JSON + +## Parameters + +### assets + +[`Asset`](../type-aliases/Asset.md)[] + +The assets to convert + +## Returns + +[`Value`](../type-aliases/Value.md) + +The Cardano data Value in JSON diff --git a/docs/markdown/mesh-common/functions/verificationKey.md b/docs/markdown/mesh-common/functions/verificationKey.md new file mode 100644 index 000000000..4dbeac7cb --- /dev/null +++ b/docs/markdown/mesh-common/functions/verificationKey.md @@ -0,0 +1,27 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / verificationKey + +# Function: verificationKey() + +> **verificationKey**(`bytes`): [`VerificationKey`](../type-aliases/VerificationKey.md) + +Defined in: data/json/credentials.ts:42 + +The utility function to create a Plutus Data verification key in JSON + +## Parameters + +### bytes + +`string` + +The public key hash in hex + +## Returns + +[`VerificationKey`](../type-aliases/VerificationKey.md) + +The Plutus Data verification key object diff --git a/docs/markdown/mesh-common/globals.md b/docs/markdown/mesh-common/globals.md new file mode 100644 index 000000000..daeb2f96f --- /dev/null +++ b/docs/markdown/mesh-common/globals.md @@ -0,0 +1,299 @@ +[**@meshsdk/common**](README.md) + +*** + +# @meshsdk/common + +## Classes + +- [AssetFingerprint](classes/AssetFingerprint.md) +- [BigNum](classes/BigNum.md) +- [MeshValue](classes/MeshValue.md) +- [TxTester](classes/TxTester.md) +- [UtxoSelection](classes/UtxoSelection.md) + +## Interfaces + +- [IDeserializer](interfaces/IDeserializer.md) +- [IEvaluator](interfaces/IEvaluator.md) +- [IFetcher](interfaces/IFetcher.md) +- [IInitiator](interfaces/IInitiator.md) +- [IListener](interfaces/IListener.md) +- [IMeshTxSerializer](interfaces/IMeshTxSerializer.md) +- [IMintingBlueprint](interfaces/IMintingBlueprint.md) +- [IResolver](interfaces/IResolver.md) +- [ISigner](interfaces/ISigner.md) +- [ISpendingBlueprint](interfaces/ISpendingBlueprint.md) +- [ISubmitter](interfaces/ISubmitter.md) +- [ITxParser](interfaces/ITxParser.md) +- [IWallet](interfaces/IWallet.md) +- [IWithdrawalBlueprint](interfaces/IWithdrawalBlueprint.md) + +## Type Aliases + +- [AccountInfo](type-aliases/AccountInfo.md) +- [Action](type-aliases/Action.md) +- [Anchor](type-aliases/Anchor.md) +- [Asset](type-aliases/Asset.md) +- [AssetClass](type-aliases/AssetClass.md) +- [AssetExtended](type-aliases/AssetExtended.md) +- [AssetMetadata](type-aliases/AssetMetadata.md) +- [AssetName](type-aliases/AssetName.md) +- [AssocMap](type-aliases/AssocMap.md) +- [AssocMapItem](type-aliases/AssocMapItem.md) +- [BasicVote](type-aliases/BasicVote.md) +- [BlockInfo](type-aliases/BlockInfo.md) +- [Bool](type-aliases/Bool.md) +- [Budget](type-aliases/Budget.md) +- [BuilderData](type-aliases/BuilderData.md) +- [BuiltinByteString](type-aliases/BuiltinByteString.md) +- [ByteString](type-aliases/ByteString.md) +- [Certificate](type-aliases/Certificate.md) +- [CertificateType](type-aliases/CertificateType.md) +- [ConStr](type-aliases/ConStr.md) +- [ConStr0](type-aliases/ConStr0.md) +- [ConStr1](type-aliases/ConStr1.md) +- [ConStr2](type-aliases/ConStr2.md) +- [ConStr3](type-aliases/ConStr3.md) +- [Credential](type-aliases/Credential.md) +- [CurrencySymbol](type-aliases/CurrencySymbol.md) +- [Data](type-aliases/Data.md) +- [DataSignature](type-aliases/DataSignature.md) +- [DatumSource](type-aliases/DatumSource.md) +- [DeserializedAddress](type-aliases/DeserializedAddress.md) +- [DeserializedScript](type-aliases/DeserializedScript.md) +- [Dict](type-aliases/Dict.md) +- [DictItem](type-aliases/DictItem.md) +- [DRep](type-aliases/DRep.md) +- [Era](type-aliases/Era.md) +- [Extension](type-aliases/Extension.md) +- [Files](type-aliases/Files.md) +- [ForkNeighbor](type-aliases/ForkNeighbor.md) +- [FungibleAssetMetadata](type-aliases/FungibleAssetMetadata.md) +- [GovernanceProposalInfo](type-aliases/GovernanceProposalInfo.md) +- [IFetcherOptions](type-aliases/IFetcherOptions.md) +- [ImageAssetMetadata](type-aliases/ImageAssetMetadata.md) +- [Integer](type-aliases/Integer.md) +- [LanguageVersion](type-aliases/LanguageVersion.md) +- [List](type-aliases/List.md) +- [MAssetClass](type-aliases/MAssetClass.md) +- [MaybeStakingHash](type-aliases/MaybeStakingHash.md) +- [MBool](type-aliases/MBool.md) +- [MConStr](type-aliases/MConStr.md) +- [MConStr0](type-aliases/MConStr0.md) +- [MConStr1](type-aliases/MConStr1.md) +- [MConStr2](type-aliases/MConStr2.md) +- [MConStr3](type-aliases/MConStr3.md) +- [MCredential](type-aliases/MCredential.md) +- [MeshTxBuilderBody](type-aliases/MeshTxBuilderBody.md) +- [Message](type-aliases/Message.md) +- [Metadata](type-aliases/Metadata.md) +- [Metadatum](type-aliases/Metadatum.md) +- [MetadatumMap](type-aliases/MetadatumMap.md) +- [Mint](type-aliases/Mint.md) +- [MintItem](type-aliases/MintItem.md) +- [MintParam](type-aliases/MintParam.md) +- [MMaybeStakingHash](type-aliases/MMaybeStakingHash.md) +- [MNone](type-aliases/MNone.md) +- [MOption](type-aliases/MOption.md) +- [MOutputReference](type-aliases/MOutputReference.md) +- [MPubKeyAddress](type-aliases/MPubKeyAddress.md) +- [MScript](type-aliases/MScript.md) +- [MScriptAddress](type-aliases/MScriptAddress.md) +- [MSome](type-aliases/MSome.md) +- [MTuple](type-aliases/MTuple.md) +- [MTxOutRef](type-aliases/MTxOutRef.md) +- [MValue](type-aliases/MValue.md) +- [MVerificationKey](type-aliases/MVerificationKey.md) +- [NativeScript](type-aliases/NativeScript.md) +- [Network](type-aliases/Network.md) +- [None](type-aliases/None.md) +- [NonFungibleAssetMetadata](type-aliases/NonFungibleAssetMetadata.md) +- [Option](type-aliases/Option.md) +- [Output](type-aliases/Output.md) +- [OutputReference](type-aliases/OutputReference.md) +- [Pair](type-aliases/Pair.md) +- [Pairs](type-aliases/Pairs.md) +- [PlutusData](type-aliases/PlutusData.md) +- [PlutusDataType](type-aliases/PlutusDataType.md) +- [PlutusScript](type-aliases/PlutusScript.md) +- [PolicyId](type-aliases/PolicyId.md) +- [PoolMetadata](type-aliases/PoolMetadata.md) +- [PoolParams](type-aliases/PoolParams.md) +- [POSIXTime](type-aliases/POSIXTime.md) +- [ProofStep](type-aliases/ProofStep.md) +- [ProofStepBranch](type-aliases/ProofStepBranch.md) +- [ProofStepFork](type-aliases/ProofStepFork.md) +- [ProofStepLeaf](type-aliases/ProofStepLeaf.md) +- [Protocol](type-aliases/Protocol.md) +- [PubKeyAddress](type-aliases/PubKeyAddress.md) +- [PubKeyHash](type-aliases/PubKeyHash.md) +- [PubKeyTxIn](type-aliases/PubKeyTxIn.md) +- [PubKeyWithdrawal](type-aliases/PubKeyWithdrawal.md) +- [Quantity](type-aliases/Quantity.md) +- [Recipient](type-aliases/Recipient.md) +- [Redeemer](type-aliases/Redeemer.md) +- [RedeemerTagType](type-aliases/RedeemerTagType.md) +- [RefTxIn](type-aliases/RefTxIn.md) +- [Relay](type-aliases/Relay.md) +- [RequiredWith](type-aliases/RequiredWith.md) +- [RoyaltiesStandard](type-aliases/RoyaltiesStandard.md) +- [Script](type-aliases/Script.md) +- [ScriptAddress](type-aliases/ScriptAddress.md) +- [ScriptHash](type-aliases/ScriptHash.md) +- [ScriptSource](type-aliases/ScriptSource.md) +- [ScriptTxIn](type-aliases/ScriptTxIn.md) +- [ScriptTxInParameter](type-aliases/ScriptTxInParameter.md) +- [ScriptVote](type-aliases/ScriptVote.md) +- [ScriptWithdrawal](type-aliases/ScriptWithdrawal.md) +- [SimpleScriptSourceInfo](type-aliases/SimpleScriptSourceInfo.md) +- [SimpleScriptTxIn](type-aliases/SimpleScriptTxIn.md) +- [SimpleScriptTxInParameter](type-aliases/SimpleScriptTxInParameter.md) +- [SimpleScriptVote](type-aliases/SimpleScriptVote.md) +- [SimpleScriptWithdrawal](type-aliases/SimpleScriptWithdrawal.md) +- [SlotConfig](type-aliases/SlotConfig.md) +- [Some](type-aliases/Some.md) +- [Token](type-aliases/Token.md) +- [TokenName](type-aliases/TokenName.md) +- [TransactionInfo](type-aliases/TransactionInfo.md) +- [Tuple](type-aliases/Tuple.md) +- [TxIn](type-aliases/TxIn.md) +- [TxInParameter](type-aliases/TxInParameter.md) +- [TxInput](type-aliases/TxInput.md) +- [TxMetadata](type-aliases/TxMetadata.md) +- [TxOutput](type-aliases/TxOutput.md) +- [TxOutRef](type-aliases/TxOutRef.md) +- [Unit](type-aliases/Unit.md) +- [UTxO](type-aliases/UTxO.md) +- [UtxoSelectionStrategy](type-aliases/UtxoSelectionStrategy.md) +- [ValidityRange](type-aliases/ValidityRange.md) +- [Value](type-aliases/Value.md) +- [VerificationKey](type-aliases/VerificationKey.md) +- [Vote](type-aliases/Vote.md) +- [VoteKind](type-aliases/VoteKind.md) +- [Voter](type-aliases/Voter.md) +- [VoteType](type-aliases/VoteType.md) +- [VotingProcedure](type-aliases/VotingProcedure.md) +- [Wallet](type-aliases/Wallet.md) +- [Withdrawal](type-aliases/Withdrawal.md) + +## Variables + +- [DEFAULT\_FETCHER\_OPTIONS](variables/DEFAULT_FETCHER_OPTIONS.md) +- [DEFAULT\_PROTOCOL\_PARAMETERS](variables/DEFAULT_PROTOCOL_PARAMETERS.md) +- [DEFAULT\_REDEEMER\_BUDGET](variables/DEFAULT_REDEEMER_BUDGET.md) +- [DEFAULT\_V1\_COST\_MODEL\_LIST](variables/DEFAULT_V1_COST_MODEL_LIST.md) +- [DEFAULT\_V2\_COST\_MODEL\_LIST](variables/DEFAULT_V2_COST_MODEL_LIST.md) +- [DEFAULT\_V3\_COST\_MODEL\_LIST](variables/DEFAULT_V3_COST_MODEL_LIST.md) +- [DREP\_DEPOSIT](variables/DREP_DEPOSIT.md) +- [fungibleAssetKeys](variables/fungibleAssetKeys.md) +- [HARDENED\_KEY\_START](variables/HARDENED_KEY_START.md) +- [LANGUAGE\_VERSIONS](variables/LANGUAGE_VERSIONS.md) +- [metadataStandardKeys](variables/metadataStandardKeys.md) +- [POLICY\_ID\_LENGTH](variables/POLICY_ID_LENGTH.md) +- [royaltiesStandardKeys](variables/royaltiesStandardKeys.md) +- [SLOT\_CONFIG\_NETWORK](variables/SLOT_CONFIG_NETWORK.md) +- [SUPPORTED\_CLOCKS](variables/SUPPORTED_CLOCKS.md) +- [SUPPORTED\_HANDLES](variables/SUPPORTED_HANDLES.md) +- [SUPPORTED\_LANGUAGE\_VIEWS](variables/SUPPORTED_LANGUAGE_VIEWS.md) +- [SUPPORTED\_OGMIOS\_LINKS](variables/SUPPORTED_OGMIOS_LINKS.md) +- [SUPPORTED\_TOKENS](variables/SUPPORTED_TOKENS.md) +- [SUPPORTED\_WALLETS](variables/SUPPORTED_WALLETS.md) + +## Functions + +- [assetClass](functions/assetClass.md) +- [assetName](functions/assetName.md) +- [assocMap](functions/assocMap.md) +- [bool](functions/bool.md) +- [builtinByteString](functions/builtinByteString.md) +- [bytesToHex](functions/bytesToHex.md) +- [byteString](functions/byteString.md) +- [castProtocol](functions/castProtocol.md) +- [CIP68\_100](functions/CIP68_100.md) +- [CIP68\_222](functions/CIP68_222.md) +- [cloneTxBuilderBody](functions/cloneTxBuilderBody.md) +- [conStr](functions/conStr.md) +- [conStr0](functions/conStr0.md) +- [conStr1](functions/conStr1.md) +- [conStr2](functions/conStr2.md) +- [conStr3](functions/conStr3.md) +- [credential](functions/credential.md) +- [currencySymbol](functions/currencySymbol.md) +- [dict](functions/dict.md) +- [emptyTxBuilderBody](functions/emptyTxBuilderBody.md) +- [experimentalSelectUtxos](functions/experimentalSelectUtxos.md) +- [fromUTF8](functions/fromUTF8.md) +- [getFile](functions/getFile.md) +- [hashByteString](functions/hashByteString.md) +- [hashDrepAnchor](functions/hashDrepAnchor.md) +- [hexToBytes](functions/hexToBytes.md) +- [hexToString](functions/hexToString.md) +- [integer](functions/integer.md) +- [isHexString](functions/isHexString.md) +- [isNetwork](functions/isNetwork.md) +- [jsonProofToPlutusData](functions/jsonProofToPlutusData.md) +- [keepRelevant](functions/keepRelevant.md) +- [keySignedLogic](functions/keySignedLogic.md) +- [largestFirst](functions/largestFirst.md) +- [largestFirstMultiAsset](functions/largestFirstMultiAsset.md) +- [list](functions/list.md) +- [mAssetClass](functions/mAssetClass.md) +- [maybeStakingHash](functions/maybeStakingHash.md) +- [mBool](functions/mBool.md) +- [mConStr](functions/mConStr.md) +- [mConStr0](functions/mConStr0.md) +- [mConStr1](functions/mConStr1.md) +- [mConStr2](functions/mConStr2.md) +- [mConStr3](functions/mConStr3.md) +- [mCredential](functions/mCredential.md) +- [mergeAssets](functions/mergeAssets.md) +- [metadataToCip68](functions/metadataToCip68.md) +- [mMaybeStakingHash](functions/mMaybeStakingHash.md) +- [mNone](functions/mNone.md) +- [mOption](functions/mOption.md) +- [mOutputReference](functions/mOutputReference.md) +- [mPlutusBSArrayToString](functions/mPlutusBSArrayToString.md) +- [mPubKeyAddress](functions/mPubKeyAddress.md) +- [mScript](functions/mScript.md) +- [mScriptAddress](functions/mScriptAddress.md) +- [mSome](functions/mSome.md) +- [mStringToPlutusBSArray](functions/mStringToPlutusBSArray.md) +- [mTuple](functions/mTuple.md) +- [mTxOutRef](functions/mTxOutRef.md) +- [mValue](functions/mValue.md) +- [mVerificationKey](functions/mVerificationKey.md) +- [none](functions/none.md) +- [option](functions/option.md) +- [outputReference](functions/outputReference.md) +- [pairs](functions/pairs.md) +- [parseAssetUnit](functions/parseAssetUnit.md) +- [plutusBSArrayToString](functions/plutusBSArrayToString.md) +- [policyId](functions/policyId.md) +- [posixTime](functions/posixTime.md) +- [pubKeyAddress](functions/pubKeyAddress.md) +- [pubKeyHash](functions/pubKeyHash.md) +- [resolveEpochNo](functions/resolveEpochNo.md) +- [resolveFingerprint](functions/resolveFingerprint.md) +- [resolveLanguageView](functions/resolveLanguageView.md) +- [resolveSlotNo](functions/resolveSlotNo.md) +- [resolveTxFees](functions/resolveTxFees.md) +- [script](functions/script.md) +- [scriptAddress](functions/scriptAddress.md) +- [scriptHash](functions/scriptHash.md) +- [slotToBeginUnixTime](functions/slotToBeginUnixTime.md) +- [some](functions/some.md) +- [stringToBSArray](functions/stringToBSArray.md) +- [stringToHex](functions/stringToHex.md) +- [toBytes](functions/toBytes.md) +- [tokenMintedLogic](functions/tokenMintedLogic.md) +- [tokenName](functions/tokenName.md) +- [toUTF8](functions/toUTF8.md) +- [tuple](functions/tuple.md) +- [txInToUtxo](functions/txInToUtxo.md) +- [txOutRef](functions/txOutRef.md) +- [unixTimeToEnclosingSlot](functions/unixTimeToEnclosingSlot.md) +- [validityRangeFromObj](functions/validityRangeFromObj.md) +- [validityRangeToObj](functions/validityRangeToObj.md) +- [value](functions/value.md) +- [verificationKey](functions/verificationKey.md) diff --git a/docs/markdown/mesh-common/interfaces/IDeserializer.md b/docs/markdown/mesh-common/interfaces/IDeserializer.md new file mode 100644 index 000000000..179944781 --- /dev/null +++ b/docs/markdown/mesh-common/interfaces/IDeserializer.md @@ -0,0 +1,89 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / IDeserializer + +# Interface: IDeserializer + +Defined in: interfaces/serializer.ts:71 + +## Properties + +### cert + +> **cert**: `object` + +Defined in: interfaces/serializer.ts:79 + +#### deserializePoolId() + +> **deserializePoolId**(`poolId`): `string` + +##### Parameters + +###### poolId + +`string` + +##### Returns + +`string` + +*** + +### key + +> **key**: `object` + +Defined in: interfaces/serializer.ts:72 + +#### deserializeAddress() + +> **deserializeAddress**(`bech32`): [`DeserializedAddress`](../type-aliases/DeserializedAddress.md) + +##### Parameters + +###### bech32 + +`string` + +##### Returns + +[`DeserializedAddress`](../type-aliases/DeserializedAddress.md) + +*** + +### script + +> **script**: `object` + +Defined in: interfaces/serializer.ts:75 + +#### deserializeNativeScript() + +> **deserializeNativeScript**(`script`): [`DeserializedScript`](../type-aliases/DeserializedScript.md) + +##### Parameters + +###### script + +[`NativeScript`](../type-aliases/NativeScript.md) + +##### Returns + +[`DeserializedScript`](../type-aliases/DeserializedScript.md) + +#### deserializePlutusScript() + +> **deserializePlutusScript**(`script`): [`DeserializedScript`](../type-aliases/DeserializedScript.md) + +##### Parameters + +###### script + +[`PlutusScript`](../type-aliases/PlutusScript.md) + +##### Returns + +[`DeserializedScript`](../type-aliases/DeserializedScript.md) diff --git a/docs/markdown/mesh-common/interfaces/IEvaluator.md b/docs/markdown/mesh-common/interfaces/IEvaluator.md new file mode 100644 index 000000000..4c3d1fbb6 --- /dev/null +++ b/docs/markdown/mesh-common/interfaces/IEvaluator.md @@ -0,0 +1,35 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / IEvaluator + +# Interface: IEvaluator + +Defined in: interfaces/evaluator.ts:3 + +## Methods + +### evaluateTx() + +> **evaluateTx**(`tx`, `additionalUtxos?`, `additionalTxs?`): `Promise`\<`Omit`\<[`Action`](../type-aliases/Action.md), `"data"`\>[]\> + +Defined in: interfaces/evaluator.ts:4 + +#### Parameters + +##### tx + +`string` + +##### additionalUtxos? + +[`UTxO`](../type-aliases/UTxO.md)[] + +##### additionalTxs? + +`string`[] + +#### Returns + +`Promise`\<`Omit`\<[`Action`](../type-aliases/Action.md), `"data"`\>[]\> diff --git a/docs/markdown/mesh-common/interfaces/IFetcher.md b/docs/markdown/mesh-common/interfaces/IFetcher.md new file mode 100644 index 000000000..d0c3f126d --- /dev/null +++ b/docs/markdown/mesh-common/interfaces/IFetcher.md @@ -0,0 +1,247 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / IFetcher + +# Interface: IFetcher + +Defined in: interfaces/fetcher.ts:26 + +Fetcher interface defines end points to query blockchain data. + +## Methods + +### fetchAccountInfo() + +> **fetchAccountInfo**(`address`): `Promise`\<[`AccountInfo`](../type-aliases/AccountInfo.md)\> + +Defined in: interfaces/fetcher.ts:27 + +#### Parameters + +##### address + +`string` + +#### Returns + +`Promise`\<[`AccountInfo`](../type-aliases/AccountInfo.md)\> + +*** + +### fetchAddressTxs() + +> **fetchAddressTxs**(`address`, `options?`): `Promise`\<[`TransactionInfo`](../type-aliases/TransactionInfo.md)[]\> + +Defined in: interfaces/fetcher.ts:29 + +#### Parameters + +##### address + +`string` + +##### options? + +[`IFetcherOptions`](../type-aliases/IFetcherOptions.md) + +#### Returns + +`Promise`\<[`TransactionInfo`](../type-aliases/TransactionInfo.md)[]\> + +*** + +### fetchAddressUTxOs() + +> **fetchAddressUTxOs**(`address`, `asset?`): `Promise`\<[`UTxO`](../type-aliases/UTxO.md)[]\> + +Defined in: interfaces/fetcher.ts:28 + +#### Parameters + +##### address + +`string` + +##### asset? + +`string` + +#### Returns + +`Promise`\<[`UTxO`](../type-aliases/UTxO.md)[]\> + +*** + +### fetchAssetAddresses() + +> **fetchAssetAddresses**(`asset`): `Promise`\<`object`[]\> + +Defined in: interfaces/fetcher.ts:33 + +#### Parameters + +##### asset + +`string` + +#### Returns + +`Promise`\<`object`[]\> + +*** + +### fetchAssetMetadata() + +> **fetchAssetMetadata**(`asset`): `Promise`\<`any`\> + +Defined in: interfaces/fetcher.ts:36 + +#### Parameters + +##### asset + +`string` + +#### Returns + +`Promise`\<`any`\> + +*** + +### fetchBlockInfo() + +> **fetchBlockInfo**(`hash`): `Promise`\<[`BlockInfo`](../type-aliases/BlockInfo.md)\> + +Defined in: interfaces/fetcher.ts:37 + +#### Parameters + +##### hash + +`string` + +#### Returns + +`Promise`\<[`BlockInfo`](../type-aliases/BlockInfo.md)\> + +*** + +### fetchCollectionAssets() + +> **fetchCollectionAssets**(`policyId`, `cursor?`): `Promise`\<\{ `assets`: [`Asset`](../type-aliases/Asset.md)[]; `next?`: `null` \| `string` \| `number`; \}\> + +Defined in: interfaces/fetcher.ts:38 + +#### Parameters + +##### policyId + +`string` + +##### cursor? + +`string` | `number` + +#### Returns + +`Promise`\<\{ `assets`: [`Asset`](../type-aliases/Asset.md)[]; `next?`: `null` \| `string` \| `number`; \}\> + +*** + +### fetchGovernanceProposal() + +> **fetchGovernanceProposal**(`txHash`, `certIndex`): `Promise`\<[`GovernanceProposalInfo`](../type-aliases/GovernanceProposalInfo.md)\> + +Defined in: interfaces/fetcher.ts:45 + +#### Parameters + +##### txHash + +`string` + +##### certIndex + +`number` + +#### Returns + +`Promise`\<[`GovernanceProposalInfo`](../type-aliases/GovernanceProposalInfo.md)\> + +*** + +### fetchProtocolParameters() + +> **fetchProtocolParameters**(`epoch`): `Promise`\<[`Protocol`](../type-aliases/Protocol.md)\> + +Defined in: interfaces/fetcher.ts:42 + +#### Parameters + +##### epoch + +`number` + +#### Returns + +`Promise`\<[`Protocol`](../type-aliases/Protocol.md)\> + +*** + +### fetchTxInfo() + +> **fetchTxInfo**(`hash`): `Promise`\<[`TransactionInfo`](../type-aliases/TransactionInfo.md)\> + +Defined in: interfaces/fetcher.ts:43 + +#### Parameters + +##### hash + +`string` + +#### Returns + +`Promise`\<[`TransactionInfo`](../type-aliases/TransactionInfo.md)\> + +*** + +### fetchUTxOs() + +> **fetchUTxOs**(`hash`, `index?`): `Promise`\<[`UTxO`](../type-aliases/UTxO.md)[]\> + +Defined in: interfaces/fetcher.ts:44 + +#### Parameters + +##### hash + +`string` + +##### index? + +`number` + +#### Returns + +`Promise`\<[`UTxO`](../type-aliases/UTxO.md)[]\> + +*** + +### get() + +> **get**(`url`): `Promise`\<`any`\> + +Defined in: interfaces/fetcher.ts:49 + +#### Parameters + +##### url + +`string` + +#### Returns + +`Promise`\<`any`\> diff --git a/docs/markdown/mesh-common/interfaces/IInitiator.md b/docs/markdown/mesh-common/interfaces/IInitiator.md new file mode 100644 index 000000000..febf6b797 --- /dev/null +++ b/docs/markdown/mesh-common/interfaces/IInitiator.md @@ -0,0 +1,49 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / IInitiator + +# Interface: IInitiator + +Defined in: interfaces/initiator.ts:3 + +## Extended by + +- [`IWallet`](IWallet.md) + +## Methods + +### getChangeAddress() + +> **getChangeAddress**(): `Promise`\<`string`\> + +Defined in: interfaces/initiator.ts:4 + +#### Returns + +`Promise`\<`string`\> + +*** + +### getCollateral() + +> **getCollateral**(): `Promise`\<[`UTxO`](../type-aliases/UTxO.md)[]\> + +Defined in: interfaces/initiator.ts:5 + +#### Returns + +`Promise`\<[`UTxO`](../type-aliases/UTxO.md)[]\> + +*** + +### getUtxos() + +> **getUtxos**(): `Promise`\<[`UTxO`](../type-aliases/UTxO.md)[]\> + +Defined in: interfaces/initiator.ts:6 + +#### Returns + +`Promise`\<[`UTxO`](../type-aliases/UTxO.md)[]\> diff --git a/docs/markdown/mesh-common/interfaces/IListener.md b/docs/markdown/mesh-common/interfaces/IListener.md new file mode 100644 index 000000000..d5cb1fef1 --- /dev/null +++ b/docs/markdown/mesh-common/interfaces/IListener.md @@ -0,0 +1,35 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / IListener + +# Interface: IListener + +Defined in: interfaces/listener.ts:1 + +## Methods + +### onTxConfirmed() + +> **onTxConfirmed**(`txHash`, `callback`, `limit?`): `void` + +Defined in: interfaces/listener.ts:2 + +#### Parameters + +##### txHash + +`string` + +##### callback + +() => `void` + +##### limit? + +`number` + +#### Returns + +`void` diff --git a/docs/markdown/mesh-common/interfaces/IMeshTxSerializer.md b/docs/markdown/mesh-common/interfaces/IMeshTxSerializer.md new file mode 100644 index 000000000..8ef5979ea --- /dev/null +++ b/docs/markdown/mesh-common/interfaces/IMeshTxSerializer.md @@ -0,0 +1,219 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / IMeshTxSerializer + +# Interface: IMeshTxSerializer + +Defined in: interfaces/serializer.ts:17 + +## Properties + +### deserializer + +> **deserializer**: [`IDeserializer`](IDeserializer.md) + +Defined in: interfaces/serializer.ts:38 + +*** + +### parser + +> **parser**: [`ITxParser`](ITxParser.md) + +Defined in: interfaces/serializer.ts:39 + +*** + +### resolver + +> **resolver**: [`IResolver`](IResolver.md) + +Defined in: interfaces/serializer.ts:37 + +## Methods + +### addSigningKeys() + +> **addSigningKeys**(`txHex`, `signingKeys`): `string` + +Defined in: interfaces/serializer.ts:26 + +#### Parameters + +##### txHex + +`string` + +##### signingKeys + +`string`[] + +#### Returns + +`string` + +*** + +### serializeAddress() + +> **serializeAddress**(`address`, `networkId?`): `string` + +Defined in: interfaces/serializer.ts:28 + +#### Parameters + +##### address + +[`DeserializedAddress`](../type-aliases/DeserializedAddress.md) + +##### networkId? + +`0` | `1` + +#### Returns + +`string` + +*** + +### serializeData() + +> **serializeData**(`data`): `string` + +Defined in: interfaces/serializer.ts:27 + +#### Parameters + +##### data + +[`BuilderData`](../type-aliases/BuilderData.md) + +#### Returns + +`string` + +*** + +### serializeOutput() + +> **serializeOutput**(`output`): `string` + +Defined in: interfaces/serializer.ts:35 + +#### Parameters + +##### output + +[`Output`](../type-aliases/Output.md) + +#### Returns + +`string` + +*** + +### serializePoolId() + +> **serializePoolId**(`hash`): `string` + +Defined in: interfaces/serializer.ts:29 + +#### Parameters + +##### hash + +`string` + +#### Returns + +`string` + +*** + +### serializeRewardAddress() + +> **serializeRewardAddress**(`stakeKeyHash`, `isScriptHash?`, `network_id?`): `string` + +Defined in: interfaces/serializer.ts:30 + +#### Parameters + +##### stakeKeyHash + +`string` + +##### isScriptHash? + +`boolean` + +##### network\_id? + +`0` | `1` + +#### Returns + +`string` + +*** + +### serializeTxBody() + +> **serializeTxBody**(`txBuilderBody`, `protocolParams`): `string` + +Defined in: interfaces/serializer.ts:18 + +#### Parameters + +##### txBuilderBody + +[`MeshTxBuilderBody`](../type-aliases/MeshTxBuilderBody.md) + +##### protocolParams + +[`Protocol`](../type-aliases/Protocol.md) + +#### Returns + +`string` + +*** + +### serializeTxBodyWithMockSignatures() + +> **serializeTxBodyWithMockSignatures**(`txBuilderBody`, `protocolParams`): `string` + +Defined in: interfaces/serializer.ts:22 + +#### Parameters + +##### txBuilderBody + +[`MeshTxBuilderBody`](../type-aliases/MeshTxBuilderBody.md) + +##### protocolParams + +[`Protocol`](../type-aliases/Protocol.md) + +#### Returns + +`string` + +*** + +### serializeValue() + +> **serializeValue**(`value`): `string` + +Defined in: interfaces/serializer.ts:36 + +#### Parameters + +##### value + +[`Asset`](../type-aliases/Asset.md)[] + +#### Returns + +`string` diff --git a/docs/markdown/mesh-common/interfaces/IMintingBlueprint.md b/docs/markdown/mesh-common/interfaces/IMintingBlueprint.md new file mode 100644 index 000000000..07a0bbae9 --- /dev/null +++ b/docs/markdown/mesh-common/interfaces/IMintingBlueprint.md @@ -0,0 +1,77 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / IMintingBlueprint + +# Interface: IMintingBlueprint + +Defined in: types/blueprint/minting.ts:4 + +## Properties + +### cbor + +> **cbor**: `string` + +Defined in: types/blueprint/minting.ts:6 + +*** + +### hash + +> **hash**: `string` + +Defined in: types/blueprint/minting.ts:7 + +*** + +### version + +> **version**: `"V1"` \| `"V2"` \| `"V3"` + +Defined in: types/blueprint/minting.ts:5 + +## Methods + +### noParamScript() + +> **noParamScript**(`compiledCode`): `this` + +Defined in: types/blueprint/minting.ts:13 + +#### Parameters + +##### compiledCode + +`string` + +#### Returns + +`this` + +*** + +### paramScript() + +> **paramScript**(`compiledCode`, `params`, `paramsType`): `this` + +Defined in: types/blueprint/minting.ts:8 + +#### Parameters + +##### compiledCode + +`string` + +##### params + +`string`[] + +##### paramsType + +[`PlutusDataType`](../type-aliases/PlutusDataType.md) + +#### Returns + +`this` diff --git a/docs/markdown/mesh-common/interfaces/IResolver.md b/docs/markdown/mesh-common/interfaces/IResolver.md new file mode 100644 index 000000000..cd7f0e1f7 --- /dev/null +++ b/docs/markdown/mesh-common/interfaces/IResolver.md @@ -0,0 +1,143 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / IResolver + +# Interface: IResolver + +Defined in: interfaces/serializer.ts:50 + +## Properties + +### data + +> **data**: `object` + +Defined in: interfaces/serializer.ts:60 + +#### resolveDataHash() + +> **resolveDataHash**(`rawData`, `type?`): `string` + +##### Parameters + +###### rawData + +`object` | [`Data`](../type-aliases/Data.md) + +###### type? + +[`PlutusDataType`](../type-aliases/PlutusDataType.md) + +##### Returns + +`string` + +*** + +### keys + +> **keys**: `object` + +Defined in: interfaces/serializer.ts:51 + +#### resolveEd25519KeyHash() + +> **resolveEd25519KeyHash**(`bech32`): `string` + +##### Parameters + +###### bech32 + +`string` + +##### Returns + +`string` + +#### resolvePrivateKey() + +> **resolvePrivateKey**(`words`): `string` + +##### Parameters + +###### words + +`string`[] + +##### Returns + +`string` + +#### resolveRewardAddress() + +> **resolveRewardAddress**(`bech32`): `string` + +##### Parameters + +###### bech32 + +`string` + +##### Returns + +`string` + +#### resolveStakeKeyHash() + +> **resolveStakeKeyHash**(`bech32`): `string` + +##### Parameters + +###### bech32 + +`string` + +##### Returns + +`string` + +*** + +### script + +> **script**: `object` + +Defined in: interfaces/serializer.ts:66 + +#### resolveScriptRef() + +> **resolveScriptRef**(`script`): `string` + +##### Parameters + +###### script + +[`NativeScript`](../type-aliases/NativeScript.md) | [`PlutusScript`](../type-aliases/PlutusScript.md) + +##### Returns + +`string` + +*** + +### tx + +> **tx**: `object` + +Defined in: interfaces/serializer.ts:57 + +#### resolveTxHash() + +> **resolveTxHash**(`txHex`): `string` + +##### Parameters + +###### txHex + +`string` + +##### Returns + +`string` diff --git a/docs/markdown/mesh-common/interfaces/ISigner.md b/docs/markdown/mesh-common/interfaces/ISigner.md new file mode 100644 index 000000000..6333a9aa9 --- /dev/null +++ b/docs/markdown/mesh-common/interfaces/ISigner.md @@ -0,0 +1,79 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / ISigner + +# Interface: ISigner + +Defined in: interfaces/signer.ts:3 + +## Extended by + +- [`IWallet`](IWallet.md) + +## Methods + +### signData() + +> **signData**(`payload`, `address?`): `Promise`\<[`DataSignature`](../type-aliases/DataSignature.md)\> + +Defined in: interfaces/signer.ts:4 + +#### Parameters + +##### payload + +`string` + +##### address? + +`string` + +#### Returns + +`Promise`\<[`DataSignature`](../type-aliases/DataSignature.md)\> + +*** + +### signTx() + +> **signTx**(`unsignedTx`, `partialSign?`): `Promise`\<`string`\> + +Defined in: interfaces/signer.ts:5 + +#### Parameters + +##### unsignedTx + +`string` + +##### partialSign? + +`boolean` + +#### Returns + +`Promise`\<`string`\> + +*** + +### signTxs() + +> **signTxs**(`unsignedTxs`, `partialSign?`): `Promise`\<`string`[]\> + +Defined in: interfaces/signer.ts:6 + +#### Parameters + +##### unsignedTxs + +`string`[] + +##### partialSign? + +`boolean` + +#### Returns + +`Promise`\<`string`[]\> diff --git a/docs/markdown/mesh-common/interfaces/ISpendingBlueprint.md b/docs/markdown/mesh-common/interfaces/ISpendingBlueprint.md new file mode 100644 index 000000000..a225ee340 --- /dev/null +++ b/docs/markdown/mesh-common/interfaces/ISpendingBlueprint.md @@ -0,0 +1,109 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / ISpendingBlueprint + +# Interface: ISpendingBlueprint + +Defined in: types/blueprint/spending.ts:4 + +## Properties + +### address + +> **address**: `string` + +Defined in: types/blueprint/spending.ts:9 + +*** + +### cbor + +> **cbor**: `string` + +Defined in: types/blueprint/spending.ts:7 + +*** + +### hash + +> **hash**: `string` + +Defined in: types/blueprint/spending.ts:8 + +*** + +### isStakeScriptCredential + +> **isStakeScriptCredential**: `boolean` + +Defined in: types/blueprint/spending.ts:11 + +*** + +### networkId + +> **networkId**: `number` + +Defined in: types/blueprint/spending.ts:6 + +*** + +### stakeHash? + +> `optional` **stakeHash**: `string` + +Defined in: types/blueprint/spending.ts:10 + +*** + +### version + +> **version**: `"V1"` \| `"V2"` \| `"V3"` + +Defined in: types/blueprint/spending.ts:5 + +## Methods + +### noParamScript() + +> **noParamScript**(`compiledCode`): `this` + +Defined in: types/blueprint/spending.ts:17 + +#### Parameters + +##### compiledCode + +`string` + +#### Returns + +`this` + +*** + +### paramScript() + +> **paramScript**(`compiledCode`, `params`, `paramsType`): `this` + +Defined in: types/blueprint/spending.ts:12 + +#### Parameters + +##### compiledCode + +`string` + +##### params + +`string`[] + +##### paramsType + +[`PlutusDataType`](../type-aliases/PlutusDataType.md) + +#### Returns + +`this` diff --git a/docs/markdown/mesh-common/interfaces/ISubmitter.md b/docs/markdown/mesh-common/interfaces/ISubmitter.md new file mode 100644 index 000000000..e27f29eef --- /dev/null +++ b/docs/markdown/mesh-common/interfaces/ISubmitter.md @@ -0,0 +1,31 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / ISubmitter + +# Interface: ISubmitter + +Defined in: interfaces/submitter.ts:1 + +## Extended by + +- [`IWallet`](IWallet.md) + +## Methods + +### submitTx() + +> **submitTx**(`tx`): `Promise`\<`string`\> + +Defined in: interfaces/submitter.ts:2 + +#### Parameters + +##### tx + +`string` + +#### Returns + +`Promise`\<`string`\> diff --git a/docs/markdown/mesh-common/interfaces/ITxParser.md b/docs/markdown/mesh-common/interfaces/ITxParser.md new file mode 100644 index 000000000..f5603eb5f --- /dev/null +++ b/docs/markdown/mesh-common/interfaces/ITxParser.md @@ -0,0 +1,85 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / ITxParser + +# Interface: ITxParser + +Defined in: interfaces/serializer.ts:42 + +## Methods + +### getBuilderBody() + +> **getBuilderBody**(): [`MeshTxBuilderBody`](../type-aliases/MeshTxBuilderBody.md) + +Defined in: interfaces/serializer.ts:46 + +#### Returns + +[`MeshTxBuilderBody`](../type-aliases/MeshTxBuilderBody.md) + +*** + +### getBuilderBodyWithoutChange() + +> **getBuilderBodyWithoutChange**(): [`MeshTxBuilderBody`](../type-aliases/MeshTxBuilderBody.md) + +Defined in: interfaces/serializer.ts:47 + +#### Returns + +[`MeshTxBuilderBody`](../type-aliases/MeshTxBuilderBody.md) + +*** + +### getRequiredInputs() + +> **getRequiredInputs**(`txHex`): [`TxInput`](../type-aliases/TxInput.md)[] + +Defined in: interfaces/serializer.ts:43 + +#### Parameters + +##### txHex + +`string` + +#### Returns + +[`TxInput`](../type-aliases/TxInput.md)[] + +*** + +### parse() + +> **parse**(`txHex`, `resolvedUtxos?`): `void` + +Defined in: interfaces/serializer.ts:44 + +#### Parameters + +##### txHex + +`string` + +##### resolvedUtxos? + +[`UTxO`](../type-aliases/UTxO.md)[] + +#### Returns + +`void` + +*** + +### toTester() + +> **toTester**(): [`TxTester`](../classes/TxTester.md) + +Defined in: interfaces/serializer.ts:45 + +#### Returns + +[`TxTester`](../classes/TxTester.md) diff --git a/docs/markdown/mesh-common/interfaces/IWallet.md b/docs/markdown/mesh-common/interfaces/IWallet.md new file mode 100644 index 000000000..c2ed30eb0 --- /dev/null +++ b/docs/markdown/mesh-common/interfaces/IWallet.md @@ -0,0 +1,323 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / IWallet + +# Interface: IWallet + +Defined in: interfaces/wallet.ts:6 + +## Extends + +- [`IInitiator`](IInitiator.md).[`ISigner`](ISigner.md).[`ISubmitter`](ISubmitter.md) + +## Methods + +### getAssets() + +> **getAssets**(): `Promise`\<[`AssetExtended`](../type-aliases/AssetExtended.md)[]\> + +Defined in: interfaces/wallet.ts:7 + +#### Returns + +`Promise`\<[`AssetExtended`](../type-aliases/AssetExtended.md)[]\> + +*** + +### getBalance() + +> **getBalance**(): `Promise`\<[`Asset`](../type-aliases/Asset.md)[]\> + +Defined in: interfaces/wallet.ts:8 + +#### Returns + +`Promise`\<[`Asset`](../type-aliases/Asset.md)[]\> + +*** + +### getChangeAddress() + +> **getChangeAddress**(): `Promise`\<`string`\> + +Defined in: interfaces/initiator.ts:4 + +#### Returns + +`Promise`\<`string`\> + +#### Inherited from + +[`IInitiator`](IInitiator.md).[`getChangeAddress`](IInitiator.md#getchangeaddress) + +*** + +### getCollateral() + +> **getCollateral**(): `Promise`\<[`UTxO`](../type-aliases/UTxO.md)[]\> + +Defined in: interfaces/initiator.ts:5 + +#### Returns + +`Promise`\<[`UTxO`](../type-aliases/UTxO.md)[]\> + +#### Inherited from + +[`IInitiator`](IInitiator.md).[`getCollateral`](IInitiator.md#getcollateral) + +*** + +### getDRep() + +> **getDRep**(): `Promise`\<`undefined` \| \{ `dRepIDCip105`: `string`; `publicKey`: `string`; `publicKeyHash`: `string`; \}\> + +Defined in: interfaces/wallet.ts:14 + +#### Returns + +`Promise`\<`undefined` \| \{ `dRepIDCip105`: `string`; `publicKey`: `string`; `publicKeyHash`: `string`; \}\> + +*** + +### getExtensions() + +> **getExtensions**(): `Promise`\<`number`[]\> + +Defined in: interfaces/wallet.ts:9 + +#### Returns + +`Promise`\<`number`[]\> + +*** + +### getLovelace() + +> **getLovelace**(): `Promise`\<`string`\> + +Defined in: interfaces/wallet.ts:11 + +#### Returns + +`Promise`\<`string`\> + +*** + +### getNetworkId() + +> **getNetworkId**(): `Promise`\<`number`\> + +Defined in: interfaces/wallet.ts:12 + +#### Returns + +`Promise`\<`number`\> + +*** + +### getPolicyIdAssets() + +> **getPolicyIdAssets**(`policyId`): `Promise`\<[`AssetExtended`](../type-aliases/AssetExtended.md)[]\> + +Defined in: interfaces/wallet.ts:23 + +#### Parameters + +##### policyId + +`string` + +#### Returns + +`Promise`\<[`AssetExtended`](../type-aliases/AssetExtended.md)[]\> + +*** + +### getPolicyIds() + +> **getPolicyIds**(): `Promise`\<`string`[]\> + +Defined in: interfaces/wallet.ts:24 + +#### Returns + +`Promise`\<`string`[]\> + +*** + +### getRegisteredPubStakeKeys() + +> **getRegisteredPubStakeKeys**(): `Promise`\<`undefined` \| \{ `pubStakeKeyHashes`: `string`[]; `pubStakeKeys`: `string`[]; \}\> + +Defined in: interfaces/wallet.ts:25 + +#### Returns + +`Promise`\<`undefined` \| \{ `pubStakeKeyHashes`: `string`[]; `pubStakeKeys`: `string`[]; \}\> + +*** + +### getRewardAddresses() + +> **getRewardAddresses**(): `Promise`\<`string`[]\> + +Defined in: interfaces/wallet.ts:13 + +#### Returns + +`Promise`\<`string`[]\> + +*** + +### getUnregisteredPubStakeKeys() + +> **getUnregisteredPubStakeKeys**(): `Promise`\<`undefined` \| \{ `pubStakeKeyHashes`: `string`[]; `pubStakeKeys`: `string`[]; \}\> + +Defined in: interfaces/wallet.ts:32 + +#### Returns + +`Promise`\<`undefined` \| \{ `pubStakeKeyHashes`: `string`[]; `pubStakeKeys`: `string`[]; \}\> + +*** + +### getUnusedAddresses() + +> **getUnusedAddresses**(): `Promise`\<`string`[]\> + +Defined in: interfaces/wallet.ts:22 + +#### Returns + +`Promise`\<`string`[]\> + +*** + +### getUsedAddresses() + +> **getUsedAddresses**(): `Promise`\<`string`[]\> + +Defined in: interfaces/wallet.ts:10 + +#### Returns + +`Promise`\<`string`[]\> + +*** + +### getUtxos() + +> **getUtxos**(): `Promise`\<[`UTxO`](../type-aliases/UTxO.md)[]\> + +Defined in: interfaces/initiator.ts:6 + +#### Returns + +`Promise`\<[`UTxO`](../type-aliases/UTxO.md)[]\> + +#### Inherited from + +[`IInitiator`](IInitiator.md).[`getUtxos`](IInitiator.md#getutxos) + +*** + +### signData() + +> **signData**(`payload`, `address?`): `Promise`\<[`DataSignature`](../type-aliases/DataSignature.md)\> + +Defined in: interfaces/signer.ts:4 + +#### Parameters + +##### payload + +`string` + +##### address? + +`string` + +#### Returns + +`Promise`\<[`DataSignature`](../type-aliases/DataSignature.md)\> + +#### Inherited from + +[`ISigner`](ISigner.md).[`signData`](ISigner.md#signdata) + +*** + +### signTx() + +> **signTx**(`unsignedTx`, `partialSign?`): `Promise`\<`string`\> + +Defined in: interfaces/signer.ts:5 + +#### Parameters + +##### unsignedTx + +`string` + +##### partialSign? + +`boolean` + +#### Returns + +`Promise`\<`string`\> + +#### Inherited from + +[`ISigner`](ISigner.md).[`signTx`](ISigner.md#signtx) + +*** + +### signTxs() + +> **signTxs**(`unsignedTxs`, `partialSign?`): `Promise`\<`string`[]\> + +Defined in: interfaces/signer.ts:6 + +#### Parameters + +##### unsignedTxs + +`string`[] + +##### partialSign? + +`boolean` + +#### Returns + +`Promise`\<`string`[]\> + +#### Inherited from + +[`ISigner`](ISigner.md).[`signTxs`](ISigner.md#signtxs) + +*** + +### submitTx() + +> **submitTx**(`tx`): `Promise`\<`string`\> + +Defined in: interfaces/submitter.ts:2 + +#### Parameters + +##### tx + +`string` + +#### Returns + +`Promise`\<`string`\> + +#### Inherited from + +[`ISubmitter`](ISubmitter.md).[`submitTx`](ISubmitter.md#submittx) diff --git a/docs/markdown/mesh-common/interfaces/IWithdrawalBlueprint.md b/docs/markdown/mesh-common/interfaces/IWithdrawalBlueprint.md new file mode 100644 index 000000000..eb1e5a029 --- /dev/null +++ b/docs/markdown/mesh-common/interfaces/IWithdrawalBlueprint.md @@ -0,0 +1,93 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / IWithdrawalBlueprint + +# Interface: IWithdrawalBlueprint + +Defined in: types/blueprint/withdrawal.ts:4 + +## Properties + +### address + +> **address**: `string` + +Defined in: types/blueprint/withdrawal.ts:9 + +*** + +### cbor + +> **cbor**: `string` + +Defined in: types/blueprint/withdrawal.ts:7 + +*** + +### hash + +> **hash**: `string` + +Defined in: types/blueprint/withdrawal.ts:8 + +*** + +### networkId + +> **networkId**: `number` + +Defined in: types/blueprint/withdrawal.ts:6 + +*** + +### version + +> **version**: `"V1"` \| `"V2"` \| `"V3"` + +Defined in: types/blueprint/withdrawal.ts:5 + +## Methods + +### noParamScript() + +> **noParamScript**(`compiledCode`): `this` + +Defined in: types/blueprint/withdrawal.ts:15 + +#### Parameters + +##### compiledCode + +`string` + +#### Returns + +`this` + +*** + +### paramScript() + +> **paramScript**(`compiledCode`, `params`, `paramsType`): `this` + +Defined in: types/blueprint/withdrawal.ts:10 + +#### Parameters + +##### compiledCode + +`string` + +##### params + +`string`[] + +##### paramsType + +[`PlutusDataType`](../type-aliases/PlutusDataType.md) + +#### Returns + +`this` diff --git a/docs/markdown/mesh-common/type-aliases/AccountInfo.md b/docs/markdown/mesh-common/type-aliases/AccountInfo.md new file mode 100644 index 000000000..f31e92e2a --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/AccountInfo.md @@ -0,0 +1,51 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / AccountInfo + +# Type Alias: AccountInfo + +> **AccountInfo** = `object` + +Defined in: types/account-info.ts:1 + +## Properties + +### active + +> **active**: `boolean` + +Defined in: types/account-info.ts:2 + +*** + +### balance + +> **balance**: `string` + +Defined in: types/account-info.ts:4 + +*** + +### poolId? + +> `optional` **poolId**: `string` + +Defined in: types/account-info.ts:3 + +*** + +### rewards + +> **rewards**: `string` + +Defined in: types/account-info.ts:5 + +*** + +### withdrawals + +> **withdrawals**: `string` + +Defined in: types/account-info.ts:6 diff --git a/docs/markdown/mesh-common/type-aliases/Action.md b/docs/markdown/mesh-common/type-aliases/Action.md new file mode 100644 index 000000000..122b5db0a --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/Action.md @@ -0,0 +1,43 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / Action + +# Type Alias: Action + +> **Action** = `object` + +Defined in: types/action.ts:5 + +## Properties + +### budget + +> **budget**: [`Budget`](Budget.md) + +Defined in: types/action.ts:8 + +*** + +### data + +> **data**: [`Data`](Data.md) + +Defined in: types/action.ts:6 + +*** + +### index + +> **index**: `number` + +Defined in: types/action.ts:7 + +*** + +### tag + +> **tag**: [`RedeemerTagType`](RedeemerTagType.md) + +Defined in: types/action.ts:9 diff --git a/docs/markdown/mesh-common/type-aliases/Anchor.md b/docs/markdown/mesh-common/type-aliases/Anchor.md new file mode 100644 index 000000000..8842ddd8b --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/Anchor.md @@ -0,0 +1,27 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / Anchor + +# Type Alias: Anchor + +> **Anchor** = `object` + +Defined in: types/transaction-builder/certificate.ts:87 + +## Properties + +### anchorDataHash + +> **anchorDataHash**: `string` + +Defined in: types/transaction-builder/certificate.ts:89 + +*** + +### anchorUrl + +> **anchorUrl**: `string` + +Defined in: types/transaction-builder/certificate.ts:88 diff --git a/docs/markdown/mesh-common/type-aliases/Asset.md b/docs/markdown/mesh-common/type-aliases/Asset.md new file mode 100644 index 000000000..2eed9eeaa --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/Asset.md @@ -0,0 +1,27 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / Asset + +# Type Alias: Asset + +> **Asset** = `object` + +Defined in: types/asset.ts:1 + +## Properties + +### quantity + +> **quantity**: [`Quantity`](Quantity.md) + +Defined in: types/asset.ts:3 + +*** + +### unit + +> **unit**: [`Unit`](Unit.md) + +Defined in: types/asset.ts:2 diff --git a/docs/markdown/mesh-common/type-aliases/AssetClass.md b/docs/markdown/mesh-common/type-aliases/AssetClass.md new file mode 100644 index 000000000..eedf45d04 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/AssetClass.md @@ -0,0 +1,14 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / AssetClass + +# Type Alias: AssetClass + +> **AssetClass** = [`ConStr0`](ConStr0.md)\<\[[`CurrencySymbol`](CurrencySymbol.md), [`TokenName`](TokenName.md)\]\> + +Defined in: data/json/aliases.ts:49 + +PlutusTx alias +The Plutus Data asset class in JSON diff --git a/docs/markdown/mesh-common/type-aliases/AssetExtended.md b/docs/markdown/mesh-common/type-aliases/AssetExtended.md new file mode 100644 index 000000000..1bb80024e --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/AssetExtended.md @@ -0,0 +1,51 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / AssetExtended + +# Type Alias: AssetExtended + +> **AssetExtended** = `object` + +Defined in: types/asset-extended.ts:3 + +## Properties + +### assetName + +> **assetName**: `string` + +Defined in: types/asset-extended.ts:6 + +*** + +### fingerprint + +> **fingerprint**: `string` + +Defined in: types/asset-extended.ts:7 + +*** + +### policyId + +> **policyId**: `string` + +Defined in: types/asset-extended.ts:5 + +*** + +### quantity + +> **quantity**: [`Quantity`](Quantity.md) + +Defined in: types/asset-extended.ts:8 + +*** + +### unit + +> **unit**: [`Unit`](Unit.md) + +Defined in: types/asset-extended.ts:4 diff --git a/docs/markdown/mesh-common/type-aliases/AssetMetadata.md b/docs/markdown/mesh-common/type-aliases/AssetMetadata.md new file mode 100644 index 000000000..ee40b4917 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/AssetMetadata.md @@ -0,0 +1,11 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / AssetMetadata + +# Type Alias: AssetMetadata + +> **AssetMetadata** = [`FungibleAssetMetadata`](FungibleAssetMetadata.md) \| [`NonFungibleAssetMetadata`](NonFungibleAssetMetadata.md) \| [`RoyaltiesStandard`](RoyaltiesStandard.md) + +Defined in: types/asset-metadata.ts:33 diff --git a/docs/markdown/mesh-common/type-aliases/AssetName.md b/docs/markdown/mesh-common/type-aliases/AssetName.md new file mode 100644 index 000000000..3ee2694cc --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/AssetName.md @@ -0,0 +1,14 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / AssetName + +# Type Alias: AssetName + +> **AssetName** = [`ByteString`](ByteString.md) + +Defined in: data/json/aliases.ts:37 + +Aiken alias +The Plutus Data asset name in JSON diff --git a/docs/markdown/mesh-common/type-aliases/AssocMap.md b/docs/markdown/mesh-common/type-aliases/AssocMap.md new file mode 100644 index 000000000..f98a79043 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/AssocMap.md @@ -0,0 +1,32 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / AssocMap + +# Type Alias: AssocMap\ + +> **AssocMap**\<`K`, `V`\> = `object` + +Defined in: data/json/primitives.ts:39 + +PlutusTx alias +The Plutus Data association map in JSON + +## Type Parameters + +### K + +`K` = `any` + +### V + +`V` = `any` + +## Properties + +### map + +> **map**: [`AssocMapItem`](AssocMapItem.md)\<`K`, `V`\>[] + +Defined in: data/json/primitives.ts:39 diff --git a/docs/markdown/mesh-common/type-aliases/AssocMapItem.md b/docs/markdown/mesh-common/type-aliases/AssocMapItem.md new file mode 100644 index 000000000..85e8077b2 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/AssocMapItem.md @@ -0,0 +1,40 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / AssocMapItem + +# Type Alias: AssocMapItem\ + +> **AssocMapItem**\<`K`, `V`\> = `object` + +Defined in: data/json/primitives.ts:33 + +PlutusTx alias +The Plutus Data association map item in JSON + +## Type Parameters + +### K + +`K` + +### V + +`V` + +## Properties + +### k + +> **k**: `K` + +Defined in: data/json/primitives.ts:33 + +*** + +### v + +> **v**: `V` + +Defined in: data/json/primitives.ts:33 diff --git a/docs/markdown/mesh-common/type-aliases/BasicVote.md b/docs/markdown/mesh-common/type-aliases/BasicVote.md new file mode 100644 index 000000000..4eb4dbba6 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/BasicVote.md @@ -0,0 +1,27 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / BasicVote + +# Type Alias: BasicVote + +> **BasicVote** = `object` + +Defined in: types/transaction-builder/vote.ts:9 + +## Properties + +### type + +> **type**: `"BasicVote"` + +Defined in: types/transaction-builder/vote.ts:10 + +*** + +### vote + +> **vote**: [`VoteType`](VoteType.md) + +Defined in: types/transaction-builder/vote.ts:11 diff --git a/docs/markdown/mesh-common/type-aliases/BlockInfo.md b/docs/markdown/mesh-common/type-aliases/BlockInfo.md new file mode 100644 index 000000000..52df499ff --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/BlockInfo.md @@ -0,0 +1,131 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / BlockInfo + +# Type Alias: BlockInfo + +> **BlockInfo** = `object` + +Defined in: types/block-info.ts:1 + +## Properties + +### confirmations + +> **confirmations**: `number` + +Defined in: types/block-info.ts:14 + +*** + +### epoch + +> **epoch**: `number` + +Defined in: types/block-info.ts:5 + +*** + +### epochSlot + +> **epochSlot**: `string` + +Defined in: types/block-info.ts:6 + +*** + +### fees + +> **fees**: `string` + +Defined in: types/block-info.ts:11 + +*** + +### hash + +> **hash**: `string` + +Defined in: types/block-info.ts:3 + +*** + +### nextBlock + +> **nextBlock**: `string` + +Defined in: types/block-info.ts:13 + +*** + +### operationalCertificate + +> **operationalCertificate**: `string` + +Defined in: types/block-info.ts:15 + +*** + +### output + +> **output**: `string` + +Defined in: types/block-info.ts:10 + +*** + +### previousBlock + +> **previousBlock**: `string` + +Defined in: types/block-info.ts:12 + +*** + +### size + +> **size**: `number` + +Defined in: types/block-info.ts:8 + +*** + +### slot + +> **slot**: `string` + +Defined in: types/block-info.ts:4 + +*** + +### slotLeader + +> **slotLeader**: `string` + +Defined in: types/block-info.ts:7 + +*** + +### time + +> **time**: `number` + +Defined in: types/block-info.ts:2 + +*** + +### txCount + +> **txCount**: `number` + +Defined in: types/block-info.ts:9 + +*** + +### VRFKey + +> **VRFKey**: `string` + +Defined in: types/block-info.ts:16 diff --git a/docs/markdown/mesh-common/type-aliases/Bool.md b/docs/markdown/mesh-common/type-aliases/Bool.md new file mode 100644 index 000000000..828bd08ff --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/Bool.md @@ -0,0 +1,13 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / Bool + +# Type Alias: Bool + +> **Bool** = [`ConStr0`](ConStr0.md)\<\[\]\> \| [`ConStr1`](ConStr1.md)\<\[\]\> + +Defined in: data/json/primitives.ts:7 + +The Plutus Data boolean in JSON diff --git a/docs/markdown/mesh-common/type-aliases/Budget.md b/docs/markdown/mesh-common/type-aliases/Budget.md new file mode 100644 index 000000000..e79ec4bbd --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/Budget.md @@ -0,0 +1,27 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / Budget + +# Type Alias: Budget + +> **Budget** = `object` + +Defined in: types/action.ts:12 + +## Properties + +### mem + +> **mem**: `number` + +Defined in: types/action.ts:13 + +*** + +### steps + +> **steps**: `number` + +Defined in: types/action.ts:14 diff --git a/docs/markdown/mesh-common/type-aliases/BuilderData.md b/docs/markdown/mesh-common/type-aliases/BuilderData.md new file mode 100644 index 000000000..04d7eb290 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/BuilderData.md @@ -0,0 +1,11 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / BuilderData + +# Type Alias: BuilderData + +> **BuilderData** = \{ `content`: [`Data`](Data.md); `type`: `"Mesh"`; \} \| \{ `content`: `object` \| `string`; `type`: `"JSON"`; \} \| \{ `content`: `string`; `type`: `"CBOR"`; \} + +Defined in: types/transaction-builder/data.ts:3 diff --git a/docs/markdown/mesh-common/type-aliases/BuiltinByteString.md b/docs/markdown/mesh-common/type-aliases/BuiltinByteString.md new file mode 100644 index 000000000..6f5d2bf5f --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/BuiltinByteString.md @@ -0,0 +1,21 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / BuiltinByteString + +# Type Alias: BuiltinByteString + +> **BuiltinByteString** = `object` + +Defined in: data/json/primitives.ts:12 + +The Plutus Data byte string, representing in hex, in JSON + +## Properties + +### bytes + +> **bytes**: `string` + +Defined in: data/json/primitives.ts:12 diff --git a/docs/markdown/mesh-common/type-aliases/ByteString.md b/docs/markdown/mesh-common/type-aliases/ByteString.md new file mode 100644 index 000000000..a8a4562d5 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/ByteString.md @@ -0,0 +1,21 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / ByteString + +# Type Alias: ByteString + +> **ByteString** = `object` + +Defined in: data/json/primitives.ts:17 + +The Plutus Data byte string, representing in hex, in JSON + +## Properties + +### bytes + +> **bytes**: `string` + +Defined in: data/json/primitives.ts:17 diff --git a/docs/markdown/mesh-common/type-aliases/Certificate.md b/docs/markdown/mesh-common/type-aliases/Certificate.md new file mode 100644 index 000000000..4ebe2a92c --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/Certificate.md @@ -0,0 +1,11 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / Certificate + +# Type Alias: Certificate + +> **Certificate** = \{ `certType`: [`CertificateType`](CertificateType.md); `type`: `"BasicCertificate"`; \} \| \{ `certType`: [`CertificateType`](CertificateType.md); `redeemer?`: [`Redeemer`](Redeemer.md); `scriptSource?`: [`ScriptSource`](ScriptSource.md); `type`: `"ScriptCertificate"`; \} \| \{ `certType`: [`CertificateType`](CertificateType.md); `simpleScriptSource?`: [`SimpleScriptSourceInfo`](SimpleScriptSourceInfo.md); `type`: `"SimpleScriptCertificate"`; \} + +Defined in: types/transaction-builder/certificate.ts:5 diff --git a/docs/markdown/mesh-common/type-aliases/CertificateType.md b/docs/markdown/mesh-common/type-aliases/CertificateType.md new file mode 100644 index 000000000..b36bb3f90 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/CertificateType.md @@ -0,0 +1,11 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / CertificateType + +# Type Alias: CertificateType + +> **CertificateType** = \{ `poolParams`: [`PoolParams`](PoolParams.md); `type`: `"RegisterPool"`; \} \| \{ `stakeKeyAddress`: `string`; `type`: `"RegisterStake"`; \} \| \{ `poolId`: `string`; `stakeKeyAddress`: `string`; `type`: `"DelegateStake"`; \} \| \{ `stakeKeyAddress`: `string`; `type`: `"DeregisterStake"`; \} \| \{ `epoch`: `number`; `poolId`: `string`; `type`: `"RetirePool"`; \} \| \{ `drep`: [`DRep`](DRep.md); `stakeKeyAddress`: `string`; `type`: `"VoteDelegation"`; \} \| \{ `drep`: [`DRep`](DRep.md); `poolKeyHash`: `string`; `stakeKeyAddress`: `string`; `type`: `"StakeAndVoteDelegation"`; \} \| \{ `coin`: `number`; `poolKeyHash`: `string`; `stakeKeyAddress`: `string`; `type`: `"StakeRegistrationAndDelegation"`; \} \| \{ `coin`: `number`; `drep`: [`DRep`](DRep.md); `stakeKeyAddress`: `string`; `type`: `"VoteRegistrationAndDelegation"`; \} \| \{ `coin`: `number`; `drep`: [`DRep`](DRep.md); `poolKeyHash`: `string`; `stakeKeyAddress`: `string`; `type`: `"StakeVoteRegistrationAndDelegation"`; \} \| \{ `committeeColdKeyAddress`: `string`; `committeeHotKeyAddress`: `string`; `type`: `"CommitteeHotAuth"`; \} \| \{ `anchor?`: [`Anchor`](Anchor.md); `committeeColdKeyAddress`: `string`; `type`: `"CommitteeColdResign"`; \} \| \{ `anchor?`: [`Anchor`](Anchor.md); `coin`: `number`; `drepId`: `string`; `type`: `"DRepRegistration"`; \} \| \{ `coin`: `number`; `drepId`: `string`; `type`: `"DRepDeregistration"`; \} \| \{ `anchor?`: [`Anchor`](Anchor.md); `drepId`: `string`; `type`: `"DRepUpdate"`; \} + +Defined in: types/transaction-builder/certificate.ts:19 diff --git a/docs/markdown/mesh-common/type-aliases/ConStr.md b/docs/markdown/mesh-common/type-aliases/ConStr.md new file mode 100644 index 000000000..d12fc35a2 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/ConStr.md @@ -0,0 +1,39 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / ConStr + +# Type Alias: ConStr\ + +> **ConStr**\<`N`, `T`\> = `object` + +Defined in: data/json/constructors.ts:4 + +The Plutus Data constructor object, representing custom data type in JSON + +## Type Parameters + +### N + +`N` = `0` + +### T + +`T` = `any` + +## Properties + +### constructor + +> **constructor**: `N` + +Defined in: data/json/constructors.ts:4 + +*** + +### fields + +> **fields**: `T` + +Defined in: data/json/constructors.ts:4 diff --git a/docs/markdown/mesh-common/type-aliases/ConStr0.md b/docs/markdown/mesh-common/type-aliases/ConStr0.md new file mode 100644 index 000000000..a1ba94656 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/ConStr0.md @@ -0,0 +1,19 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / ConStr0 + +# Type Alias: ConStr0\ + +> **ConStr0**\<`T`\> = [`ConStr`](ConStr.md)\<`0`, `T`\> + +Defined in: data/json/constructors.ts:9 + +The Plutus Data index 0 constructor object, representing custom data type in JSON + +## Type Parameters + +### T + +`T` = `any` diff --git a/docs/markdown/mesh-common/type-aliases/ConStr1.md b/docs/markdown/mesh-common/type-aliases/ConStr1.md new file mode 100644 index 000000000..ea52e33db --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/ConStr1.md @@ -0,0 +1,19 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / ConStr1 + +# Type Alias: ConStr1\ + +> **ConStr1**\<`T`\> = [`ConStr`](ConStr.md)\<`1`, `T`\> + +Defined in: data/json/constructors.ts:14 + +The Plutus Data index 1 constructor object, representing custom data type in JSON + +## Type Parameters + +### T + +`T` = `any` diff --git a/docs/markdown/mesh-common/type-aliases/ConStr2.md b/docs/markdown/mesh-common/type-aliases/ConStr2.md new file mode 100644 index 000000000..1db9e54a3 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/ConStr2.md @@ -0,0 +1,19 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / ConStr2 + +# Type Alias: ConStr2\ + +> **ConStr2**\<`T`\> = [`ConStr`](ConStr.md)\<`2`, `T`\> + +Defined in: data/json/constructors.ts:19 + +The Plutus Data index 2 constructor object, representing custom data type in JSON + +## Type Parameters + +### T + +`T` = `any` diff --git a/docs/markdown/mesh-common/type-aliases/ConStr3.md b/docs/markdown/mesh-common/type-aliases/ConStr3.md new file mode 100644 index 000000000..a2ea6dbaf --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/ConStr3.md @@ -0,0 +1,19 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / ConStr3 + +# Type Alias: ConStr3\ + +> **ConStr3**\<`T`\> = [`ConStr`](ConStr.md)\<`3`, `T`\> + +Defined in: data/json/constructors.ts:24 + +The Plutus Data index 3 constructor object, representing custom data type in JSON + +## Type Parameters + +### T + +`T` = `any` diff --git a/docs/markdown/mesh-common/type-aliases/Credential.md b/docs/markdown/mesh-common/type-aliases/Credential.md new file mode 100644 index 000000000..150a72679 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/Credential.md @@ -0,0 +1,13 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / Credential + +# Type Alias: Credential + +> **Credential** = [`VerificationKey`](VerificationKey.md) \| [`Script`](Script.md) + +Defined in: data/json/credentials.ts:35 + +The Plutus Data credential in JSON diff --git a/docs/markdown/mesh-common/type-aliases/CurrencySymbol.md b/docs/markdown/mesh-common/type-aliases/CurrencySymbol.md new file mode 100644 index 000000000..83f08947e --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/CurrencySymbol.md @@ -0,0 +1,14 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / CurrencySymbol + +# Type Alias: CurrencySymbol + +> **CurrencySymbol** = [`ByteString`](ByteString.md) + +Defined in: data/json/aliases.ts:31 + +PlutusTx alias +The Plutus Data currency symbol in JSON diff --git a/docs/markdown/mesh-common/type-aliases/DRep.md b/docs/markdown/mesh-common/type-aliases/DRep.md new file mode 100644 index 000000000..8c275c0fc --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/DRep.md @@ -0,0 +1,11 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / DRep + +# Type Alias: DRep + +> **DRep** = \{ `dRepId`: `string`; \} \| \{ `alwaysAbstain`: `null`; \} \| \{ `alwaysNoConfidence`: `null`; \} + +Defined in: types/transaction-builder/certificate.ts:78 diff --git a/docs/markdown/mesh-common/type-aliases/Data.md b/docs/markdown/mesh-common/type-aliases/Data.md new file mode 100644 index 000000000..4878f6437 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/Data.md @@ -0,0 +1,11 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / Data + +# Type Alias: Data + +> **Data** = `string` \| `number` \| `bigint` \| `Data`[] \| `Map`\<`Data`, `Data`\> \| \{ `alternative`: `number`; `fields`: `Data`[]; \} + +Defined in: types/data.ts:1 diff --git a/docs/markdown/mesh-common/type-aliases/DataSignature.md b/docs/markdown/mesh-common/type-aliases/DataSignature.md new file mode 100644 index 000000000..66074af7a --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/DataSignature.md @@ -0,0 +1,27 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / DataSignature + +# Type Alias: DataSignature + +> **DataSignature** = `object` + +Defined in: types/data-signature.ts:1 + +## Properties + +### key + +> **key**: `string` + +Defined in: types/data-signature.ts:3 + +*** + +### signature + +> **signature**: `string` + +Defined in: types/data-signature.ts:2 diff --git a/docs/markdown/mesh-common/type-aliases/DatumSource.md b/docs/markdown/mesh-common/type-aliases/DatumSource.md new file mode 100644 index 000000000..d2fa0bd0b --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/DatumSource.md @@ -0,0 +1,11 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / DatumSource + +# Type Alias: DatumSource + +> **DatumSource** = \{ `data`: [`BuilderData`](BuilderData.md); `type`: `"Provided"`; \} \| \{ `txHash`: `string`; `txIndex`: `number`; `type`: `"Inline"`; \} + +Defined in: types/transaction-builder/data.ts:22 diff --git a/docs/markdown/mesh-common/type-aliases/DeserializedAddress.md b/docs/markdown/mesh-common/type-aliases/DeserializedAddress.md new file mode 100644 index 000000000..9d8f7b7f4 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/DeserializedAddress.md @@ -0,0 +1,43 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / DeserializedAddress + +# Type Alias: DeserializedAddress + +> **DeserializedAddress** = `object` + +Defined in: types/deserialized/deserialized-address.ts:1 + +## Properties + +### pubKeyHash + +> **pubKeyHash**: `string` + +Defined in: types/deserialized/deserialized-address.ts:2 + +*** + +### scriptHash + +> **scriptHash**: `string` + +Defined in: types/deserialized/deserialized-address.ts:3 + +*** + +### stakeCredentialHash + +> **stakeCredentialHash**: `string` + +Defined in: types/deserialized/deserialized-address.ts:4 + +*** + +### stakeScriptCredentialHash + +> **stakeScriptCredentialHash**: `string` + +Defined in: types/deserialized/deserialized-address.ts:5 diff --git a/docs/markdown/mesh-common/type-aliases/DeserializedScript.md b/docs/markdown/mesh-common/type-aliases/DeserializedScript.md new file mode 100644 index 000000000..3f5fa8605 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/DeserializedScript.md @@ -0,0 +1,27 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / DeserializedScript + +# Type Alias: DeserializedScript + +> **DeserializedScript** = `object` + +Defined in: types/deserialized/deserialized-script.ts:1 + +## Properties + +### scriptCbor? + +> `optional` **scriptCbor**: `string` + +Defined in: types/deserialized/deserialized-script.ts:3 + +*** + +### scriptHash + +> **scriptHash**: `string` + +Defined in: types/deserialized/deserialized-script.ts:2 diff --git a/docs/markdown/mesh-common/type-aliases/Dict.md b/docs/markdown/mesh-common/type-aliases/Dict.md new file mode 100644 index 000000000..51826db90 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/Dict.md @@ -0,0 +1,28 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / Dict + +# Type Alias: Dict\ + +> **Dict**\<`V`\> = `object` + +Defined in: data/json/aliases.ts:79 + +Aiken alias +The Plutus Data dictionary in JSON + +## Type Parameters + +### V + +`V` + +## Properties + +### map + +> **map**: [`DictItem`](DictItem.md)\<`V`\>[] + +Defined in: data/json/aliases.ts:79 diff --git a/docs/markdown/mesh-common/type-aliases/DictItem.md b/docs/markdown/mesh-common/type-aliases/DictItem.md new file mode 100644 index 000000000..2d2f67ac1 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/DictItem.md @@ -0,0 +1,36 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / DictItem + +# Type Alias: DictItem\ + +> **DictItem**\<`V`\> = `object` + +Defined in: data/json/aliases.ts:73 + +Aiken alias +The Plutus Data dictionary item in JSON + +## Type Parameters + +### V + +`V` + +## Properties + +### k + +> **k**: [`ByteString`](ByteString.md) + +Defined in: data/json/aliases.ts:73 + +*** + +### v + +> **v**: `V` + +Defined in: data/json/aliases.ts:73 diff --git a/docs/markdown/mesh-common/type-aliases/Era.md b/docs/markdown/mesh-common/type-aliases/Era.md new file mode 100644 index 000000000..73b19da1c --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/Era.md @@ -0,0 +1,11 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / Era + +# Type Alias: Era + +> **Era** = `"ALONZO"` \| `"BABBAGE"` + +Defined in: types/era.ts:1 diff --git a/docs/markdown/mesh-common/type-aliases/Extension.md b/docs/markdown/mesh-common/type-aliases/Extension.md new file mode 100644 index 000000000..2df6f6865 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/Extension.md @@ -0,0 +1,19 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / Extension + +# Type Alias: Extension + +> **Extension** = `object` + +Defined in: types/extension.ts:1 + +## Properties + +### cip + +> **cip**: `number` + +Defined in: types/extension.ts:2 diff --git a/docs/markdown/mesh-common/type-aliases/Files.md b/docs/markdown/mesh-common/type-aliases/Files.md new file mode 100644 index 000000000..6b0d2e498 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/Files.md @@ -0,0 +1,19 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / Files + +# Type Alias: Files + +> **Files** = `object` + +Defined in: types/asset-metadata.ts:23 + +## Properties + +### files? + +> `optional` **files**: \[\{ `mediaType`: `` `${string}/${string}` ``; `name`: `string`; `src`: `` `${string}://${string}` ``; \}\] + +Defined in: types/asset-metadata.ts:24 diff --git a/docs/markdown/mesh-common/type-aliases/ForkNeighbor.md b/docs/markdown/mesh-common/type-aliases/ForkNeighbor.md new file mode 100644 index 000000000..49bbb5ca9 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/ForkNeighbor.md @@ -0,0 +1,11 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / ForkNeighbor + +# Type Alias: ForkNeighbor + +> **ForkNeighbor** = [`ConStr0`](ConStr0.md)\<\[[`Integer`](Integer.md), [`ByteString`](ByteString.md), [`ByteString`](ByteString.md)\]\> + +Defined in: data/json/mpf.ts:31 diff --git a/docs/markdown/mesh-common/type-aliases/FungibleAssetMetadata.md b/docs/markdown/mesh-common/type-aliases/FungibleAssetMetadata.md new file mode 100644 index 000000000..03706540f --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/FungibleAssetMetadata.md @@ -0,0 +1,25 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / FungibleAssetMetadata + +# Type Alias: FungibleAssetMetadata + +> **FungibleAssetMetadata** = `MetadataStandard` & `object` + +Defined in: types/asset-metadata.ts:38 + +## Type declaration + +### decimals + +> **decimals**: `number` + +### ticker + +> **ticker**: `string` + +### version + +> **version**: `` `${number}.${number}` `` diff --git a/docs/markdown/mesh-common/type-aliases/GovernanceProposalInfo.md b/docs/markdown/mesh-common/type-aliases/GovernanceProposalInfo.md new file mode 100644 index 000000000..058336447 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/GovernanceProposalInfo.md @@ -0,0 +1,107 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / GovernanceProposalInfo + +# Type Alias: GovernanceProposalInfo + +> **GovernanceProposalInfo** = `object` + +Defined in: types/governance.ts:1 + +## Properties + +### certIndex + +> **certIndex**: `number` + +Defined in: types/governance.ts:3 + +*** + +### deposit + +> **deposit**: `number` + +Defined in: types/governance.ts:5 + +*** + +### droppedEpoch + +> **droppedEpoch**: `number` + +Defined in: types/governance.ts:10 + +*** + +### enactedEpoch + +> **enactedEpoch**: `number` + +Defined in: types/governance.ts:9 + +*** + +### expiration + +> **expiration**: `number` + +Defined in: types/governance.ts:12 + +*** + +### expiredEpoch + +> **expiredEpoch**: `number` + +Defined in: types/governance.ts:11 + +*** + +### governanceDescription + +> **governanceDescription**: `string` + +Defined in: types/governance.ts:7 + +*** + +### governanceType + +> **governanceType**: `string` + +Defined in: types/governance.ts:4 + +*** + +### metadata + +> **metadata**: `object` + +Defined in: types/governance.ts:13 + +*** + +### ratifiedEpoch + +> **ratifiedEpoch**: `number` + +Defined in: types/governance.ts:8 + +*** + +### returnAddress + +> **returnAddress**: `string` + +Defined in: types/governance.ts:6 + +*** + +### txHash + +> **txHash**: `string` + +Defined in: types/governance.ts:2 diff --git a/docs/markdown/mesh-common/type-aliases/IFetcherOptions.md b/docs/markdown/mesh-common/type-aliases/IFetcherOptions.md new file mode 100644 index 000000000..e2d069dc4 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/IFetcherOptions.md @@ -0,0 +1,31 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / IFetcherOptions + +# Type Alias: IFetcherOptions + +> **IFetcherOptions** = `object` + +Defined in: interfaces/fetcher.ts:12 + +## Indexable + +\[`key`: `string`\]: `any` + +## Properties + +### maxPage? + +> `optional` **maxPage**: `number` + +Defined in: interfaces/fetcher.ts:13 + +*** + +### order? + +> `optional` **order**: `"asc"` \| `"desc"` + +Defined in: interfaces/fetcher.ts:14 diff --git a/docs/markdown/mesh-common/type-aliases/ImageAssetMetadata.md b/docs/markdown/mesh-common/type-aliases/ImageAssetMetadata.md new file mode 100644 index 000000000..63d79f581 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/ImageAssetMetadata.md @@ -0,0 +1,29 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / ImageAssetMetadata + +# Type Alias: ImageAssetMetadata + +> **ImageAssetMetadata** = `MetadataStandard` & [`Files`](Files.md) & `object` + +Defined in: types/asset-metadata.ts:54 + +## Type declaration + +### artists? + +> `optional` **artists**: \[\{ `name`: `string`; `twitter?`: `` `https://twitter.com/${string}` ``; \}\] + +### attributes? + +> `optional` **attributes**: `object` + +#### Index Signature + +\[`key`: `string`\]: `string` + +### traits? + +> `optional` **traits**: `string`[] diff --git a/docs/markdown/mesh-common/type-aliases/Integer.md b/docs/markdown/mesh-common/type-aliases/Integer.md new file mode 100644 index 000000000..8300a771a --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/Integer.md @@ -0,0 +1,21 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / Integer + +# Type Alias: Integer + +> **Integer** = `object` + +Defined in: data/json/primitives.ts:22 + +The Plutus Data integer in JSON + +## Properties + +### int + +> **int**: `number` \| `bigint` + +Defined in: data/json/primitives.ts:22 diff --git a/docs/markdown/mesh-common/type-aliases/LanguageVersion.md b/docs/markdown/mesh-common/type-aliases/LanguageVersion.md new file mode 100644 index 000000000..cc6a71241 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/LanguageVersion.md @@ -0,0 +1,11 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / LanguageVersion + +# Type Alias: LanguageVersion + +> **LanguageVersion** = keyof *typeof* [`LANGUAGE_VERSIONS`](../variables/LANGUAGE_VERSIONS.md) + +Defined in: types/plutus-script.ts:8 diff --git a/docs/markdown/mesh-common/type-aliases/List.md b/docs/markdown/mesh-common/type-aliases/List.md new file mode 100644 index 000000000..ba975866d --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/List.md @@ -0,0 +1,27 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / List + +# Type Alias: List\ + +> **List**\<`T`\> = `object` + +Defined in: data/json/primitives.ts:27 + +The Plutus Data list in JSON + +## Type Parameters + +### T + +`T` = `any` + +## Properties + +### list + +> **list**: `T`[] + +Defined in: data/json/primitives.ts:27 diff --git a/docs/markdown/mesh-common/type-aliases/MAssetClass.md b/docs/markdown/mesh-common/type-aliases/MAssetClass.md new file mode 100644 index 000000000..1446ab206 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/MAssetClass.md @@ -0,0 +1,14 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / MAssetClass + +# Type Alias: MAssetClass + +> **MAssetClass** = [`MConStr0`](MConStr0.md)\<\[`string`, `string`\]\> + +Defined in: data/mesh/aliases.ts:9 + +PlutusTx alias +The Mesh Data asset class diff --git a/docs/markdown/mesh-common/type-aliases/MBool.md b/docs/markdown/mesh-common/type-aliases/MBool.md new file mode 100644 index 000000000..c1a475052 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/MBool.md @@ -0,0 +1,13 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / MBool + +# Type Alias: MBool + +> **MBool** = [`MConStr0`](MConStr0.md)\<\[\]\> \| [`MConStr1`](MConStr1.md)\<\[\]\> + +Defined in: data/mesh/primitives.ts:6 + +The Mesh Data boolean diff --git a/docs/markdown/mesh-common/type-aliases/MConStr.md b/docs/markdown/mesh-common/type-aliases/MConStr.md new file mode 100644 index 000000000..f28547060 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/MConStr.md @@ -0,0 +1,39 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / MConStr + +# Type Alias: MConStr\ + +> **MConStr**\<`N`, `T`\> = `object` + +Defined in: data/mesh/constructors.ts:6 + +The Mesh Data constructor object, representing custom data type + +## Type Parameters + +### N + +`N` = `0` + +### T + +`T` = `any` + +## Properties + +### alternative + +> **alternative**: `N` + +Defined in: data/mesh/constructors.ts:6 + +*** + +### fields + +> **fields**: `T` + +Defined in: data/mesh/constructors.ts:6 diff --git a/docs/markdown/mesh-common/type-aliases/MConStr0.md b/docs/markdown/mesh-common/type-aliases/MConStr0.md new file mode 100644 index 000000000..cc2c8c576 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/MConStr0.md @@ -0,0 +1,19 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / MConStr0 + +# Type Alias: MConStr0\ + +> **MConStr0**\<`T`\> = [`MConStr`](MConStr.md)\<`0`, `T`\> + +Defined in: data/mesh/constructors.ts:11 + +The Mesh Data index 0 constructor object, representing custom data type + +## Type Parameters + +### T + +`T` = `any` diff --git a/docs/markdown/mesh-common/type-aliases/MConStr1.md b/docs/markdown/mesh-common/type-aliases/MConStr1.md new file mode 100644 index 000000000..db4c6acbc --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/MConStr1.md @@ -0,0 +1,19 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / MConStr1 + +# Type Alias: MConStr1\ + +> **MConStr1**\<`T`\> = [`MConStr`](MConStr.md)\<`1`, `T`\> + +Defined in: data/mesh/constructors.ts:16 + +The Mesh Data index 1 constructor object, representing custom data type + +## Type Parameters + +### T + +`T` = `any` diff --git a/docs/markdown/mesh-common/type-aliases/MConStr2.md b/docs/markdown/mesh-common/type-aliases/MConStr2.md new file mode 100644 index 000000000..3ec5e3f7e --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/MConStr2.md @@ -0,0 +1,19 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / MConStr2 + +# Type Alias: MConStr2\ + +> **MConStr2**\<`T`\> = [`MConStr`](MConStr.md)\<`2`, `T`\> + +Defined in: data/mesh/constructors.ts:21 + +The Mesh Data index 2 constructor object, representing custom data type + +## Type Parameters + +### T + +`T` = `any` diff --git a/docs/markdown/mesh-common/type-aliases/MConStr3.md b/docs/markdown/mesh-common/type-aliases/MConStr3.md new file mode 100644 index 000000000..2a8c5abe4 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/MConStr3.md @@ -0,0 +1,19 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / MConStr3 + +# Type Alias: MConStr3\ + +> **MConStr3**\<`T`\> = [`MConStr`](MConStr.md)\<`3`, `T`\> + +Defined in: data/mesh/constructors.ts:26 + +The Mesh Data index 3 constructor object, representing custom data type + +## Type Parameters + +### T + +`T` = `any` diff --git a/docs/markdown/mesh-common/type-aliases/MCredential.md b/docs/markdown/mesh-common/type-aliases/MCredential.md new file mode 100644 index 000000000..65f6c43ca --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/MCredential.md @@ -0,0 +1,13 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / MCredential + +# Type Alias: MCredential + +> **MCredential** = [`MVerificationKey`](MVerificationKey.md) \| [`MScript`](MScript.md) + +Defined in: data/mesh/credentials.ts:34 + +The Mesh Data credential diff --git a/docs/markdown/mesh-common/type-aliases/MMaybeStakingHash.md b/docs/markdown/mesh-common/type-aliases/MMaybeStakingHash.md new file mode 100644 index 000000000..65c9401f2 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/MMaybeStakingHash.md @@ -0,0 +1,13 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / MMaybeStakingHash + +# Type Alias: MMaybeStakingHash + +> **MMaybeStakingHash** = [`MConStr1`](MConStr1.md)\<\[\]\> \| [`MConStr0`](MConStr0.md)\<\[[`MConStr0`](MConStr0.md)\<\[[`MVerificationKey`](MVerificationKey.md)\]\>\]\> \| [`MConStr0`](MConStr0.md)\<\[[`MConStr0`](MConStr0.md)\<\[[`MScript`](MScript.md)\]\>\]\> + +Defined in: data/mesh/credentials.ts:16 + +The Mesh Data staking credential diff --git a/docs/markdown/mesh-common/type-aliases/MNone.md b/docs/markdown/mesh-common/type-aliases/MNone.md new file mode 100644 index 000000000..ce86b2c11 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/MNone.md @@ -0,0 +1,14 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / MNone + +# Type Alias: MNone + +> **MNone** = [`MConStr1`](MConStr1.md)\<\[\]\> + +Defined in: data/mesh/aliases.ts:45 + +Aiken alias +The Mesh Data Option - None type diff --git a/docs/markdown/mesh-common/type-aliases/MOption.md b/docs/markdown/mesh-common/type-aliases/MOption.md new file mode 100644 index 000000000..fc00131ea --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/MOption.md @@ -0,0 +1,20 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / MOption + +# Type Alias: MOption\ + +> **MOption**\<`T`\> = [`MSome`](MSome.md)\<`T`\> \| [`MNone`](MNone.md) + +Defined in: data/mesh/aliases.ts:33 + +Aiken alias +The Mesh Data Option type + +## Type Parameters + +### T + +`T` diff --git a/docs/markdown/mesh-common/type-aliases/MOutputReference.md b/docs/markdown/mesh-common/type-aliases/MOutputReference.md new file mode 100644 index 000000000..00e7f1b81 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/MOutputReference.md @@ -0,0 +1,14 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / MOutputReference + +# Type Alias: MOutputReference + +> **MOutputReference** = [`MConStr0`](MConStr0.md)\<\[`string`, `number`\]\> + +Defined in: data/mesh/aliases.ts:15 + +Aiken alias +The Mesh Data output reference diff --git a/docs/markdown/mesh-common/type-aliases/MPubKeyAddress.md b/docs/markdown/mesh-common/type-aliases/MPubKeyAddress.md new file mode 100644 index 000000000..f34e54830 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/MPubKeyAddress.md @@ -0,0 +1,13 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / MPubKeyAddress + +# Type Alias: MPubKeyAddress + +> **MPubKeyAddress** = [`MConStr0`](MConStr0.md)\<\[[`MVerificationKey`](MVerificationKey.md), [`MMaybeStakingHash`](MMaybeStakingHash.md)\]\> + +Defined in: data/mesh/credentials.ts:24 + +The Mesh Data public key address diff --git a/docs/markdown/mesh-common/type-aliases/MScript.md b/docs/markdown/mesh-common/type-aliases/MScript.md new file mode 100644 index 000000000..8bf40c26d --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/MScript.md @@ -0,0 +1,13 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / MScript + +# Type Alias: MScript + +> **MScript** = [`MConStr1`](MConStr1.md)\<\[`string`\]\> + +Defined in: data/mesh/credentials.ts:11 + +The Mesh Data script key diff --git a/docs/markdown/mesh-common/type-aliases/MScriptAddress.md b/docs/markdown/mesh-common/type-aliases/MScriptAddress.md new file mode 100644 index 000000000..88a72678c --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/MScriptAddress.md @@ -0,0 +1,13 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / MScriptAddress + +# Type Alias: MScriptAddress + +> **MScriptAddress** = [`MConStr0`](MConStr0.md)\<\[[`MScript`](MScript.md), [`MMaybeStakingHash`](MMaybeStakingHash.md)\]\> + +Defined in: data/mesh/credentials.ts:29 + +The Mesh Data script address diff --git a/docs/markdown/mesh-common/type-aliases/MSome.md b/docs/markdown/mesh-common/type-aliases/MSome.md new file mode 100644 index 000000000..b32dbc98a --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/MSome.md @@ -0,0 +1,20 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / MSome + +# Type Alias: MSome\ + +> **MSome**\<`T`\> = [`MConStr0`](MConStr0.md)\<\[`T`\]\> + +Defined in: data/mesh/aliases.ts:39 + +Aiken alias +The Mesh Data Option - Some type + +## Type Parameters + +### T + +`T` diff --git a/docs/markdown/mesh-common/type-aliases/MTuple.md b/docs/markdown/mesh-common/type-aliases/MTuple.md new file mode 100644 index 000000000..16e990c28 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/MTuple.md @@ -0,0 +1,20 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / MTuple + +# Type Alias: MTuple\ + +> **MTuple**\<`T`\> = `T`[] + +Defined in: data/mesh/aliases.ts:27 + +Aiken alias +The Mesh Data tuple + +## Type Parameters + +### T + +`T` *extends* `any` diff --git a/docs/markdown/mesh-common/type-aliases/MTxOutRef.md b/docs/markdown/mesh-common/type-aliases/MTxOutRef.md new file mode 100644 index 000000000..6e2d83fdb --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/MTxOutRef.md @@ -0,0 +1,14 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / MTxOutRef + +# Type Alias: MTxOutRef + +> **MTxOutRef** = [`MConStr0`](MConStr0.md)\<\[[`MConStr0`](MConStr0.md)\<\[`string`\]\>, `number`\]\> + +Defined in: data/mesh/aliases.ts:21 + +PlutusTx alias +The Mesh Data TxOutRef diff --git a/docs/markdown/mesh-common/type-aliases/MValue.md b/docs/markdown/mesh-common/type-aliases/MValue.md new file mode 100644 index 000000000..e961eff3d --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/MValue.md @@ -0,0 +1,14 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / MValue + +# Type Alias: MValue + +> **MValue** = `Map`\<`string`, `Map`\<`string`, `bigint`\>\> + +Defined in: data/value.ts:29 + +Aiken alias +MValue is the Cardano data Value in Mesh Data type diff --git a/docs/markdown/mesh-common/type-aliases/MVerificationKey.md b/docs/markdown/mesh-common/type-aliases/MVerificationKey.md new file mode 100644 index 000000000..c6f82fbcd --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/MVerificationKey.md @@ -0,0 +1,13 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / MVerificationKey + +# Type Alias: MVerificationKey + +> **MVerificationKey** = [`MConStr0`](MConStr0.md)\<\[`string`\]\> + +Defined in: data/mesh/credentials.ts:6 + +The Mesh Data verification key diff --git a/docs/markdown/mesh-common/type-aliases/MaybeStakingHash.md b/docs/markdown/mesh-common/type-aliases/MaybeStakingHash.md new file mode 100644 index 000000000..5aebab2f0 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/MaybeStakingHash.md @@ -0,0 +1,13 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / MaybeStakingHash + +# Type Alias: MaybeStakingHash + +> **MaybeStakingHash** = [`ConStr1`](ConStr1.md)\<\[\]\> \| [`ConStr0`](ConStr0.md)\<\[[`ConStr0`](ConStr0.md)\<\[[`VerificationKey`](VerificationKey.md)\]\>\]\> \| [`ConStr0`](ConStr0.md)\<\[[`ConStr0`](ConStr0.md)\<\[[`Script`](Script.md)\]\>\]\> + +Defined in: data/json/credentials.ts:17 + +The Plutus Data staking credential in JSON diff --git a/docs/markdown/mesh-common/type-aliases/MeshTxBuilderBody.md b/docs/markdown/mesh-common/type-aliases/MeshTxBuilderBody.md new file mode 100644 index 000000000..6facef8ee --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/MeshTxBuilderBody.md @@ -0,0 +1,207 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / MeshTxBuilderBody + +# Type Alias: MeshTxBuilderBody + +> **MeshTxBuilderBody** = `object` + +Defined in: types/transaction-builder/index.ts:21 + +## Properties + +### certificates + +> **certificates**: [`Certificate`](Certificate.md)[] + +Defined in: types/transaction-builder/index.ts:32 + +*** + +### chainedTxs + +> **chainedTxs**: `string`[] + +Defined in: types/transaction-builder/index.ts:42 + +*** + +### changeAddress + +> **changeAddress**: `string` + +Defined in: types/transaction-builder/index.ts:29 + +*** + +### collateralReturnAddress? + +> `optional` **collateralReturnAddress**: `string` + +Defined in: types/transaction-builder/index.ts:48 + +*** + +### collaterals + +> **collaterals**: [`PubKeyTxIn`](PubKeyTxIn.md)[] + +Defined in: types/transaction-builder/index.ts:25 + +*** + +### expectedByronAddressWitnesses + +> **expectedByronAddressWitnesses**: `string`[] + +Defined in: types/transaction-builder/index.ts:46 + +*** + +### expectedNumberKeyWitnesses + +> **expectedNumberKeyWitnesses**: `number` + +Defined in: types/transaction-builder/index.ts:45 + +*** + +### extraInputs + +> **extraInputs**: [`UTxO`](UTxO.md)[] + +Defined in: types/transaction-builder/index.ts:36 + +*** + +### fee + +> **fee**: [`Quantity`](Quantity.md) + +Defined in: types/transaction-builder/index.ts:24 + +*** + +### inputs + +> **inputs**: [`TxIn`](TxIn.md)[] + +Defined in: types/transaction-builder/index.ts:22 + +*** + +### inputsForEvaluation + +> **inputsForEvaluation**: `Record`\<`string`, [`UTxO`](UTxO.md)\> + +Defined in: types/transaction-builder/index.ts:43 + +*** + +### metadata + +> **metadata**: [`TxMetadata`](TxMetadata.md) + +Defined in: types/transaction-builder/index.ts:30 + +*** + +### mints + +> **mints**: [`MintParam`](MintParam.md)[] + +Defined in: types/transaction-builder/index.ts:28 + +*** + +### network + +> **network**: [`Network`](Network.md) \| `number`[][] + +Defined in: types/transaction-builder/index.ts:44 + +*** + +### outputs + +> **outputs**: [`Output`](Output.md)[] + +Defined in: types/transaction-builder/index.ts:23 + +*** + +### referenceInputs + +> **referenceInputs**: [`RefTxIn`](RefTxIn.md)[] + +Defined in: types/transaction-builder/index.ts:27 + +*** + +### requiredSignatures + +> **requiredSignatures**: `string`[] + +Defined in: types/transaction-builder/index.ts:26 + +*** + +### selectionConfig + +> **selectionConfig**: `object` + +Defined in: types/transaction-builder/index.ts:37 + +#### includeTxFees + +> **includeTxFees**: `boolean` + +#### strategy + +> **strategy**: [`UtxoSelectionStrategy`](UtxoSelectionStrategy.md) + +#### threshold + +> **threshold**: `string` + +*** + +### signingKey + +> **signingKey**: `string`[] + +Defined in: types/transaction-builder/index.ts:35 + +*** + +### totalCollateral? + +> `optional` **totalCollateral**: [`Quantity`](Quantity.md) + +Defined in: types/transaction-builder/index.ts:47 + +*** + +### validityRange + +> **validityRange**: [`ValidityRange`](ValidityRange.md) + +Defined in: types/transaction-builder/index.ts:31 + +*** + +### votes + +> **votes**: [`Vote`](Vote.md)[] + +Defined in: types/transaction-builder/index.ts:34 + +*** + +### withdrawals + +> **withdrawals**: [`Withdrawal`](Withdrawal.md)[] + +Defined in: types/transaction-builder/index.ts:33 diff --git a/docs/markdown/mesh-common/type-aliases/Message.md b/docs/markdown/mesh-common/type-aliases/Message.md new file mode 100644 index 000000000..4c13f1bbc --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/Message.md @@ -0,0 +1,27 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / Message + +# Type Alias: Message + +> **Message** = `object` + +Defined in: types/message.ts:1 + +## Properties + +### externalAAD? + +> `optional` **externalAAD**: `string` + +Defined in: types/message.ts:3 + +*** + +### payload + +> **payload**: `string` + +Defined in: types/message.ts:2 diff --git a/docs/markdown/mesh-common/type-aliases/Metadata.md b/docs/markdown/mesh-common/type-aliases/Metadata.md new file mode 100644 index 000000000..0004b5a4c --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/Metadata.md @@ -0,0 +1,27 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / Metadata + +# Type Alias: Metadata + +> **Metadata** = `object` + +Defined in: types/transaction-builder/index.ts:108 + +## Properties + +### metadata + +> **metadata**: `string` + +Defined in: types/transaction-builder/index.ts:110 + +*** + +### tag + +> **tag**: `string` + +Defined in: types/transaction-builder/index.ts:109 diff --git a/docs/markdown/mesh-common/type-aliases/Metadatum.md b/docs/markdown/mesh-common/type-aliases/Metadatum.md new file mode 100644 index 000000000..00da4d3fd --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/Metadatum.md @@ -0,0 +1,11 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / Metadatum + +# Type Alias: Metadatum + +> **Metadatum** = `bigint` \| `number` \| `string` \| `Uint8Array` \| [`MetadatumMap`](MetadatumMap.md) \| `Metadatum`[] + +Defined in: types/transaction-builder/index.ts:98 diff --git a/docs/markdown/mesh-common/type-aliases/MetadatumMap.md b/docs/markdown/mesh-common/type-aliases/MetadatumMap.md new file mode 100644 index 000000000..ac4aaf415 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/MetadatumMap.md @@ -0,0 +1,11 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / MetadatumMap + +# Type Alias: MetadatumMap + +> **MetadatumMap** = `Map`\<[`Metadatum`](Metadatum.md), [`Metadatum`](Metadatum.md)\> + +Defined in: types/transaction-builder/index.ts:97 diff --git a/docs/markdown/mesh-common/type-aliases/Mint.md b/docs/markdown/mesh-common/type-aliases/Mint.md new file mode 100644 index 000000000..6c92d590b --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/Mint.md @@ -0,0 +1,59 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / Mint + +# Type Alias: Mint + +> **Mint** = `object` + +Defined in: types/mint.ts:5 + +## Properties + +### assetName + +> **assetName**: `string` + +Defined in: types/mint.ts:6 + +*** + +### assetQuantity + +> **assetQuantity**: [`Quantity`](Quantity.md) + +Defined in: types/mint.ts:7 + +*** + +### cip68ScriptAddress? + +> `optional` **cip68ScriptAddress**: `string` + +Defined in: types/mint.ts:11 + +*** + +### label? + +> `optional` **label**: `"20"` \| `"721"` \| `"777"` \| `` `${number}` `` + +Defined in: types/mint.ts:10 + +*** + +### metadata? + +> `optional` **metadata**: [`AssetMetadata`](AssetMetadata.md) + +Defined in: types/mint.ts:9 + +*** + +### recipient? + +> `optional` **recipient**: [`Recipient`](Recipient.md) + +Defined in: types/mint.ts:8 diff --git a/docs/markdown/mesh-common/type-aliases/MintItem.md b/docs/markdown/mesh-common/type-aliases/MintItem.md new file mode 100644 index 000000000..d182f05c1 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/MintItem.md @@ -0,0 +1,59 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / MintItem + +# Type Alias: MintItem + +> **MintItem** = `object` + +Defined in: types/transaction-builder/mint.ts:15 + +## Properties + +### amount + +> **amount**: `string` + +Defined in: types/transaction-builder/mint.ts:19 + +*** + +### assetName + +> **assetName**: `string` + +Defined in: types/transaction-builder/mint.ts:18 + +*** + +### policyId + +> **policyId**: `string` + +Defined in: types/transaction-builder/mint.ts:17 + +*** + +### redeemer? + +> `optional` **redeemer**: [`Redeemer`](Redeemer.md) + +Defined in: types/transaction-builder/mint.ts:20 + +*** + +### scriptSource? + +> `optional` **scriptSource**: [`ScriptSource`](ScriptSource.md) \| [`SimpleScriptSourceInfo`](SimpleScriptSourceInfo.md) + +Defined in: types/transaction-builder/mint.ts:21 + +*** + +### type + +> **type**: `"Plutus"` \| `"Native"` + +Defined in: types/transaction-builder/mint.ts:16 diff --git a/docs/markdown/mesh-common/type-aliases/MintParam.md b/docs/markdown/mesh-common/type-aliases/MintParam.md new file mode 100644 index 000000000..99e163a28 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/MintParam.md @@ -0,0 +1,59 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / MintParam + +# Type Alias: MintParam + +> **MintParam** = `object` + +Defined in: types/transaction-builder/mint.ts:4 + +## Properties + +### mintValue + +> **mintValue**: `object`[] + +Defined in: types/transaction-builder/mint.ts:7 + +#### amount + +> **amount**: `string` + +#### assetName + +> **assetName**: `string` + +*** + +### policyId + +> **policyId**: `string` + +Defined in: types/transaction-builder/mint.ts:6 + +*** + +### redeemer? + +> `optional` **redeemer**: [`Redeemer`](Redeemer.md) + +Defined in: types/transaction-builder/mint.ts:11 + +*** + +### scriptSource? + +> `optional` **scriptSource**: [`ScriptSource`](ScriptSource.md) \| [`SimpleScriptSourceInfo`](SimpleScriptSourceInfo.md) + +Defined in: types/transaction-builder/mint.ts:12 + +*** + +### type + +> **type**: `"Plutus"` \| `"Native"` + +Defined in: types/transaction-builder/mint.ts:5 diff --git a/docs/markdown/mesh-common/type-aliases/NativeScript.md b/docs/markdown/mesh-common/type-aliases/NativeScript.md new file mode 100644 index 000000000..f8b059384 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/NativeScript.md @@ -0,0 +1,11 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / NativeScript + +# Type Alias: NativeScript + +> **NativeScript** = \{ `slot`: `string`; `type`: `"after"` \| `"before"`; \} \| \{ `scripts`: `NativeScript`[]; `type`: `"all"` \| `"any"`; \} \| \{ `required`: `number`; `scripts`: `NativeScript`[]; `type`: `"atLeast"`; \} \| \{ `keyHash`: `string`; `type`: `"sig"`; \} + +Defined in: types/native-script.ts:1 diff --git a/docs/markdown/mesh-common/type-aliases/Network.md b/docs/markdown/mesh-common/type-aliases/Network.md new file mode 100644 index 000000000..8b844b69e --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/Network.md @@ -0,0 +1,11 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / Network + +# Type Alias: Network + +> **Network** = *typeof* `ALL_NETWORKS`\[`number`\] + +Defined in: types/network.ts:3 diff --git a/docs/markdown/mesh-common/type-aliases/NonFungibleAssetMetadata.md b/docs/markdown/mesh-common/type-aliases/NonFungibleAssetMetadata.md new file mode 100644 index 000000000..18325238f --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/NonFungibleAssetMetadata.md @@ -0,0 +1,11 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / NonFungibleAssetMetadata + +# Type Alias: NonFungibleAssetMetadata + +> **NonFungibleAssetMetadata** = `AudioAssetMetadata` \| [`ImageAssetMetadata`](ImageAssetMetadata.md) \| `SmartAssetMetadata` \| `VideoAssetMetadata` + +Defined in: types/asset-metadata.ts:46 diff --git a/docs/markdown/mesh-common/type-aliases/None.md b/docs/markdown/mesh-common/type-aliases/None.md new file mode 100644 index 000000000..0eee50296 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/None.md @@ -0,0 +1,14 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / None + +# Type Alias: None + +> **None** = [`ConStr1`](ConStr1.md)\<\[\]\> + +Defined in: data/json/aliases.ts:103 + +Aiken alias +The Plutus Data Option - None in JSON diff --git a/docs/markdown/mesh-common/type-aliases/Option.md b/docs/markdown/mesh-common/type-aliases/Option.md new file mode 100644 index 000000000..d80654f49 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/Option.md @@ -0,0 +1,20 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / Option + +# Type Alias: Option\ + +> **Option**\<`T`\> = [`Some`](Some.md)\<`T`\> \| [`None`](None.md) + +Defined in: data/json/aliases.ts:91 + +Aiken alias +The Plutus Data Option in JSON + +## Type Parameters + +### T + +`T` diff --git a/docs/markdown/mesh-common/type-aliases/Output.md b/docs/markdown/mesh-common/type-aliases/Output.md new file mode 100644 index 000000000..e8229386f --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/Output.md @@ -0,0 +1,51 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / Output + +# Type Alias: Output + +> **Output** = `object` + +Defined in: types/transaction-builder/output.ts:4 + +## Properties + +### address + +> **address**: `string` + +Defined in: types/transaction-builder/output.ts:5 + +*** + +### amount + +> **amount**: [`Asset`](Asset.md)[] + +Defined in: types/transaction-builder/output.ts:6 + +*** + +### datum? + +> `optional` **datum**: `object` + +Defined in: types/transaction-builder/output.ts:7 + +#### data + +> **data**: [`BuilderData`](BuilderData.md) + +#### type + +> **type**: `"Hash"` \| `"Inline"` \| `"Embedded"` + +*** + +### referenceScript? + +> `optional` **referenceScript**: [`PlutusScript`](PlutusScript.md) + +Defined in: types/transaction-builder/output.ts:11 diff --git a/docs/markdown/mesh-common/type-aliases/OutputReference.md b/docs/markdown/mesh-common/type-aliases/OutputReference.md new file mode 100644 index 000000000..b3aaf8bcc --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/OutputReference.md @@ -0,0 +1,14 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / OutputReference + +# Type Alias: OutputReference + +> **OutputReference** = [`ConStr0`](ConStr0.md)\<\[[`ByteString`](ByteString.md), [`Integer`](Integer.md)\]\> + +Defined in: data/json/aliases.ts:55 + +Aiken alias +The Plutus Data output reference in JSON diff --git a/docs/markdown/mesh-common/type-aliases/POSIXTime.md b/docs/markdown/mesh-common/type-aliases/POSIXTime.md new file mode 100644 index 000000000..3eee0439e --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/POSIXTime.md @@ -0,0 +1,14 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / POSIXTime + +# Type Alias: POSIXTime + +> **POSIXTime** = [`Integer`](Integer.md) + +Defined in: data/json/aliases.ts:67 + +PlutusTx alias +The Plutus Data POSIX time in JSON diff --git a/docs/markdown/mesh-common/type-aliases/Pair.md b/docs/markdown/mesh-common/type-aliases/Pair.md new file mode 100644 index 000000000..901dcaf5d --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/Pair.md @@ -0,0 +1,40 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / Pair + +# Type Alias: Pair\ + +> **Pair**\<`K`, `V`\> = `object` + +Defined in: data/json/primitives.ts:45 + +Aiken alias +The Plutus Data association map item in JSON + +## Type Parameters + +### K + +`K` + +### V + +`V` + +## Properties + +### k + +> **k**: `K` + +Defined in: data/json/primitives.ts:45 + +*** + +### v + +> **v**: `V` + +Defined in: data/json/primitives.ts:45 diff --git a/docs/markdown/mesh-common/type-aliases/Pairs.md b/docs/markdown/mesh-common/type-aliases/Pairs.md new file mode 100644 index 000000000..3c48cf303 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/Pairs.md @@ -0,0 +1,32 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / Pairs + +# Type Alias: Pairs\ + +> **Pairs**\<`K`, `V`\> = `object` + +Defined in: data/json/primitives.ts:51 + +Aiken alias +The Plutus Data association map in JSON + +## Type Parameters + +### K + +`K` = `any` + +### V + +`V` = `any` + +## Properties + +### map + +> **map**: [`Pair`](Pair.md)\<`K`, `V`\>[] + +Defined in: data/json/primitives.ts:51 diff --git a/docs/markdown/mesh-common/type-aliases/PlutusData.md b/docs/markdown/mesh-common/type-aliases/PlutusData.md new file mode 100644 index 000000000..5b87c9b7e --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/PlutusData.md @@ -0,0 +1,11 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / PlutusData + +# Type Alias: PlutusData + +> **PlutusData** = [`ConStr`](ConStr.md) \| [`Bool`](Bool.md) \| [`ByteString`](ByteString.md) \| [`Integer`](Integer.md) \| [`List`](List.md) \| [`AssocMap`](AssocMap.md) \| [`Pairs`](Pairs.md) \| [`MaybeStakingHash`](MaybeStakingHash.md) \| [`PubKeyAddress`](PubKeyAddress.md) \| [`ScriptAddress`](ScriptAddress.md) \| [`AssetClass`](AssetClass.md) \| [`OutputReference`](OutputReference.md) \| [`PubKeyHash`](PubKeyHash.md) \| [`POSIXTime`](POSIXTime.md) \| [`Dict`](Dict.md)\<`any`\> \| [`Tuple`](Tuple.md)\<`any`\> + +Defined in: data/json/index.ts:13 diff --git a/docs/markdown/mesh-common/type-aliases/PlutusDataType.md b/docs/markdown/mesh-common/type-aliases/PlutusDataType.md new file mode 100644 index 000000000..e88f43b4b --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/PlutusDataType.md @@ -0,0 +1,11 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / PlutusDataType + +# Type Alias: PlutusDataType + +> **PlutusDataType** = `"Mesh"` \| `"JSON"` \| `"CBOR"` + +Defined in: data/index.ts:7 diff --git a/docs/markdown/mesh-common/type-aliases/PlutusScript.md b/docs/markdown/mesh-common/type-aliases/PlutusScript.md new file mode 100644 index 000000000..56e8506bb --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/PlutusScript.md @@ -0,0 +1,27 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / PlutusScript + +# Type Alias: PlutusScript + +> **PlutusScript** = `object` + +Defined in: types/plutus-script.ts:3 + +## Properties + +### code + +> **code**: `string` + +Defined in: types/plutus-script.ts:5 + +*** + +### version + +> **version**: [`LanguageVersion`](LanguageVersion.md) + +Defined in: types/plutus-script.ts:4 diff --git a/docs/markdown/mesh-common/type-aliases/PolicyId.md b/docs/markdown/mesh-common/type-aliases/PolicyId.md new file mode 100644 index 000000000..587a89c05 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/PolicyId.md @@ -0,0 +1,14 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / PolicyId + +# Type Alias: PolicyId + +> **PolicyId** = [`ByteString`](ByteString.md) + +Defined in: data/json/aliases.ts:25 + +Aiken alias +The Plutus Data policy id in JSON diff --git a/docs/markdown/mesh-common/type-aliases/PoolMetadata.md b/docs/markdown/mesh-common/type-aliases/PoolMetadata.md new file mode 100644 index 000000000..0eb491372 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/PoolMetadata.md @@ -0,0 +1,27 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / PoolMetadata + +# Type Alias: PoolMetadata + +> **PoolMetadata** = `object` + +Defined in: types/pool-params.ts:15 + +## Properties + +### hash + +> **hash**: `string` + +Defined in: types/pool-params.ts:17 + +*** + +### URL + +> **URL**: `string` + +Defined in: types/pool-params.ts:16 diff --git a/docs/markdown/mesh-common/type-aliases/PoolParams.md b/docs/markdown/mesh-common/type-aliases/PoolParams.md new file mode 100644 index 000000000..464649055 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/PoolParams.md @@ -0,0 +1,83 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / PoolParams + +# Type Alias: PoolParams + +> **PoolParams** = `object` + +Defined in: types/pool-params.ts:3 + +## Properties + +### cost + +> **cost**: `string` + +Defined in: types/pool-params.ts:7 + +*** + +### margin + +> **margin**: \[`number`, `number`\] + +Defined in: types/pool-params.ts:8 + +*** + +### metadata? + +> `optional` **metadata**: [`PoolMetadata`](PoolMetadata.md) + +Defined in: types/pool-params.ts:12 + +*** + +### operator + +> **operator**: `string` + +Defined in: types/pool-params.ts:5 + +*** + +### owners + +> **owners**: `string`[] + +Defined in: types/pool-params.ts:10 + +*** + +### pledge + +> **pledge**: `string` + +Defined in: types/pool-params.ts:6 + +*** + +### relays + +> **relays**: [`Relay`](Relay.md)[] + +Defined in: types/pool-params.ts:9 + +*** + +### rewardAddress + +> **rewardAddress**: `string` + +Defined in: types/pool-params.ts:11 + +*** + +### vrfKeyHash + +> **vrfKeyHash**: `string` + +Defined in: types/pool-params.ts:4 diff --git a/docs/markdown/mesh-common/type-aliases/ProofStep.md b/docs/markdown/mesh-common/type-aliases/ProofStep.md new file mode 100644 index 000000000..9ac418c2b --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/ProofStep.md @@ -0,0 +1,11 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / ProofStep + +# Type Alias: ProofStep + +> **ProofStep** = [`ProofStepBranch`](ProofStepBranch.md) \| [`ProofStepFork`](ProofStepFork.md) \| [`ProofStepLeaf`](ProofStepLeaf.md) + +Defined in: data/json/mpf.ts:11 diff --git a/docs/markdown/mesh-common/type-aliases/ProofStepBranch.md b/docs/markdown/mesh-common/type-aliases/ProofStepBranch.md new file mode 100644 index 000000000..508564cce --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/ProofStepBranch.md @@ -0,0 +1,11 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / ProofStepBranch + +# Type Alias: ProofStepBranch + +> **ProofStepBranch** = [`ConStr0`](ConStr0.md)\<\[[`Integer`](Integer.md), [`ByteString`](ByteString.md)\]\> + +Defined in: data/json/mpf.ts:12 diff --git a/docs/markdown/mesh-common/type-aliases/ProofStepFork.md b/docs/markdown/mesh-common/type-aliases/ProofStepFork.md new file mode 100644 index 000000000..e0329d2d5 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/ProofStepFork.md @@ -0,0 +1,11 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / ProofStepFork + +# Type Alias: ProofStepFork + +> **ProofStepFork** = [`ConStr1`](ConStr1.md)\<\[[`Integer`](Integer.md), [`ForkNeighbor`](ForkNeighbor.md)\]\> + +Defined in: data/json/mpf.ts:18 diff --git a/docs/markdown/mesh-common/type-aliases/ProofStepLeaf.md b/docs/markdown/mesh-common/type-aliases/ProofStepLeaf.md new file mode 100644 index 000000000..a623ee4ae --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/ProofStepLeaf.md @@ -0,0 +1,11 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / ProofStepLeaf + +# Type Alias: ProofStepLeaf + +> **ProofStepLeaf** = [`ConStr2`](ConStr2.md)\<\[[`Integer`](Integer.md), [`ByteString`](ByteString.md), [`ByteString`](ByteString.md)\]\> + +Defined in: data/json/mpf.ts:24 diff --git a/docs/markdown/mesh-common/type-aliases/Protocol.md b/docs/markdown/mesh-common/type-aliases/Protocol.md new file mode 100644 index 000000000..bb2474c6e --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/Protocol.md @@ -0,0 +1,179 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / Protocol + +# Type Alias: Protocol + +> **Protocol** = `object` + +Defined in: types/protocol.ts:3 + +## Properties + +### coinsPerUtxoSize + +> **coinsPerUtxoSize**: `number` + +Defined in: types/protocol.ts:23 + +*** + +### collateralPercent + +> **collateralPercent**: `number` + +Defined in: types/protocol.ts:21 + +*** + +### decentralisation + +> **decentralisation**: `number` + +Defined in: types/protocol.ts:12 + +*** + +### epoch + +> **epoch**: `number` + +Defined in: types/protocol.ts:4 + +*** + +### keyDeposit + +> **keyDeposit**: `number` + +Defined in: types/protocol.ts:10 + +*** + +### maxBlockExMem + +> **maxBlockExMem**: `string` + +Defined in: types/protocol.ts:18 + +*** + +### maxBlockExSteps + +> **maxBlockExSteps**: `string` + +Defined in: types/protocol.ts:19 + +*** + +### maxBlockHeaderSize + +> **maxBlockHeaderSize**: `number` + +Defined in: types/protocol.ts:9 + +*** + +### maxBlockSize + +> **maxBlockSize**: `number` + +Defined in: types/protocol.ts:7 + +*** + +### maxCollateralInputs + +> **maxCollateralInputs**: `number` + +Defined in: types/protocol.ts:22 + +*** + +### maxTxExMem + +> **maxTxExMem**: `string` + +Defined in: types/protocol.ts:16 + +*** + +### maxTxExSteps + +> **maxTxExSteps**: `string` + +Defined in: types/protocol.ts:17 + +*** + +### maxTxSize + +> **maxTxSize**: `number` + +Defined in: types/protocol.ts:8 + +*** + +### maxValSize + +> **maxValSize**: `number` + +Defined in: types/protocol.ts:20 + +*** + +### minFeeA + +> **minFeeA**: `number` + +Defined in: types/protocol.ts:5 + +*** + +### minFeeB + +> **minFeeB**: `number` + +Defined in: types/protocol.ts:6 + +*** + +### minFeeRefScriptCostPerByte + +> **minFeeRefScriptCostPerByte**: `number` + +Defined in: types/protocol.ts:24 + +*** + +### minPoolCost + +> **minPoolCost**: `string` + +Defined in: types/protocol.ts:13 + +*** + +### poolDeposit + +> **poolDeposit**: `number` + +Defined in: types/protocol.ts:11 + +*** + +### priceMem + +> **priceMem**: `number` + +Defined in: types/protocol.ts:14 + +*** + +### priceStep + +> **priceStep**: `number` + +Defined in: types/protocol.ts:15 diff --git a/docs/markdown/mesh-common/type-aliases/PubKeyAddress.md b/docs/markdown/mesh-common/type-aliases/PubKeyAddress.md new file mode 100644 index 000000000..10b5baae4 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/PubKeyAddress.md @@ -0,0 +1,13 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / PubKeyAddress + +# Type Alias: PubKeyAddress + +> **PubKeyAddress** = [`ConStr0`](ConStr0.md)\<\[[`VerificationKey`](VerificationKey.md), [`MaybeStakingHash`](MaybeStakingHash.md)\]\> + +Defined in: data/json/credentials.ts:25 + +The Plutus Data public key address in JSON diff --git a/docs/markdown/mesh-common/type-aliases/PubKeyHash.md b/docs/markdown/mesh-common/type-aliases/PubKeyHash.md new file mode 100644 index 000000000..e326d354d --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/PubKeyHash.md @@ -0,0 +1,13 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / PubKeyHash + +# Type Alias: PubKeyHash + +> **PubKeyHash** = [`ByteString`](ByteString.md) + +Defined in: data/json/aliases.ts:19 + +The Plutus Data public key hash in JSON diff --git a/docs/markdown/mesh-common/type-aliases/PubKeyTxIn.md b/docs/markdown/mesh-common/type-aliases/PubKeyTxIn.md new file mode 100644 index 000000000..b6ca38f3a --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/PubKeyTxIn.md @@ -0,0 +1,27 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / PubKeyTxIn + +# Type Alias: PubKeyTxIn + +> **PubKeyTxIn** = `object` + +Defined in: types/transaction-builder/txin.ts:18 + +## Properties + +### txIn + +> **txIn**: [`TxInParameter`](TxInParameter.md) + +Defined in: types/transaction-builder/txin.ts:18 + +*** + +### type + +> **type**: `"PubKey"` + +Defined in: types/transaction-builder/txin.ts:18 diff --git a/docs/markdown/mesh-common/type-aliases/PubKeyWithdrawal.md b/docs/markdown/mesh-common/type-aliases/PubKeyWithdrawal.md new file mode 100644 index 000000000..08019de3f --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/PubKeyWithdrawal.md @@ -0,0 +1,35 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / PubKeyWithdrawal + +# Type Alias: PubKeyWithdrawal + +> **PubKeyWithdrawal** = `object` + +Defined in: types/transaction-builder/withdrawal.ts:9 + +## Properties + +### address + +> **address**: `string` + +Defined in: types/transaction-builder/withdrawal.ts:11 + +*** + +### coin + +> **coin**: `string` + +Defined in: types/transaction-builder/withdrawal.ts:12 + +*** + +### type + +> **type**: `"PubKeyWithdrawal"` + +Defined in: types/transaction-builder/withdrawal.ts:10 diff --git a/docs/markdown/mesh-common/type-aliases/Quantity.md b/docs/markdown/mesh-common/type-aliases/Quantity.md new file mode 100644 index 000000000..bcaa14e4c --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/Quantity.md @@ -0,0 +1,11 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / Quantity + +# Type Alias: Quantity + +> **Quantity** = `string` + +Defined in: types/asset.ts:8 diff --git a/docs/markdown/mesh-common/type-aliases/Recipient.md b/docs/markdown/mesh-common/type-aliases/Recipient.md new file mode 100644 index 000000000..cbce47e0d --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/Recipient.md @@ -0,0 +1,11 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / Recipient + +# Type Alias: Recipient + +> **Recipient** = `string` \| \{ `address`: `string`; `datum?`: \{ `inline?`: `boolean`; `value`: [`Data`](Data.md); \}; \} + +Defined in: types/recipient.ts:6 diff --git a/docs/markdown/mesh-common/type-aliases/Redeemer.md b/docs/markdown/mesh-common/type-aliases/Redeemer.md new file mode 100644 index 000000000..095ef23f9 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/Redeemer.md @@ -0,0 +1,27 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / Redeemer + +# Type Alias: Redeemer + +> **Redeemer** = `object` + +Defined in: types/transaction-builder/data.ts:17 + +## Properties + +### data + +> **data**: [`BuilderData`](BuilderData.md) + +Defined in: types/transaction-builder/data.ts:18 + +*** + +### exUnits + +> **exUnits**: [`Budget`](Budget.md) + +Defined in: types/transaction-builder/data.ts:19 diff --git a/docs/markdown/mesh-common/type-aliases/RedeemerTagType.md b/docs/markdown/mesh-common/type-aliases/RedeemerTagType.md new file mode 100644 index 000000000..8ad84c1ab --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/RedeemerTagType.md @@ -0,0 +1,11 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / RedeemerTagType + +# Type Alias: RedeemerTagType + +> **RedeemerTagType** = `"CERT"` \| `"MINT"` \| `"REWARD"` \| `"SPEND"` \| `"VOTE"` \| `"PROPOSE"` + +Defined in: types/action.ts:3 diff --git a/docs/markdown/mesh-common/type-aliases/RefTxIn.md b/docs/markdown/mesh-common/type-aliases/RefTxIn.md new file mode 100644 index 000000000..58b227d5e --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/RefTxIn.md @@ -0,0 +1,35 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / RefTxIn + +# Type Alias: RefTxIn + +> **RefTxIn** = `object` + +Defined in: types/transaction-builder/txin.ts:6 + +## Properties + +### scriptSize? + +> `optional` **scriptSize**: `number` + +Defined in: types/transaction-builder/txin.ts:6 + +*** + +### txHash + +> **txHash**: `string` + +Defined in: types/transaction-builder/txin.ts:6 + +*** + +### txIndex + +> **txIndex**: `number` + +Defined in: types/transaction-builder/txin.ts:6 diff --git a/docs/markdown/mesh-common/type-aliases/Relay.md b/docs/markdown/mesh-common/type-aliases/Relay.md new file mode 100644 index 000000000..87415ec58 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/Relay.md @@ -0,0 +1,11 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / Relay + +# Type Alias: Relay + +> **Relay** = \{ `IPV4?`: `string`; `IPV6?`: `string`; `port?`: `number`; `type`: `"SingleHostAddr"`; \} \| \{ `domainName`: `string`; `port?`: `number`; `type`: `"SingleHostName"`; \} \| \{ `domainName`: `string`; `type`: `"MultiHostName"`; \} + +Defined in: types/relay.ts:1 diff --git a/docs/markdown/mesh-common/type-aliases/RequiredWith.md b/docs/markdown/mesh-common/type-aliases/RequiredWith.md new file mode 100644 index 000000000..8f5fefc72 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/RequiredWith.md @@ -0,0 +1,21 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / RequiredWith + +# Type Alias: RequiredWith\ + +> **RequiredWith**\<`T`, `K`\> = `Required`\<`T`\> & `{ [P in K]: Required }` + +Defined in: types/transaction-builder/index.ts:115 + +## Type Parameters + +### T + +`T` + +### K + +`K` *extends* keyof `T` diff --git a/docs/markdown/mesh-common/type-aliases/RoyaltiesStandard.md b/docs/markdown/mesh-common/type-aliases/RoyaltiesStandard.md new file mode 100644 index 000000000..a86cc895d --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/RoyaltiesStandard.md @@ -0,0 +1,27 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / RoyaltiesStandard + +# Type Alias: RoyaltiesStandard + +> **RoyaltiesStandard** = `object` + +Defined in: types/asset-metadata.ts:3 + +## Properties + +### address + +> **address**: `string` + +Defined in: types/asset-metadata.ts:5 + +*** + +### rate + +> **rate**: `string` + +Defined in: types/asset-metadata.ts:4 diff --git a/docs/markdown/mesh-common/type-aliases/Script.md b/docs/markdown/mesh-common/type-aliases/Script.md new file mode 100644 index 000000000..2948f4820 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/Script.md @@ -0,0 +1,13 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / Script + +# Type Alias: Script + +> **Script** = [`ConStr1`](ConStr1.md)\<\[[`ScriptHash`](ScriptHash.md)\]\> + +Defined in: data/json/credentials.ts:12 + +The Plutus Data Script key in JSON diff --git a/docs/markdown/mesh-common/type-aliases/ScriptAddress.md b/docs/markdown/mesh-common/type-aliases/ScriptAddress.md new file mode 100644 index 000000000..3dfe78551 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/ScriptAddress.md @@ -0,0 +1,13 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / ScriptAddress + +# Type Alias: ScriptAddress + +> **ScriptAddress** = [`ConStr0`](ConStr0.md)\<\[[`Script`](Script.md), [`MaybeStakingHash`](MaybeStakingHash.md)\]\> + +Defined in: data/json/credentials.ts:30 + +The Plutus Data script address in JSON diff --git a/docs/markdown/mesh-common/type-aliases/ScriptHash.md b/docs/markdown/mesh-common/type-aliases/ScriptHash.md new file mode 100644 index 000000000..1aacada82 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/ScriptHash.md @@ -0,0 +1,13 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / ScriptHash + +# Type Alias: ScriptHash + +> **ScriptHash** = [`ByteString`](ByteString.md) + +Defined in: data/json/aliases.ts:14 + +The Plutus Data script hash in JSON diff --git a/docs/markdown/mesh-common/type-aliases/ScriptSource.md b/docs/markdown/mesh-common/type-aliases/ScriptSource.md new file mode 100644 index 000000000..f46223d2c --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/ScriptSource.md @@ -0,0 +1,11 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / ScriptSource + +# Type Alias: ScriptSource + +> **ScriptSource** = \{ `script`: [`PlutusScript`](PlutusScript.md); `type`: `"Provided"`; \} \| \{ `scriptHash?`: `string`; `scriptSize?`: `string`; `txHash`: `string`; `txIndex`: `number`; `type`: `"Inline"`; `version?`: [`LanguageVersion`](LanguageVersion.md); \} + +Defined in: types/transaction-builder/script.ts:3 diff --git a/docs/markdown/mesh-common/type-aliases/ScriptTxIn.md b/docs/markdown/mesh-common/type-aliases/ScriptTxIn.md new file mode 100644 index 000000000..16f82fbb9 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/ScriptTxIn.md @@ -0,0 +1,35 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / ScriptTxIn + +# Type Alias: ScriptTxIn + +> **ScriptTxIn** = `object` + +Defined in: types/transaction-builder/txin.ts:36 + +## Properties + +### scriptTxIn + +> **scriptTxIn**: [`ScriptTxInParameter`](ScriptTxInParameter.md) + +Defined in: types/transaction-builder/txin.ts:39 + +*** + +### txIn + +> **txIn**: [`TxInParameter`](TxInParameter.md) + +Defined in: types/transaction-builder/txin.ts:38 + +*** + +### type + +> **type**: `"Script"` + +Defined in: types/transaction-builder/txin.ts:37 diff --git a/docs/markdown/mesh-common/type-aliases/ScriptTxInParameter.md b/docs/markdown/mesh-common/type-aliases/ScriptTxInParameter.md new file mode 100644 index 000000000..e33d85888 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/ScriptTxInParameter.md @@ -0,0 +1,35 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / ScriptTxInParameter + +# Type Alias: ScriptTxInParameter + +> **ScriptTxInParameter** = `object` + +Defined in: types/transaction-builder/txin.ts:30 + +## Properties + +### datumSource? + +> `optional` **datumSource**: [`DatumSource`](DatumSource.md) + +Defined in: types/transaction-builder/txin.ts:32 + +*** + +### redeemer? + +> `optional` **redeemer**: [`Redeemer`](Redeemer.md) + +Defined in: types/transaction-builder/txin.ts:33 + +*** + +### scriptSource? + +> `optional` **scriptSource**: [`ScriptSource`](ScriptSource.md) + +Defined in: types/transaction-builder/txin.ts:31 diff --git a/docs/markdown/mesh-common/type-aliases/ScriptVote.md b/docs/markdown/mesh-common/type-aliases/ScriptVote.md new file mode 100644 index 000000000..b514e91e5 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/ScriptVote.md @@ -0,0 +1,43 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / ScriptVote + +# Type Alias: ScriptVote + +> **ScriptVote** = `object` + +Defined in: types/transaction-builder/vote.ts:20 + +## Properties + +### redeemer? + +> `optional` **redeemer**: [`Redeemer`](Redeemer.md) + +Defined in: types/transaction-builder/vote.ts:23 + +*** + +### scriptSource? + +> `optional` **scriptSource**: [`ScriptSource`](ScriptSource.md) + +Defined in: types/transaction-builder/vote.ts:24 + +*** + +### type + +> **type**: `"ScriptVote"` + +Defined in: types/transaction-builder/vote.ts:21 + +*** + +### vote + +> **vote**: [`VoteType`](VoteType.md) + +Defined in: types/transaction-builder/vote.ts:22 diff --git a/docs/markdown/mesh-common/type-aliases/ScriptWithdrawal.md b/docs/markdown/mesh-common/type-aliases/ScriptWithdrawal.md new file mode 100644 index 000000000..c4fb2c15b --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/ScriptWithdrawal.md @@ -0,0 +1,51 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / ScriptWithdrawal + +# Type Alias: ScriptWithdrawal + +> **ScriptWithdrawal** = `object` + +Defined in: types/transaction-builder/withdrawal.ts:15 + +## Properties + +### address + +> **address**: `string` + +Defined in: types/transaction-builder/withdrawal.ts:17 + +*** + +### coin + +> **coin**: `string` + +Defined in: types/transaction-builder/withdrawal.ts:18 + +*** + +### redeemer? + +> `optional` **redeemer**: [`Redeemer`](Redeemer.md) + +Defined in: types/transaction-builder/withdrawal.ts:20 + +*** + +### scriptSource? + +> `optional` **scriptSource**: [`ScriptSource`](ScriptSource.md) + +Defined in: types/transaction-builder/withdrawal.ts:19 + +*** + +### type + +> **type**: `"ScriptWithdrawal"` + +Defined in: types/transaction-builder/withdrawal.ts:16 diff --git a/docs/markdown/mesh-common/type-aliases/SimpleScriptSourceInfo.md b/docs/markdown/mesh-common/type-aliases/SimpleScriptSourceInfo.md new file mode 100644 index 000000000..6aec8d115 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/SimpleScriptSourceInfo.md @@ -0,0 +1,11 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / SimpleScriptSourceInfo + +# Type Alias: SimpleScriptSourceInfo + +> **SimpleScriptSourceInfo** = \{ `scriptCode`: `string`; `type`: `"Provided"`; \} \| \{ `scriptSize?`: `string`; `simpleScriptHash?`: `string`; `txHash`: `string`; `txIndex`: `number`; `type`: `"Inline"`; \} + +Defined in: types/transaction-builder/script.ts:17 diff --git a/docs/markdown/mesh-common/type-aliases/SimpleScriptTxIn.md b/docs/markdown/mesh-common/type-aliases/SimpleScriptTxIn.md new file mode 100644 index 000000000..7ac110952 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/SimpleScriptTxIn.md @@ -0,0 +1,35 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / SimpleScriptTxIn + +# Type Alias: SimpleScriptTxIn + +> **SimpleScriptTxIn** = `object` + +Defined in: types/transaction-builder/txin.ts:20 + +## Properties + +### simpleScriptTxIn + +> **simpleScriptTxIn**: [`SimpleScriptTxInParameter`](SimpleScriptTxInParameter.md) + +Defined in: types/transaction-builder/txin.ts:23 + +*** + +### txIn + +> **txIn**: [`TxInParameter`](TxInParameter.md) + +Defined in: types/transaction-builder/txin.ts:22 + +*** + +### type + +> **type**: `"SimpleScript"` + +Defined in: types/transaction-builder/txin.ts:21 diff --git a/docs/markdown/mesh-common/type-aliases/SimpleScriptTxInParameter.md b/docs/markdown/mesh-common/type-aliases/SimpleScriptTxInParameter.md new file mode 100644 index 000000000..23a75de99 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/SimpleScriptTxInParameter.md @@ -0,0 +1,19 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / SimpleScriptTxInParameter + +# Type Alias: SimpleScriptTxInParameter + +> **SimpleScriptTxInParameter** = `object` + +Defined in: types/transaction-builder/txin.ts:26 + +## Properties + +### scriptSource? + +> `optional` **scriptSource**: [`SimpleScriptSourceInfo`](SimpleScriptSourceInfo.md) + +Defined in: types/transaction-builder/txin.ts:27 diff --git a/docs/markdown/mesh-common/type-aliases/SimpleScriptVote.md b/docs/markdown/mesh-common/type-aliases/SimpleScriptVote.md new file mode 100644 index 000000000..fc68bf3d5 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/SimpleScriptVote.md @@ -0,0 +1,35 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / SimpleScriptVote + +# Type Alias: SimpleScriptVote + +> **SimpleScriptVote** = `object` + +Defined in: types/transaction-builder/vote.ts:14 + +## Properties + +### simpleScriptSource + +> **simpleScriptSource**: [`SimpleScriptSourceInfo`](SimpleScriptSourceInfo.md) + +Defined in: types/transaction-builder/vote.ts:17 + +*** + +### type + +> **type**: `"SimpleScriptVote"` + +Defined in: types/transaction-builder/vote.ts:15 + +*** + +### vote + +> **vote**: [`VoteType`](VoteType.md) + +Defined in: types/transaction-builder/vote.ts:16 diff --git a/docs/markdown/mesh-common/type-aliases/SimpleScriptWithdrawal.md b/docs/markdown/mesh-common/type-aliases/SimpleScriptWithdrawal.md new file mode 100644 index 000000000..c292a470d --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/SimpleScriptWithdrawal.md @@ -0,0 +1,43 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / SimpleScriptWithdrawal + +# Type Alias: SimpleScriptWithdrawal + +> **SimpleScriptWithdrawal** = `object` + +Defined in: types/transaction-builder/withdrawal.ts:23 + +## Properties + +### address + +> **address**: `string` + +Defined in: types/transaction-builder/withdrawal.ts:25 + +*** + +### coin + +> **coin**: `string` + +Defined in: types/transaction-builder/withdrawal.ts:26 + +*** + +### scriptSource? + +> `optional` **scriptSource**: [`SimpleScriptSourceInfo`](SimpleScriptSourceInfo.md) + +Defined in: types/transaction-builder/withdrawal.ts:27 + +*** + +### type + +> **type**: `"SimpleScriptWithdrawal"` + +Defined in: types/transaction-builder/withdrawal.ts:24 diff --git a/docs/markdown/mesh-common/type-aliases/SlotConfig.md b/docs/markdown/mesh-common/type-aliases/SlotConfig.md new file mode 100644 index 000000000..77e8fd2ba --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/SlotConfig.md @@ -0,0 +1,51 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / SlotConfig + +# Type Alias: SlotConfig + +> **SlotConfig** = `object` + +Defined in: data/time.ts:3 + +## Properties + +### epochLength + +> **epochLength**: `number` + +Defined in: data/time.ts:8 + +*** + +### slotLength + +> **slotLength**: `number` + +Defined in: data/time.ts:6 + +*** + +### startEpoch + +> **startEpoch**: `number` + +Defined in: data/time.ts:7 + +*** + +### zeroSlot + +> **zeroSlot**: `number` + +Defined in: data/time.ts:5 + +*** + +### zeroTime + +> **zeroTime**: `number` + +Defined in: data/time.ts:4 diff --git a/docs/markdown/mesh-common/type-aliases/Some.md b/docs/markdown/mesh-common/type-aliases/Some.md new file mode 100644 index 000000000..c6f67e8cf --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/Some.md @@ -0,0 +1,20 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / Some + +# Type Alias: Some\ + +> **Some**\<`T`\> = [`ConStr0`](ConStr0.md)\<\[`T`\]\> + +Defined in: data/json/aliases.ts:97 + +Aiken alias +The Plutus Data Option - Some in JSON + +## Type Parameters + +### T + +`T` diff --git a/docs/markdown/mesh-common/type-aliases/Token.md b/docs/markdown/mesh-common/type-aliases/Token.md new file mode 100644 index 000000000..69390623f --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/Token.md @@ -0,0 +1,11 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / Token + +# Type Alias: Token + +> **Token** = keyof *typeof* [`SUPPORTED_TOKENS`](../variables/SUPPORTED_TOKENS.md) + +Defined in: types/token.ts:3 diff --git a/docs/markdown/mesh-common/type-aliases/TokenName.md b/docs/markdown/mesh-common/type-aliases/TokenName.md new file mode 100644 index 000000000..3a4bd3d89 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/TokenName.md @@ -0,0 +1,14 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / TokenName + +# Type Alias: TokenName + +> **TokenName** = [`ByteString`](ByteString.md) + +Defined in: data/json/aliases.ts:43 + +PlutusTx alias +The Plutus Data token name in JSON diff --git a/docs/markdown/mesh-common/type-aliases/TransactionInfo.md b/docs/markdown/mesh-common/type-aliases/TransactionInfo.md new file mode 100644 index 000000000..79f1c3ae4 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/TransactionInfo.md @@ -0,0 +1,115 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / TransactionInfo + +# Type Alias: TransactionInfo + +> **TransactionInfo** = `object` + +Defined in: types/transaction-info.ts:3 + +## Properties + +### block + +> **block**: `string` + +Defined in: types/transaction-info.ts:5 + +*** + +### blockHeight? + +> `optional` **blockHeight**: `number` + +Defined in: types/transaction-info.ts:15 + +*** + +### blockTime? + +> `optional` **blockTime**: `number` + +Defined in: types/transaction-info.ts:16 + +*** + +### deposit + +> **deposit**: `string` + +Defined in: types/transaction-info.ts:10 + +*** + +### fees + +> **fees**: `string` + +Defined in: types/transaction-info.ts:8 + +*** + +### hash + +> **hash**: `string` + +Defined in: types/transaction-info.ts:6 + +*** + +### index + +> **index**: `number` + +Defined in: types/transaction-info.ts:4 + +*** + +### inputs + +> **inputs**: [`UTxO`](UTxO.md)[] + +Defined in: types/transaction-info.ts:13 + +*** + +### invalidAfter + +> **invalidAfter**: `string` + +Defined in: types/transaction-info.ts:12 + +*** + +### invalidBefore + +> **invalidBefore**: `string` + +Defined in: types/transaction-info.ts:11 + +*** + +### outputs + +> **outputs**: [`UTxO`](UTxO.md)[] + +Defined in: types/transaction-info.ts:14 + +*** + +### size + +> **size**: `number` + +Defined in: types/transaction-info.ts:9 + +*** + +### slot + +> **slot**: `string` + +Defined in: types/transaction-info.ts:7 diff --git a/docs/markdown/mesh-common/type-aliases/Tuple.md b/docs/markdown/mesh-common/type-aliases/Tuple.md new file mode 100644 index 000000000..09181f69f --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/Tuple.md @@ -0,0 +1,28 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / Tuple + +# Type Alias: Tuple\ + +> **Tuple**\<`T`\> = `object` + +Defined in: data/json/aliases.ts:85 + +Aiken alias +The Plutus Data tuple in JSON + +## Type Parameters + +### T + +`T` *extends* `any`[] + +## Properties + +### list + +> **list**: `T` + +Defined in: data/json/aliases.ts:85 diff --git a/docs/markdown/mesh-common/type-aliases/TxIn.md b/docs/markdown/mesh-common/type-aliases/TxIn.md new file mode 100644 index 000000000..d59db9125 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/TxIn.md @@ -0,0 +1,11 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / TxIn + +# Type Alias: TxIn + +> **TxIn** = [`PubKeyTxIn`](PubKeyTxIn.md) \| [`SimpleScriptTxIn`](SimpleScriptTxIn.md) \| [`ScriptTxIn`](ScriptTxIn.md) + +Defined in: types/transaction-builder/txin.ts:16 diff --git a/docs/markdown/mesh-common/type-aliases/TxInParameter.md b/docs/markdown/mesh-common/type-aliases/TxInParameter.md new file mode 100644 index 000000000..112449323 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/TxInParameter.md @@ -0,0 +1,51 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / TxInParameter + +# Type Alias: TxInParameter + +> **TxInParameter** = `object` + +Defined in: types/transaction-builder/txin.ts:8 + +## Properties + +### address? + +> `optional` **address**: `string` + +Defined in: types/transaction-builder/txin.ts:12 + +*** + +### amount? + +> `optional` **amount**: [`Asset`](Asset.md)[] + +Defined in: types/transaction-builder/txin.ts:11 + +*** + +### scriptSize? + +> `optional` **scriptSize**: `number` + +Defined in: types/transaction-builder/txin.ts:13 + +*** + +### txHash + +> **txHash**: `string` + +Defined in: types/transaction-builder/txin.ts:9 + +*** + +### txIndex + +> **txIndex**: `number` + +Defined in: types/transaction-builder/txin.ts:10 diff --git a/docs/markdown/mesh-common/type-aliases/TxInput.md b/docs/markdown/mesh-common/type-aliases/TxInput.md new file mode 100644 index 000000000..ba637cc8f --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/TxInput.md @@ -0,0 +1,27 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / TxInput + +# Type Alias: TxInput + +> **TxInput** = `object` + +Defined in: types/utxo.ts:12 + +## Properties + +### outputIndex + +> **outputIndex**: `number` + +Defined in: types/utxo.ts:14 + +*** + +### txHash + +> **txHash**: `string` + +Defined in: types/utxo.ts:13 diff --git a/docs/markdown/mesh-common/type-aliases/TxMetadata.md b/docs/markdown/mesh-common/type-aliases/TxMetadata.md new file mode 100644 index 000000000..4c22c4618 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/TxMetadata.md @@ -0,0 +1,11 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / TxMetadata + +# Type Alias: TxMetadata + +> **TxMetadata** = `Map`\<`bigint`, [`Metadatum`](Metadatum.md)\> + +Defined in: types/transaction-builder/index.ts:105 diff --git a/docs/markdown/mesh-common/type-aliases/TxOutRef.md b/docs/markdown/mesh-common/type-aliases/TxOutRef.md new file mode 100644 index 000000000..a58247c88 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/TxOutRef.md @@ -0,0 +1,14 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / TxOutRef + +# Type Alias: TxOutRef + +> **TxOutRef** = [`ConStr0`](ConStr0.md)\<\[[`ConStr0`](ConStr0.md)\<\[[`ByteString`](ByteString.md)\]\>, [`Integer`](Integer.md)\]\> + +Defined in: data/json/aliases.ts:61 + +PlutusTx alias +The Plutus Data TxOutRef in JSON diff --git a/docs/markdown/mesh-common/type-aliases/TxOutput.md b/docs/markdown/mesh-common/type-aliases/TxOutput.md new file mode 100644 index 000000000..5a03bd5fa --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/TxOutput.md @@ -0,0 +1,59 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / TxOutput + +# Type Alias: TxOutput + +> **TxOutput** = `object` + +Defined in: types/utxo.ts:3 + +## Properties + +### address + +> **address**: `string` + +Defined in: types/utxo.ts:4 + +*** + +### amount + +> **amount**: [`Asset`](Asset.md)[] + +Defined in: types/utxo.ts:5 + +*** + +### dataHash? + +> `optional` **dataHash**: `string` + +Defined in: types/utxo.ts:6 + +*** + +### plutusData? + +> `optional` **plutusData**: `string` + +Defined in: types/utxo.ts:7 + +*** + +### scriptHash? + +> `optional` **scriptHash**: `string` + +Defined in: types/utxo.ts:9 + +*** + +### scriptRef? + +> `optional` **scriptRef**: `string` + +Defined in: types/utxo.ts:8 diff --git a/docs/markdown/mesh-common/type-aliases/UTxO.md b/docs/markdown/mesh-common/type-aliases/UTxO.md new file mode 100644 index 000000000..ac2521669 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/UTxO.md @@ -0,0 +1,27 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / UTxO + +# Type Alias: UTxO + +> **UTxO** = `object` + +Defined in: types/utxo.ts:17 + +## Properties + +### input + +> **input**: [`TxInput`](TxInput.md) + +Defined in: types/utxo.ts:18 + +*** + +### output + +> **output**: [`TxOutput`](TxOutput.md) + +Defined in: types/utxo.ts:19 diff --git a/docs/markdown/mesh-common/type-aliases/Unit.md b/docs/markdown/mesh-common/type-aliases/Unit.md new file mode 100644 index 000000000..7bc24c52d --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/Unit.md @@ -0,0 +1,11 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / Unit + +# Type Alias: Unit + +> **Unit** = `string` + +Defined in: types/asset.ts:6 diff --git a/docs/markdown/mesh-common/type-aliases/UtxoSelectionStrategy.md b/docs/markdown/mesh-common/type-aliases/UtxoSelectionStrategy.md new file mode 100644 index 000000000..b340a3812 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/UtxoSelectionStrategy.md @@ -0,0 +1,11 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / UtxoSelectionStrategy + +# Type Alias: UtxoSelectionStrategy + +> **UtxoSelectionStrategy** = keyof [`UtxoSelection`](../classes/UtxoSelection.md) + +Defined in: utxo-selection/index.ts:65 diff --git a/docs/markdown/mesh-common/type-aliases/ValidityRange.md b/docs/markdown/mesh-common/type-aliases/ValidityRange.md new file mode 100644 index 000000000..90fdacf69 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/ValidityRange.md @@ -0,0 +1,27 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / ValidityRange + +# Type Alias: ValidityRange + +> **ValidityRange** = `object` + +Defined in: types/transaction-builder/index.ts:88 + +## Properties + +### invalidBefore? + +> `optional` **invalidBefore**: `number` + +Defined in: types/transaction-builder/index.ts:89 + +*** + +### invalidHereafter? + +> `optional` **invalidHereafter**: `number` + +Defined in: types/transaction-builder/index.ts:90 diff --git a/docs/markdown/mesh-common/type-aliases/Value.md b/docs/markdown/mesh-common/type-aliases/Value.md new file mode 100644 index 000000000..00b250dde --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/Value.md @@ -0,0 +1,14 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / Value + +# Type Alias: Value + +> **Value** = [`AssocMap`](AssocMap.md)\<[`CurrencySymbol`](CurrencySymbol.md), [`AssocMap`](AssocMap.md)\<[`TokenName`](TokenName.md), [`Integer`](Integer.md)\>\> + +Defined in: data/value.ts:23 + +Aiken alias +Value is the JSON representation of Cardano data Value diff --git a/docs/markdown/mesh-common/type-aliases/VerificationKey.md b/docs/markdown/mesh-common/type-aliases/VerificationKey.md new file mode 100644 index 000000000..8f056e2f5 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/VerificationKey.md @@ -0,0 +1,13 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / VerificationKey + +# Type Alias: VerificationKey + +> **VerificationKey** = [`ConStr0`](ConStr0.md)\<\[[`PubKeyHash`](PubKeyHash.md)\]\> + +Defined in: data/json/credentials.ts:7 + +The Plutus Data verification key in JSON diff --git a/docs/markdown/mesh-common/type-aliases/Vote.md b/docs/markdown/mesh-common/type-aliases/Vote.md new file mode 100644 index 000000000..fe336e031 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/Vote.md @@ -0,0 +1,11 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / Vote + +# Type Alias: Vote + +> **Vote** = [`BasicVote`](BasicVote.md) \| [`ScriptVote`](ScriptVote.md) \| [`SimpleScriptVote`](SimpleScriptVote.md) + +Defined in: types/transaction-builder/vote.ts:7 diff --git a/docs/markdown/mesh-common/type-aliases/VoteKind.md b/docs/markdown/mesh-common/type-aliases/VoteKind.md new file mode 100644 index 000000000..7db775ab7 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/VoteKind.md @@ -0,0 +1,11 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / VoteKind + +# Type Alias: VoteKind + +> **VoteKind** = `"Yes"` \| `"No"` \| `"Abstain"` + +Defined in: types/transaction-builder/vote.ts:52 diff --git a/docs/markdown/mesh-common/type-aliases/VoteType.md b/docs/markdown/mesh-common/type-aliases/VoteType.md new file mode 100644 index 000000000..f106a5604 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/VoteType.md @@ -0,0 +1,35 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / VoteType + +# Type Alias: VoteType + +> **VoteType** = `object` + +Defined in: types/transaction-builder/vote.ts:27 + +## Properties + +### govActionId + +> **govActionId**: [`RefTxIn`](RefTxIn.md) + +Defined in: types/transaction-builder/vote.ts:29 + +*** + +### voter + +> **voter**: [`Voter`](Voter.md) + +Defined in: types/transaction-builder/vote.ts:28 + +*** + +### votingProcedure + +> **votingProcedure**: [`VotingProcedure`](VotingProcedure.md) + +Defined in: types/transaction-builder/vote.ts:30 diff --git a/docs/markdown/mesh-common/type-aliases/Voter.md b/docs/markdown/mesh-common/type-aliases/Voter.md new file mode 100644 index 000000000..c6af8d9fa --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/Voter.md @@ -0,0 +1,11 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / Voter + +# Type Alias: Voter + +> **Voter** = \{ `hotCred`: `Credential`; `type`: `"ConstitutionalCommittee"`; \} \| \{ `drepId`: `string`; `type`: `"DRep"`; \} \| \{ `keyHash`: `string`; `type`: `"StakingPool"`; \} + +Defined in: types/transaction-builder/vote.ts:33 diff --git a/docs/markdown/mesh-common/type-aliases/VotingProcedure.md b/docs/markdown/mesh-common/type-aliases/VotingProcedure.md new file mode 100644 index 000000000..9c35f2be4 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/VotingProcedure.md @@ -0,0 +1,27 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / VotingProcedure + +# Type Alias: VotingProcedure + +> **VotingProcedure** = `object` + +Defined in: types/transaction-builder/vote.ts:47 + +## Properties + +### anchor? + +> `optional` **anchor**: [`Anchor`](Anchor.md) + +Defined in: types/transaction-builder/vote.ts:49 + +*** + +### voteKind + +> **voteKind**: [`VoteKind`](VoteKind.md) + +Defined in: types/transaction-builder/vote.ts:48 diff --git a/docs/markdown/mesh-common/type-aliases/Wallet.md b/docs/markdown/mesh-common/type-aliases/Wallet.md new file mode 100644 index 000000000..7ea17b218 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/Wallet.md @@ -0,0 +1,43 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / Wallet + +# Type Alias: Wallet + +> **Wallet** = `object` + +Defined in: types/wallet.ts:1 + +## Properties + +### icon + +> **icon**: `string` + +Defined in: types/wallet.ts:4 + +*** + +### id + +> **id**: `string` + +Defined in: types/wallet.ts:2 + +*** + +### name + +> **name**: `string` + +Defined in: types/wallet.ts:3 + +*** + +### version + +> **version**: `string` + +Defined in: types/wallet.ts:5 diff --git a/docs/markdown/mesh-common/type-aliases/Withdrawal.md b/docs/markdown/mesh-common/type-aliases/Withdrawal.md new file mode 100644 index 000000000..fdab658d2 --- /dev/null +++ b/docs/markdown/mesh-common/type-aliases/Withdrawal.md @@ -0,0 +1,11 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / Withdrawal + +# Type Alias: Withdrawal + +> **Withdrawal** = [`PubKeyWithdrawal`](PubKeyWithdrawal.md) \| [`ScriptWithdrawal`](ScriptWithdrawal.md) \| [`SimpleScriptWithdrawal`](SimpleScriptWithdrawal.md) + +Defined in: types/transaction-builder/withdrawal.ts:4 diff --git a/docs/markdown/mesh-common/variables/DEFAULT_FETCHER_OPTIONS.md b/docs/markdown/mesh-common/variables/DEFAULT_FETCHER_OPTIONS.md new file mode 100644 index 000000000..e17baf87c --- /dev/null +++ b/docs/markdown/mesh-common/variables/DEFAULT_FETCHER_OPTIONS.md @@ -0,0 +1,11 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / DEFAULT\_FETCHER\_OPTIONS + +# Variable: DEFAULT\_FETCHER\_OPTIONS + +> `const` **DEFAULT\_FETCHER\_OPTIONS**: [`IFetcherOptions`](../type-aliases/IFetcherOptions.md) + +Defined in: interfaces/fetcher.ts:18 diff --git a/docs/markdown/mesh-common/variables/DEFAULT_PROTOCOL_PARAMETERS.md b/docs/markdown/mesh-common/variables/DEFAULT_PROTOCOL_PARAMETERS.md new file mode 100644 index 000000000..3447a36f6 --- /dev/null +++ b/docs/markdown/mesh-common/variables/DEFAULT_PROTOCOL_PARAMETERS.md @@ -0,0 +1,11 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / DEFAULT\_PROTOCOL\_PARAMETERS + +# Variable: DEFAULT\_PROTOCOL\_PARAMETERS + +> `const` **DEFAULT\_PROTOCOL\_PARAMETERS**: [`Protocol`](../type-aliases/Protocol.md) + +Defined in: constants/protocol-parameters.ts:3 diff --git a/docs/markdown/mesh-common/variables/DEFAULT_REDEEMER_BUDGET.md b/docs/markdown/mesh-common/variables/DEFAULT_REDEEMER_BUDGET.md new file mode 100644 index 000000000..ba405ca2c --- /dev/null +++ b/docs/markdown/mesh-common/variables/DEFAULT_REDEEMER_BUDGET.md @@ -0,0 +1,11 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / DEFAULT\_REDEEMER\_BUDGET + +# Variable: DEFAULT\_REDEEMER\_BUDGET + +> `const` **DEFAULT\_REDEEMER\_BUDGET**: [`Budget`](../type-aliases/Budget.md) + +Defined in: constants/index.ts:8 diff --git a/docs/markdown/mesh-common/variables/DEFAULT_V1_COST_MODEL_LIST.md b/docs/markdown/mesh-common/variables/DEFAULT_V1_COST_MODEL_LIST.md new file mode 100644 index 000000000..b373c8126 --- /dev/null +++ b/docs/markdown/mesh-common/variables/DEFAULT_V1_COST_MODEL_LIST.md @@ -0,0 +1,11 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / DEFAULT\_V1\_COST\_MODEL\_LIST + +# Variable: DEFAULT\_V1\_COST\_MODEL\_LIST + +> `const` **DEFAULT\_V1\_COST\_MODEL\_LIST**: `number`[] + +Defined in: constants/cost-models.ts:1 diff --git a/docs/markdown/mesh-common/variables/DEFAULT_V2_COST_MODEL_LIST.md b/docs/markdown/mesh-common/variables/DEFAULT_V2_COST_MODEL_LIST.md new file mode 100644 index 000000000..300cda381 --- /dev/null +++ b/docs/markdown/mesh-common/variables/DEFAULT_V2_COST_MODEL_LIST.md @@ -0,0 +1,11 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / DEFAULT\_V2\_COST\_MODEL\_LIST + +# Variable: DEFAULT\_V2\_COST\_MODEL\_LIST + +> `const` **DEFAULT\_V2\_COST\_MODEL\_LIST**: `number`[] + +Defined in: constants/cost-models.ts:16 diff --git a/docs/markdown/mesh-common/variables/DEFAULT_V3_COST_MODEL_LIST.md b/docs/markdown/mesh-common/variables/DEFAULT_V3_COST_MODEL_LIST.md new file mode 100644 index 000000000..d52526407 --- /dev/null +++ b/docs/markdown/mesh-common/variables/DEFAULT_V3_COST_MODEL_LIST.md @@ -0,0 +1,11 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / DEFAULT\_V3\_COST\_MODEL\_LIST + +# Variable: DEFAULT\_V3\_COST\_MODEL\_LIST + +> `const` **DEFAULT\_V3\_COST\_MODEL\_LIST**: `number`[] + +Defined in: constants/cost-models.ts:31 diff --git a/docs/markdown/mesh-common/variables/DREP_DEPOSIT.md b/docs/markdown/mesh-common/variables/DREP_DEPOSIT.md new file mode 100644 index 000000000..5953e86fa --- /dev/null +++ b/docs/markdown/mesh-common/variables/DREP_DEPOSIT.md @@ -0,0 +1,11 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / DREP\_DEPOSIT + +# Variable: DREP\_DEPOSIT + +> `const` **DREP\_DEPOSIT**: `"500000000"` = `"500000000"` + +Defined in: constants/protocol-parameters.ts:27 diff --git a/docs/markdown/mesh-common/variables/HARDENED_KEY_START.md b/docs/markdown/mesh-common/variables/HARDENED_KEY_START.md new file mode 100644 index 000000000..6cbd44b2a --- /dev/null +++ b/docs/markdown/mesh-common/variables/HARDENED_KEY_START.md @@ -0,0 +1,11 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / HARDENED\_KEY\_START + +# Variable: HARDENED\_KEY\_START + +> `const` **HARDENED\_KEY\_START**: `2147483648` = `0x80000000` + +Defined in: constants/index.ts:21 diff --git a/docs/markdown/mesh-common/variables/LANGUAGE_VERSIONS.md b/docs/markdown/mesh-common/variables/LANGUAGE_VERSIONS.md new file mode 100644 index 000000000..1245dd2b5 --- /dev/null +++ b/docs/markdown/mesh-common/variables/LANGUAGE_VERSIONS.md @@ -0,0 +1,25 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / LANGUAGE\_VERSIONS + +# Variable: LANGUAGE\_VERSIONS + +> `const` **LANGUAGE\_VERSIONS**: `object` + +Defined in: constants/index.ts:15 + +## Type declaration + +### V1 + +> **V1**: `string` = `"V1"` + +### V2 + +> **V2**: `string` = `"V2"` + +### V3 + +> **V3**: `string` = `"V3"` diff --git a/docs/markdown/mesh-common/variables/POLICY_ID_LENGTH.md b/docs/markdown/mesh-common/variables/POLICY_ID_LENGTH.md new file mode 100644 index 000000000..a910651ee --- /dev/null +++ b/docs/markdown/mesh-common/variables/POLICY_ID_LENGTH.md @@ -0,0 +1,11 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / POLICY\_ID\_LENGTH + +# Variable: POLICY\_ID\_LENGTH + +> `const` **POLICY\_ID\_LENGTH**: `56` = `56` + +Defined in: constants/index.ts:13 diff --git a/docs/markdown/mesh-common/variables/SLOT_CONFIG_NETWORK.md b/docs/markdown/mesh-common/variables/SLOT_CONFIG_NETWORK.md new file mode 100644 index 000000000..dba7d5756 --- /dev/null +++ b/docs/markdown/mesh-common/variables/SLOT_CONFIG_NETWORK.md @@ -0,0 +1,11 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / SLOT\_CONFIG\_NETWORK + +# Variable: SLOT\_CONFIG\_NETWORK + +> `const` **SLOT\_CONFIG\_NETWORK**: `Record`\<[`Network`](../type-aliases/Network.md), [`SlotConfig`](../type-aliases/SlotConfig.md)\> + +Defined in: data/time.ts:21 diff --git a/docs/markdown/mesh-common/variables/SUPPORTED_CLOCKS.md b/docs/markdown/mesh-common/variables/SUPPORTED_CLOCKS.md new file mode 100644 index 000000000..2ea396225 --- /dev/null +++ b/docs/markdown/mesh-common/variables/SUPPORTED_CLOCKS.md @@ -0,0 +1,11 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / SUPPORTED\_CLOCKS + +# Variable: SUPPORTED\_CLOCKS + +> `const` **SUPPORTED\_CLOCKS**: `Record`\<[`Network`](../type-aliases/Network.md), \[`string`, `string`, `string`, `string`\]\> + +Defined in: constants/index.ts:23 diff --git a/docs/markdown/mesh-common/variables/SUPPORTED_HANDLES.md b/docs/markdown/mesh-common/variables/SUPPORTED_HANDLES.md new file mode 100644 index 000000000..07a1ed010 --- /dev/null +++ b/docs/markdown/mesh-common/variables/SUPPORTED_HANDLES.md @@ -0,0 +1,11 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / SUPPORTED\_HANDLES + +# Variable: SUPPORTED\_HANDLES + +> `const` **SUPPORTED\_HANDLES**: `Record`\<`number`, `string`\> + +Defined in: constants/index.ts:33 diff --git a/docs/markdown/mesh-common/variables/SUPPORTED_LANGUAGE_VIEWS.md b/docs/markdown/mesh-common/variables/SUPPORTED_LANGUAGE_VIEWS.md new file mode 100644 index 000000000..95cea8e55 --- /dev/null +++ b/docs/markdown/mesh-common/variables/SUPPORTED_LANGUAGE_VIEWS.md @@ -0,0 +1,11 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / SUPPORTED\_LANGUAGE\_VIEWS + +# Variable: SUPPORTED\_LANGUAGE\_VIEWS + +> `const` **SUPPORTED\_LANGUAGE\_VIEWS**: `Record`\<[`Era`](../type-aliases/Era.md), `Partial`\<`Record`\\>\> + +Defined in: constants/language-views.ts:4 diff --git a/docs/markdown/mesh-common/variables/SUPPORTED_OGMIOS_LINKS.md b/docs/markdown/mesh-common/variables/SUPPORTED_OGMIOS_LINKS.md new file mode 100644 index 000000000..aa2d79ccc --- /dev/null +++ b/docs/markdown/mesh-common/variables/SUPPORTED_OGMIOS_LINKS.md @@ -0,0 +1,11 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / SUPPORTED\_OGMIOS\_LINKS + +# Variable: SUPPORTED\_OGMIOS\_LINKS + +> `const` **SUPPORTED\_OGMIOS\_LINKS**: `Record`\<[`Network`](../type-aliases/Network.md), `string`\> + +Defined in: constants/index.ts:38 diff --git a/docs/markdown/mesh-common/variables/SUPPORTED_TOKENS.md b/docs/markdown/mesh-common/variables/SUPPORTED_TOKENS.md new file mode 100644 index 000000000..3bd16aa36 --- /dev/null +++ b/docs/markdown/mesh-common/variables/SUPPORTED_TOKENS.md @@ -0,0 +1,125 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / SUPPORTED\_TOKENS + +# Variable: SUPPORTED\_TOKENS + +> `const` **SUPPORTED\_TOKENS**: `object` + +Defined in: constants/index.ts:45 + +## Type declaration + +### AGIX + +> **AGIX**: `string` = `"f43a62fdc3965df486de8a0d32fe800963589c41b38946602a0dc53541474958"` + +### C3 + +> **C3**: `string` = `"8e51398904a5d3fc129fbf4f1589701de23c7824d5c90fdb9490e15a434841524c4933"` + +### CLAY + +> **CLAY**: `string` = `"38ad9dc3aec6a2f38e220142b9aa6ade63ebe71f65e7cc2b7d8a8535434c4159"` + +### COPI + +> **COPI**: `string` = `"b6a7467ea1deb012808ef4e87b5ff371e85f7142d7b356a40d9b42a0436f726e75636f70696173205b76696120436861696e506f72742e696f5d"` + +### DING + +> **DING**: `string` = `"ce5b9e0f8a88255b65f2e4d065c6e716e9fa9a8a86dfb86423dd1ac044494e47"` + +### DJED + +> **DJED**: `string` = `"8db269c3ec630e06ae29f74bc39edd1f87c819f1056206e879a1cd61446a65644d6963726f555344"` + +### GENS + +> **GENS**: `string` = `"dda5fdb1002f7389b33e036b6afee82a8189becb6cba852e8b79b4fb0014df1047454e53"` + +### GERO + +> **GERO**: `string` = `"10a49b996e2402269af553a8a96fb8eb90d79e9eca79e2b4223057b64745524f"` + +### GIMBAL + +> **GIMBAL**: `string` = `"2b0a04a7b60132b1805b296c7fcb3b217ff14413991bf76f72663c3067696d62616c"` + +### GREENS + +> **GREENS**: `string` = `"4623ab311b7d982d8d26fcbe1a9439ca56661aafcdcd8d8a0ef31fd6475245454e53"` + +### HOSKY + +> **HOSKY**: `string` = `"a0028f350aaabe0545fdcb56b039bfb08e4bb4d8c4d7c3c7d481c235484f534b59"` + +### iBTC + +> **iBTC**: `string` = `"f66d78b4a3cb3d37afa0ec36461e51ecbde00f26c8f0a68f94b6988069425443"` + +### iETH + +> **iETH**: `string` = `"f66d78b4a3cb3d37afa0ec36461e51ecbde00f26c8f0a68f94b6988069455448"` + +### INDY + +> **INDY**: `string` = `"533bb94a8850ee3ccbe483106489399112b74c905342cb1792a797a0494e4459"` + +### iUSD + +> **iUSD**: `string` = `"f66d78b4a3cb3d37afa0ec36461e51ecbde00f26c8f0a68f94b6988069555344"` + +### LQ + +> **LQ**: `string` = `"da8c30857834c6ae7203935b89278c532b3995245295456f993e1d244c51"` + +### MCOS + +> **MCOS**: `string` = `"6f46e1304b16d884c85c62fb0eef35028facdc41aaa0fd319a152ed64d434f53"` + +### MELD + +> **MELD**: `string` = `"6ac8ef33b510ec004fe11585f7c5a9f0c07f0c23428ab4f29c1d7d104d454c44"` + +### MILK + +> **MILK**: `string` = `"8a1cfae21368b8bebbbed9800fec304e95cce39a2a57dc35e2e3ebaa4d494c4b"` + +### MIN + +> **MIN**: `string` = `"29d222ce763455e3d7a09a665ce554f00ac89d2e99a1a83d267170c64d494e"` + +### NMKR + +> **NMKR**: `string` = `"5dac8536653edc12f6f5e1045d8164b9f59998d3bdc300fc928434894e4d4b52"` + +### NTX + +> **NTX**: `string` = `"edfd7a1d77bcb8b884c474bdc92a16002d1fb720e454fa6e993444794e5458"` + +### PAVIA + +> **PAVIA**: `string` = `"884892bcdc360bcef87d6b3f806e7f9cd5ac30d999d49970e7a903ae5041564941"` + +### SHEN + +> **SHEN**: `string` = `"8db269c3ec630e06ae29f74bc39edd1f87c819f1056206e879a1cd615368656e4d6963726f555344"` + +### SOCIETY + +> **SOCIETY**: `string` = `"25f0fc240e91bd95dcdaebd2ba7713fc5168ac77234a3d79449fc20c534f4349455459"` + +### SUNDAE + +> **SUNDAE**: `string` = `"9a9693a9a37912a5097918f97918d15240c92ab729a0b7c4aa144d7753554e444145"` + +### WMT + +> **WMT**: `string` = `"1d7f33bd23d85e1a25d87d86fac4f199c3197a2f7afeb662a0f34e1e776f726c646d6f62696c65746f6b656e"` + +### YUMMI + +> **YUMMI**: `string` = `"078eafce5cd7edafdf63900edef2c1ea759e77f30ca81d6bbdeec92479756d6d69"` diff --git a/docs/markdown/mesh-common/variables/SUPPORTED_WALLETS.md b/docs/markdown/mesh-common/variables/SUPPORTED_WALLETS.md new file mode 100644 index 000000000..1a64fe822 --- /dev/null +++ b/docs/markdown/mesh-common/variables/SUPPORTED_WALLETS.md @@ -0,0 +1,11 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / SUPPORTED\_WALLETS + +# Variable: SUPPORTED\_WALLETS + +> `const` **SUPPORTED\_WALLETS**: `string`[] + +Defined in: constants/supported-wallets.ts:1 diff --git a/docs/markdown/mesh-common/variables/fungibleAssetKeys.md b/docs/markdown/mesh-common/variables/fungibleAssetKeys.md new file mode 100644 index 000000000..471e34157 --- /dev/null +++ b/docs/markdown/mesh-common/variables/fungibleAssetKeys.md @@ -0,0 +1,11 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / fungibleAssetKeys + +# Variable: fungibleAssetKeys + +> `const` **fungibleAssetKeys**: `string`[] + +Defined in: types/asset-metadata.ts:44 diff --git a/docs/markdown/mesh-common/variables/metadataStandardKeys.md b/docs/markdown/mesh-common/variables/metadataStandardKeys.md new file mode 100644 index 000000000..c7e2c06d6 --- /dev/null +++ b/docs/markdown/mesh-common/variables/metadataStandardKeys.md @@ -0,0 +1,11 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / metadataStandardKeys + +# Variable: metadataStandardKeys + +> `const` **metadataStandardKeys**: `string`[] + +Defined in: types/asset-metadata.ts:12 diff --git a/docs/markdown/mesh-common/variables/royaltiesStandardKeys.md b/docs/markdown/mesh-common/variables/royaltiesStandardKeys.md new file mode 100644 index 000000000..4117ad311 --- /dev/null +++ b/docs/markdown/mesh-common/variables/royaltiesStandardKeys.md @@ -0,0 +1,11 @@ +[**@meshsdk/common**](../README.md) + +*** + +[@meshsdk/common](../globals.md) / royaltiesStandardKeys + +# Variable: royaltiesStandardKeys + +> `const` **royaltiesStandardKeys**: `string`[] + +Defined in: types/asset-metadata.ts:8 diff --git a/docs/markdown/mesh-contracts/README.md b/docs/markdown/mesh-contracts/README.md new file mode 100644 index 000000000..eb1b7303b --- /dev/null +++ b/docs/markdown/mesh-contracts/README.md @@ -0,0 +1,50 @@ +**@meshsdk/contract** + +*** + +# Mesh Smart Contracts Library + +Here's a list of open-source smart contracts, complete with documentation, live demos, and end-to-end source code. + +[meshjs.dev/smart-contracts](https://meshjs.dev/smart-contracts) + +| Contract | Description | Links | +| --- | --- | --- | +| Content Ownership | Create a content registry and users can create content that is stored in the registry | [[demo](https://meshjs.dev/smart-contracts/content-ownership)] [[source](https://github.com/MeshJS/mesh/tree/main/packages/mesh-contract/src/content-ownership)] [[docs](https://docs.meshjs.dev/contracts/classes/MeshContentOwnershipContract)] | +| Escrow | Facilitates the secure exchange of assets between two parties by acting as a trusted intermediary that holds the assets until the conditions of the agreement are met | [[demo](https://meshjs.dev/smart-contracts/escrow)] [[source](https://github.com/MeshJS/mesh/tree/main/packages/mesh-contract/src/escrow)] [[docs](https://docs.meshjs.dev/contracts/classes/MeshEscrowContract)] | +| Giftcard | Allows users to create a transactions to lock assets into the smart contract, which can be redeemed by any user | [[demo](https://meshjs.dev/smart-contracts/giftcard)] [[source](https://github.com/MeshJS/mesh/tree/main/packages/mesh-contract/src/giftcard)] [[docs](https://docs.meshjs.dev/contracts/classes/MeshGiftcardContract)] | +| Hello World | A simple lock-and-unlock assets contract, providing a hands-on introduction to end-to-end smart contract validation and transaction building | [[demo](https://meshjs.dev/smart-contracts/hello-world)] [[source](https://github.com/MeshJS/mesh/tree/main/packages/mesh-contract/src/hello-world)] [[docs](https://docs.meshjs.dev/contracts/classes/MeshHelloWorldContract)] | +| Marketplace | Allows anyone to buy and sell native assets such as NFTs | [[demo](https://meshjs.dev/smart-contracts/marketplace)] [[source](https://github.com/MeshJS/mesh/tree/main/packages/mesh-contract/src/marketplace)] [[docs](https://docs.meshjs.dev/contracts/classes/MeshMarketplaceContract)] | +| NFT Minting Machine | Mint NFTs with an automatically incremented index, which increases by one for each newly minted NFT | [[demo](https://meshjs.dev/smart-contracts/plutus-nft)] [[source](https://github.com/MeshJS/mesh/tree/main/packages/mesh-contract/src/plutus-nft)] [[docs](https://docs.meshjs.dev/contracts/classes/MeshPlutusNFTContract)] | +| Payment Splitter | Allows users to split incoming payments among a group of accounts | [[demo](https://meshjs.dev/smart-contracts/payment-splitter)] [[source](https://github.com/MeshJS/mesh/tree/main/packages/mesh-contract/src/payment-splitter)] [[docs](https://docs.meshjs.dev/contracts/classes/MeshPaymentSplitterContract)] | +| Swap | Facilitates the exchange of assets between two parties | [[demo](https://meshjs.dev/smart-contracts/swap)] [[source](https://github.com/MeshJS/mesh/tree/main/packages/mesh-contract/src/swap)] [[docs](https://docs.meshjs.dev/contracts/classes/MeshSwapContract)] | +| Vesting | Allows users to lock tokens for a period of time and withdraw the funds after the lockup period | [[demo](https://meshjs.dev/smart-contracts/vesting)] [[source](https://github.com/MeshJS/mesh/tree/main/packages/mesh-contract/src/vesting)] [[docs](https://docs.meshjs.dev/contracts/classes/MeshVestingContract)] | + +# List of 'Bad' Contracts + +This helps developers to better understand how smart contracts work and improves their ability to fix bad contracts. + +## [Unbound value](https://github.com/MeshJS/mesh/tree/main/packages/mesh-contract/src/escrow/unbound-value) + +Unbound value is a vulnerability where the hackers can spam the application by providing excessive unnecessary tokens in a validator, causing permanent lock of value in validator due to protocol limitation of execution units. In the escrow example, we did not specificallly guard this scenario since it did not make economical sense for both initiator and recipient to perform such hack. However, it other application or scenario it may be required to specifically check the length of input / output to prevent such hack from happening. + +## [Infinite mint](https://github.com/MeshJS/mesh/tree/main/packages/mesh-contract/src/giftcard/infinite-mint) + +Infinite mint is a vulnerability where there is no strict restriction on minting a particular policy where malicious players can mint more than desired tokens from one transaction. Normally it comes from when the validator checks against whether a particular token has been minted without strictly prohibiting other tokens from minting. This vulnerability is dangerous when a complex application relies on certain policy ID for authentication, while malicious players can produce uncontrolled circulation of token with that policy ID, leading to complex hacking scenarios causing loss of funds. + +## [Insufficient stake control](https://github.com/MeshJS/mesh/tree/main/packages/mesh-contract/src/marketplace/insufficient-stake-control) + +Insufficient stake control is a vulnerability where the value payment only check against payment key but not checking with a full address. Malicious player can fulfill the validator unlocking logic by sending value to an address with his/her own stake key to steal the staking reward and voting power if the user is not aware of that. + +## [Locked value](https://github.com/MeshJS/mesh/tree/main/packages/mesh-contract/src/plutus-nft/locked-value) + +Locked value is a design where the application would cause permanent lock of value alike burning value permenantly. It will cause loss of fund and value circulation. However, in some scenarios it might be a intented behaviour to produce umtamperable utxos to serve as single proven source of truth for apps. One should consider the economics and tradeoff against the design choice. In the plutus nft example, locked value vulnerability is not considered as severe since only around 2 ADA would be permenantly lock in oracle. + +## [Double satisfaction](https://github.com/MeshJS/mesh/tree/main/packages/mesh-contract/src/swap/double-satisfaction) + +This is a vulnerability where a bad actor can unlock multiple script utxos by fulfilling less than intented criteria. This swap example illustrate this vulnerability by not checking there is only 1 script input. It leads to bad actors can extract more value than it was expected from the protocol. + +### Resources + +- [Workshop #1 video recording](https://www.youtube.com/watch?v=JgIhzix7rMo) +- [Workshop #1 video recording](https://www.youtube.com/watch?v=IQoN6yL3z1A) diff --git a/docs/markdown/mesh-contracts/classes/MeshContentOwnershipContract.md b/docs/markdown/mesh-contracts/classes/MeshContentOwnershipContract.md new file mode 100644 index 000000000..0a4271d65 --- /dev/null +++ b/docs/markdown/mesh-contracts/classes/MeshContentOwnershipContract.md @@ -0,0 +1,1102 @@ +[**@meshsdk/contract**](../README.md) + +*** + +[@meshsdk/contract](../globals.md) / MeshContentOwnershipContract + +# Class: MeshContentOwnershipContract + +Defined in: mesh-contract/src/content-ownership/offchain/offchain.ts:71 + +Mesh Content Ownership Contract + +This contract is used to manage the ownership of content. +It facilitates on-chain record of content (i.e. file on IPFS) ownership and transfer. +While one cannot prefer others from obtaining a copy of the content, the app owner of the +contract can serve the single source of truth of who owns the content. With the blockchain +trace and record in place, it provides a trustless way to verify the ownership of the content +and facilitates further application logics such as royalties, licensing, etc. + +## Example + +```typescript + const meshTxBuilder = new MeshTxBuilder({ + fetcher: provider, // one of the Providers + submitter: provider, + verbose: true, +}); + +const contract = new MeshContentOwnershipContract( + { + mesh: meshTxBuilder, + fetcher: provider, + wallet: wallet, + networkId: 0, + }, + { + operationAddress: operationAddress, // the address of the app owner, where most of the actions should be signed by the spending key of this address + paramUtxo: { outputIndex: 0, txHash: "0000000000000000000000000000000000000000000000000000000000000000" }, // you can get this from the output of `mintOneTimeMintingPolicy()` transaction + refScriptUtxos?: { // you can get these from the output of `sendRefScriptOnchain()` transactions + contentRegistry: { outputIndex: 0, txHash: "0000000000000000000000000000000000000000000000000000000000000000" }, + contentRefToken: { outputIndex: 0, txHash: "0000000000000000000000000000000000000000000000000000000000000000" }, + ownershipRegistry: { outputIndex: 0, txHash: "0000000000000000000000000000000000000000000000000000000000000000" }, + ownershipRefToken: { outputIndex: 0, txHash: "0000000000000000000000000000000000000000000000000000000000000000" }, + }, + }, +); +``` + +## Extends + +- `MeshTxInitiator` + +## Constructors + +### Constructor + +> **new MeshContentOwnershipContract**(`inputs`, `contract`): `MeshContentOwnershipContract` + +Defined in: mesh-contract/src/content-ownership/offchain/offchain.ts:105 + +#### Parameters + +##### inputs + +`MeshTxInitiatorInput` + +##### contract + +###### operationAddress + +`string` + +###### paramUtxo? + +`TxInput` + +###### refScriptUtxos? + +\{ `contentRefToken`: `TxInput`; `contentRegistry`: `TxInput`; `ownershipRefToken`: `TxInput`; `ownershipRegistry`: `TxInput`; \} + +###### refScriptUtxos.contentRefToken + +`TxInput` + +###### refScriptUtxos.contentRegistry + +`TxInput` + +###### refScriptUtxos.ownershipRefToken + +`TxInput` + +###### refScriptUtxos.ownershipRegistry + +`TxInput` + +#### Returns + +`MeshContentOwnershipContract` + +#### Overrides + +`MeshTxInitiator.constructor` + +## Properties + +### fetcher? + +> `optional` **fetcher**: `IFetcher` + +Defined in: mesh-contract/src/common.ts:23 + +#### Inherited from + +`MeshTxInitiator.fetcher` + +*** + +### languageVersion + +> **languageVersion**: `"V1"` \| `"V2"` \| `"V3"` = `"V2"` + +Defined in: mesh-contract/src/common.ts:28 + +#### Inherited from + +`MeshTxInitiator.languageVersion` + +*** + +### mesh + +> **mesh**: `MeshTxBuilder` + +Defined in: mesh-contract/src/common.ts:22 + +#### Inherited from + +`MeshTxInitiator.mesh` + +*** + +### networkId + +> **networkId**: `number` = `0` + +Defined in: mesh-contract/src/common.ts:26 + +#### Inherited from + +`MeshTxInitiator.networkId` + +*** + +### operationAddress + +> **operationAddress**: `string` + +Defined in: mesh-contract/src/content-ownership/offchain/offchain.ts:102 + +*** + +### opsKey + +> **opsKey**: `string` + +Defined in: mesh-contract/src/content-ownership/offchain/offchain.ts:103 + +*** + +### paramUtxo + +> **paramUtxo**: `object` + +Defined in: mesh-contract/src/content-ownership/offchain/offchain.ts:72 + +#### outputIndex + +> **outputIndex**: `number` = `0` + +#### txHash + +> **txHash**: `string` = `"0000000000000000000000000000000000000000000000000000000000000000"` + +*** + +### refScriptUtxos + +> **refScriptUtxos**: `object` + +Defined in: mesh-contract/src/content-ownership/offchain/offchain.ts:80 + +#### contentRefToken + +> **contentRefToken**: `object` + +##### contentRefToken.outputIndex + +> **outputIndex**: `number` = `0` + +##### contentRefToken.txHash + +> **txHash**: `string` = `"0000000000000000000000000000000000000000000000000000000000000000"` + +#### contentRegistry + +> **contentRegistry**: `object` + +##### contentRegistry.outputIndex + +> **outputIndex**: `number` = `0` + +##### contentRegistry.txHash + +> **txHash**: `string` = `"0000000000000000000000000000000000000000000000000000000000000000"` + +#### ownershipRefToken + +> **ownershipRefToken**: `object` + +##### ownershipRefToken.outputIndex + +> **outputIndex**: `number` = `0` + +##### ownershipRefToken.txHash + +> **txHash**: `string` = `"0000000000000000000000000000000000000000000000000000000000000000"` + +#### ownershipRegistry + +> **ownershipRegistry**: `object` + +##### ownershipRegistry.outputIndex + +> **outputIndex**: `number` = `0` + +##### ownershipRegistry.txHash + +> **txHash**: `string` = `"0000000000000000000000000000000000000000000000000000000000000000"` + +*** + +### scriptInfo + +> **scriptInfo**: `object` + +Defined in: mesh-contract/src/content-ownership/offchain/offchain.ts:76 + +#### contentRefToken + +> **contentRefToken**: `object` + +##### contentRefToken.cbor + +> **cbor**: `string` + +##### contentRefToken.hash + +> **hash**: `string` + +#### contentRegistry + +> **contentRegistry**: `object` + +##### contentRegistry.address + +> **address**: `string` = `""` + +##### contentRegistry.cbor + +> **cbor**: `string` + +##### contentRegistry.hash + +> **hash**: `string` + +#### oracleNFT + +> **oracleNFT**: `object` + +##### oracleNFT.cbor + +> **cbor**: `string` + +##### oracleNFT.hash + +> **hash**: `string` + +#### oracleValidator + +> **oracleValidator**: `object` + +##### oracleValidator.address + +> **address**: `string` = `""` + +##### oracleValidator.cbor + +> **cbor**: `string` + +##### oracleValidator.hash + +> **hash**: `string` + +#### ownershipRefToken + +> **ownershipRefToken**: `object` + +##### ownershipRefToken.cbor + +> **cbor**: `string` + +##### ownershipRefToken.hash + +> **hash**: `string` + +#### ownershipRegistry + +> **ownershipRegistry**: `object` + +##### ownershipRegistry.address + +> **address**: `string` = `""` + +##### ownershipRegistry.cbor + +> **cbor**: `string` + +##### ownershipRegistry.hash + +> **hash**: `string` + +*** + +### stakeCredential? + +> `optional` **stakeCredential**: `string` + +Defined in: mesh-contract/src/common.ts:25 + +#### Inherited from + +`MeshTxInitiator.stakeCredential` + +*** + +### version + +> **version**: `number` = `2` + +Defined in: mesh-contract/src/common.ts:27 + +#### Inherited from + +`MeshTxInitiator.version` + +*** + +### wallet? + +> `optional` **wallet**: `IWallet` + +Defined in: mesh-contract/src/common.ts:24 + +#### Inherited from + +`MeshTxInitiator.wallet` + +## Methods + +### \_getUtxoByTxHash() + +> `protected` **\_getUtxoByTxHash**(`txHash`, `scriptCbor?`): `Promise`\<`undefined` \| `UTxO`\> + +Defined in: mesh-contract/src/common.ts:197 + +#### Parameters + +##### txHash + +`string` + +##### scriptCbor? + +`string` + +#### Returns + +`Promise`\<`undefined` \| `UTxO`\> + +#### Inherited from + +`MeshTxInitiator._getUtxoByTxHash` + +*** + +### createContent() + +> **createContent**(`ownerAssetHex`, `contentHashHex`, `registryNumber`): `Promise`\<`string`\> + +Defined in: mesh-contract/src/content-ownership/offchain/offchain.ts:543 + +#### Parameters + +##### ownerAssetHex + +`string` + +##### contentHashHex + +`string` + +##### registryNumber + +`number` = `0` + +#### Returns + +`Promise`\<`string`\> + +*** + +### createContentRegistry() + +> **createContentRegistry**(): `Promise`\<`string`\> + +Defined in: mesh-contract/src/content-ownership/offchain/offchain.ts:317 + +[Setup phase] +This is the next transaction you need to setup the contract after completing all the `sendRefScriptOnchain` transactions. + +This transaction creates one content registry. Each registry should comes in pair with one ownership registry and +each pair of registry serves around 50 records of content ownership. The application can be scaled indefinitely +according to the number of parallelization needed and volumes of content expected to be managed. + +Note: You must provide the `paramUtxo` from the `mintOneTimeMintingPolicy` transaction. +Note: You must provide the txHash for `ContentRegistry`, `ContentRefToken`, `OwnershipRegistry`, `OwnershipRefToken` + +#### Returns + +`Promise`\<`string`\> + +#### Example + +```typescript +const txHex = await contract.createContentRegistry(); +const signedTx = await wallet.signTx(txHex); +const txHash = await wallet.submitTx(signedTx); +``` + +*** + +### createOwnershipRegistry() + +> **createOwnershipRegistry**(): `Promise`\<`string`\> + +Defined in: mesh-contract/src/content-ownership/offchain/offchain.ts:398 + +[Setup phase] +This is the last transaction you need to setup the contract after completing all the `sendRefScriptOnchain` transactions. + +This transaction creates one content registry. Each registry should comes in pair with one content registry and +each pair of registry serves around 50 records of content ownership. The application can be scaled indefinitely +according to the number of parallelization needed and volumes of content expected to be managed. + +Note: You must provide the `paramUtxo` from the `mintOneTimeMintingPolicy` transaction. +Note: You must provide the txHash for `ContentRegistry`, `ContentRefToken`, `OwnershipRegistry`, `OwnershipRefToken` + +#### Returns + +`Promise`\<`string`\> + +#### Example + +```typescript +const txHex = await contract.createOwnershipRegistry(); +const signedTx = await wallet.signTx(txHex); +const txHash = await wallet.submitTx(signedTx); +``` + +*** + +### getAddressUtxosWithMinLovelace() + +> `protected` **getAddressUtxosWithMinLovelace**(`walletAddress`, `lovelace`, `providedUtxos`): `Promise`\<`UTxO`[]\> + +Defined in: mesh-contract/src/common.ts:147 + +#### Parameters + +##### walletAddress + +`string` + +##### lovelace + +`number` + +##### providedUtxos + +`UTxO`[] = `[]` + +#### Returns + +`Promise`\<`UTxO`[]\> + +#### Inherited from + +`MeshTxInitiator.getAddressUtxosWithMinLovelace` + +*** + +### getAddressUtxosWithToken() + +> `protected` **getAddressUtxosWithToken**(`walletAddress`, `assetHex`, `userUtxos`): `Promise`\<`UTxO`[]\> + +Defined in: mesh-contract/src/common.ts:164 + +#### Parameters + +##### walletAddress + +`string` + +##### assetHex + +`string` + +##### userUtxos + +`UTxO`[] = `[]` + +#### Returns + +`Promise`\<`UTxO`[]\> + +#### Inherited from + +`MeshTxInitiator.getAddressUtxosWithToken` + +*** + +### getContent() + +> **getContent**(`registryNumber`, `contentNumber`): `Promise`\<`string`\> + +Defined in: mesh-contract/src/content-ownership/offchain/offchain.ts:647 + +Get the content at the registry given the registry number and content number. + +#### Parameters + +##### registryNumber + +`number` + +##### contentNumber + +`number` + +#### Returns + +`Promise`\<`string`\> + +*** + +### getContentDatum() + +> `protected` **getContentDatum**(`contentArray`): `MConStr0`\<(`number` \| `string`[])[]\> + +Defined in: mesh-contract/src/content-ownership/offchain/offchain.ts:979 + +#### Parameters + +##### contentArray + +`string`[] + +#### Returns + +`MConStr0`\<(`number` \| `string`[])[]\> + +*** + +### getCurrentOracleDatum() + +> `protected` **getCurrentOracleDatum**(`utxos?`): `Promise`\<`OracleDatum`\> + +Defined in: mesh-contract/src/content-ownership/offchain/offchain.ts:934 + +#### Parameters + +##### utxos? + +`UTxO`[] + +#### Returns + +`Promise`\<`OracleDatum`\> + +*** + +### getOracleData() + +> **getOracleData**(): `Promise`\<\{ `contentNumber`: `number`; `ownershipNumber`: `number`; \}\> + +Defined in: mesh-contract/src/content-ownership/offchain/offchain.ts:471 + +Get the current oracle data. + +#### Returns + +`Promise`\<\{ `contentNumber`: `number`; `ownershipNumber`: `number`; \}\> + +#### Example + +```typescript +const oracleData = await contract.getOracleData(); +``` + +*** + +### getOracleDatum() + +> `protected` **getOracleDatum**(`contentRegistryCount`, `ownershipRegistryCount`): `MConStr0`\<(`string` \| `number` \| `MScriptAddress`)[]\> + +Defined in: mesh-contract/src/content-ownership/offchain/offchain.ts:948 + +#### Parameters + +##### contentRegistryCount + +`number` + +##### ownershipRegistryCount + +`number` + +#### Returns + +`MConStr0`\<(`string` \| `number` \| `MScriptAddress`)[]\> + +*** + +### getOwnerNativeScript() + +> **getOwnerNativeScript**(): `object` + +Defined in: mesh-contract/src/content-ownership/offchain/offchain.ts:135 + +#### Returns + +`object` + +##### nativeScript + +> **nativeScript**: `object` + +###### nativeScript.scripts + +> **scripts**: `NativeScript`[] + +###### nativeScript.type + +> **type**: `"all"` \| `"any"` + +##### scriptAddress + +> **scriptAddress**: `string` + +*** + +### getOwnershipDatum() + +> `protected` **getOwnershipDatum**(`ownershipArray`): `MConStr0`\<(`number` \| \[`string`, `string`\][])[]\> + +Defined in: mesh-contract/src/content-ownership/offchain/offchain.ts:983 + +#### Parameters + +##### ownershipArray + +\[`string`, `string`\][] + +#### Returns + +`MConStr0`\<(`number` \| \[`string`, `string`\][])[]\> + +*** + +### getScriptAddress() + +> **getScriptAddress**(`scriptCbor`): `string` + +Defined in: mesh-contract/src/common.ts:69 + +#### Parameters + +##### scriptCbor + +`string` + +#### Returns + +`string` + +#### Inherited from + +`MeshTxInitiator.getScriptAddress` + +*** + +### getScriptUtxos() + +> **getScriptUtxos**(`registryNumber`, `toFetch`): `Promise`\<(`undefined` \| `UTxO`)[]\> + +Defined in: mesh-contract/src/content-ownership/offchain/offchain.ts:987 + +#### Parameters + +##### registryNumber + +`number` + +##### toFetch + +(`"oracle"` \| `"content"` \| `"ownership"`)[] = `...` + +#### Returns + +`Promise`\<(`undefined` \| `UTxO`)[]\> + +*** + +### getWalletCollateral() + +> `protected` **getWalletCollateral**(): `Promise`\<`undefined` \| `UTxO`\> + +Defined in: mesh-contract/src/common.ts:107 + +#### Returns + +`Promise`\<`undefined` \| `UTxO`\> + +#### Inherited from + +`MeshTxInitiator.getWalletCollateral` + +*** + +### getWalletDappAddress() + +> `protected` **getWalletDappAddress**(): `Promise`\<`undefined` \| `string`\> + +Defined in: mesh-contract/src/common.ts:93 + +#### Returns + +`Promise`\<`undefined` \| `string`\> + +#### Inherited from + +`MeshTxInitiator.getWalletDappAddress` + +*** + +### getWalletInfoForTx() + +> `protected` **getWalletInfoForTx**(): `Promise`\<\{ `collateral`: `UTxO`; `utxos`: `UTxO`[]; `walletAddress`: `string`; \}\> + +Defined in: mesh-contract/src/common.ts:181 + +#### Returns + +`Promise`\<\{ `collateral`: `UTxO`; `utxos`: `UTxO`[]; `walletAddress`: `string`; \}\> + +#### Inherited from + +`MeshTxInitiator.getWalletInfoForTx` + +*** + +### getWalletUtxosWithMinLovelace() + +> `protected` **getWalletUtxosWithMinLovelace**(`lovelace`, `providedUtxos`): `Promise`\<`UTxO`[]\> + +Defined in: mesh-contract/src/common.ts:115 + +#### Parameters + +##### lovelace + +`number` + +##### providedUtxos + +`UTxO`[] = `[]` + +#### Returns + +`Promise`\<`UTxO`[]\> + +#### Inherited from + +`MeshTxInitiator.getWalletUtxosWithMinLovelace` + +*** + +### getWalletUtxosWithToken() + +> `protected` **getWalletUtxosWithToken**(`assetHex`, `userUtxos`): `Promise`\<`UTxO`[]\> + +Defined in: mesh-contract/src/common.ts:131 + +#### Parameters + +##### assetHex + +`string` + +##### userUtxos + +`UTxO`[] = `[]` + +#### Returns + +`Promise`\<`UTxO`[]\> + +#### Inherited from + +`MeshTxInitiator.getWalletUtxosWithToken` + +*** + +### mintOneTimeMintingPolicy() + +> **mintOneTimeMintingPolicy**(): `Promise`\<\{ `paramUtxo`: `TxInput`; `tx`: `string`; \}\> + +Defined in: mesh-contract/src/content-ownership/offchain/offchain.ts:177 + +[Setup phase] +This is the first transaction you need to setup the contract. + +This transaction mints the one-time minting policy (a NFT) for the contract. +It will be attached with the datum which serves as the single source of truth for the contract oracle. + +Note: You must save the `paramUtxo` for future transactions. + +#### Returns + +`Promise`\<\{ `paramUtxo`: `TxInput`; `tx`: `string`; \}\> + +#### Example + +```typescript +const { tx, paramUtxo } = await contract.mintOneTimeMintingPolicy(); +const signedTx = await wallet.signTx(tx); +const txHash = await wallet.submitTx(signedTx); +``` + +*** + +### mintUserToken() + +> **mintUserToken**(`tokenName`, `tokenMetadata`): `Promise`\<`string`\> + +Defined in: mesh-contract/src/content-ownership/offchain/offchain.ts:505 + +[User] + +This transaction mints a user token which can be used to represent the ownership of the content. This token is used in `createContent()` transaction. + +#### Parameters + +##### tokenName + +`string` + +The name of the token that you can specify. + +##### tokenMetadata + +The metadata of the token that you can specify. + +#### Returns + +`Promise`\<`string`\> + +#### Example + +```typescript +const tx = await contract.mintUserToken("MeshContentOwnership", { + name: "Mesh Content Ownership", + description: "Demo at https://meshjs.dev/smart-contracts/content-ownership", +}); +const signedTx = await wallet.signTx(tx, true); +const txHash = await wallet.submitTx(signedTx); + +*** + +### queryUtxos() + +> `protected` **queryUtxos**(`walletAddress`): `Promise`\<`UTxO`[]\> + +Defined in: mesh-contract/src/common.ts:85 + +#### Parameters + +##### walletAddress + +`string` + +#### Returns + +`Promise`\<`UTxO`[]\> + +#### Inherited from + +`MeshTxInitiator.queryUtxos` + +*** + +### sendRefScriptOnchain() + +> **sendRefScriptOnchain**(`scriptIndex`): `Promise`\<`string`\> + +Defined in: mesh-contract/src/content-ownership/offchain/offchain.ts:285 + +[Setup phase] +This are the next transactions you need to setup the contract. +You need to run once for each script, and you would likely have to run one after the previous one is confirmed. + +This transaction sends the reference scripts to the blockchain for later transactions, +boosting efficiency and avoid exceeding 16kb of transaction size limits enforced by protocol parameter. + +Note: You must provide the `paramUtxo` from the `mintOneTimeMintingPolicy` transaction. +Note: You must save txHash (after signed and submitted) for `ContentRegistry`, `ContentRefToken`, `OwnershipRegistry`, `OwnershipRefToken` transactions for future transactions. + +#### Parameters + +##### scriptIndex + +`ScriptIndex` + +"OracleNFT" | "OracleValidator" | "ContentRegistry" | "ContentRefToken" | "OwnershipRegistry" | "OwnershipRefToken" + +#### Returns + +`Promise`\<`string`\> + +#### Example + +```typescript +const txHexOracleNFT = await contract.sendRefScriptOnchain("OracleNFT"); +const signedTxOracleNFT = await wallet.signTx(txHexOracleNFT); +const txHashOracleNFT = await wallet.submitTx(signedTxOracleNFT); + +const txHexOracleValidator = await contract.sendRefScriptOnchain("OracleValidator"); +... // repeat for each script + +const txHexOwnershipRefToken = await contract.sendRefScriptOnchain("OwnershipRefToken"); +const signedTxOwnershipRefToken = await wallet.signTx(txHexOwnershipRefToken); +const txHashOwnershipRefToken = await wallet.submitTx(signedTxOwnershipRefToken); +``` + +*** + +### setupOracleUtxo() + +> **setupOracleUtxo**(): `Promise`\<`string`\> + +Defined in: mesh-contract/src/content-ownership/offchain/offchain.ts:243 + +[Setup phase] +This is the second transaction you need to setup the contract. + +This transaction send the NFT to a oracle contract locking the datum, +which serves as the single source of truth for the contract oracle with data integrity. + +Note: You must provide the `paramUtxo` from the `mintOneTimeMintingPolicy` transaction. + +#### Returns + +`Promise`\<`string`\> + +#### Example + +```typescript +const txHex = await contract.setupOracleUtxo(); +const signedTx = await wallet.signTx(txHex); +const txHash = await wallet.submitTx(signedTx); +``` + +*** + +### signSubmitReset() + +> `protected` **signSubmitReset**(): `Promise`\<`undefined` \| `string`\> + +Defined in: mesh-contract/src/common.ts:78 + +#### Returns + +`Promise`\<`undefined` \| `string`\> + +#### Inherited from + +`MeshTxInitiator.signSubmitReset` + +*** + +### stopContentRegistry() + +> **stopContentRegistry**(`registryNumber`): `Promise`\<`string`\> + +Defined in: mesh-contract/src/content-ownership/offchain/offchain.ts:798 + +#### Parameters + +##### registryNumber + +`number` + +#### Returns + +`Promise`\<`string`\> + +*** + +### stopOracle() + +> **stopOracle**(`txInHash`, `txInId`): `Promise`\<`string`\> + +Defined in: mesh-contract/src/content-ownership/offchain/offchain.ts:896 + +#### Parameters + +##### txInHash + +`string` + +##### txInId + +`number` + +#### Returns + +`Promise`\<`string`\> + +*** + +### stopOwnershipRegistry() + +> **stopOwnershipRegistry**(`registryNumber`): `Promise`\<`string`\> + +Defined in: mesh-contract/src/content-ownership/offchain/offchain.ts:847 + +#### Parameters + +##### registryNumber + +`number` + +#### Returns + +`Promise`\<`string`\> + +*** + +### transferContent() + +> **transferContent**(`__namedParameters`): `Promise`\<`string`\> + +Defined in: mesh-contract/src/content-ownership/offchain/offchain.ts:730 + +#### Parameters + +##### \_\_namedParameters + +`TransferContent` + +#### Returns + +`Promise`\<`string`\> + +*** + +### updateContent() + +> **updateContent**(`__namedParameters`): `Promise`\<`string`\> + +Defined in: mesh-contract/src/content-ownership/offchain/offchain.ts:666 + +#### Parameters + +##### \_\_namedParameters + +`UpdateContent` + +#### Returns + +`Promise`\<`string`\> diff --git a/docs/markdown/mesh-contracts/classes/MeshEscrowContract.md b/docs/markdown/mesh-contracts/classes/MeshEscrowContract.md new file mode 100644 index 000000000..e00a4990c --- /dev/null +++ b/docs/markdown/mesh-contracts/classes/MeshEscrowContract.md @@ -0,0 +1,487 @@ +[**@meshsdk/contract**](../README.md) + +*** + +[@meshsdk/contract](../globals.md) / MeshEscrowContract + +# Class: MeshEscrowContract + +Defined in: mesh-contract/src/escrow/offchain.ts:66 + +## Extends + +- `MeshTxInitiator` + +## Constructors + +### Constructor + +> **new MeshEscrowContract**(`inputs`): `MeshEscrowContract` + +Defined in: mesh-contract/src/escrow/offchain.ts:70 + +#### Parameters + +##### inputs + +`MeshTxInitiatorInput` + +#### Returns + +`MeshEscrowContract` + +#### Overrides + +`MeshTxInitiator.constructor` + +## Properties + +### fetcher? + +> `optional` **fetcher**: `IFetcher` + +Defined in: mesh-contract/src/common.ts:23 + +#### Inherited from + +`MeshTxInitiator.fetcher` + +*** + +### languageVersion + +> **languageVersion**: `"V1"` \| `"V2"` \| `"V3"` = `"V2"` + +Defined in: mesh-contract/src/common.ts:28 + +#### Inherited from + +`MeshTxInitiator.languageVersion` + +*** + +### mesh + +> **mesh**: `MeshTxBuilder` + +Defined in: mesh-contract/src/common.ts:22 + +#### Inherited from + +`MeshTxInitiator.mesh` + +*** + +### networkId + +> **networkId**: `number` = `0` + +Defined in: mesh-contract/src/common.ts:26 + +#### Inherited from + +`MeshTxInitiator.networkId` + +*** + +### scriptAddress + +> **scriptAddress**: `string` + +Defined in: mesh-contract/src/escrow/offchain.ts:68 + +*** + +### scriptCbor + +> **scriptCbor**: `string` + +Defined in: mesh-contract/src/escrow/offchain.ts:67 + +*** + +### stakeCredential? + +> `optional` **stakeCredential**: `string` + +Defined in: mesh-contract/src/common.ts:25 + +#### Inherited from + +`MeshTxInitiator.stakeCredential` + +*** + +### version + +> **version**: `number` = `2` + +Defined in: mesh-contract/src/common.ts:27 + +#### Inherited from + +`MeshTxInitiator.version` + +*** + +### wallet? + +> `optional` **wallet**: `IWallet` + +Defined in: mesh-contract/src/common.ts:24 + +#### Inherited from + +`MeshTxInitiator.wallet` + +## Methods + +### \_getUtxoByTxHash() + +> `protected` **\_getUtxoByTxHash**(`txHash`, `scriptCbor?`): `Promise`\<`undefined` \| `UTxO`\> + +Defined in: mesh-contract/src/common.ts:197 + +#### Parameters + +##### txHash + +`string` + +##### scriptCbor? + +`string` + +#### Returns + +`Promise`\<`undefined` \| `UTxO`\> + +#### Inherited from + +`MeshTxInitiator._getUtxoByTxHash` + +*** + +### cancelEscrow() + +> **cancelEscrow**(`escrowUtxo`): `Promise`\<`string`\> + +Defined in: mesh-contract/src/escrow/offchain.ts:102 + +#### Parameters + +##### escrowUtxo + +`UTxO` + +#### Returns + +`Promise`\<`string`\> + +*** + +### completeEscrow() + +> **completeEscrow**(`escrowUtxo`): `Promise`\<`string`\> + +Defined in: mesh-contract/src/escrow/offchain.ts:208 + +#### Parameters + +##### escrowUtxo + +`UTxO` + +#### Returns + +`Promise`\<`string`\> + +*** + +### getAddressUtxosWithMinLovelace() + +> `protected` **getAddressUtxosWithMinLovelace**(`walletAddress`, `lovelace`, `providedUtxos`): `Promise`\<`UTxO`[]\> + +Defined in: mesh-contract/src/common.ts:147 + +#### Parameters + +##### walletAddress + +`string` + +##### lovelace + +`number` + +##### providedUtxos + +`UTxO`[] = `[]` + +#### Returns + +`Promise`\<`UTxO`[]\> + +#### Inherited from + +`MeshTxInitiator.getAddressUtxosWithMinLovelace` + +*** + +### getAddressUtxosWithToken() + +> `protected` **getAddressUtxosWithToken**(`walletAddress`, `assetHex`, `userUtxos`): `Promise`\<`UTxO`[]\> + +Defined in: mesh-contract/src/common.ts:164 + +#### Parameters + +##### walletAddress + +`string` + +##### assetHex + +`string` + +##### userUtxos + +`UTxO`[] = `[]` + +#### Returns + +`Promise`\<`UTxO`[]\> + +#### Inherited from + +`MeshTxInitiator.getAddressUtxosWithToken` + +*** + +### getScriptAddress() + +> **getScriptAddress**(`scriptCbor`): `string` + +Defined in: mesh-contract/src/common.ts:69 + +#### Parameters + +##### scriptCbor + +`string` + +#### Returns + +`string` + +#### Inherited from + +`MeshTxInitiator.getScriptAddress` + +*** + +### getScriptCbor() + +> **getScriptCbor**(): `string` + +Defined in: mesh-contract/src/escrow/offchain.ts:76 + +#### Returns + +`string` + +*** + +### getUtxoByTxHash() + +> **getUtxoByTxHash**(`txHash`): `Promise`\<`undefined` \| `UTxO`\> + +Defined in: mesh-contract/src/escrow/offchain.ts:259 + +#### Parameters + +##### txHash + +`string` + +#### Returns + +`Promise`\<`undefined` \| `UTxO`\> + +*** + +### getWalletCollateral() + +> `protected` **getWalletCollateral**(): `Promise`\<`undefined` \| `UTxO`\> + +Defined in: mesh-contract/src/common.ts:107 + +#### Returns + +`Promise`\<`undefined` \| `UTxO`\> + +#### Inherited from + +`MeshTxInitiator.getWalletCollateral` + +*** + +### getWalletDappAddress() + +> `protected` **getWalletDappAddress**(): `Promise`\<`undefined` \| `string`\> + +Defined in: mesh-contract/src/common.ts:93 + +#### Returns + +`Promise`\<`undefined` \| `string`\> + +#### Inherited from + +`MeshTxInitiator.getWalletDappAddress` + +*** + +### getWalletInfoForTx() + +> `protected` **getWalletInfoForTx**(): `Promise`\<\{ `collateral`: `UTxO`; `utxos`: `UTxO`[]; `walletAddress`: `string`; \}\> + +Defined in: mesh-contract/src/common.ts:181 + +#### Returns + +`Promise`\<\{ `collateral`: `UTxO`; `utxos`: `UTxO`[]; `walletAddress`: `string`; \}\> + +#### Inherited from + +`MeshTxInitiator.getWalletInfoForTx` + +*** + +### getWalletUtxosWithMinLovelace() + +> `protected` **getWalletUtxosWithMinLovelace**(`lovelace`, `providedUtxos`): `Promise`\<`UTxO`[]\> + +Defined in: mesh-contract/src/common.ts:115 + +#### Parameters + +##### lovelace + +`number` + +##### providedUtxos + +`UTxO`[] = `[]` + +#### Returns + +`Promise`\<`UTxO`[]\> + +#### Inherited from + +`MeshTxInitiator.getWalletUtxosWithMinLovelace` + +*** + +### getWalletUtxosWithToken() + +> `protected` **getWalletUtxosWithToken**(`assetHex`, `userUtxos`): `Promise`\<`UTxO`[]\> + +Defined in: mesh-contract/src/common.ts:131 + +#### Parameters + +##### assetHex + +`string` + +##### userUtxos + +`UTxO`[] = `[]` + +#### Returns + +`Promise`\<`UTxO`[]\> + +#### Inherited from + +`MeshTxInitiator.getWalletUtxosWithToken` + +*** + +### initiateEscrow() + +> **initiateEscrow**(`escrowAmount`): `Promise`\<`string`\> + +Defined in: mesh-contract/src/escrow/offchain.ts:87 + +#### Parameters + +##### escrowAmount + +`Asset`[] + +#### Returns + +`Promise`\<`string`\> + +*** + +### queryUtxos() + +> `protected` **queryUtxos**(`walletAddress`): `Promise`\<`UTxO`[]\> + +Defined in: mesh-contract/src/common.ts:85 + +#### Parameters + +##### walletAddress + +`string` + +#### Returns + +`Promise`\<`UTxO`[]\> + +#### Inherited from + +`MeshTxInitiator.queryUtxos` + +*** + +### recipientDeposit() + +> **recipientDeposit**(`escrowUtxo`, `depositAmount`): `Promise`\<`string`\> + +Defined in: mesh-contract/src/escrow/offchain.ts:160 + +#### Parameters + +##### escrowUtxo + +`UTxO` + +##### depositAmount + +`Asset`[] + +#### Returns + +`Promise`\<`string`\> + +*** + +### signSubmitReset() + +> `protected` **signSubmitReset**(): `Promise`\<`undefined` \| `string`\> + +Defined in: mesh-contract/src/common.ts:78 + +#### Returns + +`Promise`\<`undefined` \| `string`\> + +#### Inherited from + +`MeshTxInitiator.signSubmitReset` diff --git a/docs/markdown/mesh-contracts/classes/MeshGiftCardContract.md b/docs/markdown/mesh-contracts/classes/MeshGiftCardContract.md new file mode 100644 index 000000000..9136e0259 --- /dev/null +++ b/docs/markdown/mesh-contracts/classes/MeshGiftCardContract.md @@ -0,0 +1,495 @@ +[**@meshsdk/contract**](../README.md) + +*** + +[@meshsdk/contract](../globals.md) / MeshGiftCardContract + +# Class: MeshGiftCardContract + +Defined in: mesh-contract/src/giftcard/offchain.ts:25 + +## Extends + +- `MeshTxInitiator` + +## Constructors + +### Constructor + +> **new MeshGiftCardContract**(`inputs`, `tokenNameHex?`, `paramUtxo?`): `MeshGiftCardContract` + +Defined in: mesh-contract/src/giftcard/offchain.ts:29 + +#### Parameters + +##### inputs + +`MeshTxInitiatorInput` + +##### tokenNameHex? + +`string` + +##### paramUtxo? + +`TxInput` + +#### Returns + +`MeshGiftCardContract` + +#### Overrides + +`MeshTxInitiator.constructor` + +## Properties + +### fetcher? + +> `optional` **fetcher**: `IFetcher` + +Defined in: mesh-contract/src/common.ts:23 + +#### Inherited from + +`MeshTxInitiator.fetcher` + +*** + +### languageVersion + +> **languageVersion**: `"V1"` \| `"V2"` \| `"V3"` = `"V2"` + +Defined in: mesh-contract/src/common.ts:28 + +#### Inherited from + +`MeshTxInitiator.languageVersion` + +*** + +### mesh + +> **mesh**: `MeshTxBuilder` + +Defined in: mesh-contract/src/common.ts:22 + +#### Inherited from + +`MeshTxInitiator.mesh` + +*** + +### networkId + +> **networkId**: `number` = `0` + +Defined in: mesh-contract/src/common.ts:26 + +#### Inherited from + +`MeshTxInitiator.networkId` + +*** + +### paramUtxo + +> **paramUtxo**: `TxInput` + +Defined in: mesh-contract/src/giftcard/offchain.ts:27 + +*** + +### stakeCredential? + +> `optional` **stakeCredential**: `string` + +Defined in: mesh-contract/src/common.ts:25 + +#### Inherited from + +`MeshTxInitiator.stakeCredential` + +*** + +### tokenNameHex + +> **tokenNameHex**: `string` = `""` + +Defined in: mesh-contract/src/giftcard/offchain.ts:26 + +*** + +### version + +> **version**: `number` = `2` + +Defined in: mesh-contract/src/common.ts:27 + +#### Inherited from + +`MeshTxInitiator.version` + +*** + +### wallet? + +> `optional` **wallet**: `IWallet` + +Defined in: mesh-contract/src/common.ts:24 + +#### Inherited from + +`MeshTxInitiator.wallet` + +## Methods + +### \_getUtxoByTxHash() + +> `protected` **\_getUtxoByTxHash**(`txHash`, `scriptCbor?`): `Promise`\<`undefined` \| `UTxO`\> + +Defined in: mesh-contract/src/common.ts:197 + +#### Parameters + +##### txHash + +`string` + +##### scriptCbor? + +`string` + +#### Returns + +`Promise`\<`undefined` \| `UTxO`\> + +#### Inherited from + +`MeshTxInitiator._getUtxoByTxHash` + +*** + +### createGiftCard() + +> **createGiftCard**(`tokenName`, `giftValue`): `Promise`\<`string`\> + +Defined in: mesh-contract/src/giftcard/offchain.ts:81 + +#### Parameters + +##### tokenName + +`string` + +##### giftValue + +`Asset`[] + +#### Returns + +`Promise`\<`string`\> + +*** + +### getAddressUtxosWithMinLovelace() + +> `protected` **getAddressUtxosWithMinLovelace**(`walletAddress`, `lovelace`, `providedUtxos`): `Promise`\<`UTxO`[]\> + +Defined in: mesh-contract/src/common.ts:147 + +#### Parameters + +##### walletAddress + +`string` + +##### lovelace + +`number` + +##### providedUtxos + +`UTxO`[] = `[]` + +#### Returns + +`Promise`\<`UTxO`[]\> + +#### Inherited from + +`MeshTxInitiator.getAddressUtxosWithMinLovelace` + +*** + +### getAddressUtxosWithToken() + +> `protected` **getAddressUtxosWithToken**(`walletAddress`, `assetHex`, `userUtxos`): `Promise`\<`UTxO`[]\> + +Defined in: mesh-contract/src/common.ts:164 + +#### Parameters + +##### walletAddress + +`string` + +##### assetHex + +`string` + +##### userUtxos + +`UTxO`[] = `[]` + +#### Returns + +`Promise`\<`UTxO`[]\> + +#### Inherited from + +`MeshTxInitiator.getAddressUtxosWithToken` + +*** + +### getScriptAddress() + +> **getScriptAddress**(`scriptCbor`): `string` + +Defined in: mesh-contract/src/common.ts:69 + +#### Parameters + +##### scriptCbor + +`string` + +#### Returns + +`string` + +#### Inherited from + +`MeshTxInitiator.getScriptAddress` + +*** + +### getUtxoByTxHash() + +> **getUtxoByTxHash**(`txHash`): `Promise`\<`undefined` \| `UTxO`\> + +Defined in: mesh-contract/src/giftcard/offchain.ts:195 + +#### Parameters + +##### txHash + +`string` + +#### Returns + +`Promise`\<`undefined` \| `UTxO`\> + +*** + +### getWalletCollateral() + +> `protected` **getWalletCollateral**(): `Promise`\<`undefined` \| `UTxO`\> + +Defined in: mesh-contract/src/common.ts:107 + +#### Returns + +`Promise`\<`undefined` \| `UTxO`\> + +#### Inherited from + +`MeshTxInitiator.getWalletCollateral` + +*** + +### getWalletDappAddress() + +> `protected` **getWalletDappAddress**(): `Promise`\<`undefined` \| `string`\> + +Defined in: mesh-contract/src/common.ts:93 + +#### Returns + +`Promise`\<`undefined` \| `string`\> + +#### Inherited from + +`MeshTxInitiator.getWalletDappAddress` + +*** + +### getWalletInfoForTx() + +> `protected` **getWalletInfoForTx**(): `Promise`\<\{ `collateral`: `UTxO`; `utxos`: `UTxO`[]; `walletAddress`: `string`; \}\> + +Defined in: mesh-contract/src/common.ts:181 + +#### Returns + +`Promise`\<\{ `collateral`: `UTxO`; `utxos`: `UTxO`[]; `walletAddress`: `string`; \}\> + +#### Inherited from + +`MeshTxInitiator.getWalletInfoForTx` + +*** + +### getWalletUtxosWithMinLovelace() + +> `protected` **getWalletUtxosWithMinLovelace**(`lovelace`, `providedUtxos`): `Promise`\<`UTxO`[]\> + +Defined in: mesh-contract/src/common.ts:115 + +#### Parameters + +##### lovelace + +`number` + +##### providedUtxos + +`UTxO`[] = `[]` + +#### Returns + +`Promise`\<`UTxO`[]\> + +#### Inherited from + +`MeshTxInitiator.getWalletUtxosWithMinLovelace` + +*** + +### getWalletUtxosWithToken() + +> `protected` **getWalletUtxosWithToken**(`assetHex`, `userUtxos`): `Promise`\<`UTxO`[]\> + +Defined in: mesh-contract/src/common.ts:131 + +#### Parameters + +##### assetHex + +`string` + +##### userUtxos + +`UTxO`[] = `[]` + +#### Returns + +`Promise`\<`UTxO`[]\> + +#### Inherited from + +`MeshTxInitiator.getWalletUtxosWithToken` + +*** + +### giftCardCbor() + +> **giftCardCbor**(`tokenNameHex`, `utxoTxHash`, `utxoTxId`): `string` + +Defined in: mesh-contract/src/giftcard/offchain.ts:43 + +#### Parameters + +##### tokenNameHex + +`string` + +##### utxoTxHash + +`string` + +##### utxoTxId + +`number` + +#### Returns + +`string` + +*** + +### queryUtxos() + +> `protected` **queryUtxos**(`walletAddress`): `Promise`\<`UTxO`[]\> + +Defined in: mesh-contract/src/common.ts:85 + +#### Parameters + +##### walletAddress + +`string` + +#### Returns + +`Promise`\<`UTxO`[]\> + +#### Inherited from + +`MeshTxInitiator.queryUtxos` + +*** + +### redeemCbor() + +> **redeemCbor**(`tokenNameHex`, `policyId`): `string` + +Defined in: mesh-contract/src/giftcard/offchain.ts:68 + +#### Parameters + +##### tokenNameHex + +`string` + +##### policyId + +`string` + +#### Returns + +`string` + +*** + +### redeemGiftCard() + +> **redeemGiftCard**(`giftCardUtxo`): `Promise`\<`string`\> + +Defined in: mesh-contract/src/giftcard/offchain.ts:145 + +#### Parameters + +##### giftCardUtxo + +`UTxO` + +#### Returns + +`Promise`\<`string`\> + +*** + +### signSubmitReset() + +> `protected` **signSubmitReset**(): `Promise`\<`undefined` \| `string`\> + +Defined in: mesh-contract/src/common.ts:78 + +#### Returns + +`Promise`\<`undefined` \| `string`\> + +#### Inherited from + +`MeshTxInitiator.signSubmitReset` diff --git a/docs/markdown/mesh-contracts/classes/MeshHelloWorldContract.md b/docs/markdown/mesh-contracts/classes/MeshHelloWorldContract.md new file mode 100644 index 000000000..1762a75db --- /dev/null +++ b/docs/markdown/mesh-contracts/classes/MeshHelloWorldContract.md @@ -0,0 +1,451 @@ +[**@meshsdk/contract**](../README.md) + +*** + +[@meshsdk/contract](../globals.md) / MeshHelloWorldContract + +# Class: MeshHelloWorldContract + +Defined in: mesh-contract/src/hello-world/offchain.ts:21 + +## Extends + +- `MeshTxInitiator` + +## Constructors + +### Constructor + +> **new MeshHelloWorldContract**(`inputs`): `MeshHelloWorldContract` + +Defined in: mesh-contract/src/hello-world/offchain.ts:25 + +#### Parameters + +##### inputs + +`MeshTxInitiatorInput` + +#### Returns + +`MeshHelloWorldContract` + +#### Overrides + +`MeshTxInitiator.constructor` + +## Properties + +### fetcher? + +> `optional` **fetcher**: `IFetcher` + +Defined in: mesh-contract/src/common.ts:23 + +#### Inherited from + +`MeshTxInitiator.fetcher` + +*** + +### languageVersion + +> **languageVersion**: `"V1"` \| `"V2"` \| `"V3"` = `"V2"` + +Defined in: mesh-contract/src/common.ts:28 + +#### Inherited from + +`MeshTxInitiator.languageVersion` + +*** + +### mesh + +> **mesh**: `MeshTxBuilder` + +Defined in: mesh-contract/src/common.ts:22 + +#### Inherited from + +`MeshTxInitiator.mesh` + +*** + +### networkId + +> **networkId**: `number` = `0` + +Defined in: mesh-contract/src/common.ts:26 + +#### Inherited from + +`MeshTxInitiator.networkId` + +*** + +### scriptAddress + +> **scriptAddress**: `string` + +Defined in: mesh-contract/src/hello-world/offchain.ts:23 + +*** + +### scriptCbor + +> **scriptCbor**: `string` + +Defined in: mesh-contract/src/hello-world/offchain.ts:22 + +*** + +### stakeCredential? + +> `optional` **stakeCredential**: `string` + +Defined in: mesh-contract/src/common.ts:25 + +#### Inherited from + +`MeshTxInitiator.stakeCredential` + +*** + +### version + +> **version**: `number` = `2` + +Defined in: mesh-contract/src/common.ts:27 + +#### Inherited from + +`MeshTxInitiator.version` + +*** + +### wallet? + +> `optional` **wallet**: `IWallet` + +Defined in: mesh-contract/src/common.ts:24 + +#### Inherited from + +`MeshTxInitiator.wallet` + +## Methods + +### \_getUtxoByTxHash() + +> `protected` **\_getUtxoByTxHash**(`txHash`, `scriptCbor?`): `Promise`\<`undefined` \| `UTxO`\> + +Defined in: mesh-contract/src/common.ts:197 + +#### Parameters + +##### txHash + +`string` + +##### scriptCbor? + +`string` + +#### Returns + +`Promise`\<`undefined` \| `UTxO`\> + +#### Inherited from + +`MeshTxInitiator._getUtxoByTxHash` + +*** + +### getAddressUtxosWithMinLovelace() + +> `protected` **getAddressUtxosWithMinLovelace**(`walletAddress`, `lovelace`, `providedUtxos`): `Promise`\<`UTxO`[]\> + +Defined in: mesh-contract/src/common.ts:147 + +#### Parameters + +##### walletAddress + +`string` + +##### lovelace + +`number` + +##### providedUtxos + +`UTxO`[] = `[]` + +#### Returns + +`Promise`\<`UTxO`[]\> + +#### Inherited from + +`MeshTxInitiator.getAddressUtxosWithMinLovelace` + +*** + +### getAddressUtxosWithToken() + +> `protected` **getAddressUtxosWithToken**(`walletAddress`, `assetHex`, `userUtxos`): `Promise`\<`UTxO`[]\> + +Defined in: mesh-contract/src/common.ts:164 + +#### Parameters + +##### walletAddress + +`string` + +##### assetHex + +`string` + +##### userUtxos + +`UTxO`[] = `[]` + +#### Returns + +`Promise`\<`UTxO`[]\> + +#### Inherited from + +`MeshTxInitiator.getAddressUtxosWithToken` + +*** + +### getScriptAddress() + +> **getScriptAddress**(`scriptCbor`): `string` + +Defined in: mesh-contract/src/common.ts:69 + +#### Parameters + +##### scriptCbor + +`string` + +#### Returns + +`string` + +#### Inherited from + +`MeshTxInitiator.getScriptAddress` + +*** + +### getScriptCbor() + +> **getScriptCbor**(): `string` + +Defined in: mesh-contract/src/hello-world/offchain.ts:31 + +#### Returns + +`string` + +*** + +### getUtxoByTxHash() + +> **getUtxoByTxHash**(`txHash`): `Promise`\<`undefined` \| `UTxO`\> + +Defined in: mesh-contract/src/hello-world/offchain.ts:84 + +#### Parameters + +##### txHash + +`string` + +#### Returns + +`Promise`\<`undefined` \| `UTxO`\> + +*** + +### getWalletCollateral() + +> `protected` **getWalletCollateral**(): `Promise`\<`undefined` \| `UTxO`\> + +Defined in: mesh-contract/src/common.ts:107 + +#### Returns + +`Promise`\<`undefined` \| `UTxO`\> + +#### Inherited from + +`MeshTxInitiator.getWalletCollateral` + +*** + +### getWalletDappAddress() + +> `protected` **getWalletDappAddress**(): `Promise`\<`undefined` \| `string`\> + +Defined in: mesh-contract/src/common.ts:93 + +#### Returns + +`Promise`\<`undefined` \| `string`\> + +#### Inherited from + +`MeshTxInitiator.getWalletDappAddress` + +*** + +### getWalletInfoForTx() + +> `protected` **getWalletInfoForTx**(): `Promise`\<\{ `collateral`: `UTxO`; `utxos`: `UTxO`[]; `walletAddress`: `string`; \}\> + +Defined in: mesh-contract/src/common.ts:181 + +#### Returns + +`Promise`\<\{ `collateral`: `UTxO`; `utxos`: `UTxO`[]; `walletAddress`: `string`; \}\> + +#### Inherited from + +`MeshTxInitiator.getWalletInfoForTx` + +*** + +### getWalletUtxosWithMinLovelace() + +> `protected` **getWalletUtxosWithMinLovelace**(`lovelace`, `providedUtxos`): `Promise`\<`UTxO`[]\> + +Defined in: mesh-contract/src/common.ts:115 + +#### Parameters + +##### lovelace + +`number` + +##### providedUtxos + +`UTxO`[] = `[]` + +#### Returns + +`Promise`\<`UTxO`[]\> + +#### Inherited from + +`MeshTxInitiator.getWalletUtxosWithMinLovelace` + +*** + +### getWalletUtxosWithToken() + +> `protected` **getWalletUtxosWithToken**(`assetHex`, `userUtxos`): `Promise`\<`UTxO`[]\> + +Defined in: mesh-contract/src/common.ts:131 + +#### Parameters + +##### assetHex + +`string` + +##### userUtxos + +`UTxO`[] = `[]` + +#### Returns + +`Promise`\<`UTxO`[]\> + +#### Inherited from + +`MeshTxInitiator.getWalletUtxosWithToken` + +*** + +### lockAsset() + +> **lockAsset**(`assets`): `Promise`\<`string`\> + +Defined in: mesh-contract/src/hello-world/offchain.ts:40 + +#### Parameters + +##### assets + +`Asset`[] + +#### Returns + +`Promise`\<`string`\> + +*** + +### queryUtxos() + +> `protected` **queryUtxos**(`walletAddress`): `Promise`\<`UTxO`[]\> + +Defined in: mesh-contract/src/common.ts:85 + +#### Parameters + +##### walletAddress + +`string` + +#### Returns + +`Promise`\<`UTxO`[]\> + +#### Inherited from + +`MeshTxInitiator.queryUtxos` + +*** + +### signSubmitReset() + +> `protected` **signSubmitReset**(): `Promise`\<`undefined` \| `string`\> + +Defined in: mesh-contract/src/common.ts:78 + +#### Returns + +`Promise`\<`undefined` \| `string`\> + +#### Inherited from + +`MeshTxInitiator.signSubmitReset` + +*** + +### unlockAsset() + +> **unlockAsset**(`scriptUtxo`, `message`): `Promise`\<`string`\> + +Defined in: mesh-contract/src/hello-world/offchain.ts:54 + +#### Parameters + +##### scriptUtxo + +`UTxO` + +##### message + +`string` + +#### Returns + +`Promise`\<`string`\> diff --git a/docs/markdown/mesh-contracts/classes/MeshMarketplaceContract.md b/docs/markdown/mesh-contracts/classes/MeshMarketplaceContract.md new file mode 100644 index 000000000..a77b22e57 --- /dev/null +++ b/docs/markdown/mesh-contracts/classes/MeshMarketplaceContract.md @@ -0,0 +1,547 @@ +[**@meshsdk/contract**](../README.md) + +*** + +[@meshsdk/contract](../globals.md) / MeshMarketplaceContract + +# Class: MeshMarketplaceContract + +Defined in: mesh-contract/src/marketplace/offchain.ts:48 + +## Extends + +- `MeshTxInitiator` + +## Constructors + +### Constructor + +> **new MeshMarketplaceContract**(`inputs`, `ownerAddress`, `feePercentageBasisPoint`): `MeshMarketplaceContract` + +Defined in: mesh-contract/src/marketplace/offchain.ts:54 + +#### Parameters + +##### inputs + +`MeshTxInitiatorInput` + +##### ownerAddress + +`string` + +##### feePercentageBasisPoint + +`number` + +#### Returns + +`MeshMarketplaceContract` + +#### Overrides + +`MeshTxInitiator.constructor` + +## Properties + +### feePercentageBasisPoint + +> **feePercentageBasisPoint**: `number` + +Defined in: mesh-contract/src/marketplace/offchain.ts:50 + +*** + +### fetcher? + +> `optional` **fetcher**: `IFetcher` + +Defined in: mesh-contract/src/common.ts:23 + +#### Inherited from + +`MeshTxInitiator.fetcher` + +*** + +### languageVersion + +> **languageVersion**: `"V1"` \| `"V2"` \| `"V3"` = `"V2"` + +Defined in: mesh-contract/src/common.ts:28 + +#### Inherited from + +`MeshTxInitiator.languageVersion` + +*** + +### mesh + +> **mesh**: `MeshTxBuilder` + +Defined in: mesh-contract/src/common.ts:22 + +#### Inherited from + +`MeshTxInitiator.mesh` + +*** + +### networkId + +> **networkId**: `number` = `0` + +Defined in: mesh-contract/src/common.ts:26 + +#### Inherited from + +`MeshTxInitiator.networkId` + +*** + +### ownerAddress + +> **ownerAddress**: `string` + +Defined in: mesh-contract/src/marketplace/offchain.ts:49 + +*** + +### scriptAddress + +> **scriptAddress**: `string` + +Defined in: mesh-contract/src/marketplace/offchain.ts:52 + +*** + +### scriptCbor + +> **scriptCbor**: `string` + +Defined in: mesh-contract/src/marketplace/offchain.ts:51 + +*** + +### stakeCredential? + +> `optional` **stakeCredential**: `string` + +Defined in: mesh-contract/src/common.ts:25 + +#### Inherited from + +`MeshTxInitiator.stakeCredential` + +*** + +### version + +> **version**: `number` = `2` + +Defined in: mesh-contract/src/common.ts:27 + +#### Inherited from + +`MeshTxInitiator.version` + +*** + +### wallet? + +> `optional` **wallet**: `IWallet` + +Defined in: mesh-contract/src/common.ts:24 + +#### Inherited from + +`MeshTxInitiator.wallet` + +## Methods + +### \_getUtxoByTxHash() + +> `protected` **\_getUtxoByTxHash**(`txHash`, `scriptCbor?`): `Promise`\<`undefined` \| `UTxO`\> + +Defined in: mesh-contract/src/common.ts:197 + +#### Parameters + +##### txHash + +`string` + +##### scriptCbor? + +`string` + +#### Returns + +`Promise`\<`undefined` \| `UTxO`\> + +#### Inherited from + +`MeshTxInitiator._getUtxoByTxHash` + +*** + +### delistAsset() + +> **delistAsset**(`marketplaceUtxo`): `Promise`\<`string`\> + +Defined in: mesh-contract/src/marketplace/offchain.ts:120 + +#### Parameters + +##### marketplaceUtxo + +`UTxO` + +#### Returns + +`Promise`\<`string`\> + +*** + +### getAddressUtxosWithMinLovelace() + +> `protected` **getAddressUtxosWithMinLovelace**(`walletAddress`, `lovelace`, `providedUtxos`): `Promise`\<`UTxO`[]\> + +Defined in: mesh-contract/src/common.ts:147 + +#### Parameters + +##### walletAddress + +`string` + +##### lovelace + +`number` + +##### providedUtxos + +`UTxO`[] = `[]` + +#### Returns + +`Promise`\<`UTxO`[]\> + +#### Inherited from + +`MeshTxInitiator.getAddressUtxosWithMinLovelace` + +*** + +### getAddressUtxosWithToken() + +> `protected` **getAddressUtxosWithToken**(`walletAddress`, `assetHex`, `userUtxos`): `Promise`\<`UTxO`[]\> + +Defined in: mesh-contract/src/common.ts:164 + +#### Parameters + +##### walletAddress + +`string` + +##### assetHex + +`string` + +##### userUtxos + +`UTxO`[] = `[]` + +#### Returns + +`Promise`\<`UTxO`[]\> + +#### Inherited from + +`MeshTxInitiator.getAddressUtxosWithToken` + +*** + +### getScriptAddress() + +> **getScriptAddress**(`scriptCbor`): `string` + +Defined in: mesh-contract/src/common.ts:69 + +#### Parameters + +##### scriptCbor + +`string` + +#### Returns + +`string` + +#### Inherited from + +`MeshTxInitiator.getScriptAddress` + +*** + +### getScriptCbor() + +> **getScriptCbor**(`pubKeyHash`, `stakeCredentialHash`, `feePercentageBasisPoint`): `string` + +Defined in: mesh-contract/src/marketplace/offchain.ts:74 + +#### Parameters + +##### pubKeyHash + +`string` + +##### stakeCredentialHash + +`string` + +##### feePercentageBasisPoint + +`number` + +#### Returns + +`string` + +*** + +### getUtxoByTxHash() + +> **getUtxoByTxHash**(`txHash`): `Promise`\<`undefined` \| `UTxO`\> + +Defined in: mesh-contract/src/marketplace/offchain.ts:256 + +#### Parameters + +##### txHash + +`string` + +#### Returns + +`Promise`\<`undefined` \| `UTxO`\> + +*** + +### getWalletCollateral() + +> `protected` **getWalletCollateral**(): `Promise`\<`undefined` \| `UTxO`\> + +Defined in: mesh-contract/src/common.ts:107 + +#### Returns + +`Promise`\<`undefined` \| `UTxO`\> + +#### Inherited from + +`MeshTxInitiator.getWalletCollateral` + +*** + +### getWalletDappAddress() + +> `protected` **getWalletDappAddress**(): `Promise`\<`undefined` \| `string`\> + +Defined in: mesh-contract/src/common.ts:93 + +#### Returns + +`Promise`\<`undefined` \| `string`\> + +#### Inherited from + +`MeshTxInitiator.getWalletDappAddress` + +*** + +### getWalletInfoForTx() + +> `protected` **getWalletInfoForTx**(): `Promise`\<\{ `collateral`: `UTxO`; `utxos`: `UTxO`[]; `walletAddress`: `string`; \}\> + +Defined in: mesh-contract/src/common.ts:181 + +#### Returns + +`Promise`\<\{ `collateral`: `UTxO`; `utxos`: `UTxO`[]; `walletAddress`: `string`; \}\> + +#### Inherited from + +`MeshTxInitiator.getWalletInfoForTx` + +*** + +### getWalletUtxosWithMinLovelace() + +> `protected` **getWalletUtxosWithMinLovelace**(`lovelace`, `providedUtxos`): `Promise`\<`UTxO`[]\> + +Defined in: mesh-contract/src/common.ts:115 + +#### Parameters + +##### lovelace + +`number` + +##### providedUtxos + +`UTxO`[] = `[]` + +#### Returns + +`Promise`\<`UTxO`[]\> + +#### Inherited from + +`MeshTxInitiator.getWalletUtxosWithMinLovelace` + +*** + +### getWalletUtxosWithToken() + +> `protected` **getWalletUtxosWithToken**(`assetHex`, `userUtxos`): `Promise`\<`UTxO`[]\> + +Defined in: mesh-contract/src/common.ts:131 + +#### Parameters + +##### assetHex + +`string` + +##### userUtxos + +`UTxO`[] = `[]` + +#### Returns + +`Promise`\<`UTxO`[]\> + +#### Inherited from + +`MeshTxInitiator.getWalletUtxosWithToken` + +*** + +### listAsset() + +> **listAsset**(`asset`, `price`): `Promise`\<`string`\> + +Defined in: mesh-contract/src/marketplace/offchain.ts:101 + +#### Parameters + +##### asset + +`string` + +##### price + +`number` + +#### Returns + +`Promise`\<`string`\> + +*** + +### purchaseAsset() + +> **purchaseAsset**(`marketplaceUtxo`): `Promise`\<`string`\> + +Defined in: mesh-contract/src/marketplace/offchain.ts:149 + +#### Parameters + +##### marketplaceUtxo + +`UTxO` + +#### Returns + +`Promise`\<`string`\> + +*** + +### queryUtxos() + +> `protected` **queryUtxos**(`walletAddress`): `Promise`\<`UTxO`[]\> + +Defined in: mesh-contract/src/common.ts:85 + +#### Parameters + +##### walletAddress + +`string` + +#### Returns + +`Promise`\<`UTxO`[]\> + +#### Inherited from + +`MeshTxInitiator.queryUtxos` + +*** + +### relistAsset() + +> **relistAsset**(`marketplaceUtxo`, `newPrice`): `Promise`\<`string`\> + +Defined in: mesh-contract/src/marketplace/offchain.ts:219 + +#### Parameters + +##### marketplaceUtxo + +`UTxO` + +##### newPrice + +`number` + +#### Returns + +`Promise`\<`string`\> + +*** + +### signSubmitReset() + +> `protected` **signSubmitReset**(): `Promise`\<`undefined` \| `string`\> + +Defined in: mesh-contract/src/common.ts:78 + +#### Returns + +`Promise`\<`undefined` \| `string`\> + +#### Inherited from + +`MeshTxInitiator.signSubmitReset` + +*** + +### getCompiledCode() + +> `static` **getCompiledCode**(`version`): `string` + +Defined in: mesh-contract/src/marketplace/offchain.ts:260 + +#### Parameters + +##### version + +`number` = `2` + +#### Returns + +`string` diff --git a/docs/markdown/mesh-contracts/classes/MeshPaymentSplitterContract.md b/docs/markdown/mesh-contracts/classes/MeshPaymentSplitterContract.md new file mode 100644 index 000000000..2f72292fd --- /dev/null +++ b/docs/markdown/mesh-contracts/classes/MeshPaymentSplitterContract.md @@ -0,0 +1,453 @@ +[**@meshsdk/contract**](../README.md) + +*** + +[@meshsdk/contract](../globals.md) / MeshPaymentSplitterContract + +# Class: MeshPaymentSplitterContract + +Defined in: mesh-contract/src/payment-splitter/offchain.ts:14 + +## Extends + +- `MeshTxInitiator` + +## Constructors + +### Constructor + +> **new MeshPaymentSplitterContract**(`inputs`, `payees`): `MeshPaymentSplitterContract` + +Defined in: mesh-contract/src/payment-splitter/offchain.ts:26 + +#### Parameters + +##### inputs + +`MeshTxInitiatorInput` + +##### payees + +`string`[] + +#### Returns + +`MeshPaymentSplitterContract` + +#### Overrides + +`MeshTxInitiator.constructor` + +## Properties + +### fetcher? + +> `optional` **fetcher**: `IFetcher` + +Defined in: mesh-contract/src/common.ts:23 + +#### Inherited from + +`MeshTxInitiator.fetcher` + +*** + +### languageVersion + +> **languageVersion**: `"V1"` \| `"V2"` \| `"V3"` = `"V2"` + +Defined in: mesh-contract/src/common.ts:28 + +#### Inherited from + +`MeshTxInitiator.languageVersion` + +*** + +### mesh + +> **mesh**: `MeshTxBuilder` + +Defined in: mesh-contract/src/common.ts:22 + +#### Inherited from + +`MeshTxInitiator.mesh` + +*** + +### networkId + +> **networkId**: `number` = `0` + +Defined in: mesh-contract/src/common.ts:26 + +#### Inherited from + +`MeshTxInitiator.networkId` + +*** + +### payees + +> **payees**: `string`[] = `[]` + +Defined in: mesh-contract/src/payment-splitter/offchain.ts:17 + +*** + +### scriptAddress + +> **scriptAddress**: `string` + +Defined in: mesh-contract/src/payment-splitter/offchain.ts:16 + +*** + +### scriptCbor + +> **scriptCbor**: `string` + +Defined in: mesh-contract/src/payment-splitter/offchain.ts:15 + +*** + +### stakeCredential? + +> `optional` **stakeCredential**: `string` + +Defined in: mesh-contract/src/common.ts:25 + +#### Inherited from + +`MeshTxInitiator.stakeCredential` + +*** + +### version + +> **version**: `number` = `2` + +Defined in: mesh-contract/src/common.ts:27 + +#### Inherited from + +`MeshTxInitiator.version` + +*** + +### wallet? + +> `optional` **wallet**: `IWallet` + +Defined in: mesh-contract/src/common.ts:24 + +#### Inherited from + +`MeshTxInitiator.wallet` + +## Methods + +### \_getUtxoByTxHash() + +> `protected` **\_getUtxoByTxHash**(`txHash`, `scriptCbor?`): `Promise`\<`undefined` \| `UTxO`\> + +Defined in: mesh-contract/src/common.ts:197 + +#### Parameters + +##### txHash + +`string` + +##### scriptCbor? + +`string` + +#### Returns + +`Promise`\<`undefined` \| `UTxO`\> + +#### Inherited from + +`MeshTxInitiator._getUtxoByTxHash` + +*** + +### getAddressUtxosWithMinLovelace() + +> `protected` **getAddressUtxosWithMinLovelace**(`walletAddress`, `lovelace`, `providedUtxos`): `Promise`\<`UTxO`[]\> + +Defined in: mesh-contract/src/common.ts:147 + +#### Parameters + +##### walletAddress + +`string` + +##### lovelace + +`number` + +##### providedUtxos + +`UTxO`[] = `[]` + +#### Returns + +`Promise`\<`UTxO`[]\> + +#### Inherited from + +`MeshTxInitiator.getAddressUtxosWithMinLovelace` + +*** + +### getAddressUtxosWithToken() + +> `protected` **getAddressUtxosWithToken**(`walletAddress`, `assetHex`, `userUtxos`): `Promise`\<`UTxO`[]\> + +Defined in: mesh-contract/src/common.ts:164 + +#### Parameters + +##### walletAddress + +`string` + +##### assetHex + +`string` + +##### userUtxos + +`UTxO`[] = `[]` + +#### Returns + +`Promise`\<`UTxO`[]\> + +#### Inherited from + +`MeshTxInitiator.getAddressUtxosWithToken` + +*** + +### getScriptAddress() + +> **getScriptAddress**(`scriptCbor`): `string` + +Defined in: mesh-contract/src/common.ts:69 + +#### Parameters + +##### scriptCbor + +`string` + +#### Returns + +`string` + +#### Inherited from + +`MeshTxInitiator.getScriptAddress` + +*** + +### getScriptCbor() + +> **getScriptCbor**(): `string` + +Defined in: mesh-contract/src/payment-splitter/offchain.ts:44 + +#### Returns + +`string` + +*** + +### getWalletCollateral() + +> `protected` **getWalletCollateral**(): `Promise`\<`undefined` \| `UTxO`\> + +Defined in: mesh-contract/src/common.ts:107 + +#### Returns + +`Promise`\<`undefined` \| `UTxO`\> + +#### Inherited from + +`MeshTxInitiator.getWalletCollateral` + +*** + +### getWalletDappAddress() + +> `protected` **getWalletDappAddress**(): `Promise`\<`undefined` \| `string`\> + +Defined in: mesh-contract/src/common.ts:93 + +#### Returns + +`Promise`\<`undefined` \| `string`\> + +#### Inherited from + +`MeshTxInitiator.getWalletDappAddress` + +*** + +### getWalletInfoForTx() + +> `protected` **getWalletInfoForTx**(): `Promise`\<\{ `collateral`: `UTxO`; `utxos`: `UTxO`[]; `walletAddress`: `string`; \}\> + +Defined in: mesh-contract/src/common.ts:181 + +#### Returns + +`Promise`\<\{ `collateral`: `UTxO`; `utxos`: `UTxO`[]; `walletAddress`: `string`; \}\> + +#### Inherited from + +`MeshTxInitiator.getWalletInfoForTx` + +*** + +### getWalletUtxosWithMinLovelace() + +> `protected` **getWalletUtxosWithMinLovelace**(`lovelace`, `providedUtxos`): `Promise`\<`UTxO`[]\> + +Defined in: mesh-contract/src/common.ts:115 + +#### Parameters + +##### lovelace + +`number` + +##### providedUtxos + +`UTxO`[] = `[]` + +#### Returns + +`Promise`\<`UTxO`[]\> + +#### Inherited from + +`MeshTxInitiator.getWalletUtxosWithMinLovelace` + +*** + +### getWalletUtxosWithToken() + +> `protected` **getWalletUtxosWithToken**(`assetHex`, `userUtxos`): `Promise`\<`UTxO`[]\> + +Defined in: mesh-contract/src/common.ts:131 + +#### Parameters + +##### assetHex + +`string` + +##### userUtxos + +`UTxO`[] = `[]` + +#### Returns + +`Promise`\<`UTxO`[]\> + +#### Inherited from + +`MeshTxInitiator.getWalletUtxosWithToken` + +*** + +### queryUtxos() + +> `protected` **queryUtxos**(`walletAddress`): `Promise`\<`UTxO`[]\> + +Defined in: mesh-contract/src/common.ts:85 + +#### Parameters + +##### walletAddress + +`string` + +#### Returns + +`Promise`\<`UTxO`[]\> + +#### Inherited from + +`MeshTxInitiator.queryUtxos` + +*** + +### sendLovelaceToSplitter() + +> **sendLovelaceToSplitter**(`lovelaceAmount`): `Promise`\<`string`\> + +Defined in: mesh-contract/src/payment-splitter/offchain.ts:62 + +#### Parameters + +##### lovelaceAmount + +`number` + +#### Returns + +`Promise`\<`string`\> + +*** + +### signSubmitReset() + +> `protected` **signSubmitReset**(): `Promise`\<`undefined` \| `string`\> + +Defined in: mesh-contract/src/common.ts:78 + +#### Returns + +`Promise`\<`undefined` \| `string`\> + +#### Inherited from + +`MeshTxInitiator.signSubmitReset` + +*** + +### triggerPayout() + +> **triggerPayout**(): `Promise`\<`string`\> + +Defined in: mesh-contract/src/payment-splitter/offchain.ts:87 + +#### Returns + +`Promise`\<`string`\> + +*** + +### wrapPayees() + +> **wrapPayees**(`payees`): `List`\<`BuiltinByteString`\> + +Defined in: mesh-contract/src/payment-splitter/offchain.ts:19 + +#### Parameters + +##### payees + +`string`[] + +#### Returns + +`List`\<`BuiltinByteString`\> diff --git a/docs/markdown/mesh-contracts/classes/MeshPlutusNFTContract.md b/docs/markdown/mesh-contracts/classes/MeshPlutusNFTContract.md new file mode 100644 index 000000000..f177316b6 --- /dev/null +++ b/docs/markdown/mesh-contracts/classes/MeshPlutusNFTContract.md @@ -0,0 +1,547 @@ +[**@meshsdk/contract**](../README.md) + +*** + +[@meshsdk/contract](../globals.md) / MeshPlutusNFTContract + +# Class: MeshPlutusNFTContract + +Defined in: mesh-contract/src/plutus-nft/offchain.ts:37 + +Mesh Plutus NFT contract class + +This NFT minting script enables users to mint NFTs with an automatically incremented index, which increases by one for each newly minted NFT. + +To facilitate this process, the first step is to set up a one-time minting policy by minting an oracle token. This oracle token is essential as it holds the current state and index of the NFTs, acting as a reference for the minting sequence. + +With each new NFT minted, the token index within the oracle is incremented by one, ensuring a consistent and orderly progression in the numbering of the NFTs. + +## Extends + +- `MeshTxInitiator` + +## Constructors + +### Constructor + +> **new MeshPlutusNFTContract**(`inputs`, `contract`): `MeshPlutusNFTContract` + +Defined in: mesh-contract/src/plutus-nft/offchain.ts:60 + +#### Parameters + +##### inputs + +`MeshTxInitiatorInput` + +##### contract + +###### collectionName + +`string` + +###### paramUtxo? + +`TxInput` + +#### Returns + +`MeshPlutusNFTContract` + +#### Overrides + +`MeshTxInitiator.constructor` + +## Properties + +### collectionName + +> **collectionName**: `string` + +Defined in: mesh-contract/src/plutus-nft/offchain.ts:38 + +*** + +### fetcher? + +> `optional` **fetcher**: `IFetcher` + +Defined in: mesh-contract/src/common.ts:23 + +#### Inherited from + +`MeshTxInitiator.fetcher` + +*** + +### languageVersion + +> **languageVersion**: `"V1"` \| `"V2"` \| `"V3"` = `"V2"` + +Defined in: mesh-contract/src/common.ts:28 + +#### Inherited from + +`MeshTxInitiator.languageVersion` + +*** + +### mesh + +> **mesh**: `MeshTxBuilder` + +Defined in: mesh-contract/src/common.ts:22 + +#### Inherited from + +`MeshTxInitiator.mesh` + +*** + +### networkId + +> **networkId**: `number` = `0` + +Defined in: mesh-contract/src/common.ts:26 + +#### Inherited from + +`MeshTxInitiator.networkId` + +*** + +### oracleAddress + +> **oracleAddress**: `string` + +Defined in: mesh-contract/src/plutus-nft/offchain.ts:40 + +*** + +### paramUtxo + +> **paramUtxo**: `TxInput` + +Defined in: mesh-contract/src/plutus-nft/offchain.ts:39 + +*** + +### stakeCredential? + +> `optional` **stakeCredential**: `string` + +Defined in: mesh-contract/src/common.ts:25 + +#### Inherited from + +`MeshTxInitiator.stakeCredential` + +*** + +### version + +> **version**: `number` = `2` + +Defined in: mesh-contract/src/common.ts:27 + +#### Inherited from + +`MeshTxInitiator.version` + +*** + +### wallet? + +> `optional` **wallet**: `IWallet` + +Defined in: mesh-contract/src/common.ts:24 + +#### Inherited from + +`MeshTxInitiator.wallet` + +## Methods + +### \_getUtxoByTxHash() + +> `protected` **\_getUtxoByTxHash**(`txHash`, `scriptCbor?`): `Promise`\<`undefined` \| `UTxO`\> + +Defined in: mesh-contract/src/common.ts:197 + +#### Parameters + +##### txHash + +`string` + +##### scriptCbor? + +`string` + +#### Returns + +`Promise`\<`undefined` \| `UTxO`\> + +#### Inherited from + +`MeshTxInitiator._getUtxoByTxHash` + +*** + +### getAddressUtxosWithMinLovelace() + +> `protected` **getAddressUtxosWithMinLovelace**(`walletAddress`, `lovelace`, `providedUtxos`): `Promise`\<`UTxO`[]\> + +Defined in: mesh-contract/src/common.ts:147 + +#### Parameters + +##### walletAddress + +`string` + +##### lovelace + +`number` + +##### providedUtxos + +`UTxO`[] = `[]` + +#### Returns + +`Promise`\<`UTxO`[]\> + +#### Inherited from + +`MeshTxInitiator.getAddressUtxosWithMinLovelace` + +*** + +### getAddressUtxosWithToken() + +> `protected` **getAddressUtxosWithToken**(`walletAddress`, `assetHex`, `userUtxos`): `Promise`\<`UTxO`[]\> + +Defined in: mesh-contract/src/common.ts:164 + +#### Parameters + +##### walletAddress + +`string` + +##### assetHex + +`string` + +##### userUtxos + +`UTxO`[] = `[]` + +#### Returns + +`Promise`\<`UTxO`[]\> + +#### Inherited from + +`MeshTxInitiator.getAddressUtxosWithToken` + +*** + +### getNFTCbor() + +> **getNFTCbor**(): `string` + +Defined in: mesh-contract/src/plutus-nft/offchain.ts:52 + +#### Returns + +`string` + +*** + +### getOracleCbor() + +> **getOracleCbor**(): `string` + +Defined in: mesh-contract/src/plutus-nft/offchain.ts:42 + +#### Returns + +`string` + +*** + +### getOracleData() + +> **getOracleData**(): `Promise`\<\{ `feeCollectorAddress`: `string`; `feeCollectorAddressObj`: `PubKeyAddress`; `lovelacePrice`: `number` \| `bigint`; `nftIndex`: `number` \| `bigint`; `oracleNftPolicyId`: `string`; `oracleUtxo`: `UTxO`; `policyId`: `string`; \}\> + +Defined in: mesh-contract/src/plutus-nft/offchain.ts:233 + +Get the current oracle data. + +#### Returns + +`Promise`\<\{ `feeCollectorAddress`: `string`; `feeCollectorAddressObj`: `PubKeyAddress`; `lovelacePrice`: `number` \| `bigint`; `nftIndex`: `number` \| `bigint`; `oracleNftPolicyId`: `string`; `oracleUtxo`: `UTxO`; `policyId`: `string`; \}\> + +- Oracle data + +#### Example + +```typescript +const oracleData = await contract.getOracleData(); +``` + +*** + +### getOracleNFTCbor() + +> **getOracleNFTCbor**(): `string` + +Defined in: mesh-contract/src/plutus-nft/offchain.ts:46 + +#### Returns + +`string` + +*** + +### getScriptAddress() + +> **getScriptAddress**(`scriptCbor`): `string` + +Defined in: mesh-contract/src/common.ts:69 + +#### Parameters + +##### scriptCbor + +`string` + +#### Returns + +`string` + +#### Inherited from + +`MeshTxInitiator.getScriptAddress` + +*** + +### getUtxoByTxHash() + +> **getUtxoByTxHash**(`txHash`): `Promise`\<`undefined` \| `UTxO`\> + +Defined in: mesh-contract/src/plutus-nft/offchain.ts:263 + +#### Parameters + +##### txHash + +`string` + +#### Returns + +`Promise`\<`undefined` \| `UTxO`\> + +*** + +### getWalletCollateral() + +> `protected` **getWalletCollateral**(): `Promise`\<`undefined` \| `UTxO`\> + +Defined in: mesh-contract/src/common.ts:107 + +#### Returns + +`Promise`\<`undefined` \| `UTxO`\> + +#### Inherited from + +`MeshTxInitiator.getWalletCollateral` + +*** + +### getWalletDappAddress() + +> `protected` **getWalletDappAddress**(): `Promise`\<`undefined` \| `string`\> + +Defined in: mesh-contract/src/common.ts:93 + +#### Returns + +`Promise`\<`undefined` \| `string`\> + +#### Inherited from + +`MeshTxInitiator.getWalletDappAddress` + +*** + +### getWalletInfoForTx() + +> `protected` **getWalletInfoForTx**(): `Promise`\<\{ `collateral`: `UTxO`; `utxos`: `UTxO`[]; `walletAddress`: `string`; \}\> + +Defined in: mesh-contract/src/common.ts:181 + +#### Returns + +`Promise`\<\{ `collateral`: `UTxO`; `utxos`: `UTxO`[]; `walletAddress`: `string`; \}\> + +#### Inherited from + +`MeshTxInitiator.getWalletInfoForTx` + +*** + +### getWalletUtxosWithMinLovelace() + +> `protected` **getWalletUtxosWithMinLovelace**(`lovelace`, `providedUtxos`): `Promise`\<`UTxO`[]\> + +Defined in: mesh-contract/src/common.ts:115 + +#### Parameters + +##### lovelace + +`number` + +##### providedUtxos + +`UTxO`[] = `[]` + +#### Returns + +`Promise`\<`UTxO`[]\> + +#### Inherited from + +`MeshTxInitiator.getWalletUtxosWithMinLovelace` + +*** + +### getWalletUtxosWithToken() + +> `protected` **getWalletUtxosWithToken**(`assetHex`, `userUtxos`): `Promise`\<`UTxO`[]\> + +Defined in: mesh-contract/src/common.ts:131 + +#### Parameters + +##### assetHex + +`string` + +##### userUtxos + +`UTxO`[] = `[]` + +#### Returns + +`Promise`\<`UTxO`[]\> + +#### Inherited from + +`MeshTxInitiator.getWalletUtxosWithToken` + +*** + +### mintPlutusNFT() + +> **mintPlutusNFT**(`assetMetadata?`): `Promise`\<`string`\> + +Defined in: mesh-contract/src/plutus-nft/offchain.ts:158 + +Mint NFT token with an automatically incremented index, which increases by one for each newly minted NFT. + +#### Parameters + +##### assetMetadata? + +`any` + +Asset metadata + +#### Returns + +`Promise`\<`string`\> + +- Transaction hex + +#### Example + +```typescript +const assetMetadata = { + ...demoAssetMetadata, +name: `Mesh Token ${oracleData.nftIndex}`, +}; +const tx = await contract.mintPlutusNFT(assetMetadata); +``` + +*** + +### queryUtxos() + +> `protected` **queryUtxos**(`walletAddress`): `Promise`\<`UTxO`[]\> + +Defined in: mesh-contract/src/common.ts:85 + +#### Parameters + +##### walletAddress + +`string` + +#### Returns + +`Promise`\<`UTxO`[]\> + +#### Inherited from + +`MeshTxInitiator.queryUtxos` + +*** + +### setupOracle() + +> **setupOracle**(`lovelacePrice`): `Promise`\<\{ `paramUtxo`: `TxInput`; `tx`: `string`; \}\> + +Defined in: mesh-contract/src/plutus-nft/offchain.ts:92 + +Set up a one-time minting policy by minting an oracle token. This oracle token is essential as it holds the current state and index of the NFTs, acting as a reference for the minting sequence. + +#### Parameters + +##### lovelacePrice + +`number` + +Price of the NFT in lovelace + +#### Returns + +`Promise`\<\{ `paramUtxo`: `TxInput`; `tx`: `string`; \}\> + +- Transaction hex and paramUtxo + +#### Example + +```typescript +const { tx, paramUtxo } = await contract.setupOracle(lovelacePrice); +``` + +*** + +### signSubmitReset() + +> `protected` **signSubmitReset**(): `Promise`\<`undefined` \| `string`\> + +Defined in: mesh-contract/src/common.ts:78 + +#### Returns + +`Promise`\<`undefined` \| `string`\> + +#### Inherited from + +`MeshTxInitiator.signSubmitReset` diff --git a/docs/markdown/mesh-contracts/classes/MeshSwapContract.md b/docs/markdown/mesh-contracts/classes/MeshSwapContract.md new file mode 100644 index 000000000..beb7f2bf2 --- /dev/null +++ b/docs/markdown/mesh-contracts/classes/MeshSwapContract.md @@ -0,0 +1,469 @@ +[**@meshsdk/contract**](../README.md) + +*** + +[@meshsdk/contract](../globals.md) / MeshSwapContract + +# Class: MeshSwapContract + +Defined in: mesh-contract/src/swap/offchain.ts:27 + +## Extends + +- `MeshTxInitiator` + +## Constructors + +### Constructor + +> **new MeshSwapContract**(`inputs`): `MeshSwapContract` + +Defined in: mesh-contract/src/swap/offchain.ts:31 + +#### Parameters + +##### inputs + +`MeshTxInitiatorInput` + +#### Returns + +`MeshSwapContract` + +#### Overrides + +`MeshTxInitiator.constructor` + +## Properties + +### fetcher? + +> `optional` **fetcher**: `IFetcher` + +Defined in: mesh-contract/src/common.ts:23 + +#### Inherited from + +`MeshTxInitiator.fetcher` + +*** + +### languageVersion + +> **languageVersion**: `"V1"` \| `"V2"` \| `"V3"` = `"V2"` + +Defined in: mesh-contract/src/common.ts:28 + +#### Inherited from + +`MeshTxInitiator.languageVersion` + +*** + +### mesh + +> **mesh**: `MeshTxBuilder` + +Defined in: mesh-contract/src/common.ts:22 + +#### Inherited from + +`MeshTxInitiator.mesh` + +*** + +### networkId + +> **networkId**: `number` = `0` + +Defined in: mesh-contract/src/common.ts:26 + +#### Inherited from + +`MeshTxInitiator.networkId` + +*** + +### scriptAddress + +> **scriptAddress**: `string` + +Defined in: mesh-contract/src/swap/offchain.ts:29 + +*** + +### scriptCbor + +> **scriptCbor**: `string` + +Defined in: mesh-contract/src/swap/offchain.ts:28 + +*** + +### stakeCredential? + +> `optional` **stakeCredential**: `string` + +Defined in: mesh-contract/src/common.ts:25 + +#### Inherited from + +`MeshTxInitiator.stakeCredential` + +*** + +### version + +> **version**: `number` = `2` + +Defined in: mesh-contract/src/common.ts:27 + +#### Inherited from + +`MeshTxInitiator.version` + +*** + +### wallet? + +> `optional` **wallet**: `IWallet` + +Defined in: mesh-contract/src/common.ts:24 + +#### Inherited from + +`MeshTxInitiator.wallet` + +## Methods + +### \_getUtxoByTxHash() + +> `protected` **\_getUtxoByTxHash**(`txHash`, `scriptCbor?`): `Promise`\<`undefined` \| `UTxO`\> + +Defined in: mesh-contract/src/common.ts:197 + +#### Parameters + +##### txHash + +`string` + +##### scriptCbor? + +`string` + +#### Returns + +`Promise`\<`undefined` \| `UTxO`\> + +#### Inherited from + +`MeshTxInitiator._getUtxoByTxHash` + +*** + +### acceptSwap() + +> **acceptSwap**(`swapUtxo`): `Promise`\<`string`\> + +Defined in: mesh-contract/src/swap/offchain.ts:76 + +#### Parameters + +##### swapUtxo + +`UTxO` + +#### Returns + +`Promise`\<`string`\> + +*** + +### cancelSwap() + +> **cancelSwap**(`swapUtxo`): `Promise`\<`string`\> + +Defined in: mesh-contract/src/swap/offchain.ts:115 + +#### Parameters + +##### swapUtxo + +`UTxO` + +#### Returns + +`Promise`\<`string`\> + +*** + +### getAddressUtxosWithMinLovelace() + +> `protected` **getAddressUtxosWithMinLovelace**(`walletAddress`, `lovelace`, `providedUtxos`): `Promise`\<`UTxO`[]\> + +Defined in: mesh-contract/src/common.ts:147 + +#### Parameters + +##### walletAddress + +`string` + +##### lovelace + +`number` + +##### providedUtxos + +`UTxO`[] = `[]` + +#### Returns + +`Promise`\<`UTxO`[]\> + +#### Inherited from + +`MeshTxInitiator.getAddressUtxosWithMinLovelace` + +*** + +### getAddressUtxosWithToken() + +> `protected` **getAddressUtxosWithToken**(`walletAddress`, `assetHex`, `userUtxos`): `Promise`\<`UTxO`[]\> + +Defined in: mesh-contract/src/common.ts:164 + +#### Parameters + +##### walletAddress + +`string` + +##### assetHex + +`string` + +##### userUtxos + +`UTxO`[] = `[]` + +#### Returns + +`Promise`\<`UTxO`[]\> + +#### Inherited from + +`MeshTxInitiator.getAddressUtxosWithToken` + +*** + +### getScriptAddress() + +> **getScriptAddress**(`scriptCbor`): `string` + +Defined in: mesh-contract/src/common.ts:69 + +#### Parameters + +##### scriptCbor + +`string` + +#### Returns + +`string` + +#### Inherited from + +`MeshTxInitiator.getScriptAddress` + +*** + +### getScriptCbor() + +> **getScriptCbor**(): `string` + +Defined in: mesh-contract/src/swap/offchain.ts:37 + +#### Returns + +`string` + +*** + +### getUtxoByTxHash() + +> **getUtxoByTxHash**(`txHash`): `Promise`\<`undefined` \| `UTxO`\> + +Defined in: mesh-contract/src/swap/offchain.ts:149 + +#### Parameters + +##### txHash + +`string` + +#### Returns + +`Promise`\<`undefined` \| `UTxO`\> + +*** + +### getWalletCollateral() + +> `protected` **getWalletCollateral**(): `Promise`\<`undefined` \| `UTxO`\> + +Defined in: mesh-contract/src/common.ts:107 + +#### Returns + +`Promise`\<`undefined` \| `UTxO`\> + +#### Inherited from + +`MeshTxInitiator.getWalletCollateral` + +*** + +### getWalletDappAddress() + +> `protected` **getWalletDappAddress**(): `Promise`\<`undefined` \| `string`\> + +Defined in: mesh-contract/src/common.ts:93 + +#### Returns + +`Promise`\<`undefined` \| `string`\> + +#### Inherited from + +`MeshTxInitiator.getWalletDappAddress` + +*** + +### getWalletInfoForTx() + +> `protected` **getWalletInfoForTx**(): `Promise`\<\{ `collateral`: `UTxO`; `utxos`: `UTxO`[]; `walletAddress`: `string`; \}\> + +Defined in: mesh-contract/src/common.ts:181 + +#### Returns + +`Promise`\<\{ `collateral`: `UTxO`; `utxos`: `UTxO`[]; `walletAddress`: `string`; \}\> + +#### Inherited from + +`MeshTxInitiator.getWalletInfoForTx` + +*** + +### getWalletUtxosWithMinLovelace() + +> `protected` **getWalletUtxosWithMinLovelace**(`lovelace`, `providedUtxos`): `Promise`\<`UTxO`[]\> + +Defined in: mesh-contract/src/common.ts:115 + +#### Parameters + +##### lovelace + +`number` + +##### providedUtxos + +`UTxO`[] = `[]` + +#### Returns + +`Promise`\<`UTxO`[]\> + +#### Inherited from + +`MeshTxInitiator.getWalletUtxosWithMinLovelace` + +*** + +### getWalletUtxosWithToken() + +> `protected` **getWalletUtxosWithToken**(`assetHex`, `userUtxos`): `Promise`\<`UTxO`[]\> + +Defined in: mesh-contract/src/common.ts:131 + +#### Parameters + +##### assetHex + +`string` + +##### userUtxos + +`UTxO`[] = `[]` + +#### Returns + +`Promise`\<`UTxO`[]\> + +#### Inherited from + +`MeshTxInitiator.getWalletUtxosWithToken` + +*** + +### initiateSwap() + +> **initiateSwap**(`toProvide`, `toReceive`): `Promise`\<`string`\> + +Defined in: mesh-contract/src/swap/offchain.ts:46 + +#### Parameters + +##### toProvide + +`Asset`[] + +##### toReceive + +`Asset`[] + +#### Returns + +`Promise`\<`string`\> + +*** + +### queryUtxos() + +> `protected` **queryUtxos**(`walletAddress`): `Promise`\<`UTxO`[]\> + +Defined in: mesh-contract/src/common.ts:85 + +#### Parameters + +##### walletAddress + +`string` + +#### Returns + +`Promise`\<`UTxO`[]\> + +#### Inherited from + +`MeshTxInitiator.queryUtxos` + +*** + +### signSubmitReset() + +> `protected` **signSubmitReset**(): `Promise`\<`undefined` \| `string`\> + +Defined in: mesh-contract/src/common.ts:78 + +#### Returns + +`Promise`\<`undefined` \| `string`\> + +#### Inherited from + +`MeshTxInitiator.signSubmitReset` diff --git a/docs/markdown/mesh-contracts/classes/MeshVestingContract.md b/docs/markdown/mesh-contracts/classes/MeshVestingContract.md new file mode 100644 index 000000000..f9d2d07b2 --- /dev/null +++ b/docs/markdown/mesh-contracts/classes/MeshVestingContract.md @@ -0,0 +1,455 @@ +[**@meshsdk/contract**](../README.md) + +*** + +[@meshsdk/contract](../globals.md) / MeshVestingContract + +# Class: MeshVestingContract + +Defined in: mesh-contract/src/vesting/offchain.ts:25 + +## Extends + +- `MeshTxInitiator` + +## Constructors + +### Constructor + +> **new MeshVestingContract**(`inputs`): `MeshVestingContract` + +Defined in: mesh-contract/src/vesting/offchain.ts:29 + +#### Parameters + +##### inputs + +`MeshTxInitiatorInput` + +#### Returns + +`MeshVestingContract` + +#### Overrides + +`MeshTxInitiator.constructor` + +## Properties + +### fetcher? + +> `optional` **fetcher**: `IFetcher` + +Defined in: mesh-contract/src/common.ts:23 + +#### Inherited from + +`MeshTxInitiator.fetcher` + +*** + +### languageVersion + +> **languageVersion**: `"V1"` \| `"V2"` \| `"V3"` = `"V2"` + +Defined in: mesh-contract/src/common.ts:28 + +#### Inherited from + +`MeshTxInitiator.languageVersion` + +*** + +### mesh + +> **mesh**: `MeshTxBuilder` + +Defined in: mesh-contract/src/common.ts:22 + +#### Inherited from + +`MeshTxInitiator.mesh` + +*** + +### networkId + +> **networkId**: `number` = `0` + +Defined in: mesh-contract/src/common.ts:26 + +#### Inherited from + +`MeshTxInitiator.networkId` + +*** + +### scriptAddress + +> **scriptAddress**: `string` + +Defined in: mesh-contract/src/vesting/offchain.ts:27 + +*** + +### scriptCbor + +> **scriptCbor**: `string` + +Defined in: mesh-contract/src/vesting/offchain.ts:26 + +*** + +### stakeCredential? + +> `optional` **stakeCredential**: `string` + +Defined in: mesh-contract/src/common.ts:25 + +#### Inherited from + +`MeshTxInitiator.stakeCredential` + +*** + +### version + +> **version**: `number` = `2` + +Defined in: mesh-contract/src/common.ts:27 + +#### Inherited from + +`MeshTxInitiator.version` + +*** + +### wallet? + +> `optional` **wallet**: `IWallet` + +Defined in: mesh-contract/src/common.ts:24 + +#### Inherited from + +`MeshTxInitiator.wallet` + +## Methods + +### \_getUtxoByTxHash() + +> `protected` **\_getUtxoByTxHash**(`txHash`, `scriptCbor?`): `Promise`\<`undefined` \| `UTxO`\> + +Defined in: mesh-contract/src/common.ts:197 + +#### Parameters + +##### txHash + +`string` + +##### scriptCbor? + +`string` + +#### Returns + +`Promise`\<`undefined` \| `UTxO`\> + +#### Inherited from + +`MeshTxInitiator._getUtxoByTxHash` + +*** + +### depositFund() + +> **depositFund**(`amount`, `lockUntilTimeStampMs`, `beneficiary`): `Promise`\<`string`\> + +Defined in: mesh-contract/src/vesting/offchain.ts:44 + +#### Parameters + +##### amount + +`Asset`[] + +##### lockUntilTimeStampMs + +`number` + +##### beneficiary + +`string` + +#### Returns + +`Promise`\<`string`\> + +*** + +### getAddressUtxosWithMinLovelace() + +> `protected` **getAddressUtxosWithMinLovelace**(`walletAddress`, `lovelace`, `providedUtxos`): `Promise`\<`UTxO`[]\> + +Defined in: mesh-contract/src/common.ts:147 + +#### Parameters + +##### walletAddress + +`string` + +##### lovelace + +`number` + +##### providedUtxos + +`UTxO`[] = `[]` + +#### Returns + +`Promise`\<`UTxO`[]\> + +#### Inherited from + +`MeshTxInitiator.getAddressUtxosWithMinLovelace` + +*** + +### getAddressUtxosWithToken() + +> `protected` **getAddressUtxosWithToken**(`walletAddress`, `assetHex`, `userUtxos`): `Promise`\<`UTxO`[]\> + +Defined in: mesh-contract/src/common.ts:164 + +#### Parameters + +##### walletAddress + +`string` + +##### assetHex + +`string` + +##### userUtxos + +`UTxO`[] = `[]` + +#### Returns + +`Promise`\<`UTxO`[]\> + +#### Inherited from + +`MeshTxInitiator.getAddressUtxosWithToken` + +*** + +### getScriptAddress() + +> **getScriptAddress**(`scriptCbor`): `string` + +Defined in: mesh-contract/src/common.ts:69 + +#### Parameters + +##### scriptCbor + +`string` + +#### Returns + +`string` + +#### Inherited from + +`MeshTxInitiator.getScriptAddress` + +*** + +### getScriptCbor() + +> **getScriptCbor**(): `string` + +Defined in: mesh-contract/src/vesting/offchain.ts:35 + +#### Returns + +`string` + +*** + +### getUtxoByTxHash() + +> **getUtxoByTxHash**(`txHash`): `Promise`\<`undefined` \| `UTxO`\> + +Defined in: mesh-contract/src/vesting/offchain.ts:115 + +#### Parameters + +##### txHash + +`string` + +#### Returns + +`Promise`\<`undefined` \| `UTxO`\> + +*** + +### getWalletCollateral() + +> `protected` **getWalletCollateral**(): `Promise`\<`undefined` \| `UTxO`\> + +Defined in: mesh-contract/src/common.ts:107 + +#### Returns + +`Promise`\<`undefined` \| `UTxO`\> + +#### Inherited from + +`MeshTxInitiator.getWalletCollateral` + +*** + +### getWalletDappAddress() + +> `protected` **getWalletDappAddress**(): `Promise`\<`undefined` \| `string`\> + +Defined in: mesh-contract/src/common.ts:93 + +#### Returns + +`Promise`\<`undefined` \| `string`\> + +#### Inherited from + +`MeshTxInitiator.getWalletDappAddress` + +*** + +### getWalletInfoForTx() + +> `protected` **getWalletInfoForTx**(): `Promise`\<\{ `collateral`: `UTxO`; `utxos`: `UTxO`[]; `walletAddress`: `string`; \}\> + +Defined in: mesh-contract/src/common.ts:181 + +#### Returns + +`Promise`\<\{ `collateral`: `UTxO`; `utxos`: `UTxO`[]; `walletAddress`: `string`; \}\> + +#### Inherited from + +`MeshTxInitiator.getWalletInfoForTx` + +*** + +### getWalletUtxosWithMinLovelace() + +> `protected` **getWalletUtxosWithMinLovelace**(`lovelace`, `providedUtxos`): `Promise`\<`UTxO`[]\> + +Defined in: mesh-contract/src/common.ts:115 + +#### Parameters + +##### lovelace + +`number` + +##### providedUtxos + +`UTxO`[] = `[]` + +#### Returns + +`Promise`\<`UTxO`[]\> + +#### Inherited from + +`MeshTxInitiator.getWalletUtxosWithMinLovelace` + +*** + +### getWalletUtxosWithToken() + +> `protected` **getWalletUtxosWithToken**(`assetHex`, `userUtxos`): `Promise`\<`UTxO`[]\> + +Defined in: mesh-contract/src/common.ts:131 + +#### Parameters + +##### assetHex + +`string` + +##### userUtxos + +`UTxO`[] = `[]` + +#### Returns + +`Promise`\<`UTxO`[]\> + +#### Inherited from + +`MeshTxInitiator.getWalletUtxosWithToken` + +*** + +### queryUtxos() + +> `protected` **queryUtxos**(`walletAddress`): `Promise`\<`UTxO`[]\> + +Defined in: mesh-contract/src/common.ts:85 + +#### Parameters + +##### walletAddress + +`string` + +#### Returns + +`Promise`\<`UTxO`[]\> + +#### Inherited from + +`MeshTxInitiator.queryUtxos` + +*** + +### signSubmitReset() + +> `protected` **signSubmitReset**(): `Promise`\<`undefined` \| `string`\> + +Defined in: mesh-contract/src/common.ts:78 + +#### Returns + +`Promise`\<`undefined` \| `string`\> + +#### Inherited from + +`MeshTxInitiator.signSubmitReset` + +*** + +### withdrawFund() + +> **withdrawFund**(`vestingUtxo`): `Promise`\<`string`\> + +Defined in: mesh-contract/src/vesting/offchain.ts:70 + +#### Parameters + +##### vestingUtxo + +`UTxO` + +#### Returns + +`Promise`\<`string`\> diff --git a/docs/markdown/mesh-contracts/functions/activeEscrowDatum.md b/docs/markdown/mesh-contracts/functions/activeEscrowDatum.md new file mode 100644 index 000000000..45ac23436 --- /dev/null +++ b/docs/markdown/mesh-contracts/functions/activeEscrowDatum.md @@ -0,0 +1,29 @@ +[**@meshsdk/contract**](../README.md) + +*** + +[@meshsdk/contract](../globals.md) / activeEscrowDatum + +# Function: activeEscrowDatum() + +> **activeEscrowDatum**(`initiationDatum`, `walletAddress`, `amount`): [`ActiveEscrowDatum`](../type-aliases/ActiveEscrowDatum.md) + +Defined in: mesh-contract/src/escrow/offchain.ts:45 + +## Parameters + +### initiationDatum + +[`InitiationDatum`](../type-aliases/InitiationDatum.md) + +### walletAddress + +`string` + +### amount + +`Asset`[] + +## Returns + +[`ActiveEscrowDatum`](../type-aliases/ActiveEscrowDatum.md) diff --git a/docs/markdown/mesh-contracts/functions/initiateEscrowDatum.md b/docs/markdown/mesh-contracts/functions/initiateEscrowDatum.md new file mode 100644 index 000000000..7a3faac6d --- /dev/null +++ b/docs/markdown/mesh-contracts/functions/initiateEscrowDatum.md @@ -0,0 +1,25 @@ +[**@meshsdk/contract**](../README.md) + +*** + +[@meshsdk/contract](../globals.md) / initiateEscrowDatum + +# Function: initiateEscrowDatum() + +> **initiateEscrowDatum**(`walletAddress`, `amount`): [`InitiationDatum`](../type-aliases/InitiationDatum.md) + +Defined in: mesh-contract/src/escrow/offchain.ts:31 + +## Parameters + +### walletAddress + +`string` + +### amount + +`Asset`[] + +## Returns + +[`InitiationDatum`](../type-aliases/InitiationDatum.md) diff --git a/docs/markdown/mesh-contracts/functions/marketplaceDatum.md b/docs/markdown/mesh-contracts/functions/marketplaceDatum.md new file mode 100644 index 000000000..a2b9bd4a4 --- /dev/null +++ b/docs/markdown/mesh-contracts/functions/marketplaceDatum.md @@ -0,0 +1,29 @@ +[**@meshsdk/contract**](../README.md) + +*** + +[@meshsdk/contract](../globals.md) / marketplaceDatum + +# Function: marketplaceDatum() + +> **marketplaceDatum**(`sellerAddress`, `lovelaceFee`, `assetHex`): [`MarketplaceDatum`](../type-aliases/MarketplaceDatum.md) + +Defined in: mesh-contract/src/marketplace/offchain.ts:33 + +## Parameters + +### sellerAddress + +`string` + +### lovelaceFee + +`number` + +### assetHex + +`string` + +## Returns + +[`MarketplaceDatum`](../type-aliases/MarketplaceDatum.md) diff --git a/docs/markdown/mesh-contracts/functions/recipientDepositRedeemer.md b/docs/markdown/mesh-contracts/functions/recipientDepositRedeemer.md new file mode 100644 index 000000000..7ac8497ce --- /dev/null +++ b/docs/markdown/mesh-contracts/functions/recipientDepositRedeemer.md @@ -0,0 +1,25 @@ +[**@meshsdk/contract**](../README.md) + +*** + +[@meshsdk/contract](../globals.md) / recipientDepositRedeemer + +# Function: recipientDepositRedeemer() + +> **recipientDepositRedeemer**(`recipient`, `depositAmount`): [`InitiationDatum`](../type-aliases/InitiationDatum.md) + +Defined in: mesh-contract/src/escrow/offchain.ts:61 + +## Parameters + +### recipient + +`string` + +### depositAmount + +`Asset`[] + +## Returns + +[`InitiationDatum`](../type-aliases/InitiationDatum.md) diff --git a/docs/markdown/mesh-contracts/globals.md b/docs/markdown/mesh-contracts/globals.md new file mode 100644 index 000000000..0a2af4108 --- /dev/null +++ b/docs/markdown/mesh-contracts/globals.md @@ -0,0 +1,34 @@ +[**@meshsdk/contract**](README.md) + +*** + +# @meshsdk/contract + +## Classes + +- [MeshContentOwnershipContract](classes/MeshContentOwnershipContract.md) +- [MeshEscrowContract](classes/MeshEscrowContract.md) +- [MeshGiftCardContract](classes/MeshGiftCardContract.md) +- [MeshHelloWorldContract](classes/MeshHelloWorldContract.md) +- [MeshMarketplaceContract](classes/MeshMarketplaceContract.md) +- [MeshPaymentSplitterContract](classes/MeshPaymentSplitterContract.md) +- [MeshPlutusNFTContract](classes/MeshPlutusNFTContract.md) +- [MeshSwapContract](classes/MeshSwapContract.md) +- [MeshVestingContract](classes/MeshVestingContract.md) + +## Type Aliases + +- [ActiveEscrowDatum](type-aliases/ActiveEscrowDatum.md) +- [HelloWorldDatum](type-aliases/HelloWorldDatum.md) +- [InitiationDatum](type-aliases/InitiationDatum.md) +- [MarketplaceDatum](type-aliases/MarketplaceDatum.md) +- [RecipientDepositRedeemer](type-aliases/RecipientDepositRedeemer.md) +- [SwapDatum](type-aliases/SwapDatum.md) +- [VestingDatum](type-aliases/VestingDatum.md) + +## Functions + +- [activeEscrowDatum](functions/activeEscrowDatum.md) +- [initiateEscrowDatum](functions/initiateEscrowDatum.md) +- [marketplaceDatum](functions/marketplaceDatum.md) +- [recipientDepositRedeemer](functions/recipientDepositRedeemer.md) diff --git a/docs/markdown/mesh-contracts/type-aliases/ActiveEscrowDatum.md b/docs/markdown/mesh-contracts/type-aliases/ActiveEscrowDatum.md new file mode 100644 index 000000000..78bbb29f5 --- /dev/null +++ b/docs/markdown/mesh-contracts/type-aliases/ActiveEscrowDatum.md @@ -0,0 +1,11 @@ +[**@meshsdk/contract**](../README.md) + +*** + +[@meshsdk/contract](../globals.md) / ActiveEscrowDatum + +# Type Alias: ActiveEscrowDatum + +> **ActiveEscrowDatum** = `ConStr1`\<\[`PubKeyAddress`, `Value`, `PubKeyAddress`, `Value`\]\> + +Defined in: mesh-contract/src/escrow/offchain.ts:42 diff --git a/docs/markdown/mesh-contracts/type-aliases/HelloWorldDatum.md b/docs/markdown/mesh-contracts/type-aliases/HelloWorldDatum.md new file mode 100644 index 000000000..a5af86798 --- /dev/null +++ b/docs/markdown/mesh-contracts/type-aliases/HelloWorldDatum.md @@ -0,0 +1,11 @@ +[**@meshsdk/contract**](../README.md) + +*** + +[@meshsdk/contract](../globals.md) / HelloWorldDatum + +# Type Alias: HelloWorldDatum + +> **HelloWorldDatum** = `ConStr0`\<\[`Integer`, `BuiltinByteString`, `BuiltinByteString`\]\> + +Defined in: mesh-contract/src/hello-world/offchain.ts:17 diff --git a/docs/markdown/mesh-contracts/type-aliases/InitiationDatum.md b/docs/markdown/mesh-contracts/type-aliases/InitiationDatum.md new file mode 100644 index 000000000..3995ca81e --- /dev/null +++ b/docs/markdown/mesh-contracts/type-aliases/InitiationDatum.md @@ -0,0 +1,11 @@ +[**@meshsdk/contract**](../README.md) + +*** + +[@meshsdk/contract](../globals.md) / InitiationDatum + +# Type Alias: InitiationDatum + +> **InitiationDatum** = `ConStr0`\<\[`PubKeyAddress`, `Value`\]\> + +Defined in: mesh-contract/src/escrow/offchain.ts:30 diff --git a/docs/markdown/mesh-contracts/type-aliases/MarketplaceDatum.md b/docs/markdown/mesh-contracts/type-aliases/MarketplaceDatum.md new file mode 100644 index 000000000..14071797b --- /dev/null +++ b/docs/markdown/mesh-contracts/type-aliases/MarketplaceDatum.md @@ -0,0 +1,11 @@ +[**@meshsdk/contract**](../README.md) + +*** + +[@meshsdk/contract](../globals.md) / MarketplaceDatum + +# Type Alias: MarketplaceDatum + +> **MarketplaceDatum** = `ConStr0`\<\[`PubKeyAddress`, `Integer`, `CurrencySymbol`, `TokenName`\]\> + +Defined in: mesh-contract/src/marketplace/offchain.ts:30 diff --git a/docs/markdown/mesh-contracts/type-aliases/RecipientDepositRedeemer.md b/docs/markdown/mesh-contracts/type-aliases/RecipientDepositRedeemer.md new file mode 100644 index 000000000..47be63427 --- /dev/null +++ b/docs/markdown/mesh-contracts/type-aliases/RecipientDepositRedeemer.md @@ -0,0 +1,11 @@ +[**@meshsdk/contract**](../README.md) + +*** + +[@meshsdk/contract](../globals.md) / RecipientDepositRedeemer + +# Type Alias: RecipientDepositRedeemer + +> **RecipientDepositRedeemer** = `ConStr0`\<\[`PubKeyAddress`, `Value`\]\> + +Defined in: mesh-contract/src/escrow/offchain.ts:60 diff --git a/docs/markdown/mesh-contracts/type-aliases/SwapDatum.md b/docs/markdown/mesh-contracts/type-aliases/SwapDatum.md new file mode 100644 index 000000000..a3e591b9b --- /dev/null +++ b/docs/markdown/mesh-contracts/type-aliases/SwapDatum.md @@ -0,0 +1,11 @@ +[**@meshsdk/contract**](../README.md) + +*** + +[@meshsdk/contract](../globals.md) / SwapDatum + +# Type Alias: SwapDatum + +> **SwapDatum** = `ConStr0`\<\[`PubKeyAddress`, `Value`, `Value`\]\> + +Defined in: mesh-contract/src/swap/offchain.ts:25 diff --git a/docs/markdown/mesh-contracts/type-aliases/VestingDatum.md b/docs/markdown/mesh-contracts/type-aliases/VestingDatum.md new file mode 100644 index 000000000..c9eebc3a5 --- /dev/null +++ b/docs/markdown/mesh-contracts/type-aliases/VestingDatum.md @@ -0,0 +1,11 @@ +[**@meshsdk/contract**](../README.md) + +*** + +[@meshsdk/contract](../globals.md) / VestingDatum + +# Type Alias: VestingDatum + +> **VestingDatum** = `ConStr0`\<\[`Integer`, `BuiltinByteString`, `BuiltinByteString`\]\> + +Defined in: mesh-contract/src/vesting/offchain.ts:21 diff --git a/docs/markdown/mesh-core-cst/README.md b/docs/markdown/mesh-core-cst/README.md new file mode 100644 index 000000000..f6834145b --- /dev/null +++ b/docs/markdown/mesh-core-cst/README.md @@ -0,0 +1,9 @@ +**@meshsdk/core-cst** + +*** + +# mesh-core-cst + +Types and utilities functions between Mesh and [cardano-js-sdk](https://github.com/input-output-hk/cardano-js-sdk) + +[meshjs.dev](https://meshjs.dev/) diff --git a/docs/markdown/mesh-core-cst/classes/CardanoSDKSerializer.md b/docs/markdown/mesh-core-cst/classes/CardanoSDKSerializer.md new file mode 100644 index 000000000..8c7b2ff81 --- /dev/null +++ b/docs/markdown/mesh-core-cst/classes/CardanoSDKSerializer.md @@ -0,0 +1,297 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / CardanoSDKSerializer + +# Class: CardanoSDKSerializer + +Defined in: packages/mesh-core-cst/src/serializer/index.ts:136 + +## Implements + +- `IMeshTxSerializer` + +## Constructors + +### Constructor + +> **new CardanoSDKSerializer**(`protocolParams?`): `CardanoSDKSerializer` + +Defined in: packages/mesh-core-cst/src/serializer/index.ts:139 + +#### Parameters + +##### protocolParams? + +`Protocol` + +#### Returns + +`CardanoSDKSerializer` + +## Properties + +### deserializer + +> **deserializer**: `IDeserializer` + +Defined in: packages/mesh-core-cst/src/serializer/index.ts:242 + +#### Implementation of + +`IMeshTxSerializer.deserializer` + +*** + +### parser + +> **parser**: `ITxParser` + +Defined in: packages/mesh-core-cst/src/serializer/index.ts:546 + +#### Implementation of + +`IMeshTxSerializer.parser` + +*** + +### protocolParams + +> **protocolParams**: `Protocol` + +Defined in: packages/mesh-core-cst/src/serializer/index.ts:137 + +*** + +### resolver + +> **resolver**: `IResolver` + +Defined in: packages/mesh-core-cst/src/serializer/index.ts:313 + +#### Implementation of + +`IMeshTxSerializer.resolver` + +## Methods + +### addSigningKeys() + +> **addSigningKeys**(`txHex`, `signingKeys`): `string` + +Defined in: packages/mesh-core-cst/src/serializer/index.ts:455 + +#### Parameters + +##### txHex + +`string` + +##### signingKeys + +`string`[] + +#### Returns + +`string` + +#### Implementation of + +`IMeshTxSerializer.addSigningKeys` + +*** + +### serializeAddress() + +> **serializeAddress**(`address`, `networkId?`): `string` + +Defined in: packages/mesh-core-cst/src/serializer/index.ts:160 + +#### Parameters + +##### address + +`Partial`\<`DeserializedAddress`\> + +##### networkId? + +`0` | `1` + +#### Returns + +`string` + +#### Implementation of + +`IMeshTxSerializer.serializeAddress` + +*** + +### serializeData() + +> **serializeData**(`data`): `string` + +Defined in: packages/mesh-core-cst/src/serializer/index.ts:237 + +#### Parameters + +##### data + +`BuilderData` + +#### Returns + +`string` + +#### Implementation of + +`IMeshTxSerializer.serializeData` + +*** + +### serializeOutput() + +> **serializeOutput**(`output`): `string` + +Defined in: packages/mesh-core-cst/src/serializer/index.ts:491 + +#### Parameters + +##### output + +`Output` + +#### Returns + +`string` + +#### Implementation of + +`IMeshTxSerializer.serializeOutput` + +*** + +### serializePoolId() + +> **serializePoolId**(`hash`): `string` + +Defined in: packages/mesh-core-cst/src/serializer/index.ts:156 + +#### Parameters + +##### hash + +`string` + +#### Returns + +`string` + +#### Implementation of + +`IMeshTxSerializer.serializePoolId` + +*** + +### serializeRewardAddress() + +> **serializeRewardAddress**(`stakeKeyHash`, `isScriptHash?`, `network_id?`): `string` + +Defined in: packages/mesh-core-cst/src/serializer/index.ts:143 + +#### Parameters + +##### stakeKeyHash + +`string` + +##### isScriptHash? + +`boolean` + +##### network\_id? + +`0` | `1` + +#### Returns + +`string` + +#### Implementation of + +`IMeshTxSerializer.serializeRewardAddress` + +*** + +### serializeTxBody() + +> **serializeTxBody**(`txBuilderBody`, `protocolParams?`): `string` + +Defined in: packages/mesh-core-cst/src/serializer/index.ts:436 + +#### Parameters + +##### txBuilderBody + +`MeshTxBuilderBody` + +##### protocolParams? + +`Protocol` + +#### Returns + +`string` + +#### Implementation of + +`IMeshTxSerializer.serializeTxBody` + +*** + +### serializeTxBodyWithMockSignatures() + +> **serializeTxBodyWithMockSignatures**(`txBuilderBody`, `protocolParams`): `string` + +Defined in: packages/mesh-core-cst/src/serializer/index.ts:447 + +#### Parameters + +##### txBuilderBody + +`MeshTxBuilderBody` + +##### protocolParams + +`Protocol` + +#### Returns + +`string` + +#### Implementation of + +`IMeshTxSerializer.serializeTxBodyWithMockSignatures` + +*** + +### serializeValue() + +> **serializeValue**(`value`): `string` + +Defined in: packages/mesh-core-cst/src/serializer/index.ts:487 + +#### Parameters + +##### value + +`Asset`[] + +#### Returns + +`string` + +#### Implementation of + +`IMeshTxSerializer.serializeValue` diff --git a/docs/markdown/mesh-core-cst/classes/CoseSign1.md b/docs/markdown/mesh-core-cst/classes/CoseSign1.md new file mode 100644 index 000000000..c6c1b715c --- /dev/null +++ b/docs/markdown/mesh-core-cst/classes/CoseSign1.md @@ -0,0 +1,179 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / CoseSign1 + +# Class: CoseSign1 + +Defined in: packages/mesh-core-cst/src/message-signing/cose-sign1.ts:22 + +## Constructors + +### Constructor + +> **new CoseSign1**(`payload`): `CoseSign1` + +Defined in: packages/mesh-core-cst/src/message-signing/cose-sign1.ts:31 + +#### Parameters + +##### payload + +###### payload + +`null` \| `CborBytes` + +###### protectedMap + +`CborMap` + +###### signature? + +`CborBytes` + +###### unProtectedMap + +`CborMap` + +#### Returns + +`CoseSign1` + +## Methods + +### buildMessage() + +> **buildMessage**(`signature`): `Buffer` + +Defined in: packages/mesh-core-cst/src/message-signing/cose-sign1.ts:114 + +#### Parameters + +##### signature + +`Buffer` + +#### Returns + +`Buffer` + +*** + +### createSigStructure() + +> **createSigStructure**(`externalAad`): `Buffer` + +Defined in: packages/mesh-core-cst/src/message-signing/cose-sign1.ts:93 + +#### Parameters + +##### externalAad + +`Buffer` = `...` + +#### Returns + +`Buffer` + +*** + +### getAddress() + +> **getAddress**(): `Buffer` + +Defined in: packages/mesh-core-cst/src/message-signing/cose-sign1.ts:190 + +#### Returns + +`Buffer` + +*** + +### getPayload() + +> **getPayload**(): `null` \| `Buffer` + +Defined in: packages/mesh-core-cst/src/message-signing/cose-sign1.ts:213 + +#### Returns + +`null` \| `Buffer` + +*** + +### getPublicKey() + +> **getPublicKey**(): `Buffer` + +Defined in: packages/mesh-core-cst/src/message-signing/cose-sign1.ts:201 + +#### Returns + +`Buffer` + +*** + +### getSignature() + +> **getSignature**(): `undefined` \| `Buffer` + +Defined in: packages/mesh-core-cst/src/message-signing/cose-sign1.ts:209 + +#### Returns + +`undefined` \| `Buffer` + +*** + +### hashPayload() + +> **hashPayload**(): `void` + +Defined in: packages/mesh-core-cst/src/message-signing/cose-sign1.ts:160 + +#### Returns + +`void` + +*** + +### verifySignature() + +> **verifySignature**(`__namedParameters`): `boolean` + +Defined in: packages/mesh-core-cst/src/message-signing/cose-sign1.ts:136 + +#### Parameters + +##### \_\_namedParameters + +###### externalAad? + +`Buffer` = `...` + +###### publicKeyBuffer? + +`Buffer` + +#### Returns + +`boolean` + +*** + +### fromCbor() + +> `static` **fromCbor**(`cbor`): `CoseSign1` + +Defined in: packages/mesh-core-cst/src/message-signing/cose-sign1.ts:58 + +#### Parameters + +##### cbor + +`string` + +#### Returns + +`CoseSign1` diff --git a/docs/markdown/mesh-core-cst/functions/DatumHash.md b/docs/markdown/mesh-core-cst/functions/DatumHash.md new file mode 100644 index 000000000..10c35a93d --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/DatumHash.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / DatumHash + +# Function: DatumHash() + +> **DatumHash**(`value`): `Hash32ByteBase16` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:234 + +## Parameters + +### value + +`string` + +## Returns + +`Hash32ByteBase16` diff --git a/docs/markdown/mesh-core-cst/functions/Hash32ByteBase16.md b/docs/markdown/mesh-core-cst/functions/Hash32ByteBase16.md new file mode 100644 index 000000000..bbdc30c64 --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/Hash32ByteBase16.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / Hash32ByteBase16 + +# Function: Hash32ByteBase16() + +> **Hash32ByteBase16**(`value`): `Hash32ByteBase16` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:140 + +## Parameters + +### value + +`string` + +## Returns + +`Hash32ByteBase16` diff --git a/docs/markdown/mesh-core-cst/functions/TransactionId.md b/docs/markdown/mesh-core-cst/functions/TransactionId.md new file mode 100644 index 000000000..efce0926e --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/TransactionId.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / TransactionId + +# Function: TransactionId() + +> **TransactionId**(`value`): `TransactionId` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:17 + +## Parameters + +### value + +`string` + +## Returns + +`TransactionId` diff --git a/docs/markdown/mesh-core-cst/functions/addVKeyWitnessSetToTransaction.md b/docs/markdown/mesh-core-cst/functions/addVKeyWitnessSetToTransaction.md new file mode 100644 index 000000000..f6b91b835 --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/addVKeyWitnessSetToTransaction.md @@ -0,0 +1,25 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / addVKeyWitnessSetToTransaction + +# Function: addVKeyWitnessSetToTransaction() + +> **addVKeyWitnessSetToTransaction**(`txHex`, `vkeyWitnessSet`): `string` + +Defined in: packages/mesh-core-cst/src/utils/witness-set.ts:10 + +## Parameters + +### txHex + +`string` + +### vkeyWitnessSet + +`string` + +## Returns + +`string` diff --git a/docs/markdown/mesh-core-cst/functions/addrBech32ToPlutusDataHex.md b/docs/markdown/mesh-core-cst/functions/addrBech32ToPlutusDataHex.md new file mode 100644 index 000000000..be22d6c3c --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/addrBech32ToPlutusDataHex.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / addrBech32ToPlutusDataHex + +# Function: addrBech32ToPlutusDataHex() + +> **addrBech32ToPlutusDataHex**(`bech32`): `string` + +Defined in: packages/mesh-core-cst/src/utils/address.ts:136 + +## Parameters + +### bech32 + +`string` + +## Returns + +`string` diff --git a/docs/markdown/mesh-core-cst/functions/addrBech32ToPlutusDataObj.md b/docs/markdown/mesh-core-cst/functions/addrBech32ToPlutusDataObj.md new file mode 100644 index 000000000..e05498b6d --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/addrBech32ToPlutusDataObj.md @@ -0,0 +1,27 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / addrBech32ToPlutusDataObj + +# Function: addrBech32ToPlutusDataObj() + +> **addrBech32ToPlutusDataObj**\<`T`\>(`bech32`): `T` + +Defined in: packages/mesh-core-cst/src/utils/address.ts:140 + +## Type Parameters + +### T + +`T` + +## Parameters + +### bech32 + +`string` + +## Returns + +`T` diff --git a/docs/markdown/mesh-core-cst/functions/addressToBech32.md b/docs/markdown/mesh-core-cst/functions/addressToBech32.md new file mode 100644 index 000000000..c334c40b1 --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/addressToBech32.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / addressToBech32 + +# Function: addressToBech32() + +> **addressToBech32**(`address`): `string` + +Defined in: packages/mesh-core-cst/src/utils/converter.ts:139 + +## Parameters + +### address + +`Address` + +## Returns + +`string` diff --git a/docs/markdown/mesh-core-cst/functions/applyEncoding.md b/docs/markdown/mesh-core-cst/functions/applyEncoding.md new file mode 100644 index 000000000..3609bb8d6 --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/applyEncoding.md @@ -0,0 +1,25 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / applyEncoding + +# Function: applyEncoding() + +> **applyEncoding**(`plutusScript`, `outputEncoding`): `Uint8Array` + +Defined in: packages/mesh-core-cst/src/plutus-tools/index.ts:174 + +## Parameters + +### plutusScript + +`Uint8Array` + +### outputEncoding + +[`OutputEncoding`](../type-aliases/OutputEncoding.md) + +## Returns + +`Uint8Array` diff --git a/docs/markdown/mesh-core-cst/functions/applyParamsToScript.md b/docs/markdown/mesh-core-cst/functions/applyParamsToScript.md new file mode 100644 index 000000000..cd0c3311b --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/applyParamsToScript.md @@ -0,0 +1,29 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / applyParamsToScript + +# Function: applyParamsToScript() + +> **applyParamsToScript**(`rawScript`, `params`, `type`): `string` + +Defined in: packages/mesh-core-cst/src/plutus-tools/index.ts:190 + +## Parameters + +### rawScript + +`string` + +### params + +`object`[] | `Data`[] + +### type + +`PlutusDataType` = `"Mesh"` + +## Returns + +`string` diff --git a/docs/markdown/mesh-core-cst/functions/assetTypes.md b/docs/markdown/mesh-core-cst/functions/assetTypes.md new file mode 100644 index 000000000..f1e92ebe4 --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/assetTypes.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / assetTypes + +# Function: assetTypes() + +> **assetTypes**(`v`): `number` + +Defined in: packages/mesh-core-cst/src/utils/value.ts:48 + +## Parameters + +### v + +`Value` + +## Returns + +`number` diff --git a/docs/markdown/mesh-core-cst/functions/buildBaseAddress.md b/docs/markdown/mesh-core-cst/functions/buildBaseAddress.md new file mode 100644 index 000000000..4789e149a --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/buildBaseAddress.md @@ -0,0 +1,29 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / buildBaseAddress + +# Function: buildBaseAddress() + +> **buildBaseAddress**(`networkId`, `paymentKeyHash`, `stakeKeyHash`): `BaseAddress` + +Defined in: packages/mesh-core-cst/src/utils/builder.ts:28 + +## Parameters + +### networkId + +`number` + +### paymentKeyHash + +`Hash28ByteBase16` + +### stakeKeyHash + +`Hash28ByteBase16` + +## Returns + +`BaseAddress` diff --git a/docs/markdown/mesh-core-cst/functions/buildBip32PrivateKey.md b/docs/markdown/mesh-core-cst/functions/buildBip32PrivateKey.md new file mode 100644 index 000000000..d0bb68fca --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/buildBip32PrivateKey.md @@ -0,0 +1,25 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / buildBip32PrivateKey + +# Function: buildBip32PrivateKey() + +> **buildBip32PrivateKey**(`entropy`, `password`): `Bip32PrivateKey` + +Defined in: packages/mesh-core-cst/src/utils/builder.ts:67 + +## Parameters + +### entropy + +`string` + +### password + +`string` = `""` + +## Returns + +`Bip32PrivateKey` diff --git a/docs/markdown/mesh-core-cst/functions/buildDRepID.md b/docs/markdown/mesh-core-cst/functions/buildDRepID.md new file mode 100644 index 000000000..f0001f633 --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/buildDRepID.md @@ -0,0 +1,29 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / buildDRepID + +# Function: buildDRepID() + +> **buildDRepID**(`dRepKey`, `networkId`, `addressType`): `DRepID` + +Defined in: packages/mesh-core-cst/src/utils/builder.ts:163 + +## Parameters + +### dRepKey + +`Ed25519PublicKeyHex` + +### networkId + +`NetworkId` = `NetworkId.Testnet` + +### addressType + +`AddressType` = `AddressType.EnterpriseKey` + +## Returns + +`DRepID` diff --git a/docs/markdown/mesh-core-cst/functions/buildEd25519PrivateKeyFromSecretKey.md b/docs/markdown/mesh-core-cst/functions/buildEd25519PrivateKeyFromSecretKey.md new file mode 100644 index 000000000..30c6b7c22 --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/buildEd25519PrivateKeyFromSecretKey.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / buildEd25519PrivateKeyFromSecretKey + +# Function: buildEd25519PrivateKeyFromSecretKey() + +> **buildEd25519PrivateKeyFromSecretKey**(`secretKeyHex`): `Ed25519PrivateKey` + +Defined in: packages/mesh-core-cst/src/utils/builder.ts:146 + +## Parameters + +### secretKeyHex + +`string` + +## Returns + +`Ed25519PrivateKey` diff --git a/docs/markdown/mesh-core-cst/functions/buildEnterpriseAddress.md b/docs/markdown/mesh-core-cst/functions/buildEnterpriseAddress.md new file mode 100644 index 000000000..91e183820 --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/buildEnterpriseAddress.md @@ -0,0 +1,25 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / buildEnterpriseAddress + +# Function: buildEnterpriseAddress() + +> **buildEnterpriseAddress**(`networkId`, `paymentKeyHash`): `EnterpriseAddress` + +Defined in: packages/mesh-core-cst/src/utils/builder.ts:46 + +## Parameters + +### networkId + +`number` + +### paymentKeyHash + +`Hash28ByteBase16` + +## Returns + +`EnterpriseAddress` diff --git a/docs/markdown/mesh-core-cst/functions/buildKeys.md b/docs/markdown/mesh-core-cst/functions/buildKeys.md new file mode 100644 index 000000000..4ea7c0fa3 --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/buildKeys.md @@ -0,0 +1,53 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / buildKeys + +# Function: buildKeys() + +> **buildKeys**(`privateKeyHex`, `accountIndex`, `keyIndex`): `object` + +Defined in: packages/mesh-core-cst/src/utils/builder.ts:108 + +Build a set of keys from a given private key + +NOTE - Must be called after `await Crypto.Ready()` + +## Parameters + +### privateKeyHex + +The BIP32 private key hex to derive keys from + +`string` | \[`string`, `string`\] + +### accountIndex + +`number` + +The account index to derive keys for + +### keyIndex + +`number` = `0` + +The key index to derive keys for + +## Returns + +`object` + +The payment and stake keys, and optionally the dRep key if a Bip32PrivateKey is provided + +### dRepKey? + +> `optional` **dRepKey**: `Ed25519PrivateKey` + +### paymentKey + +> **paymentKey**: `Ed25519PrivateKey` + +### stakeKey + +> **stakeKey**: `Ed25519PrivateKey` diff --git a/docs/markdown/mesh-core-cst/functions/buildRewardAddress.md b/docs/markdown/mesh-core-cst/functions/buildRewardAddress.md new file mode 100644 index 000000000..a31c09233 --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/buildRewardAddress.md @@ -0,0 +1,25 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / buildRewardAddress + +# Function: buildRewardAddress() + +> **buildRewardAddress**(`networkId`, `stakeKeyHash`): `RewardAddress` + +Defined in: packages/mesh-core-cst/src/utils/builder.ts:87 + +## Parameters + +### networkId + +`number` + +### stakeKeyHash + +`Hash28ByteBase16` + +## Returns + +`RewardAddress` diff --git a/docs/markdown/mesh-core-cst/functions/buildScriptPubkey.md b/docs/markdown/mesh-core-cst/functions/buildScriptPubkey.md new file mode 100644 index 000000000..df1aaa799 --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/buildScriptPubkey.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / buildScriptPubkey + +# Function: buildScriptPubkey() + +> **buildScriptPubkey**(`keyHash`): `NativeScript` + +Defined in: packages/mesh-core-cst/src/utils/builder.ts:158 + +## Parameters + +### keyHash + +`Ed25519KeyHash` + +## Returns + +`NativeScript` diff --git a/docs/markdown/mesh-core-cst/functions/bytesToHex.md b/docs/markdown/mesh-core-cst/functions/bytesToHex.md new file mode 100644 index 000000000..ef5594798 --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/bytesToHex.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / bytesToHex + +# Function: bytesToHex() + +> **bytesToHex**(`bytes`): `HexBlob` + +Defined in: packages/mesh-core-cst/src/utils/encoding.ts:5 + +## Parameters + +### bytes + +`Uint8Array` + +## Returns + +`HexBlob` diff --git a/docs/markdown/mesh-core-cst/functions/calculateFees.md b/docs/markdown/mesh-core-cst/functions/calculateFees.md new file mode 100644 index 000000000..64433f7d1 --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/calculateFees.md @@ -0,0 +1,45 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / calculateFees + +# Function: calculateFees() + +> **calculateFees**(`minFeeA`, `minFeeB`, `minFeeRefScriptCostPerByte`, `priceMem`, `priceStep`, `tx`, `refScriptSize`): `bigint` + +Defined in: packages/mesh-core-cst/src/utils/fee.ts:3 + +## Parameters + +### minFeeA + +`number` + +### minFeeB + +`number` + +### minFeeRefScriptCostPerByte + +`number` + +### priceMem + +`number` + +### priceStep + +`number` + +### tx + +`Transaction` + +### refScriptSize + +`number` + +## Returns + +`bigint` diff --git a/docs/markdown/mesh-core-cst/functions/checkSignature.md b/docs/markdown/mesh-core-cst/functions/checkSignature.md new file mode 100644 index 000000000..a72a8c38d --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/checkSignature.md @@ -0,0 +1,39 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / checkSignature + +# Function: checkSignature() + +> **checkSignature**(`data`, `The`, `address?`): `Promise`\<`boolean`\> + +Defined in: packages/mesh-core-cst/src/message-signing/check-signature.ts:24 + +Check the signature of a given data string + +## Parameters + +### data + +`string` + +The data string to verify the signature against + +### The + +`DataSignature` + +signature obtained by `signData` + +### address? + +`string` + +Optional Bech32 string of a stake, stake_test1, addr, or addr_test1 address. If provided, this function will validate the signer's address against this value. + +## Returns + +`Promise`\<`boolean`\> + +boolean diff --git a/docs/markdown/mesh-core-cst/functions/clampScalar.md b/docs/markdown/mesh-core-cst/functions/clampScalar.md new file mode 100644 index 000000000..5100fac52 --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/clampScalar.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / clampScalar + +# Function: clampScalar() + +> **clampScalar**(`scalar`): `Buffer` + +Defined in: packages/mesh-core-cst/src/utils/builder.ts:56 + +## Parameters + +### scalar + +`Buffer` + +## Returns + +`Buffer` diff --git a/docs/markdown/mesh-core-cst/functions/deserializeAddress.md b/docs/markdown/mesh-core-cst/functions/deserializeAddress.md new file mode 100644 index 000000000..37ba199b0 --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/deserializeAddress.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / deserializeAddress + +# Function: deserializeAddress() + +> **deserializeAddress**(`address`): `Address` + +Defined in: packages/mesh-core-cst/src/utils/address.ts:369 + +## Parameters + +### address + +`string` + +## Returns + +`Address` diff --git a/docs/markdown/mesh-core-cst/functions/deserializeBech32Address.md b/docs/markdown/mesh-core-cst/functions/deserializeBech32Address.md new file mode 100644 index 000000000..59121556b --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/deserializeBech32Address.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / deserializeBech32Address + +# Function: deserializeBech32Address() + +> **deserializeBech32Address**(`bech32Addr`): `DeserializedAddress` + +Defined in: packages/mesh-core-cst/src/utils/address.ts:345 + +## Parameters + +### bech32Addr + +`string` + +## Returns + +`DeserializedAddress` diff --git a/docs/markdown/mesh-core-cst/functions/deserializeDataHash.md b/docs/markdown/mesh-core-cst/functions/deserializeDataHash.md new file mode 100644 index 000000000..cf5385cd3 --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/deserializeDataHash.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / deserializeDataHash + +# Function: deserializeDataHash() + +> **deserializeDataHash**(`dataHash`): `Hash32ByteBase16` + +Defined in: packages/mesh-core-cst/src/utils/data.ts:260 + +## Parameters + +### dataHash + +`string` + +## Returns + +`Hash32ByteBase16` diff --git a/docs/markdown/mesh-core-cst/functions/deserializeEd25519KeyHash.md b/docs/markdown/mesh-core-cst/functions/deserializeEd25519KeyHash.md new file mode 100644 index 000000000..136a5a622 --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/deserializeEd25519KeyHash.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / deserializeEd25519KeyHash + +# Function: deserializeEd25519KeyHash() + +> **deserializeEd25519KeyHash**(`ed25519KeyHash`): `Ed25519KeyHash` + +Defined in: packages/mesh-core-cst/src/utils/deserializer.ts:21 + +## Parameters + +### ed25519KeyHash + +`string` + +## Returns + +`Ed25519KeyHash` diff --git a/docs/markdown/mesh-core-cst/functions/deserializeNativeScript.md b/docs/markdown/mesh-core-cst/functions/deserializeNativeScript.md new file mode 100644 index 000000000..a0a7e13f7 --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/deserializeNativeScript.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / deserializeNativeScript + +# Function: deserializeNativeScript() + +> **deserializeNativeScript**(`nativeScript`): `NativeScript` + +Defined in: packages/mesh-core-cst/src/utils/deserializer.ts:40 + +## Parameters + +### nativeScript + +`string` + +## Returns + +`NativeScript` diff --git a/docs/markdown/mesh-core-cst/functions/deserializePlutusData.md b/docs/markdown/mesh-core-cst/functions/deserializePlutusData.md new file mode 100644 index 000000000..d2edda514 --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/deserializePlutusData.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / deserializePlutusData + +# Function: deserializePlutusData() + +> **deserializePlutusData**(`plutusData`): `PlutusData` + +Defined in: packages/mesh-core-cst/src/utils/data.ts:263 + +## Parameters + +### plutusData + +`string` + +## Returns + +`PlutusData` diff --git a/docs/markdown/mesh-core-cst/functions/deserializePlutusScript.md b/docs/markdown/mesh-core-cst/functions/deserializePlutusScript.md new file mode 100644 index 000000000..765c14e8a --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/deserializePlutusScript.md @@ -0,0 +1,25 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / deserializePlutusScript + +# Function: deserializePlutusScript() + +> **deserializePlutusScript**(`plutusScript`, `version`): `PlutusV1Script` \| `PlutusV2Script` \| `PlutusV3Script` + +Defined in: packages/mesh-core-cst/src/utils/deserializer.ts:24 + +## Parameters + +### plutusScript + +`string` + +### version + +`"V1"` | `"V2"` | `"V3"` + +## Returns + +`PlutusV1Script` \| `PlutusV2Script` \| `PlutusV3Script` diff --git a/docs/markdown/mesh-core-cst/functions/deserializeScriptHash.md b/docs/markdown/mesh-core-cst/functions/deserializeScriptHash.md new file mode 100644 index 000000000..0a2f78fd5 --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/deserializeScriptHash.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / deserializeScriptHash + +# Function: deserializeScriptHash() + +> **deserializeScriptHash**(`scriptHash`): `Hash28ByteBase16` + +Defined in: packages/mesh-core-cst/src/utils/deserializer.ts:43 + +## Parameters + +### scriptHash + +`string` + +## Returns + +`Hash28ByteBase16` diff --git a/docs/markdown/mesh-core-cst/functions/deserializeScriptRef.md b/docs/markdown/mesh-core-cst/functions/deserializeScriptRef.md new file mode 100644 index 000000000..9e5f153f2 --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/deserializeScriptRef.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / deserializeScriptRef + +# Function: deserializeScriptRef() + +> **deserializeScriptRef**(`scriptRef`): `Script` + +Defined in: packages/mesh-core-cst/src/utils/deserializer.ts:46 + +## Parameters + +### scriptRef + +`string` + +## Returns + +`Script` diff --git a/docs/markdown/mesh-core-cst/functions/deserializeTx.md b/docs/markdown/mesh-core-cst/functions/deserializeTx.md new file mode 100644 index 000000000..67684ecda --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/deserializeTx.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / deserializeTx + +# Function: deserializeTx() + +> **deserializeTx**(`tx`): `Transaction` + +Defined in: packages/mesh-core-cst/src/utils/deserializer.ts:57 + +## Parameters + +### tx + +`string` + +## Returns + +`Transaction` diff --git a/docs/markdown/mesh-core-cst/functions/deserializeTxHash.md b/docs/markdown/mesh-core-cst/functions/deserializeTxHash.md new file mode 100644 index 000000000..aa0da884d --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/deserializeTxHash.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / deserializeTxHash + +# Function: deserializeTxHash() + +> **deserializeTxHash**(`txHash`): `TransactionId` + +Defined in: packages/mesh-core-cst/src/utils/deserializer.ts:60 + +## Parameters + +### txHash + +`string` + +## Returns + +`TransactionId` diff --git a/docs/markdown/mesh-core-cst/functions/deserializeTxUnspentOutput.md b/docs/markdown/mesh-core-cst/functions/deserializeTxUnspentOutput.md new file mode 100644 index 000000000..6fc7d177c --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/deserializeTxUnspentOutput.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / deserializeTxUnspentOutput + +# Function: deserializeTxUnspentOutput() + +> **deserializeTxUnspentOutput**(`txUnspentOutput`): `TransactionUnspentOutput` + +Defined in: packages/mesh-core-cst/src/utils/deserializer.ts:49 + +## Parameters + +### txUnspentOutput + +`string` + +## Returns + +`TransactionUnspentOutput` diff --git a/docs/markdown/mesh-core-cst/functions/deserializeValue.md b/docs/markdown/mesh-core-cst/functions/deserializeValue.md new file mode 100644 index 000000000..6566cb050 --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/deserializeValue.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / deserializeValue + +# Function: deserializeValue() + +> **deserializeValue**(`value`): `Value` + +Defined in: packages/mesh-core-cst/src/utils/deserializer.ts:54 + +## Parameters + +### value + +`string` + +## Returns + +`Value` diff --git a/docs/markdown/mesh-core-cst/functions/empty.md b/docs/markdown/mesh-core-cst/functions/empty.md new file mode 100644 index 000000000..caba590ce --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/empty.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / empty + +# Function: empty() + +> **empty**(`v`): `boolean` + +Defined in: packages/mesh-core-cst/src/utils/value.ts:59 + +## Parameters + +### v + +`Value` + +## Returns + +`boolean` diff --git a/docs/markdown/mesh-core-cst/functions/fromBuilderToPlutusData.md b/docs/markdown/mesh-core-cst/functions/fromBuilderToPlutusData.md new file mode 100644 index 000000000..530a9c66c --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/fromBuilderToPlutusData.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / fromBuilderToPlutusData + +# Function: fromBuilderToPlutusData() + +> **fromBuilderToPlutusData**(`data`): `PlutusData` + +Defined in: packages/mesh-core-cst/src/utils/data.ts:149 + +## Parameters + +### data + +`BuilderData` + +## Returns + +`PlutusData` diff --git a/docs/markdown/mesh-core-cst/functions/fromJsonToPlutusData.md b/docs/markdown/mesh-core-cst/functions/fromJsonToPlutusData.md new file mode 100644 index 000000000..1a7a99cff --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/fromJsonToPlutusData.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / fromJsonToPlutusData + +# Function: fromJsonToPlutusData() + +> **fromJsonToPlutusData**(`data`): `PlutusData` + +Defined in: packages/mesh-core-cst/src/utils/data.ts:87 + +## Parameters + +### data + +`object` + +## Returns + +`PlutusData` diff --git a/docs/markdown/mesh-core-cst/functions/fromNativeScript.md b/docs/markdown/mesh-core-cst/functions/fromNativeScript.md new file mode 100644 index 000000000..161a2ddec --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/fromNativeScript.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / fromNativeScript + +# Function: fromNativeScript() + +> **fromNativeScript**(`script`): `NativeScript` + +Defined in: packages/mesh-core-cst/src/utils/converter.ts:219 + +## Parameters + +### script + +`NativeScript` + +## Returns + +`NativeScript` diff --git a/docs/markdown/mesh-core-cst/functions/fromPlutusDataToJson.md b/docs/markdown/mesh-core-cst/functions/fromPlutusDataToJson.md new file mode 100644 index 000000000..eac9d41e3 --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/fromPlutusDataToJson.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / fromPlutusDataToJson + +# Function: fromPlutusDataToJson() + +> **fromPlutusDataToJson**(`data`): `object` + +Defined in: packages/mesh-core-cst/src/utils/data.ts:169 + +## Parameters + +### data + +`PlutusData` + +## Returns + +`object` diff --git a/docs/markdown/mesh-core-cst/functions/fromScriptRef.md b/docs/markdown/mesh-core-cst/functions/fromScriptRef.md new file mode 100644 index 000000000..9c601744b --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/fromScriptRef.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / fromScriptRef + +# Function: fromScriptRef() + +> **fromScriptRef**(`scriptRef`): `undefined` \| `PlutusScript` \| `NativeScript` + +Defined in: packages/mesh-core-cst/src/utils/converter.ts:181 + +## Parameters + +### scriptRef + +`string` + +## Returns + +`undefined` \| `PlutusScript` \| `NativeScript` diff --git a/docs/markdown/mesh-core-cst/functions/fromTxUnspentOutput.md b/docs/markdown/mesh-core-cst/functions/fromTxUnspentOutput.md new file mode 100644 index 000000000..9f4f9adf2 --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/fromTxUnspentOutput.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / fromTxUnspentOutput + +# Function: fromTxUnspentOutput() + +> **fromTxUnspentOutput**(`txUnspentOutput`): `UTxO` + +Defined in: packages/mesh-core-cst/src/utils/converter.ts:79 + +## Parameters + +### txUnspentOutput + +`TransactionUnspentOutput` + +## Returns + +`UTxO` diff --git a/docs/markdown/mesh-core-cst/functions/fromValue.md b/docs/markdown/mesh-core-cst/functions/fromValue.md new file mode 100644 index 000000000..eaf042307 --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/fromValue.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / fromValue + +# Function: fromValue() + +> **fromValue**(`value`): `Asset`[] + +Defined in: packages/mesh-core-cst/src/utils/converter.ts:143 + +## Parameters + +### value + +`Value` + +## Returns + +`Asset`[] diff --git a/docs/markdown/mesh-core-cst/functions/generateNonce.md b/docs/markdown/mesh-core-cst/functions/generateNonce.md new file mode 100644 index 000000000..d977cd849 --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/generateNonce.md @@ -0,0 +1,33 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / generateNonce + +# Function: generateNonce() + +> **generateNonce**(`label`, `length`): `string` + +Defined in: packages/mesh-core-cst/src/message-signing/generate-nonce.ts:11 + +Generate a nonce string + +## Parameters + +### label + +`string` = `""` + +The label to prepend to the nonce + +### length + +`number` = `32` + +The length of the nonce + +## Returns + +`string` + +The generated nonce in hex format diff --git a/docs/markdown/mesh-core-cst/functions/getCoseKeyFromPublicKey.md b/docs/markdown/mesh-core-cst/functions/getCoseKeyFromPublicKey.md new file mode 100644 index 000000000..b6cd36a7f --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/getCoseKeyFromPublicKey.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / getCoseKeyFromPublicKey + +# Function: getCoseKeyFromPublicKey() + +> **getCoseKeyFromPublicKey**(`cbor`): `Buffer` + +Defined in: packages/mesh-core-cst/src/message-signing/cose-sign1.ts:234 + +## Parameters + +### cbor + +`string` + +## Returns + +`Buffer` diff --git a/docs/markdown/mesh-core-cst/functions/getDRepIds.md b/docs/markdown/mesh-core-cst/functions/getDRepIds.md new file mode 100644 index 000000000..56b32117b --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/getDRepIds.md @@ -0,0 +1,29 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / getDRepIds + +# Function: getDRepIds() + +> **getDRepIds**(`dRepId`): `object` + +Defined in: packages/mesh-core-cst/src/utils/converter.ts:388 + +## Parameters + +### dRepId + +`string` + +## Returns + +`object` + +### cip105 + +> **cip105**: `string` + +### cip129 + +> **cip129**: `string` diff --git a/docs/markdown/mesh-core-cst/functions/getPublicKeyFromCoseKey.md b/docs/markdown/mesh-core-cst/functions/getPublicKeyFromCoseKey.md new file mode 100644 index 000000000..bc7e0d92d --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/getPublicKeyFromCoseKey.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / getPublicKeyFromCoseKey + +# Function: getPublicKeyFromCoseKey() + +> **getPublicKeyFromCoseKey**(`cbor`): `Buffer` + +Defined in: packages/mesh-core-cst/src/message-signing/cose-sign1.ts:218 + +## Parameters + +### cbor + +`string` + +## Returns + +`Buffer` diff --git a/docs/markdown/mesh-core-cst/functions/hexToBech32.md b/docs/markdown/mesh-core-cst/functions/hexToBech32.md new file mode 100644 index 000000000..b1d272526 --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/hexToBech32.md @@ -0,0 +1,25 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / hexToBech32 + +# Function: hexToBech32() + +> **hexToBech32**(`prefix`, `hex`): `string` + +Defined in: packages/mesh-core-cst/src/utils/encoding.ts:16 + +## Parameters + +### prefix + +`string` + +### hex + +`string` + +## Returns + +`string` diff --git a/docs/markdown/mesh-core-cst/functions/hexToBytes.md b/docs/markdown/mesh-core-cst/functions/hexToBytes.md new file mode 100644 index 000000000..f5070bea5 --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/hexToBytes.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / hexToBytes + +# Function: hexToBytes() + +> **hexToBytes**(`hex`): `Uint8Array` + +Defined in: packages/mesh-core-cst/src/utils/encoding.ts:8 + +## Parameters + +### hex + +`HexBlob` + +## Returns + +`Uint8Array` diff --git a/docs/markdown/mesh-core-cst/functions/keyHashToRewardAddress.md b/docs/markdown/mesh-core-cst/functions/keyHashToRewardAddress.md new file mode 100644 index 000000000..7451639d1 --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/keyHashToRewardAddress.md @@ -0,0 +1,25 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / keyHashToRewardAddress + +# Function: keyHashToRewardAddress() + +> **keyHashToRewardAddress**(`hash`, `networkId`): `string` + +Defined in: packages/mesh-core-cst/src/utils/address.ts:429 + +## Parameters + +### hash + +`string` + +### networkId + +`number` = `0` + +## Returns + +`string` diff --git a/docs/markdown/mesh-core-cst/functions/mergeValue.md b/docs/markdown/mesh-core-cst/functions/mergeValue.md new file mode 100644 index 000000000..635df4677 --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/mergeValue.md @@ -0,0 +1,25 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / mergeValue + +# Function: mergeValue() + +> **mergeValue**(`a`, `b`): `Value` + +Defined in: packages/mesh-core-cst/src/utils/value.ts:3 + +## Parameters + +### a + +`Value` + +### b + +`Value` + +## Returns + +`Value` diff --git a/docs/markdown/mesh-core-cst/functions/negateValue.md b/docs/markdown/mesh-core-cst/functions/negateValue.md new file mode 100644 index 000000000..072d913cb --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/negateValue.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / negateValue + +# Function: negateValue() + +> **negateValue**(`v`): `Value` + +Defined in: packages/mesh-core-cst/src/utils/value.ts:19 + +## Parameters + +### v + +`Value` + +## Returns + +`Value` diff --git a/docs/markdown/mesh-core-cst/functions/negatives.md b/docs/markdown/mesh-core-cst/functions/negatives.md new file mode 100644 index 000000000..a348e4d0d --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/negatives.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / negatives + +# Function: negatives() + +> **negatives**(`v`): `Value` + +Defined in: packages/mesh-core-cst/src/utils/value.ts:34 + +## Parameters + +### v + +`Value` + +## Returns + +`Value` diff --git a/docs/markdown/mesh-core-cst/functions/normalizePlutusScript.md b/docs/markdown/mesh-core-cst/functions/normalizePlutusScript.md new file mode 100644 index 000000000..8b3eff135 --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/normalizePlutusScript.md @@ -0,0 +1,44 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / normalizePlutusScript + +# Function: normalizePlutusScript() + +> **normalizePlutusScript**(`plutusScript`, `encoding`): `string` + +Defined in: packages/mesh-core-cst/src/plutus-tools/index.ts:121 + +Normalizes a Plutus script by extracting its pure Plutus bytes and applying a specified encoding. + +## Parameters + +### plutusScript + +`string` + +The Plutus script to be normalized as a Uint8Array. + +### encoding + +[`OutputEncoding`](../type-aliases/OutputEncoding.md) + +The desired encoding for the output. + +## Returns + +`string` + +The normalized Plutus script. + +## Description + +This function performs the following steps: +1. Extracts the pure Plutus bytes in hex from the input script. +2. Applies the specified encoding to the pure Plutus bytes. + +## Note + +- This function is useful for standardizing the format of Plutus scripts, ensuring they are in a consistent state for further processing or comparison. +- The normalization process does not modify the logical content of the script, only its representation. diff --git a/docs/markdown/mesh-core-cst/functions/parseDatumCbor.md b/docs/markdown/mesh-core-cst/functions/parseDatumCbor.md new file mode 100644 index 000000000..af023c8d7 --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/parseDatumCbor.md @@ -0,0 +1,27 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / parseDatumCbor + +# Function: parseDatumCbor() + +> **parseDatumCbor**\<`T`\>(`datumCbor`): `T` + +Defined in: packages/mesh-core-cst/src/utils/data.ts:249 + +## Type Parameters + +### T + +`T` = `any` + +## Parameters + +### datumCbor + +`string` + +## Returns + +`T` diff --git a/docs/markdown/mesh-core-cst/functions/parseInlineDatum.md b/docs/markdown/mesh-core-cst/functions/parseInlineDatum.md new file mode 100644 index 000000000..78fe899ba --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/parseInlineDatum.md @@ -0,0 +1,31 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / parseInlineDatum + +# Function: parseInlineDatum() + +> **parseInlineDatum**\<`T`, `X`\>(`utxo`): `X` + +Defined in: packages/mesh-core-cst/src/utils/data.ts:253 + +## Type Parameters + +### T + +`T` *extends* `object` + +### X + +`X` + +## Parameters + +### utxo + +`T` + +## Returns + +`X` diff --git a/docs/markdown/mesh-core-cst/functions/resolveDataHash.md b/docs/markdown/mesh-core-cst/functions/resolveDataHash.md new file mode 100644 index 000000000..d9a4f66b8 --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/resolveDataHash.md @@ -0,0 +1,25 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / resolveDataHash + +# Function: resolveDataHash() + +> **resolveDataHash**(`rawData`, `type`): `string` + +Defined in: packages/mesh-core-cst/src/resolvers/index.ts:47 + +## Parameters + +### rawData + +`object` | `Data` + +### type + +`PlutusDataType` = `"Mesh"` + +## Returns + +`string` diff --git a/docs/markdown/mesh-core-cst/functions/resolveEd25519KeyHash.md b/docs/markdown/mesh-core-cst/functions/resolveEd25519KeyHash.md new file mode 100644 index 000000000..1f9832408 --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/resolveEd25519KeyHash.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / resolveEd25519KeyHash + +# Function: resolveEd25519KeyHash() + +> **resolveEd25519KeyHash**(`bech32`): `string` + +Defined in: packages/mesh-core-cst/src/resolvers/index.ts:197 + +## Parameters + +### bech32 + +`string` + +## Returns + +`string` diff --git a/docs/markdown/mesh-core-cst/functions/resolveNativeScriptAddress.md b/docs/markdown/mesh-core-cst/functions/resolveNativeScriptAddress.md new file mode 100644 index 000000000..d9af25ab0 --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/resolveNativeScriptAddress.md @@ -0,0 +1,25 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / resolveNativeScriptAddress + +# Function: resolveNativeScriptAddress() + +> **resolveNativeScriptAddress**(`script`, `networkId`): `string` + +Defined in: packages/mesh-core-cst/src/resolvers/index.ts:58 + +## Parameters + +### script + +`NativeScript` + +### networkId + +`number` = `0` + +## Returns + +`string` diff --git a/docs/markdown/mesh-core-cst/functions/resolveNativeScriptHash.md b/docs/markdown/mesh-core-cst/functions/resolveNativeScriptHash.md new file mode 100644 index 000000000..7e1a16f96 --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/resolveNativeScriptHash.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / resolveNativeScriptHash + +# Function: resolveNativeScriptHash() + +> **resolveNativeScriptHash**(`script`): `string` + +Defined in: packages/mesh-core-cst/src/resolvers/index.ts:72 + +## Parameters + +### script + +`NativeScript` + +## Returns + +`string` diff --git a/docs/markdown/mesh-core-cst/functions/resolvePaymentKeyHash.md b/docs/markdown/mesh-core-cst/functions/resolvePaymentKeyHash.md new file mode 100644 index 000000000..55fbf6a7f --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/resolvePaymentKeyHash.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / resolvePaymentKeyHash + +# Function: resolvePaymentKeyHash() + +> **resolvePaymentKeyHash**(`bech32`): `string` + +Defined in: packages/mesh-core-cst/src/resolvers/index.ts:76 + +## Parameters + +### bech32 + +`string` + +## Returns + +`string` diff --git a/docs/markdown/mesh-core-cst/functions/resolvePlutusScriptAddress.md b/docs/markdown/mesh-core-cst/functions/resolvePlutusScriptAddress.md new file mode 100644 index 000000000..cd73fb738 --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/resolvePlutusScriptAddress.md @@ -0,0 +1,25 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / resolvePlutusScriptAddress + +# Function: resolvePlutusScriptAddress() + +> **resolvePlutusScriptAddress**(`script`, `networkId`): `string` + +Defined in: packages/mesh-core-cst/src/resolvers/index.ts:95 + +## Parameters + +### script + +`PlutusScript` + +### networkId + +`number` = `0` + +## Returns + +`string` diff --git a/docs/markdown/mesh-core-cst/functions/resolvePlutusScriptHash.md b/docs/markdown/mesh-core-cst/functions/resolvePlutusScriptHash.md new file mode 100644 index 000000000..47d2b2b6c --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/resolvePlutusScriptHash.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / resolvePlutusScriptHash + +# Function: resolvePlutusScriptHash() + +> **resolvePlutusScriptHash**(`bech32`): `string` + +Defined in: packages/mesh-core-cst/src/resolvers/index.ts:109 + +## Parameters + +### bech32 + +`string` + +## Returns + +`string` diff --git a/docs/markdown/mesh-core-cst/functions/resolvePoolId.md b/docs/markdown/mesh-core-cst/functions/resolvePoolId.md new file mode 100644 index 000000000..4f7620747 --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/resolvePoolId.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / resolvePoolId + +# Function: resolvePoolId() + +> **resolvePoolId**(`hash`): `string` + +Defined in: packages/mesh-core-cst/src/resolvers/index.ts:122 + +## Parameters + +### hash + +`string` + +## Returns + +`string` diff --git a/docs/markdown/mesh-core-cst/functions/resolvePrivateKey.md b/docs/markdown/mesh-core-cst/functions/resolvePrivateKey.md new file mode 100644 index 000000000..b8118ae70 --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/resolvePrivateKey.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / resolvePrivateKey + +# Function: resolvePrivateKey() + +> **resolvePrivateKey**(`words`): `string` + +Defined in: packages/mesh-core-cst/src/resolvers/index.ts:126 + +## Parameters + +### words + +`string`[] + +## Returns + +`string` diff --git a/docs/markdown/mesh-core-cst/functions/resolveRewardAddress.md b/docs/markdown/mesh-core-cst/functions/resolveRewardAddress.md new file mode 100644 index 000000000..24b4caa39 --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/resolveRewardAddress.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / resolveRewardAddress + +# Function: resolveRewardAddress() + +> **resolveRewardAddress**(`bech32`): `string` + +Defined in: packages/mesh-core-cst/src/resolvers/index.ts:149 + +## Parameters + +### bech32 + +`string` + +## Returns + +`string` diff --git a/docs/markdown/mesh-core-cst/functions/resolveScriptHashDRepId.md b/docs/markdown/mesh-core-cst/functions/resolveScriptHashDRepId.md new file mode 100644 index 000000000..17d452d16 --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/resolveScriptHashDRepId.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / resolveScriptHashDRepId + +# Function: resolveScriptHashDRepId() + +> **resolveScriptHashDRepId**(`scriptHash`): `string` + +Defined in: packages/mesh-core-cst/src/resolvers/index.ts:190 + +## Parameters + +### scriptHash + +`string` + +## Returns + +`string` diff --git a/docs/markdown/mesh-core-cst/functions/resolveScriptRef.md b/docs/markdown/mesh-core-cst/functions/resolveScriptRef.md new file mode 100644 index 000000000..45a3e01a2 --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/resolveScriptRef.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / resolveScriptRef + +# Function: resolveScriptRef() + +> **resolveScriptRef**(`script`): `string` + +Defined in: packages/mesh-core-cst/src/resolvers/index.ts:145 + +## Parameters + +### script + +`PlutusScript` | `NativeScript` + +## Returns + +`string` diff --git a/docs/markdown/mesh-core-cst/functions/resolveStakeKeyHash.md b/docs/markdown/mesh-core-cst/functions/resolveStakeKeyHash.md new file mode 100644 index 000000000..a99ded872 --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/resolveStakeKeyHash.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / resolveStakeKeyHash + +# Function: resolveStakeKeyHash() + +> **resolveStakeKeyHash**(`bech32`): `string` + +Defined in: packages/mesh-core-cst/src/resolvers/index.ts:167 + +## Parameters + +### bech32 + +`string` + +## Returns + +`string` diff --git a/docs/markdown/mesh-core-cst/functions/resolveTxHash.md b/docs/markdown/mesh-core-cst/functions/resolveTxHash.md new file mode 100644 index 000000000..b58985e8b --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/resolveTxHash.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / resolveTxHash + +# Function: resolveTxHash() + +> **resolveTxHash**(`txHex`): `string` + +Defined in: packages/mesh-core-cst/src/resolvers/index.ts:182 + +## Parameters + +### txHex + +`string` + +## Returns + +`string` diff --git a/docs/markdown/mesh-core-cst/functions/scriptHashToBech32.md b/docs/markdown/mesh-core-cst/functions/scriptHashToBech32.md new file mode 100644 index 000000000..fe5bb4769 --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/scriptHashToBech32.md @@ -0,0 +1,33 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / scriptHashToBech32 + +# Function: scriptHashToBech32() + +> **scriptHashToBech32**(`scriptHash`, `stakeCredentialHash?`, `networkId?`, `isScriptStakeCredentialHash?`): `string` + +Defined in: packages/mesh-core-cst/src/utils/address.ts:375 + +## Parameters + +### scriptHash + +`string` + +### stakeCredentialHash? + +`string` + +### networkId? + +`number` = `0` + +### isScriptStakeCredentialHash? + +`boolean` = `false` + +## Returns + +`string` diff --git a/docs/markdown/mesh-core-cst/functions/scriptHashToRewardAddress.md b/docs/markdown/mesh-core-cst/functions/scriptHashToRewardAddress.md new file mode 100644 index 000000000..cdd518249 --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/scriptHashToRewardAddress.md @@ -0,0 +1,25 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / scriptHashToRewardAddress + +# Function: scriptHashToRewardAddress() + +> **scriptHashToRewardAddress**(`hash`, `networkId`): `string` + +Defined in: packages/mesh-core-cst/src/utils/address.ts:419 + +## Parameters + +### hash + +`string` + +### networkId + +`number` = `0` + +## Returns + +`string` diff --git a/docs/markdown/mesh-core-cst/functions/serializeAddressObj.md b/docs/markdown/mesh-core-cst/functions/serializeAddressObj.md new file mode 100644 index 000000000..92e8ff179 --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/serializeAddressObj.md @@ -0,0 +1,25 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / serializeAddressObj + +# Function: serializeAddressObj() + +> **serializeAddressObj**(`plutusDataAddressObject`, `networkId`): `string` + +Defined in: packages/mesh-core-cst/src/utils/address.ts:329 + +## Parameters + +### plutusDataAddressObject + +`PubKeyAddress` | `ScriptAddress` + +### networkId + +`number` = `0` + +## Returns + +`string` diff --git a/docs/markdown/mesh-core-cst/functions/serializePlutusAddressToBech32.md b/docs/markdown/mesh-core-cst/functions/serializePlutusAddressToBech32.md new file mode 100644 index 000000000..6696807fe --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/serializePlutusAddressToBech32.md @@ -0,0 +1,25 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / serializePlutusAddressToBech32 + +# Function: serializePlutusAddressToBech32() + +> **serializePlutusAddressToBech32**(`plutusHex`, `networkId`): `string` + +Defined in: packages/mesh-core-cst/src/utils/address.ts:337 + +## Parameters + +### plutusHex + +`string` + +### networkId + +`number` = `0` + +## Returns + +`string` diff --git a/docs/markdown/mesh-core-cst/functions/serialzeAddress.md b/docs/markdown/mesh-core-cst/functions/serialzeAddress.md new file mode 100644 index 000000000..be629762e --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/serialzeAddress.md @@ -0,0 +1,25 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / serialzeAddress + +# Function: serialzeAddress() + +> **serialzeAddress**(`deserializedAddress`, `networkId`): `string` + +Defined in: packages/mesh-core-cst/src/utils/address.ts:28 + +## Parameters + +### deserializedAddress + +`Partial`\<`DeserializedAddress`\> + +### networkId + +`number` = `0` + +## Returns + +`string` diff --git a/docs/markdown/mesh-core-cst/functions/signData.md b/docs/markdown/mesh-core-cst/functions/signData.md new file mode 100644 index 000000000..e9c4b52ec --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/signData.md @@ -0,0 +1,33 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / signData + +# Function: signData() + +> **signData**(`data`, `signer`): `DataSignature` + +Defined in: packages/mesh-core-cst/src/message-signing/sign-data.ts:23 + +Sign the data string using the provided signer + +## Parameters + +### data + +`string` + +The data string to sign + +### signer + +[`Signer`](../type-aliases/Signer.md) + +The signer object containing the key and address + +## Returns + +`DataSignature` + +DataSignature for verification diff --git a/docs/markdown/mesh-core-cst/functions/subValue.md b/docs/markdown/mesh-core-cst/functions/subValue.md new file mode 100644 index 000000000..9350bf04e --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/subValue.md @@ -0,0 +1,25 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / subValue + +# Function: subValue() + +> **subValue**(`a`, `b`): `Value` + +Defined in: packages/mesh-core-cst/src/utils/value.ts:30 + +## Parameters + +### a + +`Value` + +### b + +`Value` + +## Returns + +`Value` diff --git a/docs/markdown/mesh-core-cst/functions/toAddress.md b/docs/markdown/mesh-core-cst/functions/toAddress.md new file mode 100644 index 000000000..eeef60ff7 --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/toAddress.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / toAddress + +# Function: toAddress() + +> **toAddress**(`bech32`): `Address` + +Defined in: packages/mesh-core-cst/src/utils/converter.ts:51 + +## Parameters + +### bech32 + +`string` + +## Returns + +`Address` diff --git a/docs/markdown/mesh-core-cst/functions/toBaseAddress.md b/docs/markdown/mesh-core-cst/functions/toBaseAddress.md new file mode 100644 index 000000000..f87e07318 --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/toBaseAddress.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / toBaseAddress + +# Function: toBaseAddress() + +> **toBaseAddress**(`bech32`): `undefined` \| `BaseAddress` + +Defined in: packages/mesh-core-cst/src/utils/converter.ts:66 + +## Parameters + +### bech32 + +`string` + +## Returns + +`undefined` \| `BaseAddress` diff --git a/docs/markdown/mesh-core-cst/functions/toCardanoAddress.md b/docs/markdown/mesh-core-cst/functions/toCardanoAddress.md new file mode 100644 index 000000000..bb415b8f9 --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/toCardanoAddress.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / toCardanoAddress + +# Function: toCardanoAddress() + +> **toCardanoAddress**(`address`): `Address` + +Defined in: packages/mesh-core-cst/src/utils/converter.ts:54 + +## Parameters + +### address + +`string` + +## Returns + +`Address` diff --git a/docs/markdown/mesh-core-cst/functions/toDRep.md b/docs/markdown/mesh-core-cst/functions/toDRep.md new file mode 100644 index 000000000..0bc2aaf83 --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/toDRep.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / toDRep + +# Function: toDRep() + +> **toDRep**(`dRepId`): `DRep` + +Defined in: packages/mesh-core-cst/src/utils/converter.ts:344 + +## Parameters + +### dRepId + +`string` + +## Returns + +`DRep` diff --git a/docs/markdown/mesh-core-cst/functions/toEnterpriseAddress.md b/docs/markdown/mesh-core-cst/functions/toEnterpriseAddress.md new file mode 100644 index 000000000..79a3a917f --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/toEnterpriseAddress.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / toEnterpriseAddress + +# Function: toEnterpriseAddress() + +> **toEnterpriseAddress**(`bech32`): `undefined` \| `EnterpriseAddress` + +Defined in: packages/mesh-core-cst/src/utils/converter.ts:70 + +## Parameters + +### bech32 + +`string` + +## Returns + +`undefined` \| `EnterpriseAddress` diff --git a/docs/markdown/mesh-core-cst/functions/toNativeScript.md b/docs/markdown/mesh-core-cst/functions/toNativeScript.md new file mode 100644 index 000000000..0640b1300 --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/toNativeScript.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / toNativeScript + +# Function: toNativeScript() + +> **toNativeScript**(`script`): `NativeScript` + +Defined in: packages/mesh-core-cst/src/utils/converter.ts:282 + +## Parameters + +### script + +`NativeScript` + +## Returns + +`NativeScript` diff --git a/docs/markdown/mesh-core-cst/functions/toPlutusData.md b/docs/markdown/mesh-core-cst/functions/toPlutusData.md new file mode 100644 index 000000000..41ac10cfc --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/toPlutusData.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / toPlutusData + +# Function: toPlutusData() + +> **toPlutusData**(`data`): `PlutusData` + +Defined in: packages/mesh-core-cst/src/utils/data.ts:14 + +## Parameters + +### data + +`Data` + +## Returns + +`PlutusData` diff --git a/docs/markdown/mesh-core-cst/functions/toRewardAddress.md b/docs/markdown/mesh-core-cst/functions/toRewardAddress.md new file mode 100644 index 000000000..c2b928876 --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/toRewardAddress.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / toRewardAddress + +# Function: toRewardAddress() + +> **toRewardAddress**(`bech32`): `undefined` \| `RewardAddress` + +Defined in: packages/mesh-core-cst/src/utils/converter.ts:76 + +## Parameters + +### bech32 + +`string` + +## Returns + +`undefined` \| `RewardAddress` diff --git a/docs/markdown/mesh-core-cst/functions/toScriptRef.md b/docs/markdown/mesh-core-cst/functions/toScriptRef.md new file mode 100644 index 000000000..4cc6fae35 --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/toScriptRef.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / toScriptRef + +# Function: toScriptRef() + +> **toScriptRef**(`script`): `Script` + +Defined in: packages/mesh-core-cst/src/utils/converter.ts:168 + +## Parameters + +### script + +`PlutusScript` | `NativeScript` + +## Returns + +`Script` diff --git a/docs/markdown/mesh-core-cst/functions/toTxUnspentOutput.md b/docs/markdown/mesh-core-cst/functions/toTxUnspentOutput.md new file mode 100644 index 000000000..48ef00807 --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/toTxUnspentOutput.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / toTxUnspentOutput + +# Function: toTxUnspentOutput() + +> **toTxUnspentOutput**(`utxo`): `TransactionUnspentOutput` + +Defined in: packages/mesh-core-cst/src/utils/converter.ts:109 + +## Parameters + +### utxo + +`UTxO` + +## Returns + +`TransactionUnspentOutput` diff --git a/docs/markdown/mesh-core-cst/functions/toValue.md b/docs/markdown/mesh-core-cst/functions/toValue.md new file mode 100644 index 000000000..0972d4cc8 --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/toValue.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / toValue + +# Function: toValue() + +> **toValue**(`assets`): `Value` + +Defined in: packages/mesh-core-cst/src/utils/converter.ts:326 + +## Parameters + +### assets + +`Asset`[] + +## Returns + +`Value` diff --git a/docs/markdown/mesh-core-cst/functions/utf8ToBytes.md b/docs/markdown/mesh-core-cst/functions/utf8ToBytes.md new file mode 100644 index 000000000..92c7046ac --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/utf8ToBytes.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / utf8ToBytes + +# Function: utf8ToBytes() + +> **utf8ToBytes**(`str`): `Uint8Array` + +Defined in: packages/mesh-core-cst/src/utils/encoding.ts:10 + +## Parameters + +### str + +`string` + +## Returns + +`Uint8Array` diff --git a/docs/markdown/mesh-core-cst/functions/utf8ToHex.md b/docs/markdown/mesh-core-cst/functions/utf8ToHex.md new file mode 100644 index 000000000..c42f78264 --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/utf8ToHex.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / utf8ToHex + +# Function: utf8ToHex() + +> **utf8ToHex**(`str`): `HexBlob` + +Defined in: packages/mesh-core-cst/src/utils/encoding.ts:13 + +## Parameters + +### str + +`string` + +## Returns + +`HexBlob` diff --git a/docs/markdown/mesh-core-cst/functions/v2ScriptToBech32.md b/docs/markdown/mesh-core-cst/functions/v2ScriptToBech32.md new file mode 100644 index 000000000..4608afcb7 --- /dev/null +++ b/docs/markdown/mesh-core-cst/functions/v2ScriptToBech32.md @@ -0,0 +1,33 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / v2ScriptToBech32 + +# Function: v2ScriptToBech32() + +> **v2ScriptToBech32**(`scriptCbor`, `stakeCredential?`, `networkId?`, `isScriptStakeCredential?`): `string` + +Defined in: packages/mesh-core-cst/src/utils/address.ts:406 + +## Parameters + +### scriptCbor + +`string` + +### stakeCredential? + +`string` + +### networkId? + +`number` = `0` + +### isScriptStakeCredential? + +`boolean` = `false` + +## Returns + +`string` diff --git a/docs/markdown/mesh-core-cst/globals.md b/docs/markdown/mesh-core-cst/globals.md new file mode 100644 index 000000000..e4062439e --- /dev/null +++ b/docs/markdown/mesh-core-cst/globals.md @@ -0,0 +1,299 @@ +[**@meshsdk/core-cst**](README.md) + +*** + +# @meshsdk/core-cst + +## Classes + +- [CardanoSDKSerializer](classes/CardanoSDKSerializer.md) +- [CoseSign1](classes/CoseSign1.md) + +## Type Aliases + +- [Address](type-aliases/Address.md) +- [AddressType](type-aliases/AddressType.md) +- [AssetFingerprint](type-aliases/AssetFingerprint.md) +- [AssetId](type-aliases/AssetId.md) +- [AssetName](type-aliases/AssetName.md) +- [AuxiliaryData](type-aliases/AuxiliaryData.md) +- [BaseAddress](type-aliases/BaseAddress.md) +- [Bip32PrivateKey](type-aliases/Bip32PrivateKey.md) +- [Bip32PrivateKeyHex](type-aliases/Bip32PrivateKeyHex.md) +- [Bip32PublicKey](type-aliases/Bip32PublicKey.md) +- [Bip32PublicKeyHex](type-aliases/Bip32PublicKeyHex.md) +- [BootstrapWitness](type-aliases/BootstrapWitness.md) +- [ByronAttributes](type-aliases/ByronAttributes.md) +- [CborWriter](type-aliases/CborWriter.md) +- [Certificate](type-aliases/Certificate.md) +- [CertificateType](type-aliases/CertificateType.md) +- [CertIndex](type-aliases/CertIndex.md) +- [ConstrPlutusData](type-aliases/ConstrPlutusData.md) +- [Costmdls](type-aliases/Costmdls.md) +- [CostModel](type-aliases/CostModel.md) +- [CostModels](type-aliases/CostModels.md) +- [Credential](type-aliases/Credential.md) +- [CredentialCore](type-aliases/CredentialCore.md) +- [CredentialType](type-aliases/CredentialType.md) +- [Datum](type-aliases/Datum.md) +- [DatumHash](type-aliases/DatumHash.md) +- [DRep](type-aliases/DRep.md) +- [DRepID](type-aliases/DRepID.md) +- [Ed25519KeyHash](type-aliases/Ed25519KeyHash.md) +- [Ed25519KeyHashHex](type-aliases/Ed25519KeyHashHex.md) +- [Ed25519PrivateExtendedKeyHex](type-aliases/Ed25519PrivateExtendedKeyHex.md) +- [Ed25519PrivateKey](type-aliases/Ed25519PrivateKey.md) +- [Ed25519PrivateNormalKeyHex](type-aliases/Ed25519PrivateNormalKeyHex.md) +- [Ed25519PublicKey](type-aliases/Ed25519PublicKey.md) +- [Ed25519PublicKeyHex](type-aliases/Ed25519PublicKeyHex.md) +- [Ed25519Signature](type-aliases/Ed25519Signature.md) +- [Ed25519SignatureHex](type-aliases/Ed25519SignatureHex.md) +- [EnterpriseAddress](type-aliases/EnterpriseAddress.md) +- [ExUnits](type-aliases/ExUnits.md) +- [Hash](type-aliases/Hash.md) +- [Hash28ByteBase16](type-aliases/Hash28ByteBase16.md) +- [Hash32ByteBase16](type-aliases/Hash32ByteBase16.md) +- [HexBlob](type-aliases/HexBlob.md) +- [Metadatum](type-aliases/Metadatum.md) +- [MetadatumList](type-aliases/MetadatumList.md) +- [MetadatumMap](type-aliases/MetadatumMap.md) +- [NativeScript](type-aliases/NativeScript.md) +- [NetworkId](type-aliases/NetworkId.md) +- [OutputEncoding](type-aliases/OutputEncoding.md) +- [PaymentAddress](type-aliases/PaymentAddress.md) +- [PlutusData](type-aliases/PlutusData.md) +- [PlutusDataKind](type-aliases/PlutusDataKind.md) +- [PlutusLanguageVersion](type-aliases/PlutusLanguageVersion.md) +- [PlutusList](type-aliases/PlutusList.md) +- [PlutusMap](type-aliases/PlutusMap.md) +- [PlutusV1Script](type-aliases/PlutusV1Script.md) +- [PlutusV2Script](type-aliases/PlutusV2Script.md) +- [PlutusV3Script](type-aliases/PlutusV3Script.md) +- [PointerAddress](type-aliases/PointerAddress.md) +- [PolicyId](type-aliases/PolicyId.md) +- [PoolId](type-aliases/PoolId.md) +- [Redeemer](type-aliases/Redeemer.md) +- [RedeemerPurpose](type-aliases/RedeemerPurpose.md) +- [Redeemers](type-aliases/Redeemers.md) +- [RedeemerTag](type-aliases/RedeemerTag.md) +- [RequireAllOf](type-aliases/RequireAllOf.md) +- [RequireAnyOf](type-aliases/RequireAnyOf.md) +- [RequireNOf](type-aliases/RequireNOf.md) +- [RequireSignature](type-aliases/RequireSignature.md) +- [RequireTimeAfter](type-aliases/RequireTimeAfter.md) +- [RequireTimeBefore](type-aliases/RequireTimeBefore.md) +- [RewardAccount](type-aliases/RewardAccount.md) +- [RewardAddress](type-aliases/RewardAddress.md) +- [Script](type-aliases/Script.md) +- [ScriptHash](type-aliases/ScriptHash.md) +- [ScriptPubkey](type-aliases/ScriptPubkey.md) +- [Signatures](type-aliases/Signatures.md) +- [Signer](type-aliases/Signer.md) +- [Slot](type-aliases/Slot.md) +- [StakeCredentialStatus](type-aliases/StakeCredentialStatus.md) +- [StakeDelegation](type-aliases/StakeDelegation.md) +- [StakeDelegationCertificate](type-aliases/StakeDelegationCertificate.md) +- [StakeRegistration](type-aliases/StakeRegistration.md) +- [TokenMap](type-aliases/TokenMap.md) +- [Transaction](type-aliases/Transaction.md) +- [TransactionBody](type-aliases/TransactionBody.md) +- [TransactionId](type-aliases/TransactionId.md) +- [TransactionInput](type-aliases/TransactionInput.md) +- [TransactionInputSet](type-aliases/TransactionInputSet.md) +- [TransactionMetadatum](type-aliases/TransactionMetadatum.md) +- [TransactionOutput](type-aliases/TransactionOutput.md) +- [TransactionUnspentOutput](type-aliases/TransactionUnspentOutput.md) +- [TransactionWitnessPlutusData](type-aliases/TransactionWitnessPlutusData.md) +- [TransactionWitnessSet](type-aliases/TransactionWitnessSet.md) +- [TxCBOR](type-aliases/TxCBOR.md) +- [TxIndex](type-aliases/TxIndex.md) +- [Value](type-aliases/Value.md) +- [VkeyWitness](type-aliases/VkeyWitness.md) +- [VrfVkBech32](type-aliases/VrfVkBech32.md) +- [Witness](type-aliases/Witness.md) + +## Variables + +- [Address](variables/Address.md) +- [AddressType](variables/AddressType.md) +- [AssetFingerprint](variables/AssetFingerprint.md) +- [AssetId](variables/AssetId.md) +- [AssetName](variables/AssetName.md) +- [AuxilliaryData](variables/AuxilliaryData.md) +- [BaseAddress](variables/BaseAddress.md) +- [Bip32PrivateKey](variables/Bip32PrivateKey.md) +- [Bip32PrivateKeyHex](variables/Bip32PrivateKeyHex.md) +- [Bip32PublicKey](variables/Bip32PublicKey.md) +- [Bip32PublicKeyHex](variables/Bip32PublicKeyHex.md) +- [blake2b](variables/blake2b.md) +- [BootstrapWitness](variables/BootstrapWitness.md) +- [CborSet](variables/CborSet.md) +- [CborWriter](variables/CborWriter.md) +- [Certificate](variables/Certificate.md) +- [CertificateType](variables/CertificateType.md) +- [CertIndex](variables/CertIndex.md) +- [computeAuxiliaryDataHash](variables/computeAuxiliaryDataHash.md) +- [ConstrPlutusData](variables/ConstrPlutusData.md) +- [Costmdls](variables/Costmdls.md) +- [CostModel](variables/CostModel.md) +- [Credential](variables/Credential.md) +- [CredentialType](variables/CredentialType.md) +- [Datum](variables/Datum.md) +- [DatumKind](variables/DatumKind.md) +- [DRep](variables/DRep.md) +- [DRepID](variables/DRepID.md) +- [Ed25519KeyHash](variables/Ed25519KeyHash.md) +- [Ed25519KeyHashHex](variables/Ed25519KeyHashHex.md) +- [Ed25519PrivateExtendedKeyHex](variables/Ed25519PrivateExtendedKeyHex.md) +- [Ed25519PrivateKey](variables/Ed25519PrivateKey.md) +- [Ed25519PrivateNormalKeyHex](variables/Ed25519PrivateNormalKeyHex.md) +- [Ed25519PublicKey](variables/Ed25519PublicKey.md) +- [Ed25519PublicKeyHex](variables/Ed25519PublicKeyHex.md) +- [Ed25519Signature](variables/Ed25519Signature.md) +- [Ed25519SignatureHex](variables/Ed25519SignatureHex.md) +- [EnterpriseAddress](variables/EnterpriseAddress.md) +- [ExUnits](variables/ExUnits.md) +- [Hash](variables/Hash.md) +- [Hash28ByteBase16](variables/Hash28ByteBase16.md) +- [HexBlob](variables/HexBlob.md) +- [MetadatumList](variables/MetadatumList.md) +- [MetadatumMap](variables/MetadatumMap.md) +- [NativeScript](variables/NativeScript.md) +- [NetworkId](variables/NetworkId.md) +- [PaymentAddress](variables/PaymentAddress.md) +- [PlutusData](variables/PlutusData.md) +- [PlutusDataKind](variables/PlutusDataKind.md) +- [PlutusLanguageVersion](variables/PlutusLanguageVersion.md) +- [PlutusList](variables/PlutusList.md) +- [PlutusMap](variables/PlutusMap.md) +- [PlutusV1Script](variables/PlutusV1Script.md) +- [PlutusV2Script](variables/PlutusV2Script.md) +- [PlutusV3Script](variables/PlutusV3Script.md) +- [PointerAddress](variables/PointerAddress.md) +- [PolicyId](variables/PolicyId.md) +- [PoolId](variables/PoolId.md) +- [Redeemer](variables/Redeemer.md) +- [RedeemerPurpose](variables/RedeemerPurpose.md) +- [Redeemers](variables/Redeemers.md) +- [RedeemerTag](variables/RedeemerTag.md) +- [RequireAllOf](variables/RequireAllOf.md) +- [RequireAnyOf](variables/RequireAnyOf.md) +- [RequireNOf](variables/RequireNOf.md) +- [RequireSignature](variables/RequireSignature.md) +- [RequireTimeAfter](variables/RequireTimeAfter.md) +- [RequireTimeBefore](variables/RequireTimeBefore.md) +- [RewardAccount](variables/RewardAccount.md) +- [RewardAddress](variables/RewardAddress.md) +- [Script](variables/Script.md) +- [ScriptHash](variables/ScriptHash.md) +- [ScriptPubkey](variables/ScriptPubkey.md) +- [Slot](variables/Slot.md) +- [StakeCredentialStatus](variables/StakeCredentialStatus.md) +- [StakeDelegation](variables/StakeDelegation.md) +- [StakeRegistration](variables/StakeRegistration.md) +- [Transaction](variables/Transaction.md) +- [TransactionBody](variables/TransactionBody.md) +- [TransactionInput](variables/TransactionInput.md) +- [TransactionMetadatum](variables/TransactionMetadatum.md) +- [TransactionOutput](variables/TransactionOutput.md) +- [TransactionUnspentOutput](variables/TransactionUnspentOutput.md) +- [TransactionWitnessSet](variables/TransactionWitnessSet.md) +- [TxCBOR](variables/TxCBOR.md) +- [TxIndex](variables/TxIndex.md) +- [Value](variables/Value.md) +- [VkeyWitness](variables/VkeyWitness.md) +- [VrfVkBech32](variables/VrfVkBech32.md) + +## Functions + +- [addrBech32ToPlutusDataHex](functions/addrBech32ToPlutusDataHex.md) +- [addrBech32ToPlutusDataObj](functions/addrBech32ToPlutusDataObj.md) +- [addressToBech32](functions/addressToBech32.md) +- [addVKeyWitnessSetToTransaction](functions/addVKeyWitnessSetToTransaction.md) +- [applyEncoding](functions/applyEncoding.md) +- [applyParamsToScript](functions/applyParamsToScript.md) +- [assetTypes](functions/assetTypes.md) +- [buildBaseAddress](functions/buildBaseAddress.md) +- [buildBip32PrivateKey](functions/buildBip32PrivateKey.md) +- [buildDRepID](functions/buildDRepID.md) +- [buildEd25519PrivateKeyFromSecretKey](functions/buildEd25519PrivateKeyFromSecretKey.md) +- [buildEnterpriseAddress](functions/buildEnterpriseAddress.md) +- [buildKeys](functions/buildKeys.md) +- [buildRewardAddress](functions/buildRewardAddress.md) +- [buildScriptPubkey](functions/buildScriptPubkey.md) +- [bytesToHex](functions/bytesToHex.md) +- [calculateFees](functions/calculateFees.md) +- [checkSignature](functions/checkSignature.md) +- [clampScalar](functions/clampScalar.md) +- [DatumHash](functions/DatumHash.md) +- [deserializeAddress](functions/deserializeAddress.md) +- [deserializeBech32Address](functions/deserializeBech32Address.md) +- [deserializeDataHash](functions/deserializeDataHash.md) +- [deserializeEd25519KeyHash](functions/deserializeEd25519KeyHash.md) +- [deserializeNativeScript](functions/deserializeNativeScript.md) +- [deserializePlutusData](functions/deserializePlutusData.md) +- [deserializePlutusScript](functions/deserializePlutusScript.md) +- [deserializeScriptHash](functions/deserializeScriptHash.md) +- [deserializeScriptRef](functions/deserializeScriptRef.md) +- [deserializeTx](functions/deserializeTx.md) +- [deserializeTxHash](functions/deserializeTxHash.md) +- [deserializeTxUnspentOutput](functions/deserializeTxUnspentOutput.md) +- [deserializeValue](functions/deserializeValue.md) +- [empty](functions/empty.md) +- [fromBuilderToPlutusData](functions/fromBuilderToPlutusData.md) +- [fromJsonToPlutusData](functions/fromJsonToPlutusData.md) +- [fromNativeScript](functions/fromNativeScript.md) +- [fromPlutusDataToJson](functions/fromPlutusDataToJson.md) +- [fromScriptRef](functions/fromScriptRef.md) +- [fromTxUnspentOutput](functions/fromTxUnspentOutput.md) +- [fromValue](functions/fromValue.md) +- [generateNonce](functions/generateNonce.md) +- [getCoseKeyFromPublicKey](functions/getCoseKeyFromPublicKey.md) +- [getDRepIds](functions/getDRepIds.md) +- [getPublicKeyFromCoseKey](functions/getPublicKeyFromCoseKey.md) +- [Hash32ByteBase16](functions/Hash32ByteBase16.md) +- [hexToBech32](functions/hexToBech32.md) +- [hexToBytes](functions/hexToBytes.md) +- [keyHashToRewardAddress](functions/keyHashToRewardAddress.md) +- [mergeValue](functions/mergeValue.md) +- [negateValue](functions/negateValue.md) +- [negatives](functions/negatives.md) +- [normalizePlutusScript](functions/normalizePlutusScript.md) +- [parseDatumCbor](functions/parseDatumCbor.md) +- [parseInlineDatum](functions/parseInlineDatum.md) +- [resolveDataHash](functions/resolveDataHash.md) +- [resolveEd25519KeyHash](functions/resolveEd25519KeyHash.md) +- [resolveNativeScriptAddress](functions/resolveNativeScriptAddress.md) +- [resolveNativeScriptHash](functions/resolveNativeScriptHash.md) +- [resolvePaymentKeyHash](functions/resolvePaymentKeyHash.md) +- [resolvePlutusScriptAddress](functions/resolvePlutusScriptAddress.md) +- [resolvePlutusScriptHash](functions/resolvePlutusScriptHash.md) +- [resolvePoolId](functions/resolvePoolId.md) +- [resolvePrivateKey](functions/resolvePrivateKey.md) +- [resolveRewardAddress](functions/resolveRewardAddress.md) +- [resolveScriptHashDRepId](functions/resolveScriptHashDRepId.md) +- [resolveScriptRef](functions/resolveScriptRef.md) +- [resolveStakeKeyHash](functions/resolveStakeKeyHash.md) +- [resolveTxHash](functions/resolveTxHash.md) +- [scriptHashToBech32](functions/scriptHashToBech32.md) +- [scriptHashToRewardAddress](functions/scriptHashToRewardAddress.md) +- [serializeAddressObj](functions/serializeAddressObj.md) +- [serializePlutusAddressToBech32](functions/serializePlutusAddressToBech32.md) +- [serialzeAddress](functions/serialzeAddress.md) +- [signData](functions/signData.md) +- [subValue](functions/subValue.md) +- [toAddress](functions/toAddress.md) +- [toBaseAddress](functions/toBaseAddress.md) +- [toCardanoAddress](functions/toCardanoAddress.md) +- [toDRep](functions/toDRep.md) +- [toEnterpriseAddress](functions/toEnterpriseAddress.md) +- [toNativeScript](functions/toNativeScript.md) +- [toPlutusData](functions/toPlutusData.md) +- [toRewardAddress](functions/toRewardAddress.md) +- [toScriptRef](functions/toScriptRef.md) +- [toTxUnspentOutput](functions/toTxUnspentOutput.md) +- [toValue](functions/toValue.md) +- [TransactionId](functions/TransactionId.md) +- [utf8ToBytes](functions/utf8ToBytes.md) +- [utf8ToHex](functions/utf8ToHex.md) +- [v2ScriptToBech32](functions/v2ScriptToBech32.md) diff --git a/docs/markdown/mesh-core-cst/type-aliases/Address.md b/docs/markdown/mesh-core-cst/type-aliases/Address.md new file mode 100644 index 000000000..1997e53cb --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/Address.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / Address + +# Type Alias: Address + +> **Address** = `Cardano.Address` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:92 diff --git a/docs/markdown/mesh-core-cst/type-aliases/AddressType.md b/docs/markdown/mesh-core-cst/type-aliases/AddressType.md new file mode 100644 index 000000000..fb3db1423 --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/AddressType.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / AddressType + +# Type Alias: AddressType + +> **AddressType** = `Cardano.AddressType` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:98 diff --git a/docs/markdown/mesh-core-cst/type-aliases/AssetFingerprint.md b/docs/markdown/mesh-core-cst/type-aliases/AssetFingerprint.md new file mode 100644 index 000000000..d57242f61 --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/AssetFingerprint.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / AssetFingerprint + +# Type Alias: AssetFingerprint + +> **AssetFingerprint** = `Cardano.AssetFingerprint` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:110 diff --git a/docs/markdown/mesh-core-cst/type-aliases/AssetId.md b/docs/markdown/mesh-core-cst/type-aliases/AssetId.md new file mode 100644 index 000000000..e70374488 --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/AssetId.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / AssetId + +# Type Alias: AssetId + +> **AssetId** = `Cardano.AssetId` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:86 diff --git a/docs/markdown/mesh-core-cst/type-aliases/AssetName.md b/docs/markdown/mesh-core-cst/type-aliases/AssetName.md new file mode 100644 index 000000000..040088b3e --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/AssetName.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / AssetName + +# Type Alias: AssetName + +> **AssetName** = `Cardano.AssetName` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:83 diff --git a/docs/markdown/mesh-core-cst/type-aliases/AuxiliaryData.md b/docs/markdown/mesh-core-cst/type-aliases/AuxiliaryData.md new file mode 100644 index 000000000..b0ad07c28 --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/AuxiliaryData.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / AuxiliaryData + +# Type Alias: AuxiliaryData + +> **AuxiliaryData** = `Serialization.AuxiliaryData` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:29 diff --git a/docs/markdown/mesh-core-cst/type-aliases/BaseAddress.md b/docs/markdown/mesh-core-cst/type-aliases/BaseAddress.md new file mode 100644 index 000000000..16c507b97 --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/BaseAddress.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / BaseAddress + +# Type Alias: BaseAddress + +> **BaseAddress** = `Cardano.BaseAddress` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:101 diff --git a/docs/markdown/mesh-core-cst/type-aliases/Bip32PrivateKey.md b/docs/markdown/mesh-core-cst/type-aliases/Bip32PrivateKey.md new file mode 100644 index 000000000..f13c1604b --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/Bip32PrivateKey.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / Bip32PrivateKey + +# Type Alias: Bip32PrivateKey + +> **Bip32PrivateKey** = `Crypto.Bip32PrivateKey` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:177 diff --git a/docs/markdown/mesh-core-cst/type-aliases/Bip32PrivateKeyHex.md b/docs/markdown/mesh-core-cst/type-aliases/Bip32PrivateKeyHex.md new file mode 100644 index 000000000..0d40dd546 --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/Bip32PrivateKeyHex.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / Bip32PrivateKeyHex + +# Type Alias: Bip32PrivateKeyHex + +> **Bip32PrivateKeyHex** = `Crypto.Bip32PrivateKeyHex` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:180 diff --git a/docs/markdown/mesh-core-cst/type-aliases/Bip32PublicKey.md b/docs/markdown/mesh-core-cst/type-aliases/Bip32PublicKey.md new file mode 100644 index 000000000..8ec659ea2 --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/Bip32PublicKey.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / Bip32PublicKey + +# Type Alias: Bip32PublicKey + +> **Bip32PublicKey** = `Crypto.Bip32PublicKey` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:183 diff --git a/docs/markdown/mesh-core-cst/type-aliases/Bip32PublicKeyHex.md b/docs/markdown/mesh-core-cst/type-aliases/Bip32PublicKeyHex.md new file mode 100644 index 000000000..5f30f62dd --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/Bip32PublicKeyHex.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / Bip32PublicKeyHex + +# Type Alias: Bip32PublicKeyHex + +> **Bip32PublicKeyHex** = `Crypto.Bip32PublicKeyHex` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:186 diff --git a/docs/markdown/mesh-core-cst/type-aliases/BootstrapWitness.md b/docs/markdown/mesh-core-cst/type-aliases/BootstrapWitness.md new file mode 100644 index 000000000..881bbf71e --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/BootstrapWitness.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / BootstrapWitness + +# Type Alias: BootstrapWitness + +> **BootstrapWitness** = `Serialization.BootstrapWitness` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:304 diff --git a/docs/markdown/mesh-core-cst/type-aliases/ByronAttributes.md b/docs/markdown/mesh-core-cst/type-aliases/ByronAttributes.md new file mode 100644 index 000000000..0cfc5e0fb --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/ByronAttributes.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / ByronAttributes + +# Type Alias: ByronAttributes + +> **ByronAttributes** = `Cardano.ByronAttributes` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:307 diff --git a/docs/markdown/mesh-core-cst/type-aliases/CborWriter.md b/docs/markdown/mesh-core-cst/type-aliases/CborWriter.md new file mode 100644 index 000000000..551636037 --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/CborWriter.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / CborWriter + +# Type Alias: CborWriter + +> **CborWriter** = `Serialization.CborWriter` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:222 diff --git a/docs/markdown/mesh-core-cst/type-aliases/CertIndex.md b/docs/markdown/mesh-core-cst/type-aliases/CertIndex.md new file mode 100644 index 000000000..140edd7b5 --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/CertIndex.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / CertIndex + +# Type Alias: CertIndex + +> **CertIndex** = `Cardano.CertIndex` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:210 diff --git a/docs/markdown/mesh-core-cst/type-aliases/Certificate.md b/docs/markdown/mesh-core-cst/type-aliases/Certificate.md new file mode 100644 index 000000000..69f8aca4f --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/Certificate.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / Certificate + +# Type Alias: Certificate + +> **Certificate** = `Serialization.Certificate` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:148 diff --git a/docs/markdown/mesh-core-cst/type-aliases/CertificateType.md b/docs/markdown/mesh-core-cst/type-aliases/CertificateType.md new file mode 100644 index 000000000..edb43d395 --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/CertificateType.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / CertificateType + +# Type Alias: CertificateType + +> **CertificateType** = `Cardano.CertificateType` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:162 diff --git a/docs/markdown/mesh-core-cst/type-aliases/ConstrPlutusData.md b/docs/markdown/mesh-core-cst/type-aliases/ConstrPlutusData.md new file mode 100644 index 000000000..eb81221ba --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/ConstrPlutusData.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / ConstrPlutusData + +# Type Alias: ConstrPlutusData + +> **ConstrPlutusData** = `Serialization.ConstrPlutusData` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:225 diff --git a/docs/markdown/mesh-core-cst/type-aliases/CostModel.md b/docs/markdown/mesh-core-cst/type-aliases/CostModel.md new file mode 100644 index 000000000..f235fd22d --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/CostModel.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / CostModel + +# Type Alias: CostModel + +> **CostModel** = `Serialization.CostModel` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:219 diff --git a/docs/markdown/mesh-core-cst/type-aliases/CostModels.md b/docs/markdown/mesh-core-cst/type-aliases/CostModels.md new file mode 100644 index 000000000..e254b54ea --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/CostModels.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / CostModels + +# Type Alias: CostModels + +> **CostModels** = `Cardano.CostModels` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:242 diff --git a/docs/markdown/mesh-core-cst/type-aliases/Costmdls.md b/docs/markdown/mesh-core-cst/type-aliases/Costmdls.md new file mode 100644 index 000000000..5c041330a --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/Costmdls.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / Costmdls + +# Type Alias: Costmdls + +> **Costmdls** = `Serialization.Costmdls` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:216 diff --git a/docs/markdown/mesh-core-cst/type-aliases/Credential.md b/docs/markdown/mesh-core-cst/type-aliases/Credential.md new file mode 100644 index 000000000..20e799c36 --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/Credential.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / Credential + +# Type Alias: Credential + +> **Credential** = `Serialization.Credential` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:113 diff --git a/docs/markdown/mesh-core-cst/type-aliases/CredentialCore.md b/docs/markdown/mesh-core-cst/type-aliases/CredentialCore.md new file mode 100644 index 000000000..1e13f4e35 --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/CredentialCore.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / CredentialCore + +# Type Alias: CredentialCore + +> **CredentialCore** = `Cardano.Credential` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:116 diff --git a/docs/markdown/mesh-core-cst/type-aliases/CredentialType.md b/docs/markdown/mesh-core-cst/type-aliases/CredentialType.md new file mode 100644 index 000000000..67e163461 --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/CredentialType.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / CredentialType + +# Type Alias: CredentialType + +> **CredentialType** = `Cardano.CredentialType` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:145 diff --git a/docs/markdown/mesh-core-cst/type-aliases/DRep.md b/docs/markdown/mesh-core-cst/type-aliases/DRep.md new file mode 100644 index 000000000..0c421a0dd --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/DRep.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / DRep + +# Type Alias: DRep + +> **DRep** = `Serialization.DRep` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:284 diff --git a/docs/markdown/mesh-core-cst/type-aliases/DRepID.md b/docs/markdown/mesh-core-cst/type-aliases/DRepID.md new file mode 100644 index 000000000..bad25d115 --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/DRepID.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / DRepID + +# Type Alias: DRepID + +> **DRepID** = `Cardano.DRepID` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:281 diff --git a/docs/markdown/mesh-core-cst/type-aliases/Datum.md b/docs/markdown/mesh-core-cst/type-aliases/Datum.md new file mode 100644 index 000000000..b3083ec2a --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/Datum.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / Datum + +# Type Alias: Datum + +> **Datum** = [`PlutusData`](PlutusData.md) \| [`DatumHash`](DatumHash.md) + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:239 diff --git a/docs/markdown/mesh-core-cst/type-aliases/DatumHash.md b/docs/markdown/mesh-core-cst/type-aliases/DatumHash.md new file mode 100644 index 000000000..a40770402 --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/DatumHash.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / DatumHash + +# Type Alias: DatumHash + +> **DatumHash** = `Crypto.Hash32ByteBase16` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:234 diff --git a/docs/markdown/mesh-core-cst/type-aliases/Ed25519KeyHash.md b/docs/markdown/mesh-core-cst/type-aliases/Ed25519KeyHash.md new file mode 100644 index 000000000..36981952d --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/Ed25519KeyHash.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / Ed25519KeyHash + +# Type Alias: Ed25519KeyHash + +> **Ed25519KeyHash** = `Crypto.Ed25519KeyHash` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:131 diff --git a/docs/markdown/mesh-core-cst/type-aliases/Ed25519KeyHashHex.md b/docs/markdown/mesh-core-cst/type-aliases/Ed25519KeyHashHex.md new file mode 100644 index 000000000..a4d30c76b --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/Ed25519KeyHashHex.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / Ed25519KeyHashHex + +# Type Alias: Ed25519KeyHashHex + +> **Ed25519KeyHashHex** = `Crypto.Ed25519KeyHashHex` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:134 diff --git a/docs/markdown/mesh-core-cst/type-aliases/Ed25519PrivateExtendedKeyHex.md b/docs/markdown/mesh-core-cst/type-aliases/Ed25519PrivateExtendedKeyHex.md new file mode 100644 index 000000000..76bae9fc1 --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/Ed25519PrivateExtendedKeyHex.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / Ed25519PrivateExtendedKeyHex + +# Type Alias: Ed25519PrivateExtendedKeyHex + +> **Ed25519PrivateExtendedKeyHex** = `OpaqueString`\<`"Ed25519PrivateKeyHex"`\> + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:126 diff --git a/docs/markdown/mesh-core-cst/type-aliases/Ed25519PrivateKey.md b/docs/markdown/mesh-core-cst/type-aliases/Ed25519PrivateKey.md new file mode 100644 index 000000000..c5355def4 --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/Ed25519PrivateKey.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / Ed25519PrivateKey + +# Type Alias: Ed25519PrivateKey + +> **Ed25519PrivateKey** = `Crypto.Ed25519PrivateKey` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:298 diff --git a/docs/markdown/mesh-core-cst/type-aliases/Ed25519PrivateNormalKeyHex.md b/docs/markdown/mesh-core-cst/type-aliases/Ed25519PrivateNormalKeyHex.md new file mode 100644 index 000000000..b651b707e --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/Ed25519PrivateNormalKeyHex.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / Ed25519PrivateNormalKeyHex + +# Type Alias: Ed25519PrivateNormalKeyHex + +> **Ed25519PrivateNormalKeyHex** = `OpaqueString`\<`"Ed25519PrivateKeyHex"`\> + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:121 diff --git a/docs/markdown/mesh-core-cst/type-aliases/Ed25519PublicKey.md b/docs/markdown/mesh-core-cst/type-aliases/Ed25519PublicKey.md new file mode 100644 index 000000000..05a46e0de --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/Ed25519PublicKey.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / Ed25519PublicKey + +# Type Alias: Ed25519PublicKey + +> **Ed25519PublicKey** = `Crypto.Ed25519PublicKey` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:171 diff --git a/docs/markdown/mesh-core-cst/type-aliases/Ed25519PublicKeyHex.md b/docs/markdown/mesh-core-cst/type-aliases/Ed25519PublicKeyHex.md new file mode 100644 index 000000000..d4d0ab233 --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/Ed25519PublicKeyHex.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / Ed25519PublicKeyHex + +# Type Alias: Ed25519PublicKeyHex + +> **Ed25519PublicKeyHex** = `Crypto.Ed25519PublicKeyHex` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:118 diff --git a/docs/markdown/mesh-core-cst/type-aliases/Ed25519Signature.md b/docs/markdown/mesh-core-cst/type-aliases/Ed25519Signature.md new file mode 100644 index 000000000..8f3fe9cba --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/Ed25519Signature.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / Ed25519Signature + +# Type Alias: Ed25519Signature + +> **Ed25519Signature** = `Crypto.Ed25519Signature` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:174 diff --git a/docs/markdown/mesh-core-cst/type-aliases/Ed25519SignatureHex.md b/docs/markdown/mesh-core-cst/type-aliases/Ed25519SignatureHex.md new file mode 100644 index 000000000..1240fc8c3 --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/Ed25519SignatureHex.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / Ed25519SignatureHex + +# Type Alias: Ed25519SignatureHex + +> **Ed25519SignatureHex** = `Crypto.Ed25519SignatureHex` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:168 diff --git a/docs/markdown/mesh-core-cst/type-aliases/EnterpriseAddress.md b/docs/markdown/mesh-core-cst/type-aliases/EnterpriseAddress.md new file mode 100644 index 000000000..cd6d35249 --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/EnterpriseAddress.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / EnterpriseAddress + +# Type Alias: EnterpriseAddress + +> **EnterpriseAddress** = `Cardano.EnterpriseAddress` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:104 diff --git a/docs/markdown/mesh-core-cst/type-aliases/ExUnits.md b/docs/markdown/mesh-core-cst/type-aliases/ExUnits.md new file mode 100644 index 000000000..48a47ecf3 --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/ExUnits.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / ExUnits + +# Type Alias: ExUnits + +> **ExUnits** = `Serialization.ExUnits` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:244 diff --git a/docs/markdown/mesh-core-cst/type-aliases/Hash.md b/docs/markdown/mesh-core-cst/type-aliases/Hash.md new file mode 100644 index 000000000..210fdb5ce --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/Hash.md @@ -0,0 +1,17 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / Hash + +# Type Alias: Hash\ + +> **Hash**\<`T`\> = `Serialization.Hash`\<`T`\> + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:231 + +## Type Parameters + +### T + +`T` *extends* `string` diff --git a/docs/markdown/mesh-core-cst/type-aliases/Hash28ByteBase16.md b/docs/markdown/mesh-core-cst/type-aliases/Hash28ByteBase16.md new file mode 100644 index 000000000..351190584 --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/Hash28ByteBase16.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / Hash28ByteBase16 + +# Type Alias: Hash28ByteBase16 + +> **Hash28ByteBase16** = `Crypto.Hash28ByteBase16` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:137 diff --git a/docs/markdown/mesh-core-cst/type-aliases/Hash32ByteBase16.md b/docs/markdown/mesh-core-cst/type-aliases/Hash32ByteBase16.md new file mode 100644 index 000000000..5172a4638 --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/Hash32ByteBase16.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / Hash32ByteBase16 + +# Type Alias: Hash32ByteBase16 + +> **Hash32ByteBase16** = `Crypto.Hash32ByteBase16` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:140 diff --git a/docs/markdown/mesh-core-cst/type-aliases/HexBlob.md b/docs/markdown/mesh-core-cst/type-aliases/HexBlob.md new file mode 100644 index 000000000..934623eca --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/HexBlob.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / HexBlob + +# Type Alias: HexBlob + +> **HexBlob** = `CardanoHexBlob` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:292 diff --git a/docs/markdown/mesh-core-cst/type-aliases/Metadatum.md b/docs/markdown/mesh-core-cst/type-aliases/Metadatum.md new file mode 100644 index 000000000..5603b7cda --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/Metadatum.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / Metadatum + +# Type Alias: Metadatum + +> **Metadatum** = `Cardano.Metadatum` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:290 diff --git a/docs/markdown/mesh-core-cst/type-aliases/MetadatumList.md b/docs/markdown/mesh-core-cst/type-aliases/MetadatumList.md new file mode 100644 index 000000000..e026f74aa --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/MetadatumList.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / MetadatumList + +# Type Alias: MetadatumList + +> **MetadatumList** = `Serialization.MetadatumList` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:37 diff --git a/docs/markdown/mesh-core-cst/type-aliases/MetadatumMap.md b/docs/markdown/mesh-core-cst/type-aliases/MetadatumMap.md new file mode 100644 index 000000000..f17c138ec --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/MetadatumMap.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / MetadatumMap + +# Type Alias: MetadatumMap + +> **MetadatumMap** = `Serialization.MetadatumMap` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:34 diff --git a/docs/markdown/mesh-core-cst/type-aliases/NativeScript.md b/docs/markdown/mesh-core-cst/type-aliases/NativeScript.md new file mode 100644 index 000000000..dfdb25ea5 --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/NativeScript.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / NativeScript + +# Type Alias: NativeScript + +> **NativeScript** = `Serialization.NativeScript` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:192 diff --git a/docs/markdown/mesh-core-cst/type-aliases/NetworkId.md b/docs/markdown/mesh-core-cst/type-aliases/NetworkId.md new file mode 100644 index 000000000..80c5ef95e --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/NetworkId.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / NetworkId + +# Type Alias: NetworkId + +> **NetworkId** = `Cardano.ChainId`\[`"networkId"`\] + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:247 diff --git a/docs/markdown/mesh-core-cst/type-aliases/OutputEncoding.md b/docs/markdown/mesh-core-cst/type-aliases/OutputEncoding.md new file mode 100644 index 000000000..4b67fdb3c --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/OutputEncoding.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / OutputEncoding + +# Type Alias: OutputEncoding + +> **OutputEncoding** = `"SingleCBOR"` \| `"DoubleCBOR"` \| `"PurePlutusScriptBytes"` + +Defined in: packages/mesh-core-cst/src/plutus-tools/index.ts:59 diff --git a/docs/markdown/mesh-core-cst/type-aliases/PaymentAddress.md b/docs/markdown/mesh-core-cst/type-aliases/PaymentAddress.md new file mode 100644 index 000000000..006b4e8d1 --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/PaymentAddress.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / PaymentAddress + +# Type Alias: PaymentAddress + +> **PaymentAddress** = `Cardano.PaymentAddress` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:107 diff --git a/docs/markdown/mesh-core-cst/type-aliases/PlutusData.md b/docs/markdown/mesh-core-cst/type-aliases/PlutusData.md new file mode 100644 index 000000000..e1fd14244 --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/PlutusData.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / PlutusData + +# Type Alias: PlutusData + +> **PlutusData** = `Serialization.PlutusData` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:56 diff --git a/docs/markdown/mesh-core-cst/type-aliases/PlutusDataKind.md b/docs/markdown/mesh-core-cst/type-aliases/PlutusDataKind.md new file mode 100644 index 000000000..f80ccc1d9 --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/PlutusDataKind.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / PlutusDataKind + +# Type Alias: PlutusDataKind + +> **PlutusDataKind** = `Serialization.PlutusDataKind` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:204 diff --git a/docs/markdown/mesh-core-cst/type-aliases/PlutusLanguageVersion.md b/docs/markdown/mesh-core-cst/type-aliases/PlutusLanguageVersion.md new file mode 100644 index 000000000..c1b55bbea --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/PlutusLanguageVersion.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / PlutusLanguageVersion + +# Type Alias: PlutusLanguageVersion + +> **PlutusLanguageVersion** = `Cardano.PlutusLanguageVersion` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:189 diff --git a/docs/markdown/mesh-core-cst/type-aliases/PlutusList.md b/docs/markdown/mesh-core-cst/type-aliases/PlutusList.md new file mode 100644 index 000000000..5350f1747 --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/PlutusList.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / PlutusList + +# Type Alias: PlutusList + +> **PlutusList** = `Serialization.PlutusList` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:59 diff --git a/docs/markdown/mesh-core-cst/type-aliases/PlutusMap.md b/docs/markdown/mesh-core-cst/type-aliases/PlutusMap.md new file mode 100644 index 000000000..999e96ce3 --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/PlutusMap.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / PlutusMap + +# Type Alias: PlutusMap + +> **PlutusMap** = `Serialization.PlutusMap` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:62 diff --git a/docs/markdown/mesh-core-cst/type-aliases/PlutusV1Script.md b/docs/markdown/mesh-core-cst/type-aliases/PlutusV1Script.md new file mode 100644 index 000000000..2004fffb4 --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/PlutusV1Script.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / PlutusV1Script + +# Type Alias: PlutusV1Script + +> **PlutusV1Script** = `Serialization.PlutusV1Script` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:195 diff --git a/docs/markdown/mesh-core-cst/type-aliases/PlutusV2Script.md b/docs/markdown/mesh-core-cst/type-aliases/PlutusV2Script.md new file mode 100644 index 000000000..87affb672 --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/PlutusV2Script.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / PlutusV2Script + +# Type Alias: PlutusV2Script + +> **PlutusV2Script** = `Serialization.PlutusV2Script` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:198 diff --git a/docs/markdown/mesh-core-cst/type-aliases/PlutusV3Script.md b/docs/markdown/mesh-core-cst/type-aliases/PlutusV3Script.md new file mode 100644 index 000000000..b81090bcb --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/PlutusV3Script.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / PlutusV3Script + +# Type Alias: PlutusV3Script + +> **PlutusV3Script** = `Serialization.PlutusV3Script` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:201 diff --git a/docs/markdown/mesh-core-cst/type-aliases/PointerAddress.md b/docs/markdown/mesh-core-cst/type-aliases/PointerAddress.md new file mode 100644 index 000000000..816210aaa --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/PointerAddress.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / PointerAddress + +# Type Alias: PointerAddress + +> **PointerAddress** = `Cardano.PointerAddress` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:207 diff --git a/docs/markdown/mesh-core-cst/type-aliases/PolicyId.md b/docs/markdown/mesh-core-cst/type-aliases/PolicyId.md new file mode 100644 index 000000000..6524f881d --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/PolicyId.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / PolicyId + +# Type Alias: PolicyId + +> **PolicyId** = `Cardano.PolicyId` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:80 diff --git a/docs/markdown/mesh-core-cst/type-aliases/PoolId.md b/docs/markdown/mesh-core-cst/type-aliases/PoolId.md new file mode 100644 index 000000000..4c726e13e --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/PoolId.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / PoolId + +# Type Alias: PoolId + +> **PoolId** = `Cardano.PoolId` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:151 diff --git a/docs/markdown/mesh-core-cst/type-aliases/Redeemer.md b/docs/markdown/mesh-core-cst/type-aliases/Redeemer.md new file mode 100644 index 000000000..e61b095f8 --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/Redeemer.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / Redeemer + +# Type Alias: Redeemer + +> **Redeemer** = `Serialization.Redeemer` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:68 diff --git a/docs/markdown/mesh-core-cst/type-aliases/RedeemerPurpose.md b/docs/markdown/mesh-core-cst/type-aliases/RedeemerPurpose.md new file mode 100644 index 000000000..8af95e408 --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/RedeemerPurpose.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / RedeemerPurpose + +# Type Alias: RedeemerPurpose + +> **RedeemerPurpose** = `Cardano.RedeemerPurpose` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:71 diff --git a/docs/markdown/mesh-core-cst/type-aliases/RedeemerTag.md b/docs/markdown/mesh-core-cst/type-aliases/RedeemerTag.md new file mode 100644 index 000000000..79373b879 --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/RedeemerTag.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / RedeemerTag + +# Type Alias: RedeemerTag + +> **RedeemerTag** = `Serialization.RedeemerTag` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:74 diff --git a/docs/markdown/mesh-core-cst/type-aliases/Redeemers.md b/docs/markdown/mesh-core-cst/type-aliases/Redeemers.md new file mode 100644 index 000000000..672e7405e --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/Redeemers.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / Redeemers + +# Type Alias: Redeemers + +> **Redeemers** = `Serialization.Redeemers` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:65 diff --git a/docs/markdown/mesh-core-cst/type-aliases/RequireAllOf.md b/docs/markdown/mesh-core-cst/type-aliases/RequireAllOf.md new file mode 100644 index 000000000..38eeeaa9f --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/RequireAllOf.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / RequireAllOf + +# Type Alias: RequireAllOf + +> **RequireAllOf** = `Cardano.NativeScriptKind.RequireAllOf` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:257 diff --git a/docs/markdown/mesh-core-cst/type-aliases/RequireAnyOf.md b/docs/markdown/mesh-core-cst/type-aliases/RequireAnyOf.md new file mode 100644 index 000000000..fbee6ae09 --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/RequireAnyOf.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / RequireAnyOf + +# Type Alias: RequireAnyOf + +> **RequireAnyOf** = `Cardano.NativeScriptKind.RequireAnyOf` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:260 diff --git a/docs/markdown/mesh-core-cst/type-aliases/RequireNOf.md b/docs/markdown/mesh-core-cst/type-aliases/RequireNOf.md new file mode 100644 index 000000000..e67afaf9b --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/RequireNOf.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / RequireNOf + +# Type Alias: RequireNOf + +> **RequireNOf** = `Cardano.NativeScriptKind.RequireNOf` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:263 diff --git a/docs/markdown/mesh-core-cst/type-aliases/RequireSignature.md b/docs/markdown/mesh-core-cst/type-aliases/RequireSignature.md new file mode 100644 index 000000000..0d6b3ad6b --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/RequireSignature.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / RequireSignature + +# Type Alias: RequireSignature + +> **RequireSignature** = `Cardano.NativeScriptKind.RequireSignature` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:266 diff --git a/docs/markdown/mesh-core-cst/type-aliases/RequireTimeAfter.md b/docs/markdown/mesh-core-cst/type-aliases/RequireTimeAfter.md new file mode 100644 index 000000000..7e0892e96 --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/RequireTimeAfter.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / RequireTimeAfter + +# Type Alias: RequireTimeAfter + +> **RequireTimeAfter** = `Cardano.NativeScriptKind.RequireTimeAfter` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:269 diff --git a/docs/markdown/mesh-core-cst/type-aliases/RequireTimeBefore.md b/docs/markdown/mesh-core-cst/type-aliases/RequireTimeBefore.md new file mode 100644 index 000000000..2ea1c21a9 --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/RequireTimeBefore.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / RequireTimeBefore + +# Type Alias: RequireTimeBefore + +> **RequireTimeBefore** = `Cardano.NativeScriptKind.RequireTimeBefore` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:272 diff --git a/docs/markdown/mesh-core-cst/type-aliases/RewardAccount.md b/docs/markdown/mesh-core-cst/type-aliases/RewardAccount.md new file mode 100644 index 000000000..ba64d1440 --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/RewardAccount.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / RewardAccount + +# Type Alias: RewardAccount + +> **RewardAccount** = `Cardano.RewardAccount` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:228 diff --git a/docs/markdown/mesh-core-cst/type-aliases/RewardAddress.md b/docs/markdown/mesh-core-cst/type-aliases/RewardAddress.md new file mode 100644 index 000000000..1214d7b56 --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/RewardAddress.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / RewardAddress + +# Type Alias: RewardAddress + +> **RewardAddress** = `Cardano.RewardAddress` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:95 diff --git a/docs/markdown/mesh-core-cst/type-aliases/Script.md b/docs/markdown/mesh-core-cst/type-aliases/Script.md new file mode 100644 index 000000000..1a497f5d5 --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/Script.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / Script + +# Type Alias: Script + +> **Script** = `Serialization.Script` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:77 diff --git a/docs/markdown/mesh-core-cst/type-aliases/ScriptHash.md b/docs/markdown/mesh-core-cst/type-aliases/ScriptHash.md new file mode 100644 index 000000000..865cff830 --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/ScriptHash.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / ScriptHash + +# Type Alias: ScriptHash + +> **ScriptHash** = `Crypto.Hash28ByteBase16` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:89 diff --git a/docs/markdown/mesh-core-cst/type-aliases/ScriptPubkey.md b/docs/markdown/mesh-core-cst/type-aliases/ScriptPubkey.md new file mode 100644 index 000000000..1d1be8d81 --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/ScriptPubkey.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / ScriptPubkey + +# Type Alias: ScriptPubkey + +> **ScriptPubkey** = `Serialization.ScriptPubkey` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:278 diff --git a/docs/markdown/mesh-core-cst/type-aliases/Signatures.md b/docs/markdown/mesh-core-cst/type-aliases/Signatures.md new file mode 100644 index 000000000..d9eb4d2af --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/Signatures.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / Signatures + +# Type Alias: Signatures + +> **Signatures** = `Cardano.Signatures` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:255 diff --git a/docs/markdown/mesh-core-cst/type-aliases/Signer.md b/docs/markdown/mesh-core-cst/type-aliases/Signer.md new file mode 100644 index 000000000..80aec2893 --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/Signer.md @@ -0,0 +1,27 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / Signer + +# Type Alias: Signer + +> **Signer** = `object` + +Defined in: packages/mesh-core-cst/src/types/signer.ts:4 + +## Properties + +### address + +> **address**: [`Address`](Address.md) + +Defined in: packages/mesh-core-cst/src/types/signer.ts:5 + +*** + +### key + +> **key**: [`Ed25519PrivateKey`](Ed25519PrivateKey.md) + +Defined in: packages/mesh-core-cst/src/types/signer.ts:6 diff --git a/docs/markdown/mesh-core-cst/type-aliases/Slot.md b/docs/markdown/mesh-core-cst/type-aliases/Slot.md new file mode 100644 index 000000000..d7a038e71 --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/Slot.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / Slot + +# Type Alias: Slot + +> **Slot** = `Cardano.Slot` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:6 diff --git a/docs/markdown/mesh-core-cst/type-aliases/StakeCredentialStatus.md b/docs/markdown/mesh-core-cst/type-aliases/StakeCredentialStatus.md new file mode 100644 index 000000000..9a1bc94b7 --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/StakeCredentialStatus.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / StakeCredentialStatus + +# Type Alias: StakeCredentialStatus + +> **StakeCredentialStatus** = `Cardano.StakeCredentialStatus` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:287 diff --git a/docs/markdown/mesh-core-cst/type-aliases/StakeDelegation.md b/docs/markdown/mesh-core-cst/type-aliases/StakeDelegation.md new file mode 100644 index 000000000..4b8d3512a --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/StakeDelegation.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / StakeDelegation + +# Type Alias: StakeDelegation + +> **StakeDelegation** = `Serialization.StakeDelegation` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:157 diff --git a/docs/markdown/mesh-core-cst/type-aliases/StakeDelegationCertificate.md b/docs/markdown/mesh-core-cst/type-aliases/StakeDelegationCertificate.md new file mode 100644 index 000000000..e87cff9d0 --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/StakeDelegationCertificate.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / StakeDelegationCertificate + +# Type Alias: StakeDelegationCertificate + +> **StakeDelegationCertificate** = `Cardano.StakeDelegationCertificate` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:160 diff --git a/docs/markdown/mesh-core-cst/type-aliases/StakeRegistration.md b/docs/markdown/mesh-core-cst/type-aliases/StakeRegistration.md new file mode 100644 index 000000000..9ceb10930 --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/StakeRegistration.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / StakeRegistration + +# Type Alias: StakeRegistration + +> **StakeRegistration** = `Serialization.StakeRegistration` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:154 diff --git a/docs/markdown/mesh-core-cst/type-aliases/TokenMap.md b/docs/markdown/mesh-core-cst/type-aliases/TokenMap.md new file mode 100644 index 000000000..841e1ecac --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/TokenMap.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / TokenMap + +# Type Alias: TokenMap + +> **TokenMap** = `Cardano.TokenMap` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:12 diff --git a/docs/markdown/mesh-core-cst/type-aliases/Transaction.md b/docs/markdown/mesh-core-cst/type-aliases/Transaction.md new file mode 100644 index 000000000..6ba5040c9 --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/Transaction.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / Transaction + +# Type Alias: Transaction + +> **Transaction** = `Serialization.Transaction` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:14 diff --git a/docs/markdown/mesh-core-cst/type-aliases/TransactionBody.md b/docs/markdown/mesh-core-cst/type-aliases/TransactionBody.md new file mode 100644 index 000000000..cdbeea312 --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/TransactionBody.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / TransactionBody + +# Type Alias: TransactionBody + +> **TransactionBody** = `Serialization.TransactionBody` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:22 diff --git a/docs/markdown/mesh-core-cst/type-aliases/TransactionId.md b/docs/markdown/mesh-core-cst/type-aliases/TransactionId.md new file mode 100644 index 000000000..c6bfba03b --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/TransactionId.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / TransactionId + +# Type Alias: TransactionId + +> **TransactionId** = `Cardano.TransactionId` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:17 diff --git a/docs/markdown/mesh-core-cst/type-aliases/TransactionInput.md b/docs/markdown/mesh-core-cst/type-aliases/TransactionInput.md new file mode 100644 index 000000000..83b150c68 --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/TransactionInput.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / TransactionInput + +# Type Alias: TransactionInput + +> **TransactionInput** = `Serialization.TransactionInput` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:43 diff --git a/docs/markdown/mesh-core-cst/type-aliases/TransactionInputSet.md b/docs/markdown/mesh-core-cst/type-aliases/TransactionInputSet.md new file mode 100644 index 000000000..d3dc7c7a0 --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/TransactionInputSet.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / TransactionInputSet + +# Type Alias: TransactionInputSet + +> **TransactionInputSet** = `Serialization.CborSet`\<`ReturnType`\<[`TransactionInput`](TransactionInput.md)\[`"toCore"`\]\>, [`TransactionInput`](TransactionInput.md)\> + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:49 diff --git a/docs/markdown/mesh-core-cst/type-aliases/TransactionMetadatum.md b/docs/markdown/mesh-core-cst/type-aliases/TransactionMetadatum.md new file mode 100644 index 000000000..1748fd7ce --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/TransactionMetadatum.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / TransactionMetadatum + +# Type Alias: TransactionMetadatum + +> **TransactionMetadatum** = `Serialization.TransactionMetadatum` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:31 diff --git a/docs/markdown/mesh-core-cst/type-aliases/TransactionOutput.md b/docs/markdown/mesh-core-cst/type-aliases/TransactionOutput.md new file mode 100644 index 000000000..5a4eb9d8b --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/TransactionOutput.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / TransactionOutput + +# Type Alias: TransactionOutput + +> **TransactionOutput** = `Serialization.TransactionOutput` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:46 diff --git a/docs/markdown/mesh-core-cst/type-aliases/TransactionUnspentOutput.md b/docs/markdown/mesh-core-cst/type-aliases/TransactionUnspentOutput.md new file mode 100644 index 000000000..354d97ff1 --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/TransactionUnspentOutput.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / TransactionUnspentOutput + +# Type Alias: TransactionUnspentOutput + +> **TransactionUnspentOutput** = `Serialization.TransactionUnspentOutput` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:40 diff --git a/docs/markdown/mesh-core-cst/type-aliases/TransactionWitnessPlutusData.md b/docs/markdown/mesh-core-cst/type-aliases/TransactionWitnessPlutusData.md new file mode 100644 index 000000000..b2be2e862 --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/TransactionWitnessPlutusData.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / TransactionWitnessPlutusData + +# Type Alias: TransactionWitnessPlutusData + +> **TransactionWitnessPlutusData** = `Set`\<[`PlutusData`](PlutusData.md)\> + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:54 diff --git a/docs/markdown/mesh-core-cst/type-aliases/TransactionWitnessSet.md b/docs/markdown/mesh-core-cst/type-aliases/TransactionWitnessSet.md new file mode 100644 index 000000000..7aff57b1b --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/TransactionWitnessSet.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / TransactionWitnessSet + +# Type Alias: TransactionWitnessSet + +> **TransactionWitnessSet** = `Serialization.TransactionWitnessSet` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:25 diff --git a/docs/markdown/mesh-core-cst/type-aliases/TxCBOR.md b/docs/markdown/mesh-core-cst/type-aliases/TxCBOR.md new file mode 100644 index 000000000..ef7810418 --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/TxCBOR.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / TxCBOR + +# Type Alias: TxCBOR + +> **TxCBOR** = `Serialization.TxCBOR` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:295 diff --git a/docs/markdown/mesh-core-cst/type-aliases/TxIndex.md b/docs/markdown/mesh-core-cst/type-aliases/TxIndex.md new file mode 100644 index 000000000..a71388801 --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/TxIndex.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / TxIndex + +# Type Alias: TxIndex + +> **TxIndex** = `Cardano.TxIndex` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:213 diff --git a/docs/markdown/mesh-core-cst/type-aliases/Value.md b/docs/markdown/mesh-core-cst/type-aliases/Value.md new file mode 100644 index 000000000..e034d674b --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/Value.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / Value + +# Type Alias: Value + +> **Value** = `Serialization.Value` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:9 diff --git a/docs/markdown/mesh-core-cst/type-aliases/VkeyWitness.md b/docs/markdown/mesh-core-cst/type-aliases/VkeyWitness.md new file mode 100644 index 000000000..f22d4cd7b --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/VkeyWitness.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / VkeyWitness + +# Type Alias: VkeyWitness + +> **VkeyWitness** = `Serialization.VkeyWitness` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:165 diff --git a/docs/markdown/mesh-core-cst/type-aliases/VrfVkBech32.md b/docs/markdown/mesh-core-cst/type-aliases/VrfVkBech32.md new file mode 100644 index 000000000..a295ae6c9 --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/VrfVkBech32.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / VrfVkBech32 + +# Type Alias: VrfVkBech32 + +> **VrfVkBech32** = `Cardano.VrfVkBech32` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:275 diff --git a/docs/markdown/mesh-core-cst/type-aliases/Witness.md b/docs/markdown/mesh-core-cst/type-aliases/Witness.md new file mode 100644 index 000000000..c58316438 --- /dev/null +++ b/docs/markdown/mesh-core-cst/type-aliases/Witness.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / Witness + +# Type Alias: Witness + +> **Witness** = `Cardano.Witness` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:254 diff --git a/docs/markdown/mesh-core-cst/variables/Address.md b/docs/markdown/mesh-core-cst/variables/Address.md new file mode 100644 index 000000000..f27ffdf60 --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/Address.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / Address + +# Variable: Address + +> `const` **Address**: *typeof* `Address` = `Cardano.Address` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:92 diff --git a/docs/markdown/mesh-core-cst/variables/AddressType.md b/docs/markdown/mesh-core-cst/variables/AddressType.md new file mode 100644 index 000000000..8242fbc07 --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/AddressType.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / AddressType + +# Variable: AddressType + +> `const` **AddressType**: *typeof* `AddressType` = `Cardano.AddressType` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:98 diff --git a/docs/markdown/mesh-core-cst/variables/AssetFingerprint.md b/docs/markdown/mesh-core-cst/variables/AssetFingerprint.md new file mode 100644 index 000000000..ee32c08e9 --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/AssetFingerprint.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / AssetFingerprint + +# Variable: AssetFingerprint() + +> `const` **AssetFingerprint**: (`value`) => `AssetFingerprint` = `Cardano.AssetFingerprint` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:110 + +## Parameters + +### value + +`string` + +## Returns + +`AssetFingerprint` diff --git a/docs/markdown/mesh-core-cst/variables/AssetId.md b/docs/markdown/mesh-core-cst/variables/AssetId.md new file mode 100644 index 000000000..91b4b6290 --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/AssetId.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / AssetId + +# Variable: AssetId() + +> `const` **AssetId**: (`value`) => `AssetId` = `Cardano.AssetId` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:86 + +## Parameters + +### value + +`string` + +## Returns + +`AssetId` diff --git a/docs/markdown/mesh-core-cst/variables/AssetName.md b/docs/markdown/mesh-core-cst/variables/AssetName.md new file mode 100644 index 000000000..4223c9544 --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/AssetName.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / AssetName + +# Variable: AssetName() + +> `const` **AssetName**: (`value`) => `AssetName` = `Cardano.AssetName` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:83 + +## Parameters + +### value + +`string` + +## Returns + +`AssetName` diff --git a/docs/markdown/mesh-core-cst/variables/AuxilliaryData.md b/docs/markdown/mesh-core-cst/variables/AuxilliaryData.md new file mode 100644 index 000000000..9350f7063 --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/AuxilliaryData.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / AuxilliaryData + +# Variable: AuxilliaryData + +> `const` **AuxilliaryData**: *typeof* `AuxiliaryData` = `Serialization.AuxiliaryData` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:28 diff --git a/docs/markdown/mesh-core-cst/variables/BaseAddress.md b/docs/markdown/mesh-core-cst/variables/BaseAddress.md new file mode 100644 index 000000000..6bab9de0d --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/BaseAddress.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / BaseAddress + +# Variable: BaseAddress + +> `const` **BaseAddress**: *typeof* `BaseAddress` = `Cardano.BaseAddress` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:101 diff --git a/docs/markdown/mesh-core-cst/variables/Bip32PrivateKey.md b/docs/markdown/mesh-core-cst/variables/Bip32PrivateKey.md new file mode 100644 index 000000000..9ea22d898 --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/Bip32PrivateKey.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / Bip32PrivateKey + +# Variable: Bip32PrivateKey + +> `const` **Bip32PrivateKey**: *typeof* `Bip32PrivateKey` = `Crypto.Bip32PrivateKey` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:177 diff --git a/docs/markdown/mesh-core-cst/variables/Bip32PrivateKeyHex.md b/docs/markdown/mesh-core-cst/variables/Bip32PrivateKeyHex.md new file mode 100644 index 000000000..02e856d9b --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/Bip32PrivateKeyHex.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / Bip32PrivateKeyHex + +# Variable: Bip32PrivateKeyHex() + +> `const` **Bip32PrivateKeyHex**: (`key`) => `Bip32PrivateKeyHex` = `Crypto.Bip32PrivateKeyHex` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:180 + +## Parameters + +### key + +`string` + +## Returns + +`Bip32PrivateKeyHex` diff --git a/docs/markdown/mesh-core-cst/variables/Bip32PublicKey.md b/docs/markdown/mesh-core-cst/variables/Bip32PublicKey.md new file mode 100644 index 000000000..cdb5685d0 --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/Bip32PublicKey.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / Bip32PublicKey + +# Variable: Bip32PublicKey + +> `const` **Bip32PublicKey**: *typeof* `Bip32PublicKey` = `Crypto.Bip32PublicKey` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:183 diff --git a/docs/markdown/mesh-core-cst/variables/Bip32PublicKeyHex.md b/docs/markdown/mesh-core-cst/variables/Bip32PublicKeyHex.md new file mode 100644 index 000000000..ff0bd42e3 --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/Bip32PublicKeyHex.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / Bip32PublicKeyHex + +# Variable: Bip32PublicKeyHex() + +> `const` **Bip32PublicKeyHex**: (`key`) => `Bip32PublicKeyHex` = `Crypto.Bip32PublicKeyHex` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:186 + +## Parameters + +### key + +`string` + +## Returns + +`Bip32PublicKeyHex` diff --git a/docs/markdown/mesh-core-cst/variables/BootstrapWitness.md b/docs/markdown/mesh-core-cst/variables/BootstrapWitness.md new file mode 100644 index 000000000..23f5b1cfd --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/BootstrapWitness.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / BootstrapWitness + +# Variable: BootstrapWitness + +> **BootstrapWitness**: *typeof* `BootstrapWitness` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:304 diff --git a/docs/markdown/mesh-core-cst/variables/CborSet.md b/docs/markdown/mesh-core-cst/variables/CborSet.md new file mode 100644 index 000000000..1a1b54817 --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/CborSet.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / CborSet + +# Variable: CborSet + +> `const` **CborSet**: *typeof* `CborSet` = `Serialization.CborSet` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:252 diff --git a/docs/markdown/mesh-core-cst/variables/CborWriter.md b/docs/markdown/mesh-core-cst/variables/CborWriter.md new file mode 100644 index 000000000..b069518e0 --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/CborWriter.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / CborWriter + +# Variable: CborWriter + +> `const` **CborWriter**: *typeof* `CborWriter` = `Serialization.CborWriter` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:222 diff --git a/docs/markdown/mesh-core-cst/variables/CertIndex.md b/docs/markdown/mesh-core-cst/variables/CertIndex.md new file mode 100644 index 000000000..7f362a4b5 --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/CertIndex.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / CertIndex + +# Variable: CertIndex() + +> `const` **CertIndex**: (`value`) => `CertIndex` = `Cardano.CertIndex` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:210 + +## Parameters + +### value + +`number` + +## Returns + +`CertIndex` diff --git a/docs/markdown/mesh-core-cst/variables/Certificate.md b/docs/markdown/mesh-core-cst/variables/Certificate.md new file mode 100644 index 000000000..8210b1b0e --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/Certificate.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / Certificate + +# Variable: Certificate + +> `const` **Certificate**: *typeof* `Certificate` = `Serialization.Certificate` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:148 diff --git a/docs/markdown/mesh-core-cst/variables/CertificateType.md b/docs/markdown/mesh-core-cst/variables/CertificateType.md new file mode 100644 index 000000000..99083e374 --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/CertificateType.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / CertificateType + +# Variable: CertificateType + +> `const` **CertificateType**: *typeof* `CertificateType` = `Cardano.CertificateType` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:162 diff --git a/docs/markdown/mesh-core-cst/variables/ConstrPlutusData.md b/docs/markdown/mesh-core-cst/variables/ConstrPlutusData.md new file mode 100644 index 000000000..4d53924aa --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/ConstrPlutusData.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / ConstrPlutusData + +# Variable: ConstrPlutusData + +> `const` **ConstrPlutusData**: *typeof* `ConstrPlutusData` = `Serialization.ConstrPlutusData` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:225 diff --git a/docs/markdown/mesh-core-cst/variables/CostModel.md b/docs/markdown/mesh-core-cst/variables/CostModel.md new file mode 100644 index 000000000..31a3f796a --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/CostModel.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / CostModel + +# Variable: CostModel + +> `const` **CostModel**: *typeof* `CostModel` = `Serialization.CostModel` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:219 diff --git a/docs/markdown/mesh-core-cst/variables/Costmdls.md b/docs/markdown/mesh-core-cst/variables/Costmdls.md new file mode 100644 index 000000000..c53248b6a --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/Costmdls.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / Costmdls + +# Variable: Costmdls + +> `const` **Costmdls**: *typeof* `Costmdls` = `Serialization.Costmdls` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:216 diff --git a/docs/markdown/mesh-core-cst/variables/Credential.md b/docs/markdown/mesh-core-cst/variables/Credential.md new file mode 100644 index 000000000..a3cc38ed3 --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/Credential.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / Credential + +# Variable: Credential + +> `const` **Credential**: *typeof* `Credential` = `Serialization.Credential` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:113 diff --git a/docs/markdown/mesh-core-cst/variables/CredentialType.md b/docs/markdown/mesh-core-cst/variables/CredentialType.md new file mode 100644 index 000000000..b7a6c4490 --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/CredentialType.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / CredentialType + +# Variable: CredentialType + +> `const` **CredentialType**: *typeof* `CredentialType` = `Cardano.CredentialType` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:145 diff --git a/docs/markdown/mesh-core-cst/variables/DRep.md b/docs/markdown/mesh-core-cst/variables/DRep.md new file mode 100644 index 000000000..7e183ebc5 --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/DRep.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / DRep + +# Variable: DRep + +> **DRep**: *typeof* `DRep` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:284 diff --git a/docs/markdown/mesh-core-cst/variables/DRepID.md b/docs/markdown/mesh-core-cst/variables/DRepID.md new file mode 100644 index 000000000..bae7c5ef5 --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/DRepID.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / DRepID + +# Variable: DRepID() + +> **DRepID**: (`value`) => `DRepID` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:281 + +## Parameters + +### value + +`string` + +## Returns + +`DRepID` diff --git a/docs/markdown/mesh-core-cst/variables/Datum.md b/docs/markdown/mesh-core-cst/variables/Datum.md new file mode 100644 index 000000000..a86b6ed50 --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/Datum.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / Datum + +# Variable: Datum + +> `const` **Datum**: *typeof* `Datum` = `Serialization.Datum` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:239 diff --git a/docs/markdown/mesh-core-cst/variables/DatumKind.md b/docs/markdown/mesh-core-cst/variables/DatumKind.md new file mode 100644 index 000000000..cdbb8003d --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/DatumKind.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / DatumKind + +# Variable: DatumKind + +> `const` **DatumKind**: *typeof* `DatumKind` = `Serialization.DatumKind` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:250 diff --git a/docs/markdown/mesh-core-cst/variables/Ed25519KeyHash.md b/docs/markdown/mesh-core-cst/variables/Ed25519KeyHash.md new file mode 100644 index 000000000..dc4df8e2e --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/Ed25519KeyHash.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / Ed25519KeyHash + +# Variable: Ed25519KeyHash + +> `const` **Ed25519KeyHash**: *typeof* `Ed25519KeyHash` = `Crypto.Ed25519KeyHash` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:131 diff --git a/docs/markdown/mesh-core-cst/variables/Ed25519KeyHashHex.md b/docs/markdown/mesh-core-cst/variables/Ed25519KeyHashHex.md new file mode 100644 index 000000000..746db3b5f --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/Ed25519KeyHashHex.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / Ed25519KeyHashHex + +# Variable: Ed25519KeyHashHex() + +> `const` **Ed25519KeyHashHex**: (`value`) => `Ed25519KeyHashHex` = `Crypto.Ed25519KeyHashHex` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:134 + +## Parameters + +### value + +`string` + +## Returns + +`Ed25519KeyHashHex` diff --git a/docs/markdown/mesh-core-cst/variables/Ed25519PrivateExtendedKeyHex.md b/docs/markdown/mesh-core-cst/variables/Ed25519PrivateExtendedKeyHex.md new file mode 100644 index 000000000..cc8c99b7f --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/Ed25519PrivateExtendedKeyHex.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / Ed25519PrivateExtendedKeyHex + +# Variable: Ed25519PrivateExtendedKeyHex() + +> **Ed25519PrivateExtendedKeyHex**: (`value`) => [`Ed25519PrivateExtendedKeyHex`](../type-aliases/Ed25519PrivateExtendedKeyHex.md) + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:126 + +## Parameters + +### value + +`string` + +## Returns + +[`Ed25519PrivateExtendedKeyHex`](../type-aliases/Ed25519PrivateExtendedKeyHex.md) diff --git a/docs/markdown/mesh-core-cst/variables/Ed25519PrivateKey.md b/docs/markdown/mesh-core-cst/variables/Ed25519PrivateKey.md new file mode 100644 index 000000000..619572920 --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/Ed25519PrivateKey.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / Ed25519PrivateKey + +# Variable: Ed25519PrivateKey + +> **Ed25519PrivateKey**: *typeof* `Ed25519PrivateKey` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:298 diff --git a/docs/markdown/mesh-core-cst/variables/Ed25519PrivateNormalKeyHex.md b/docs/markdown/mesh-core-cst/variables/Ed25519PrivateNormalKeyHex.md new file mode 100644 index 000000000..29b64a24d --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/Ed25519PrivateNormalKeyHex.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / Ed25519PrivateNormalKeyHex + +# Variable: Ed25519PrivateNormalKeyHex() + +> **Ed25519PrivateNormalKeyHex**: (`value`) => [`Ed25519PrivateNormalKeyHex`](../type-aliases/Ed25519PrivateNormalKeyHex.md) + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:121 + +## Parameters + +### value + +`string` + +## Returns + +[`Ed25519PrivateNormalKeyHex`](../type-aliases/Ed25519PrivateNormalKeyHex.md) diff --git a/docs/markdown/mesh-core-cst/variables/Ed25519PublicKey.md b/docs/markdown/mesh-core-cst/variables/Ed25519PublicKey.md new file mode 100644 index 000000000..69bd6cb51 --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/Ed25519PublicKey.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / Ed25519PublicKey + +# Variable: Ed25519PublicKey + +> `const` **Ed25519PublicKey**: *typeof* `Ed25519PublicKey` = `Crypto.Ed25519PublicKey` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:171 diff --git a/docs/markdown/mesh-core-cst/variables/Ed25519PublicKeyHex.md b/docs/markdown/mesh-core-cst/variables/Ed25519PublicKeyHex.md new file mode 100644 index 000000000..d0395e404 --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/Ed25519PublicKeyHex.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / Ed25519PublicKeyHex + +# Variable: Ed25519PublicKeyHex() + +> `const` **Ed25519PublicKeyHex**: (`value`) => `Ed25519PublicKeyHex` = `Crypto.Ed25519PublicKeyHex` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:118 + +## Parameters + +### value + +`string` + +## Returns + +`Ed25519PublicKeyHex` diff --git a/docs/markdown/mesh-core-cst/variables/Ed25519Signature.md b/docs/markdown/mesh-core-cst/variables/Ed25519Signature.md new file mode 100644 index 000000000..106280b20 --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/Ed25519Signature.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / Ed25519Signature + +# Variable: Ed25519Signature + +> `const` **Ed25519Signature**: *typeof* `Ed25519Signature` = `Crypto.Ed25519Signature` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:174 diff --git a/docs/markdown/mesh-core-cst/variables/Ed25519SignatureHex.md b/docs/markdown/mesh-core-cst/variables/Ed25519SignatureHex.md new file mode 100644 index 000000000..9cafd3f72 --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/Ed25519SignatureHex.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / Ed25519SignatureHex + +# Variable: Ed25519SignatureHex() + +> `const` **Ed25519SignatureHex**: (`value`) => `Ed25519SignatureHex` = `Crypto.Ed25519SignatureHex` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:168 + +## Parameters + +### value + +`string` + +## Returns + +`Ed25519SignatureHex` diff --git a/docs/markdown/mesh-core-cst/variables/EnterpriseAddress.md b/docs/markdown/mesh-core-cst/variables/EnterpriseAddress.md new file mode 100644 index 000000000..f76de2813 --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/EnterpriseAddress.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / EnterpriseAddress + +# Variable: EnterpriseAddress + +> `const` **EnterpriseAddress**: *typeof* `EnterpriseAddress` = `Cardano.EnterpriseAddress` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:104 diff --git a/docs/markdown/mesh-core-cst/variables/ExUnits.md b/docs/markdown/mesh-core-cst/variables/ExUnits.md new file mode 100644 index 000000000..a8419da2e --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/ExUnits.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / ExUnits + +# Variable: ExUnits + +> **ExUnits**: *typeof* `ExUnits` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:244 diff --git a/docs/markdown/mesh-core-cst/variables/Hash.md b/docs/markdown/mesh-core-cst/variables/Hash.md new file mode 100644 index 000000000..7591898b5 --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/Hash.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / Hash + +# Variable: Hash + +> `const` **Hash**: *typeof* `Hash` = `Serialization.Hash` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:231 diff --git a/docs/markdown/mesh-core-cst/variables/Hash28ByteBase16.md b/docs/markdown/mesh-core-cst/variables/Hash28ByteBase16.md new file mode 100644 index 000000000..aa1c06d1e --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/Hash28ByteBase16.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / Hash28ByteBase16 + +# Variable: Hash28ByteBase16() + +> `const` **Hash28ByteBase16**: (`value`) => `Hash28ByteBase16` = `Crypto.Hash28ByteBase16` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:137 + +## Parameters + +### value + +`string` + +## Returns + +`Hash28ByteBase16` diff --git a/docs/markdown/mesh-core-cst/variables/HexBlob.md b/docs/markdown/mesh-core-cst/variables/HexBlob.md new file mode 100644 index 000000000..b54a6b03b --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/HexBlob.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / HexBlob + +# Variable: HexBlob() + +> **HexBlob**: (`target`) => `HexBlob` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:292 + +## Parameters + +### target + +`string` + +## Returns + +`HexBlob` diff --git a/docs/markdown/mesh-core-cst/variables/MetadatumList.md b/docs/markdown/mesh-core-cst/variables/MetadatumList.md new file mode 100644 index 000000000..a95942648 --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/MetadatumList.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / MetadatumList + +# Variable: MetadatumList + +> `const` **MetadatumList**: *typeof* `MetadatumList` = `Serialization.MetadatumList` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:37 diff --git a/docs/markdown/mesh-core-cst/variables/MetadatumMap.md b/docs/markdown/mesh-core-cst/variables/MetadatumMap.md new file mode 100644 index 000000000..924db6a8b --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/MetadatumMap.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / MetadatumMap + +# Variable: MetadatumMap + +> `const` **MetadatumMap**: *typeof* `MetadatumMap` = `Serialization.MetadatumMap` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:34 diff --git a/docs/markdown/mesh-core-cst/variables/NativeScript.md b/docs/markdown/mesh-core-cst/variables/NativeScript.md new file mode 100644 index 000000000..57650bde7 --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/NativeScript.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / NativeScript + +# Variable: NativeScript + +> `const` **NativeScript**: *typeof* `NativeScript` = `Serialization.NativeScript` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:192 diff --git a/docs/markdown/mesh-core-cst/variables/NetworkId.md b/docs/markdown/mesh-core-cst/variables/NetworkId.md new file mode 100644 index 000000000..f0085605e --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/NetworkId.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / NetworkId + +# Variable: NetworkId + +> `const` **NetworkId**: *typeof* `NetworkId` = `Cardano.NetworkId` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:247 diff --git a/docs/markdown/mesh-core-cst/variables/PaymentAddress.md b/docs/markdown/mesh-core-cst/variables/PaymentAddress.md new file mode 100644 index 000000000..859437bbc --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/PaymentAddress.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / PaymentAddress + +# Variable: PaymentAddress() + +> `const` **PaymentAddress**: (`value`) => `PaymentAddress` = `Cardano.PaymentAddress` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:107 + +## Parameters + +### value + +`string` + +## Returns + +`PaymentAddress` diff --git a/docs/markdown/mesh-core-cst/variables/PlutusData.md b/docs/markdown/mesh-core-cst/variables/PlutusData.md new file mode 100644 index 000000000..b8e618ec1 --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/PlutusData.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / PlutusData + +# Variable: PlutusData + +> `const` **PlutusData**: *typeof* `PlutusData` = `Serialization.PlutusData` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:56 diff --git a/docs/markdown/mesh-core-cst/variables/PlutusDataKind.md b/docs/markdown/mesh-core-cst/variables/PlutusDataKind.md new file mode 100644 index 000000000..4946e58c0 --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/PlutusDataKind.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / PlutusDataKind + +# Variable: PlutusDataKind + +> `const` **PlutusDataKind**: *typeof* `PlutusDataKind` = `Serialization.PlutusDataKind` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:204 diff --git a/docs/markdown/mesh-core-cst/variables/PlutusLanguageVersion.md b/docs/markdown/mesh-core-cst/variables/PlutusLanguageVersion.md new file mode 100644 index 000000000..a707da3c0 --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/PlutusLanguageVersion.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / PlutusLanguageVersion + +# Variable: PlutusLanguageVersion + +> `const` **PlutusLanguageVersion**: *typeof* `PlutusLanguageVersion` = `Cardano.PlutusLanguageVersion` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:189 diff --git a/docs/markdown/mesh-core-cst/variables/PlutusList.md b/docs/markdown/mesh-core-cst/variables/PlutusList.md new file mode 100644 index 000000000..39b547a68 --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/PlutusList.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / PlutusList + +# Variable: PlutusList + +> `const` **PlutusList**: *typeof* `PlutusList` = `Serialization.PlutusList` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:59 diff --git a/docs/markdown/mesh-core-cst/variables/PlutusMap.md b/docs/markdown/mesh-core-cst/variables/PlutusMap.md new file mode 100644 index 000000000..cbaf2d7ba --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/PlutusMap.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / PlutusMap + +# Variable: PlutusMap + +> `const` **PlutusMap**: *typeof* `PlutusMap` = `Serialization.PlutusMap` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:62 diff --git a/docs/markdown/mesh-core-cst/variables/PlutusV1Script.md b/docs/markdown/mesh-core-cst/variables/PlutusV1Script.md new file mode 100644 index 000000000..1d65a1af5 --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/PlutusV1Script.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / PlutusV1Script + +# Variable: PlutusV1Script + +> `const` **PlutusV1Script**: *typeof* `PlutusV1Script` = `Serialization.PlutusV1Script` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:195 diff --git a/docs/markdown/mesh-core-cst/variables/PlutusV2Script.md b/docs/markdown/mesh-core-cst/variables/PlutusV2Script.md new file mode 100644 index 000000000..be8e95dd3 --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/PlutusV2Script.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / PlutusV2Script + +# Variable: PlutusV2Script + +> `const` **PlutusV2Script**: *typeof* `PlutusV2Script` = `Serialization.PlutusV2Script` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:198 diff --git a/docs/markdown/mesh-core-cst/variables/PlutusV3Script.md b/docs/markdown/mesh-core-cst/variables/PlutusV3Script.md new file mode 100644 index 000000000..3514049aa --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/PlutusV3Script.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / PlutusV3Script + +# Variable: PlutusV3Script + +> `const` **PlutusV3Script**: *typeof* `PlutusV3Script` = `Serialization.PlutusV3Script` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:201 diff --git a/docs/markdown/mesh-core-cst/variables/PointerAddress.md b/docs/markdown/mesh-core-cst/variables/PointerAddress.md new file mode 100644 index 000000000..3ba7c2085 --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/PointerAddress.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / PointerAddress + +# Variable: PointerAddress + +> `const` **PointerAddress**: *typeof* `PointerAddress` = `Cardano.PointerAddress` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:207 diff --git a/docs/markdown/mesh-core-cst/variables/PolicyId.md b/docs/markdown/mesh-core-cst/variables/PolicyId.md new file mode 100644 index 000000000..e8f9bcafe --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/PolicyId.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / PolicyId + +# Variable: PolicyId() + +> `const` **PolicyId**: (`value`) => `PolicyId` = `Cardano.PolicyId` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:80 + +## Parameters + +### value + +`string` + +## Returns + +`PolicyId` diff --git a/docs/markdown/mesh-core-cst/variables/PoolId.md b/docs/markdown/mesh-core-cst/variables/PoolId.md new file mode 100644 index 000000000..605cc0d7f --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/PoolId.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / PoolId + +# Variable: PoolId() + +> `const` **PoolId**: (`value`) => `PoolId` = `Cardano.PoolId` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:151 + +## Parameters + +### value + +`string` + +## Returns + +`PoolId` diff --git a/docs/markdown/mesh-core-cst/variables/Redeemer.md b/docs/markdown/mesh-core-cst/variables/Redeemer.md new file mode 100644 index 000000000..3bf143887 --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/Redeemer.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / Redeemer + +# Variable: Redeemer + +> `const` **Redeemer**: *typeof* `Redeemer` = `Serialization.Redeemer` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:68 diff --git a/docs/markdown/mesh-core-cst/variables/RedeemerPurpose.md b/docs/markdown/mesh-core-cst/variables/RedeemerPurpose.md new file mode 100644 index 000000000..a6bf1f097 --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/RedeemerPurpose.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / RedeemerPurpose + +# Variable: RedeemerPurpose + +> `const` **RedeemerPurpose**: *typeof* `RedeemerPurpose` = `Cardano.RedeemerPurpose` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:71 diff --git a/docs/markdown/mesh-core-cst/variables/RedeemerTag.md b/docs/markdown/mesh-core-cst/variables/RedeemerTag.md new file mode 100644 index 000000000..d1f979b29 --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/RedeemerTag.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / RedeemerTag + +# Variable: RedeemerTag + +> `const` **RedeemerTag**: *typeof* `RedeemerTag` = `Serialization.RedeemerTag` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:74 diff --git a/docs/markdown/mesh-core-cst/variables/Redeemers.md b/docs/markdown/mesh-core-cst/variables/Redeemers.md new file mode 100644 index 000000000..8dca5b4ec --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/Redeemers.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / Redeemers + +# Variable: Redeemers + +> `const` **Redeemers**: *typeof* `Redeemers` = `Serialization.Redeemers` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:65 diff --git a/docs/markdown/mesh-core-cst/variables/RequireAllOf.md b/docs/markdown/mesh-core-cst/variables/RequireAllOf.md new file mode 100644 index 000000000..acc527527 --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/RequireAllOf.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / RequireAllOf + +# Variable: RequireAllOf + +> **RequireAllOf**: `RequireAllOf` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:257 diff --git a/docs/markdown/mesh-core-cst/variables/RequireAnyOf.md b/docs/markdown/mesh-core-cst/variables/RequireAnyOf.md new file mode 100644 index 000000000..1717a4541 --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/RequireAnyOf.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / RequireAnyOf + +# Variable: RequireAnyOf + +> **RequireAnyOf**: `RequireAnyOf` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:260 diff --git a/docs/markdown/mesh-core-cst/variables/RequireNOf.md b/docs/markdown/mesh-core-cst/variables/RequireNOf.md new file mode 100644 index 000000000..aed88101f --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/RequireNOf.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / RequireNOf + +# Variable: RequireNOf + +> **RequireNOf**: `RequireNOf` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:263 diff --git a/docs/markdown/mesh-core-cst/variables/RequireSignature.md b/docs/markdown/mesh-core-cst/variables/RequireSignature.md new file mode 100644 index 000000000..454a4aa25 --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/RequireSignature.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / RequireSignature + +# Variable: RequireSignature + +> **RequireSignature**: `RequireSignature` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:266 diff --git a/docs/markdown/mesh-core-cst/variables/RequireTimeAfter.md b/docs/markdown/mesh-core-cst/variables/RequireTimeAfter.md new file mode 100644 index 000000000..f8d275c74 --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/RequireTimeAfter.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / RequireTimeAfter + +# Variable: RequireTimeAfter + +> **RequireTimeAfter**: `RequireTimeAfter` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:269 diff --git a/docs/markdown/mesh-core-cst/variables/RequireTimeBefore.md b/docs/markdown/mesh-core-cst/variables/RequireTimeBefore.md new file mode 100644 index 000000000..d4ffd975d --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/RequireTimeBefore.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / RequireTimeBefore + +# Variable: RequireTimeBefore + +> **RequireTimeBefore**: `RequireTimeBefore` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:272 diff --git a/docs/markdown/mesh-core-cst/variables/RewardAccount.md b/docs/markdown/mesh-core-cst/variables/RewardAccount.md new file mode 100644 index 000000000..69b1db95e --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/RewardAccount.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / RewardAccount + +# Variable: RewardAccount() + +> `const` **RewardAccount**: (`value`) => `RewardAccount` = `Cardano.RewardAccount` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:228 + +## Parameters + +### value + +`string` + +## Returns + +`RewardAccount` diff --git a/docs/markdown/mesh-core-cst/variables/RewardAddress.md b/docs/markdown/mesh-core-cst/variables/RewardAddress.md new file mode 100644 index 000000000..29dee85f6 --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/RewardAddress.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / RewardAddress + +# Variable: RewardAddress + +> `const` **RewardAddress**: *typeof* `RewardAddress` = `Cardano.RewardAddress` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:95 diff --git a/docs/markdown/mesh-core-cst/variables/Script.md b/docs/markdown/mesh-core-cst/variables/Script.md new file mode 100644 index 000000000..0e5d39532 --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/Script.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / Script + +# Variable: Script + +> `const` **Script**: *typeof* `Script` = `Serialization.Script` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:77 diff --git a/docs/markdown/mesh-core-cst/variables/ScriptHash.md b/docs/markdown/mesh-core-cst/variables/ScriptHash.md new file mode 100644 index 000000000..90fe1098a --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/ScriptHash.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / ScriptHash + +# Variable: ScriptHash() + +> `const` **ScriptHash**: (`value`) => `Hash28ByteBase16` = `Crypto.Hash28ByteBase16` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:89 + +## Parameters + +### value + +`string` + +## Returns + +`Hash28ByteBase16` diff --git a/docs/markdown/mesh-core-cst/variables/ScriptPubkey.md b/docs/markdown/mesh-core-cst/variables/ScriptPubkey.md new file mode 100644 index 000000000..b3cdc2ccc --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/ScriptPubkey.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / ScriptPubkey + +# Variable: ScriptPubkey + +> **ScriptPubkey**: *typeof* `ScriptPubkey` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:278 diff --git a/docs/markdown/mesh-core-cst/variables/Slot.md b/docs/markdown/mesh-core-cst/variables/Slot.md new file mode 100644 index 000000000..93243b4f4 --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/Slot.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / Slot + +# Variable: Slot() + +> `const` **Slot**: (`value`) => `Slot` = `Cardano.Slot` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:6 + +## Parameters + +### value + +`number` + +## Returns + +`Slot` diff --git a/docs/markdown/mesh-core-cst/variables/StakeCredentialStatus.md b/docs/markdown/mesh-core-cst/variables/StakeCredentialStatus.md new file mode 100644 index 000000000..86a1922ad --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/StakeCredentialStatus.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / StakeCredentialStatus + +# Variable: StakeCredentialStatus + +> **StakeCredentialStatus**: *typeof* `StakeCredentialStatus` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:287 diff --git a/docs/markdown/mesh-core-cst/variables/StakeDelegation.md b/docs/markdown/mesh-core-cst/variables/StakeDelegation.md new file mode 100644 index 000000000..cfa21d7ff --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/StakeDelegation.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / StakeDelegation + +# Variable: StakeDelegation + +> `const` **StakeDelegation**: *typeof* `StakeDelegation` = `Serialization.StakeDelegation` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:157 diff --git a/docs/markdown/mesh-core-cst/variables/StakeRegistration.md b/docs/markdown/mesh-core-cst/variables/StakeRegistration.md new file mode 100644 index 000000000..f1329ca9f --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/StakeRegistration.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / StakeRegistration + +# Variable: StakeRegistration + +> `const` **StakeRegistration**: *typeof* `StakeRegistration` = `Serialization.StakeRegistration` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:154 diff --git a/docs/markdown/mesh-core-cst/variables/Transaction.md b/docs/markdown/mesh-core-cst/variables/Transaction.md new file mode 100644 index 000000000..0467c13fa --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/Transaction.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / Transaction + +# Variable: Transaction + +> `const` **Transaction**: *typeof* `Transaction` = `Serialization.Transaction` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:14 diff --git a/docs/markdown/mesh-core-cst/variables/TransactionBody.md b/docs/markdown/mesh-core-cst/variables/TransactionBody.md new file mode 100644 index 000000000..1fec72dd8 --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/TransactionBody.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / TransactionBody + +# Variable: TransactionBody + +> `const` **TransactionBody**: *typeof* `TransactionBody` = `Serialization.TransactionBody` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:22 diff --git a/docs/markdown/mesh-core-cst/variables/TransactionInput.md b/docs/markdown/mesh-core-cst/variables/TransactionInput.md new file mode 100644 index 000000000..44cea40b8 --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/TransactionInput.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / TransactionInput + +# Variable: TransactionInput + +> `const` **TransactionInput**: *typeof* `TransactionInput` = `Serialization.TransactionInput` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:43 diff --git a/docs/markdown/mesh-core-cst/variables/TransactionMetadatum.md b/docs/markdown/mesh-core-cst/variables/TransactionMetadatum.md new file mode 100644 index 000000000..8789963a1 --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/TransactionMetadatum.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / TransactionMetadatum + +# Variable: TransactionMetadatum + +> `const` **TransactionMetadatum**: *typeof* `TransactionMetadatum` = `Serialization.TransactionMetadatum` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:31 diff --git a/docs/markdown/mesh-core-cst/variables/TransactionOutput.md b/docs/markdown/mesh-core-cst/variables/TransactionOutput.md new file mode 100644 index 000000000..4589cbb95 --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/TransactionOutput.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / TransactionOutput + +# Variable: TransactionOutput + +> `const` **TransactionOutput**: *typeof* `TransactionOutput` = `Serialization.TransactionOutput` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:46 diff --git a/docs/markdown/mesh-core-cst/variables/TransactionUnspentOutput.md b/docs/markdown/mesh-core-cst/variables/TransactionUnspentOutput.md new file mode 100644 index 000000000..0adbd6ef4 --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/TransactionUnspentOutput.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / TransactionUnspentOutput + +# Variable: TransactionUnspentOutput + +> `const` **TransactionUnspentOutput**: *typeof* `TransactionUnspentOutput` = `Serialization.TransactionUnspentOutput` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:40 diff --git a/docs/markdown/mesh-core-cst/variables/TransactionWitnessSet.md b/docs/markdown/mesh-core-cst/variables/TransactionWitnessSet.md new file mode 100644 index 000000000..1571d9f3a --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/TransactionWitnessSet.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / TransactionWitnessSet + +# Variable: TransactionWitnessSet + +> `const` **TransactionWitnessSet**: *typeof* `TransactionWitnessSet` = `Serialization.TransactionWitnessSet` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:25 diff --git a/docs/markdown/mesh-core-cst/variables/TxCBOR.md b/docs/markdown/mesh-core-cst/variables/TxCBOR.md new file mode 100644 index 000000000..2f64858a2 --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/TxCBOR.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / TxCBOR + +# Variable: TxCBOR() + +> **TxCBOR**: (`tx`) => `TxCBOR` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:295 + +## Parameters + +### tx + +`string` + +## Returns + +`TxCBOR` diff --git a/docs/markdown/mesh-core-cst/variables/TxIndex.md b/docs/markdown/mesh-core-cst/variables/TxIndex.md new file mode 100644 index 000000000..74c16c8fa --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/TxIndex.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / TxIndex + +# Variable: TxIndex() + +> `const` **TxIndex**: (`value`) => `TxIndex` = `Cardano.TxIndex` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:213 + +## Parameters + +### value + +`number` + +## Returns + +`TxIndex` diff --git a/docs/markdown/mesh-core-cst/variables/Value.md b/docs/markdown/mesh-core-cst/variables/Value.md new file mode 100644 index 000000000..5af2ce46f --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/Value.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / Value + +# Variable: Value + +> `const` **Value**: *typeof* `Value` = `Serialization.Value` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:9 diff --git a/docs/markdown/mesh-core-cst/variables/VkeyWitness.md b/docs/markdown/mesh-core-cst/variables/VkeyWitness.md new file mode 100644 index 000000000..283435c95 --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/VkeyWitness.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / VkeyWitness + +# Variable: VkeyWitness + +> `const` **VkeyWitness**: *typeof* `VkeyWitness` = `Serialization.VkeyWitness` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:165 diff --git a/docs/markdown/mesh-core-cst/variables/VrfVkBech32.md b/docs/markdown/mesh-core-cst/variables/VrfVkBech32.md new file mode 100644 index 000000000..f2bf43899 --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/VrfVkBech32.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / VrfVkBech32 + +# Variable: VrfVkBech32() + +> **VrfVkBech32**: (`value`) => `VrfVkBech32` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:275 + +## Parameters + +### value + +`string` + +## Returns + +`VrfVkBech32` diff --git a/docs/markdown/mesh-core-cst/variables/blake2b.md b/docs/markdown/mesh-core-cst/variables/blake2b.md new file mode 100644 index 000000000..40c5726b9 --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/blake2b.md @@ -0,0 +1,11 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / blake2b + +# Variable: blake2b + +> `const` **blake2b**: *typeof* `blake2b` = `Crypto.blake2b` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:302 diff --git a/docs/markdown/mesh-core-cst/variables/computeAuxiliaryDataHash.md b/docs/markdown/mesh-core-cst/variables/computeAuxiliaryDataHash.md new file mode 100644 index 000000000..6f4eb6440 --- /dev/null +++ b/docs/markdown/mesh-core-cst/variables/computeAuxiliaryDataHash.md @@ -0,0 +1,21 @@ +[**@meshsdk/core-cst**](../README.md) + +*** + +[@meshsdk/core-cst](../globals.md) / computeAuxiliaryDataHash + +# Variable: computeAuxiliaryDataHash() + +> `const` **computeAuxiliaryDataHash**: (`data`) => `undefined` \| `Hash32ByteBase16` = `Cardano.computeAuxiliaryDataHash` + +Defined in: packages/mesh-core-cst/src/types/cardano-sdk.ts:301 + +## Parameters + +### data + +`undefined` | `AuxiliaryData` + +## Returns + +`undefined` \| `Hash32ByteBase16` diff --git a/docs/markdown/mesh-providers/README.md b/docs/markdown/mesh-providers/README.md new file mode 100644 index 000000000..c5a1b9790 --- /dev/null +++ b/docs/markdown/mesh-providers/README.md @@ -0,0 +1,9 @@ +**@meshsdk/provider** + +*** + +# mesh-provider + +Blockchain data providers - [meshjs.dev/providers](https://meshjs.dev/providers) + +[meshjs.dev](https://meshjs.dev/) diff --git a/docs/markdown/mesh-providers/classes/BeginProvider.md b/docs/markdown/mesh-providers/classes/BeginProvider.md new file mode 100644 index 000000000..60bddd12e --- /dev/null +++ b/docs/markdown/mesh-providers/classes/BeginProvider.md @@ -0,0 +1,107 @@ +[**@meshsdk/provider**](../README.md) + +*** + +[@meshsdk/provider](../globals.md) / BeginProvider + +# Class: BeginProvider + +Defined in: begin.ts:16 + +The BeginProvider class provides methods to query Begin ID. + +To use this provider, simply create a new instance of the BeginProvider class and call the desired method. + +```typescript +import { BeginProvider } from "@meshsdk/core"; + +const beginProvider = new BeginProvider(); +``` + +## Constructors + +### Constructor + +> **new BeginProvider**(`apikey?`): `BeginProvider` + +Defined in: begin.ts:25 + +Creates a new instance of the BeginProvider. + +#### Parameters + +##### apikey? + +`string` + +The API key for querying Begin ID. + +#### Returns + +`BeginProvider` + +## Methods + +### resolveAddress() + +> **resolveAddress**(`name`, `url?`): `Promise`\<\{ `address`: `string`; `domain`: `string`; `image`: `string`; `name`: `string`; \}\> + +Defined in: begin.ts:39 + +Given a Begin ID, resolves the address and other information. + +#### Parameters + +##### name + +`string` + +name of Begin ID, e.g. `mesh` + +##### url? + +`string` + +optional URL to override the default: https://resolveidaddress-ylo5dtxzdq-uc.a.run.app + +#### Returns + +`Promise`\<\{ `address`: `string`; `domain`: `string`; `image`: `string`; `name`: `string`; \}\> + +- name: string +- domain: string +- image: string +- address: string + +*** + +### resolveAdressReverse() + +> **resolveAdressReverse**(`address`, `url?`): `Promise`\<\{ `address`: `string`; `domain`: `string`; `image`: `string`; `name`: `string`; \}\> + +Defined in: begin.ts:90 + +Given an address, resolves the Begin ID and other information. + +#### Parameters + +##### address + +`string` + +address to resolve + +##### url? + +`string` + +optional URL to override the default: https://resolveIdReserveAddress-ylo5dtxzdq-uc.a.run.app + +#### Returns + +`Promise`\<\{ `address`: `string`; `domain`: `string`; `image`: `string`; `name`: `string`; \}\> + +- name: string +- domain: string +- image: string +- address: string diff --git a/docs/markdown/mesh-providers/classes/BlockfrostProvider.md b/docs/markdown/mesh-providers/classes/BlockfrostProvider.md new file mode 100644 index 000000000..260f76c32 --- /dev/null +++ b/docs/markdown/mesh-providers/classes/BlockfrostProvider.md @@ -0,0 +1,810 @@ +[**@meshsdk/provider**](../README.md) + +*** + +[@meshsdk/provider](../globals.md) / BlockfrostProvider + +# Class: BlockfrostProvider + +Defined in: blockfrost.ts:59 + +Blockfrost provides restful APIs which allows your app to access information stored on the blockchain. + +Usage: +``` +import { BlockfrostProvider } from "@meshsdk/core"; + +const provider = new BlockfrostProvider(''); + +// With caching enabled +const providerWithCache = new BlockfrostProvider('', 0, { enableCaching: true }); +``` + +## Implements + +- `IFetcher` +- `IListener` +- `ISubmitter` +- `IEvaluator` + +## Constructors + +### Constructor + +> **new BlockfrostProvider**(`baseUrl`, `cachingOptions?`): `BlockfrostProvider` + +Defined in: blockfrost.ts:73 + +If you are using a privately hosted Blockfrost instance, you can set the URL in the parameter. + +#### Parameters + +##### baseUrl + +`string` + +The base URL of the instance. + +##### cachingOptions? + +[`BlockfrostCachingOptions`](../type-aliases/BlockfrostCachingOptions.md) + +Optional caching configuration + +#### Returns + +`BlockfrostProvider` + +### Constructor + +> **new BlockfrostProvider**(`projectId`, `version?`, `cachingOptions?`): `BlockfrostProvider` + +Defined in: blockfrost.ts:81 + +If you are using [Blockfrost](https://blockfrost.io/) hosted instance, you can set the project ID in the parameter. + +#### Parameters + +##### projectId + +`string` + +The project ID of the instance. + +##### version? + +`number` + +The version of the API. Default is 0. + +##### cachingOptions? + +[`BlockfrostCachingOptions`](../type-aliases/BlockfrostCachingOptions.md) + +Optional caching configuration + +#### Returns + +`BlockfrostProvider` + +## Methods + +### clearCache() + +> **clearCache**(): `void` + +Defined in: blockfrost.ts:885 + +Clear all cached data. + +#### Returns + +`void` + +*** + +### evaluateTx() + +> **evaluateTx**(`cbor`): `Promise`\<`Omit`\<`Action`, `"data"`\>[]\> + +Defined in: blockfrost.ts:117 + +Evaluates the resources required to execute the transaction + +#### Parameters + +##### cbor + +`string` + +#### Returns + +`Promise`\<`Omit`\<`Action`, `"data"`\>[]\> + +#### Implementation of + +`IEvaluator.evaluateTx` + +*** + +### exportCache() + +> **exportCache**(): `null` \| `string` + +Defined in: blockfrost.ts:862 + +Export the cached data as JSON string. + +#### Returns + +`null` \| `string` + +JSON string of cached data or null if caching is disabled + +*** + +### fetchAccountInfo() + +> **fetchAccountInfo**(`address`): `Promise`\<`AccountInfo`\> + +Defined in: blockfrost.ts:160 + +Obtain information about a specific stake account. + +#### Parameters + +##### address + +`string` + +Wallet address to fetch account information + +#### Returns + +`Promise`\<`AccountInfo`\> + +#### Implementation of + +`IFetcher.fetchAccountInfo` + +*** + +### fetchAddressAssets() + +> **fetchAddressAssets**(`address`): `Promise`\<\{[`key`: `string`]: `string`; \}\> + +Defined in: blockfrost.ts:190 + +Fetches the assets for a given address. + +#### Parameters + +##### address + +`string` + +The address to fetch assets for + +#### Returns + +`Promise`\<\{[`key`: `string`]: `string`; \}\> + +A map of asset unit to quantity + +*** + +### fetchAddressTransactions() + +> **fetchAddressTransactions**(`address`): `Promise`\<`TransactionInfo`[]\> + +Defined in: blockfrost.ts:238 + +Deprecated, use fetchAddressTxs instead + +#### Parameters + +##### address + +`string` + +#### Returns + +`Promise`\<`TransactionInfo`[]\> + +- partial TransactionInfo + +*** + +### fetchAddressTxs() + +> **fetchAddressTxs**(`address`, `option`): `Promise`\<`TransactionInfo`[]\> + +Defined in: blockfrost.ts:202 + +Transactions for an address. The `TransactionInfo` would only return the `hash`, `inputs`, and `outputs`. + +#### Parameters + +##### address + +`string` + +The address to fetch transactions for + +##### option + +`IFetcherOptions` = `DEFAULT_FETCHER_OPTIONS` + +#### Returns + +`Promise`\<`TransactionInfo`[]\> + +- partial TransactionInfo + +#### Implementation of + +`IFetcher.fetchAddressTxs` + +*** + +### fetchAddressUTxOs() + +> **fetchAddressUTxOs**(`address`, `asset?`): `Promise`\<`UTxO`[]\> + +Defined in: blockfrost.ts:248 + +UTXOs of the address. + +#### Parameters + +##### address + +`string` + +The address to fetch UTXO + +##### asset? + +`string` + +UTXOs of a given asset​ + +#### Returns + +`Promise`\<`UTxO`[]\> + +- Array of UTxOs + +#### Implementation of + +`IFetcher.fetchAddressUTxOs` + +*** + +### fetchAssetAddresses() + +> **fetchAssetAddresses**(`asset`): `Promise`\<`object`[]\> + +Defined in: blockfrost.ts:310 + +Fetches the asset addresses for a given asset. + +#### Parameters + +##### asset + +`string` + +The asset to fetch addresses for + +#### Returns + +`Promise`\<`object`[]\> + +#### Implementation of + +`IFetcher.fetchAssetAddresses` + +*** + +### fetchAssetMetadata() + +> **fetchAssetMetadata**(`asset`): `Promise`\<`any`\> + +Defined in: blockfrost.ts:342 + +Fetches the metadata for a given asset. + +#### Parameters + +##### asset + +`string` + +The asset to fetch metadata for + +#### Returns + +`Promise`\<`any`\> + +The metadata for the asset + +#### Implementation of + +`IFetcher.fetchAssetMetadata` + +*** + +### fetchBlockInfo() + +> **fetchBlockInfo**(`hash`): `Promise`\<`BlockInfo`\> + +Defined in: blockfrost.ts:402 + +Fetches the block information for a given block hash. + +#### Parameters + +##### hash + +`string` + +The block hash to fetch from + +#### Returns + +`Promise`\<`BlockInfo`\> + +The block information + +#### Implementation of + +`IFetcher.fetchBlockInfo` + +*** + +### fetchCollectionAssets() + +> **fetchCollectionAssets**(`policyId`, `cursor`): `Promise`\<\{ `assets`: `Asset`[]; `next`: `null` \| `string` \| `number`; \}\> + +Defined in: blockfrost.ts:437 + +Fetches the list of assets for a given policy ID. + +#### Parameters + +##### policyId + +`string` + +The policy ID to fetch assets for + +##### cursor + +`number` = `1` + +The cursor for pagination + +#### Returns + +`Promise`\<\{ `assets`: `Asset`[]; `next`: `null` \| `string` \| `number`; \}\> + +The list of assets and the next cursor + +#### Implementation of + +`IFetcher.fetchCollectionAssets` + +*** + +### fetchGovernanceProposal() + +> **fetchGovernanceProposal**(`txHash`, `certIndex`): `Promise`\<`GovernanceProposalInfo`\> + +Defined in: blockfrost.ts:612 + +Fetches the governance proposal information. + +#### Parameters + +##### txHash + +`string` + +The transaction hash of the proposal + +##### certIndex + +`number` + +The certificate index of the proposal + +#### Returns + +`Promise`\<`GovernanceProposalInfo`\> + +The governance proposal information + +#### Implementation of + +`IFetcher.fetchGovernanceProposal` + +*** + +### fetchHandle() + +> **fetchHandle**(`handle`): `Promise`\<`any`\> + +Defined in: blockfrost.ts:461 + +#### Parameters + +##### handle + +`string` + +#### Returns + +`Promise`\<`any`\> + +*** + +### fetchHandleAddress() + +> **fetchHandleAddress**(`handle`): `Promise`\<`string`\> + +Defined in: blockfrost.ts:478 + +#### Parameters + +##### handle + +`string` + +#### Returns + +`Promise`\<`string`\> + +*** + +### fetchLatestBlock() + +> **fetchLatestBlock**(): `Promise`\<`BlockInfo`\> + +Defined in: blockfrost.ts:368 + +Fetches the metadata for a given asset. + +#### Returns + +`Promise`\<`BlockInfo`\> + +The metadata for the asset + +*** + +### fetchProtocolParameters() + +> **fetchProtocolParameters**(`epoch`): `Promise`\<`Protocol`\> + +Defined in: blockfrost.ts:503 + +Fetch the latest protocol parameters. + +#### Parameters + +##### epoch + +`number` = `Number.NaN` + +Optional - The epoch to fetch protocol parameters for + +#### Returns + +`Promise`\<`Protocol`\> + +- Protocol parameters + +#### Implementation of + +`IFetcher.fetchProtocolParameters` + +*** + +### fetchTxInfo() + +> **fetchTxInfo**(`hash`): `Promise`\<`TransactionInfo`\> + +Defined in: blockfrost.ts:544 + +Fetches the transaction information for a given transaction hash. + +#### Parameters + +##### hash + +`string` + +The transaction hash to fetch + +#### Returns + +`Promise`\<`TransactionInfo`\> + +The transaction information + +#### Implementation of + +`IFetcher.fetchTxInfo` + +*** + +### fetchUTxOs() + +> **fetchUTxOs**(`hash`, `index?`): `Promise`\<`UTxO`[]\> + +Defined in: blockfrost.ts:581 + +Get UTxOs for a given hash. + +#### Parameters + +##### hash + +`string` + +The transaction hash + +##### index? + +`number` + +Optional - The output index for filtering post fetching + +#### Returns + +`Promise`\<`UTxO`[]\> + +- Array of UTxOs + +#### Implementation of + +`IFetcher.fetchUTxOs` + +*** + +### get() + +> **get**(`url`): `Promise`\<`any`\> + +Defined in: blockfrost.ts:650 + +A generic method to fetch data from a URL. + +#### Parameters + +##### url + +`string` + +The URL to fetch data from + +#### Returns + +`Promise`\<`any`\> + +- The data fetched from the URL + +#### Implementation of + +`IFetcher.get` + +*** + +### getOfflineFetcher() + +> **getOfflineFetcher**(): `undefined` \| [`OfflineFetcher`](OfflineFetcher.md) + +Defined in: blockfrost.ts:846 + +Get the current OfflineFetcher instance if caching is enabled. + +#### Returns + +`undefined` \| [`OfflineFetcher`](OfflineFetcher.md) + +The OfflineFetcher instance or undefined if caching is disabled + +*** + +### importCache() + +> **importCache**(`jsonData`, `enableCaching`): `void` + +Defined in: blockfrost.ts:871 + +Import cached data from JSON string. + +#### Parameters + +##### jsonData + +`string` + +JSON string containing cached data + +##### enableCaching + +`boolean` = `true` + +Whether to enable caching if not already enabled + +#### Returns + +`void` + +*** + +### isCachingEnabled() + +> **isCachingEnabled**(): `boolean` + +Defined in: blockfrost.ts:854 + +Check if caching is currently enabled. + +#### Returns + +`boolean` + +True if caching is enabled, false otherwise + +*** + +### onTxConfirmed() + +> **onTxConfirmed**(`txHash`, `callback`, `limit`): `void` + +Defined in: blockfrost.ts:693 + +Allow you to listen to a transaction confirmation. Upon confirmation, the callback will be called. + +#### Parameters + +##### txHash + +`string` + +The transaction hash to listen for confirmation + +##### callback + +() => `void` + +The callback function to call when the transaction is confirmed + +##### limit + +`number` = `100` + +The number of blocks to wait for confirmation + +#### Returns + +`void` + +#### Implementation of + +`IListener.onTxConfirmed` + +*** + +### post() + +> **post**(`url`, `body`, `headers`): `Promise`\<`any`\> + +Defined in: blockfrost.ts:669 + +A generic method to post data to a URL. + +#### Parameters + +##### url + +`string` + +The URL to fetch data from + +##### body + +`any` + +Payload + +##### headers + +Specify headers, default: { "Content-Type": "application/json" } + +###### Content-Type + +`string` = `"application/json"` + +#### Returns + +`Promise`\<`any`\> + +- Data + +*** + +### setCaching() + +> **setCaching**(`enable`, `offlineFetcher?`): `void` + +Defined in: blockfrost.ts:833 + +Enable or disable caching functionality. + +#### Parameters + +##### enable + +`boolean` + +Whether to enable caching + +##### offlineFetcher? + +[`OfflineFetcher`](OfflineFetcher.md) + +Optional custom OfflineFetcher instance to use + +#### Returns + +`void` + +*** + +### setSubmitTxToBytes() + +> **setSubmitTxToBytes**(`value`): `void` + +Defined in: blockfrost.ts:718 + +#### Parameters + +##### value + +`boolean` + +#### Returns + +`void` + +*** + +### submitTx() + +> **submitTx**(`tx`): `Promise`\<`string`\> + +Defined in: blockfrost.ts:727 + +Submit a serialized transaction to the network. + +#### Parameters + +##### tx + +`string` + +The serialized transaction in hex to submit + +#### Returns + +`Promise`\<`string`\> + +The transaction hash of the submitted transaction + +#### Implementation of + +`ISubmitter.submitTx` diff --git a/docs/markdown/mesh-providers/classes/KoiosProvider.md b/docs/markdown/mesh-providers/classes/KoiosProvider.md new file mode 100644 index 000000000..f81af3710 --- /dev/null +++ b/docs/markdown/mesh-providers/classes/KoiosProvider.md @@ -0,0 +1,583 @@ +[**@meshsdk/provider**](../README.md) + +*** + +[@meshsdk/provider](../globals.md) / KoiosProvider + +# Class: KoiosProvider + +Defined in: koios.ts:39 + +## Implements + +- `IFetcher` +- `IListener` +- `ISubmitter` + +## Constructors + +### Constructor + +> **new KoiosProvider**(`baseUrl`): `KoiosProvider` + +Defined in: koios.ts:43 + +#### Parameters + +##### baseUrl + +`string` + +#### Returns + +`KoiosProvider` + +### Constructor + +> **new KoiosProvider**(`network`, `token`, `version?`): `KoiosProvider` + +Defined in: koios.ts:44 + +#### Parameters + +##### network + +[`KoiosSupportedNetworks`](../type-aliases/KoiosSupportedNetworks.md) + +##### token + +`string` + +##### version? + +`number` + +#### Returns + +`KoiosProvider` + +## Methods + +### fetchAccountInfo() + +> **fetchAccountInfo**(`address`): `Promise`\<`AccountInfo`\> + +Defined in: koios.ts:81 + +Obtain information about a specific stake account. + +#### Parameters + +##### address + +`string` + +Wallet address to fetch account information + +#### Returns + +`Promise`\<`AccountInfo`\> + +#### Implementation of + +`IFetcher.fetchAccountInfo` + +*** + +### fetchAddressAssets() + +> **fetchAddressAssets**(`address`): `Promise`\<\{[`key`: `string`]: `string`; \}\> + +Defined in: koios.ts:111 + +Fetches the assets for a given address. + +#### Parameters + +##### address + +`string` + +The address to fetch assets for + +#### Returns + +`Promise`\<\{[`key`: `string`]: `string`; \}\> + +A map of asset unit to quantity + +*** + +### fetchAddressTransactions() + +> **fetchAddressTransactions**(`address`): `Promise`\<`TransactionInfo`[]\> + +Defined in: koios.ts:532 + +Deprecated, use fetchAddressTxs instead + +#### Parameters + +##### address + +`string` + +#### Returns + +`Promise`\<`TransactionInfo`[]\> + +- partial TransactionInfo + +*** + +### fetchAddressTxs() + +> **fetchAddressTxs**(`address`, `option`): `Promise`\<`TransactionInfo`[]\> + +Defined in: koios.ts:122 + +Unimplemented - open for contribution, see blockfrost.ts for reference + +#### Parameters + +##### address + +`string` + +##### option + +`IFetcherOptions` = `DEFAULT_FETCHER_OPTIONS` + +#### Returns + +`Promise`\<`TransactionInfo`[]\> + +#### Implementation of + +`IFetcher.fetchAddressTxs` + +*** + +### fetchAddressUTxOs() + +> **fetchAddressUTxOs**(`address`, `asset?`): `Promise`\<`UTxO`[]\> + +Defined in: koios.ts:157 + +UTXOs of the address. + +#### Parameters + +##### address + +`string` + +The address to fetch UTXO + +##### asset? + +`string` + +UTXOs of a given asset​ + +#### Returns + +`Promise`\<`UTxO`[]\> + +- Array of UTxOs + +#### Implementation of + +`IFetcher.fetchAddressUTxOs` + +*** + +### fetchAssetAddresses() + +> **fetchAssetAddresses**(`asset`): `Promise`\<`object`[]\> + +Defined in: koios.ts:188 + +Fetches the asset addresses for a given asset. + +#### Parameters + +##### asset + +`string` + +The asset to fetch addresses for + +#### Returns + +`Promise`\<`object`[]\> + +#### Implementation of + +`IFetcher.fetchAssetAddresses` + +*** + +### fetchAssetMetadata() + +> **fetchAssetMetadata**(`asset`): `Promise`\<`any`\> + +Defined in: koios.ts:220 + +Fetches the metadata for a given asset. + +#### Parameters + +##### asset + +`string` + +The asset to fetch metadata for + +#### Returns + +`Promise`\<`any`\> + +The metadata for the asset + +#### Implementation of + +`IFetcher.fetchAssetMetadata` + +*** + +### fetchBlockInfo() + +> **fetchBlockInfo**(`hash`): `Promise`\<`BlockInfo`\> + +Defined in: koios.ts:246 + +Fetches the block information for a given block hash. + +#### Parameters + +##### hash + +`string` + +The block hash to fetch from + +#### Returns + +`Promise`\<`BlockInfo`\> + +The block information + +#### Implementation of + +`IFetcher.fetchBlockInfo` + +*** + +### fetchCollectionAssets() + +> **fetchCollectionAssets**(`policyId`): `Promise`\<\{ `assets`: `Asset`[]; \}\> + +Defined in: koios.ts:283 + +Fetches the list of assets for a given policy ID. + +#### Parameters + +##### policyId + +`string` + +The policy ID to fetch assets for + +#### Returns + +`Promise`\<\{ `assets`: `Asset`[]; \}\> + +The list of assets and the next cursor + +#### Implementation of + +`IFetcher.fetchCollectionAssets` + +*** + +### fetchGovernanceProposal() + +> **fetchGovernanceProposal**(`txHash`, `certIndex`): `Promise`\<`GovernanceProposalInfo`\> + +Defined in: koios.ts:447 + +#### Parameters + +##### txHash + +`string` + +##### certIndex + +`number` + +#### Returns + +`Promise`\<`GovernanceProposalInfo`\> + +#### Implementation of + +`IFetcher.fetchGovernanceProposal` + +*** + +### fetchHandle() + +> **fetchHandle**(`handle`): `Promise`\<`any`\> + +Defined in: koios.ts:303 + +#### Parameters + +##### handle + +`string` + +#### Returns + +`Promise`\<`any`\> + +*** + +### fetchHandleAddress() + +> **fetchHandleAddress**(`handle`): `Promise`\<`string`\> + +Defined in: koios.ts:320 + +#### Parameters + +##### handle + +`string` + +#### Returns + +`Promise`\<`string`\> + +*** + +### fetchProtocolParameters() + +> **fetchProtocolParameters**(`epoch`): `Promise`\<`Protocol`\> + +Defined in: koios.ts:345 + +Fetch the latest protocol parameters. + +#### Parameters + +##### epoch + +`number` = `Number.NaN` + +#### Returns + +`Promise`\<`Protocol`\> + +- Protocol parameters + +#### Implementation of + +`IFetcher.fetchProtocolParameters` + +*** + +### fetchTxInfo() + +> **fetchTxInfo**(`hash`): `Promise`\<`TransactionInfo`\> + +Defined in: koios.ts:391 + +Fetches the transaction information for a given transaction hash. + +#### Parameters + +##### hash + +`string` + +The transaction hash to fetch + +#### Returns + +`Promise`\<`TransactionInfo`\> + +The transaction information + +#### Implementation of + +`IFetcher.fetchTxInfo` + +*** + +### fetchUTxOs() + +> **fetchUTxOs**(`hash`, `index?`): `Promise`\<`UTxO`[]\> + +Defined in: koios.ts:422 + +Get UTxOs for a given hash. + +#### Parameters + +##### hash + +`string` + +The transaction hash + +##### index? + +`number` + +Optional - The output index for filtering post fetching + +#### Returns + +`Promise`\<`UTxO`[]\> + +- Array of UTxOs + +#### Implementation of + +`IFetcher.fetchUTxOs` + +*** + +### get() + +> **get**(`url`): `Promise`\<`any`\> + +Defined in: koios.ts:459 + +A generic method to fetch data from a URL. + +#### Parameters + +##### url + +`string` + +The URL to fetch data from + +#### Returns + +`Promise`\<`any`\> + +- The data fetched from the URL + +#### Implementation of + +`IFetcher.get` + +*** + +### onTxConfirmed() + +> **onTxConfirmed**(`txHash`, `callback`, `limit`): `void` + +Defined in: koios.ts:502 + +Allow you to listen to a transaction confirmation. Upon confirmation, the callback will be called. + +#### Parameters + +##### txHash + +`string` + +The transaction hash to listen for confirmation + +##### callback + +() => `void` + +The callback function to call when the transaction is confirmed + +##### limit + +`number` = `100` + +The number of blocks to wait for confirmation + +#### Returns + +`void` + +#### Implementation of + +`IListener.onTxConfirmed` + +*** + +### post() + +> **post**(`url`, `body`, `headers`): `Promise`\<`any`\> + +Defined in: koios.ts:478 + +A generic method to post data to a URL. + +#### Parameters + +##### url + +`string` + +The URL to fetch data from + +##### body + +`any` + +Payload + +##### headers + +Specify headers, default: { "Content-Type": "application/json" } + +###### Content-Type + +`string` = `"application/json"` + +#### Returns + +`Promise`\<`any`\> + +- Data + +*** + +### submitTx() + +> **submitTx**(`tx`): `Promise`\<`string`\> + +Defined in: koios.ts:541 + +Submit a serialized transaction to the network. + +#### Parameters + +##### tx + +`string` + +The serialized transaction in hex to submit + +#### Returns + +`Promise`\<`string`\> + +The transaction hash of the submitted transaction + +#### Implementation of + +`ISubmitter.submitTx` diff --git a/docs/markdown/mesh-providers/classes/MaestroProvider.md b/docs/markdown/mesh-providers/classes/MaestroProvider.md new file mode 100644 index 000000000..81ab77472 --- /dev/null +++ b/docs/markdown/mesh-providers/classes/MaestroProvider.md @@ -0,0 +1,564 @@ +[**@meshsdk/provider**](../README.md) + +*** + +[@meshsdk/provider](../globals.md) / MaestroProvider + +# Class: MaestroProvider + +Defined in: maestro.ts:46 + +## Implements + +- `IFetcher` +- `ISubmitter` +- `IEvaluator` +- `IListener` + +## Constructors + +### Constructor + +> **new MaestroProvider**(`__namedParameters`): `MaestroProvider` + +Defined in: maestro.ts:59 + +#### Parameters + +##### \_\_namedParameters + +`MaestroConfig` + +#### Returns + +`MaestroProvider` + +## Properties + +### submitUrl + +> **submitUrl**: `string` + +Defined in: maestro.ts:57 + +## Methods + +### evaluateTx() + +> **evaluateTx**(`cbor`): `Promise`\<`Omit`\<`Action`, `"data"`\>[]\> + +Defined in: maestro.ts:72 + +Evaluates the resources required to execute the transaction + +#### Parameters + +##### cbor + +`string` + +#### Returns + +`Promise`\<`Omit`\<`Action`, `"data"`\>[]\> + +#### Implementation of + +`IEvaluator.evaluateTx` + +*** + +### fetchAccountInfo() + +> **fetchAccountInfo**(`address`): `Promise`\<`AccountInfo`\> + +Defined in: maestro.ts:104 + +Obtain information about a specific stake account. + +#### Parameters + +##### address + +`string` + +Wallet address to fetch account information + +#### Returns + +`Promise`\<`AccountInfo`\> + +#### Implementation of + +`IFetcher.fetchAccountInfo` + +*** + +### fetchAddressAssets() + +> **fetchAddressAssets**(`address`): `Promise`\<\{[`key`: `string`]: `string`; \}\> + +Defined in: maestro.ts:136 + +Fetches the assets for a given address. + +#### Parameters + +##### address + +`string` + +The address to fetch assets for + +#### Returns + +`Promise`\<\{[`key`: `string`]: `string`; \}\> + +A map of asset unit to quantity + +*** + +### fetchAddressTxs() + +> **fetchAddressTxs**(`address`, `option`): `Promise`\<`TransactionInfo`[]\> + +Defined in: maestro.ts:195 + +Unimplemented - open for contribution + +Transactions for an address. The `TransactionInfo` would only return the `hash`, `inputs`, and `outputs`. + +#### Parameters + +##### address + +`string` + +##### option + +`IFetcherOptions` = `...` + +#### Returns + +`Promise`\<`TransactionInfo`[]\> + +- partial TransactionInfo + +#### Implementation of + +`IFetcher.fetchAddressTxs` + +*** + +### fetchAddressUTxOs() + +> **fetchAddressUTxOs**(`address`, `asset?`): `Promise`\<`UTxO`[]\> + +Defined in: maestro.ts:149 + +UTXOs of the address. + +#### Parameters + +##### address + +`string` + +The address to fetch UTXO + +##### asset? + +`string` + +UTXOs of a given asset​ + +#### Returns + +`Promise`\<`UTxO`[]\> + +- Array of UTxOs + +#### Implementation of + +`IFetcher.fetchAddressUTxOs` + +*** + +### fetchAssetAddresses() + +> **fetchAssetAddresses**(`asset`): `Promise`\<`object`[]\> + +Defined in: maestro.ts:207 + +Fetches the asset addresses for a given asset. + +#### Parameters + +##### asset + +`string` + +The asset to fetch addresses for + +#### Returns + +`Promise`\<`object`[]\> + +#### Implementation of + +`IFetcher.fetchAssetAddresses` + +*** + +### fetchAssetMetadata() + +> **fetchAssetMetadata**(`asset`): `Promise`\<`any`\> + +Defined in: maestro.ts:253 + +Fetches the metadata for a given asset. + +#### Parameters + +##### asset + +`string` + +The asset to fetch metadata for + +#### Returns + +`Promise`\<`any`\> + +The metadata for the asset + +#### Implementation of + +`IFetcher.fetchAssetMetadata` + +*** + +### fetchBlockInfo() + +> **fetchBlockInfo**(`hash`): `Promise`\<`BlockInfo`\> + +Defined in: maestro.ts:282 + +Fetches the block information for a given block hash. + +#### Parameters + +##### hash + +`string` + +The block hash to fetch from + +#### Returns + +`Promise`\<`BlockInfo`\> + +The block information + +#### Implementation of + +`IFetcher.fetchBlockInfo` + +*** + +### fetchCollectionAssets() + +> **fetchCollectionAssets**(`policyId`, `cursor?`): `Promise`\<\{ `assets`: `Asset`[]; `next`: `null` \| `string` \| `number`; \}\> + +Defined in: maestro.ts:322 + +Fetches the list of assets for a given policy ID. + +#### Parameters + +##### policyId + +`string` + +The policy ID to fetch assets for + +##### cursor? + +`string` + +The cursor for pagination + +#### Returns + +`Promise`\<\{ `assets`: `Asset`[]; `next`: `null` \| `string` \| `number`; \}\> + +The list of assets and the next cursor + +#### Implementation of + +`IFetcher.fetchCollectionAssets` + +*** + +### fetchGovernanceProposal() + +> **fetchGovernanceProposal**(`txHash`, `certIndex`): `Promise`\<`GovernanceProposalInfo`\> + +Defined in: maestro.ts:526 + +Unimplemented - open for contribution + +Fetches the governance proposal information. + +#### Parameters + +##### txHash + +`string` + +The transaction hash of the proposal + +##### certIndex + +`number` + +The certificate index of the proposal + +#### Returns + +`Promise`\<`GovernanceProposalInfo`\> + +The governance proposal information + +#### Implementation of + +`IFetcher.fetchGovernanceProposal` + +*** + +### fetchHandle() + +> **fetchHandle**(`handle`): `Promise`\<`object`\> + +Defined in: maestro.ts:350 + +#### Parameters + +##### handle + +`string` + +#### Returns + +`Promise`\<`object`\> + +*** + +### fetchHandleAddress() + +> **fetchHandleAddress**(`handle`): `Promise`\<`string`\> + +Defined in: maestro.ts:370 + +#### Parameters + +##### handle + +`string` + +#### Returns + +`Promise`\<`string`\> + +*** + +### fetchProtocolParameters() + +> **fetchProtocolParameters**(`epoch`): `Promise`\<`Protocol`\> + +Defined in: maestro.ts:397 + +Fetch the latest protocol parameters. + +#### Parameters + +##### epoch + +`number` = `Number.NaN` + +#### Returns + +`Promise`\<`Protocol`\> + +- Protocol parameters + +#### Implementation of + +`IFetcher.fetchProtocolParameters` + +*** + +### fetchTxInfo() + +> **fetchTxInfo**(`hash`): `Promise`\<`TransactionInfo`\> + +Defined in: maestro.ts:464 + +Fetches the transaction information for a given transaction hash. + +#### Parameters + +##### hash + +`string` + +The transaction hash to fetch + +#### Returns + +`Promise`\<`TransactionInfo`\> + +The transaction information + +#### Implementation of + +`IFetcher.fetchTxInfo` + +*** + +### fetchUTxOs() + +> **fetchUTxOs**(`hash`, `index?`): `Promise`\<`UTxO`[]\> + +Defined in: maestro.ts:496 + +Get UTxOs for a given hash. + +#### Parameters + +##### hash + +`string` + +The transaction hash + +##### index? + +`number` + +Optional - The output index for filtering post fetching + +#### Returns + +`Promise`\<`UTxO`[]\> + +- Array of UTxOs + +#### Implementation of + +`IFetcher.fetchUTxOs` + +*** + +### get() + +> **get**(`url`): `Promise`\<`any`\> + +Defined in: maestro.ts:533 + +#### Parameters + +##### url + +`string` + +#### Returns + +`Promise`\<`any`\> + +#### Implementation of + +`IFetcher.get` + +*** + +### onTxConfirmed() + +> **onTxConfirmed**(`txHash`, `callback`, `limit`): `void` + +Defined in: maestro.ts:551 + +Allow you to listen to a transaction confirmation. Upon confirmation, the callback will be called. + +#### Parameters + +##### txHash + +`string` + +The transaction hash to listen for confirmation + +##### callback + +() => `void` + +The callback function to call when the transaction is confirmed + +##### limit + +`number` = `100` + +The number of blocks to wait for confirmation + +#### Returns + +`void` + +#### Implementation of + +`IListener.onTxConfirmed` + +*** + +### setSubmitTxToBytes() + +> **setSubmitTxToBytes**(`value`): `void` + +Defined in: maestro.ts:576 + +#### Parameters + +##### value + +`boolean` + +#### Returns + +`void` + +*** + +### submitTx() + +> **submitTx**(`tx`): `Promise`\<`string`\> + +Defined in: maestro.ts:585 + +Submit a serialized transaction to the network. + +#### Parameters + +##### tx + +`string` + +The serialized transaction in hex to submit + +#### Returns + +`Promise`\<`string`\> + +The transaction hash of the submitted transaction + +#### Implementation of + +`ISubmitter.submitTx` diff --git a/docs/markdown/mesh-providers/classes/OfflineFetcher.md b/docs/markdown/mesh-providers/classes/OfflineFetcher.md new file mode 100644 index 000000000..722d65111 --- /dev/null +++ b/docs/markdown/mesh-providers/classes/OfflineFetcher.md @@ -0,0 +1,816 @@ +[**@meshsdk/provider**](../README.md) + +*** + +[@meshsdk/provider](../globals.md) / OfflineFetcher + +# Class: OfflineFetcher + +Defined in: offline/offline-fetcher.ts:65 + +OfflineFetcher implements the IFetcher interface to provide offline access to blockchain data. +This class allows working with pre-loaded blockchain data without requiring network connectivity. +It's useful for testing, development, and scenarios where offline operation is needed. + +The class maintains internal storage for various blockchain data types: +- Account information +- UTXOs (Unspent Transaction Outputs) +- Asset addresses and metadata +- Block information +- Protocol parameters +- Transaction information + +Example usage: +```typescript +import { OfflineFetcher } from '@meshsdk/core'; + +// Create a new instance +const fetcher = new OfflineFetcher(); +//or const fetcher = new OfflineFetcher("mainnet"); + +// Add some blockchain data +fetcher.addAccount(address, accountInfo); +fetcher.addUTxOs(utxos); +fetcher.addSerializedTransaction("txHash"); + +// Use the fetcher with MeshWallet +const wallet = new MeshWallet({ + networkId: 0, + fetcher: fetcher, + key: { + type: 'address', + address: walletAddress + } +}); +``` + +## Implements + +- `IFetcher` + +## Constructors + +### Constructor + +> **new OfflineFetcher**(`network?`): `OfflineFetcher` + +Defined in: offline/offline-fetcher.ts:75 + +#### Parameters + +##### network? + +`"testnet"` | `"preview"` | `"preprod"` | `"mainnet"` + +#### Returns + +`OfflineFetcher` + +## Methods + +### addAccount() + +> **addAccount**(`address`, `accountInfo`): `void` + +Defined in: offline/offline-fetcher.ts:482 + +Adds account information to the fetcher. + +#### Parameters + +##### address + +`string` + +Account address + +##### accountInfo + +`AccountInfo` + +Account information + +#### Returns + +`void` + +#### Throws + +Error if address or account info invalid + +*** + +### addAssetAddresses() + +> **addAssetAddresses**(`asset`, `addresses`): `void` + +Defined in: offline/offline-fetcher.ts:611 + +Adds asset address information to the fetcher. + +#### Parameters + +##### asset + +`string` + +Asset identifier + +##### addresses + +`AssetAddress`[] + +Array of asset addresses + +#### Returns + +`void` + +#### Throws + +Error if asset or addresses invalid + +*** + +### addAssetMetadata() + +> **addAssetMetadata**(`asset`, `metadata`): `void` + +Defined in: offline/offline-fetcher.ts:639 + +Adds asset metadata to the fetcher. + +#### Parameters + +##### asset + +`string` + +Asset identifier + +##### metadata + +`any` + +Asset metadata + +#### Returns + +`void` + +#### Throws + +Error if asset or metadata invalid + +*** + +### addBlock() + +> **addBlock**(`blockInfo`): `void` + +Defined in: offline/offline-fetcher.ts:862 + +Adds block information to the fetcher. + +#### Parameters + +##### blockInfo + +`BlockInfo` + +Block information + +#### Returns + +`void` + +#### Throws + +Error if block info invalid + +*** + +### addCollectionAssets() + +> **addCollectionAssets**(`assets`): `void` + +Defined in: offline/offline-fetcher.ts:660 + +Adds collection assets to the fetcher. + +#### Parameters + +##### assets + +`Asset`[] + +Array of assets + +#### Returns + +`void` + +#### Throws + +Error if assets invalid + +*** + +### addProtocolParameters() + +> **addProtocolParameters**(`parameters`): `void` + +Defined in: offline/offline-fetcher.ts:714 + +Adds protocol parameters to the fetcher. + +#### Parameters + +##### parameters + +`Protocol` + +Protocol parameters + +#### Returns + +`void` + +#### Throws + +Error if parameters invalid + +*** + +### addSerializedTransaction() + +> **addSerializedTransaction**(`txHex`): `void` + +Defined in: offline/offline-fetcher.ts:918 + +Adds a serialized transaction to the fetcher, it's generates pseudo block in addition to transaction. +Removes spent UTxOs from the fetcher and adds new UTxOs from the transaction. + +#### Parameters + +##### txHex + +`string` + +Hexadecimal string of the transaction + +#### Returns + +`void` + +#### Throws + +Error if transaction hex invalid + +*** + +### addTransaction() + +> **addTransaction**(`txInfo`): `void` + +Defined in: offline/offline-fetcher.ts:809 + +Adds transaction information to the fetcher. + +#### Parameters + +##### txInfo + +`TransactionInfo` + +Transaction information + +#### Returns + +`void` + +#### Throws + +Error if transaction info invalid + +*** + +### addUTxOs() + +> **addUTxOs**(`utxos`): `void` + +Defined in: offline/offline-fetcher.ts:517 + +Adds UTXOs to the fetcher. + +#### Parameters + +##### utxos + +`UTxO`[] + +Array of UTXOs + +#### Returns + +`void` + +#### Throws + +Error if UTXOs invalid + +*** + +### fetchAccountInfo() + +> **fetchAccountInfo**(`address`): `Promise`\<`AccountInfo`\> + +Defined in: offline/offline-fetcher.ts:97 + +Fetches account information for a given address. + +#### Parameters + +##### address + +`string` + +Address to fetch info for + +#### Returns + +`Promise`\<`AccountInfo`\> + +Promise resolving to account information + +#### Throws + +Error if account not found + +#### Implementation of + +`IFetcher.fetchAccountInfo` + +*** + +### fetchAddressAssets() + +> **fetchAddressAssets**(`address`): `Promise`\<`Asset`[]\> + +Defined in: offline/offline-fetcher.ts:175 + +Fetches all assets associated with an address. + +#### Parameters + +##### address + +`string` + +Address to fetch assets for + +#### Returns + +`Promise`\<`Asset`[]\> + +Promise resolving to array of assets held by the address + +*** + +### fetchAddressTxs() + +> **fetchAddressTxs**(`address`, `options?`): `Promise`\<`TransactionInfo`[]\> + +Defined in: offline/offline-fetcher.ts:123 + +WIP - NOT IMPLEMENTED + +#### Parameters + +##### address + +`string` + +##### options? + +`IFetcherOptions` + +#### Returns + +`Promise`\<`TransactionInfo`[]\> + +#### Implementation of + +`IFetcher.fetchAddressTxs` + +*** + +### fetchAddressUTxOs() + +> **fetchAddressUTxOs**(`address`, `asset?`): `Promise`\<`UTxO`[]\> + +Defined in: offline/offline-fetcher.ts:109 + +Fetches UTXOs for a given address, optionally filtered by asset. + +#### Parameters + +##### address + +`string` + +Address to fetch UTXOs for + +##### asset? + +`string` + +Optional asset ID to filter UTXOs + +#### Returns + +`Promise`\<`UTxO`[]\> + +Promise resolving to array of UTXOs + +#### Implementation of + +`IFetcher.fetchAddressUTxOs` + +*** + +### fetchAssetAddresses() + +> **fetchAssetAddresses**(`asset`): `Promise`\<`AssetAddress`[]\> + +Defined in: offline/offline-fetcher.ts:135 + +Fetches addresses holding a specific asset. + +#### Parameters + +##### asset + +`string` + +Asset identifier + +#### Returns + +`Promise`\<`AssetAddress`[]\> + +Promise resolving to array of asset addresses and quantities + +#### Implementation of + +`IFetcher.fetchAssetAddresses` + +*** + +### fetchAssetMetadata() + +> **fetchAssetMetadata**(`asset`): `Promise`\<`any`\> + +Defined in: offline/offline-fetcher.ts:215 + +Fetches metadata for a specific asset. + +#### Parameters + +##### asset + +`string` + +Asset identifier + +#### Returns + +`Promise`\<`any`\> + +Promise resolving to asset metadata + +#### Throws + +Error if asset metadata not found + +#### Implementation of + +`IFetcher.fetchAssetMetadata` + +*** + +### fetchBlockInfo() + +> **fetchBlockInfo**(`hash`): `Promise`\<`BlockInfo`\> + +Defined in: offline/offline-fetcher.ts:227 + +Fetches information about a specific block. + +#### Parameters + +##### hash + +`string` + +Block hash + +#### Returns + +`Promise`\<`BlockInfo`\> + +Promise resolving to block information + +#### Throws + +Error if block not found + +#### Implementation of + +`IFetcher.fetchBlockInfo` + +*** + +### fetchCollectionAssets() + +> **fetchCollectionAssets**(`policyId`, `cursor?`): `Promise`\<\{ `assets`: `Asset`[]; `next?`: `string` \| `number`; \}\> + +Defined in: offline/offline-fetcher.ts:240 + +Fetches assets in a collection (by policy ID) with pagination. + +#### Parameters + +##### policyId + +`string` + +Policy ID of the collection + +##### cursor? + +Optional pagination cursor + +`string` | `number` + +#### Returns + +`Promise`\<\{ `assets`: `Asset`[]; `next?`: `string` \| `number`; \}\> + +Promise resolving to paginated assets and next cursor + +#### Throws + +Error if collection not found or invalid cursor + +#### Implementation of + +`IFetcher.fetchCollectionAssets` + +*** + +### fetchGovernanceProposal() + +> **fetchGovernanceProposal**(`txHash`, `certIndex`): `Promise`\<`any`\> + +Defined in: offline/offline-fetcher.ts:336 + +#### Parameters + +##### txHash + +`string` + +##### certIndex + +`number` + +#### Returns + +`Promise`\<`any`\> + +#### Implementation of + +`IFetcher.fetchGovernanceProposal` + +*** + +### fetchHandle() + +> **fetchHandle**(`handle`): `Promise`\<`any`\> + +Defined in: offline/offline-fetcher.ts:261 + +Fetches metadata for a handle. + +#### Parameters + +##### handle + +`string` + +Handle to fetch metadata for + +#### Returns + +`Promise`\<`any`\> + +Promise resolving to handle metadata + +#### Throws + +Error if handle not found or invalid + +*** + +### fetchHandleAddress() + +> **fetchHandleAddress**(`handle`): `Promise`\<`string`\> + +Defined in: offline/offline-fetcher.ts:277 + +Fetches address associated with a handle. + +#### Parameters + +##### handle + +`string` + +Handle to fetch address for + +#### Returns + +`Promise`\<`string`\> + +Promise resolving to address + +#### Throws + +Error if no address found for handle + +*** + +### fetchProtocolParameters() + +> **fetchProtocolParameters**(`epoch?`): `Promise`\<`Protocol`\> + +Defined in: offline/offline-fetcher.ts:296 + +Fetches protocol parameters for a specific epoch. + +#### Parameters + +##### epoch? + +`number` + +Epoch number + +#### Returns + +`Promise`\<`Protocol`\> + +Promise resolving to protocol parameters + +#### Throws + +Error if parameters not found for epoch + +#### Implementation of + +`IFetcher.fetchProtocolParameters` + +*** + +### fetchTxInfo() + +> **fetchTxInfo**(`hash`): `Promise`\<`TransactionInfo`\> + +Defined in: offline/offline-fetcher.ts:315 + +Fetches information about a specific transaction. + +#### Parameters + +##### hash + +`string` + +Transaction hash + +#### Returns + +`Promise`\<`TransactionInfo`\> + +Promise resolving to transaction information + +#### Throws + +Error if transaction not found + +#### Implementation of + +`IFetcher.fetchTxInfo` + +*** + +### fetchUTxOs() + +> **fetchUTxOs**(`hash`): `Promise`\<`UTxO`[]\> + +Defined in: offline/offline-fetcher.ts:327 + +Fetches all UTXOs associated with a specific transaction hash. + +#### Parameters + +##### hash + +`string` + +Transaction hash to fetch UTXOs for + +#### Returns + +`Promise`\<`UTxO`[]\> + +Promise resolving to array of UTXOs associated with the transaction + +#### Throws + +Error if no UTXOs found for the transaction hash + +#### Implementation of + +`IFetcher.fetchUTxOs` + +*** + +### get() + +> **get**(`url`): `Promise`\<`any`\> + +Defined in: offline/offline-fetcher.ts:348 + +HTTP GET method required by IFetcher interface but not implemented in OfflineFetcher. + +#### Parameters + +##### url + +`string` + +URL to fetch from + +#### Returns + +`Promise`\<`any`\> + +#### Throws + +Error always, as this fetcher operates offline + +#### Implementation of + +`IFetcher.get` + +*** + +### toJSON() + +> **toJSON**(): `string` + +Defined in: offline/offline-fetcher.ts:356 + +Serializes fetcher data to JSON string. + +#### Returns + +`string` + +JSON string containing all fetcher data + +*** + +### fromJSON() + +> `static` **fromJSON**(`json`): `OfflineFetcher` + +Defined in: offline/offline-fetcher.ts:374 + +Creates an OfflineFetcher instance from JSON data. + +#### Parameters + +##### json + +`string` + +JSON string containing fetcher data + +#### Returns + +`OfflineFetcher` + +New OfflineFetcher instance diff --git a/docs/markdown/mesh-providers/classes/OgmiosProvider.md b/docs/markdown/mesh-providers/classes/OgmiosProvider.md new file mode 100644 index 000000000..61e8461f2 --- /dev/null +++ b/docs/markdown/mesh-providers/classes/OgmiosProvider.md @@ -0,0 +1,120 @@ +[**@meshsdk/provider**](../README.md) + +*** + +[@meshsdk/provider](../globals.md) / OgmiosProvider + +# Class: OgmiosProvider + +Defined in: ogmios.ts:10 + +## Implements + +- `IEvaluator` +- `ISubmitter` + +## Constructors + +### Constructor + +> **new OgmiosProvider**(`baseUrl`): `OgmiosProvider` + +Defined in: ogmios.ts:13 + +#### Parameters + +##### baseUrl + +`string` + +#### Returns + +`OgmiosProvider` + +### Constructor + +> **new OgmiosProvider**(`network`): `OgmiosProvider` + +Defined in: ogmios.ts:14 + +#### Parameters + +##### network + +`"testnet"` | `"preview"` | `"preprod"` | `"mainnet"` + +#### Returns + +`OgmiosProvider` + +## Methods + +### evaluateTx() + +> **evaluateTx**(`tx`): `Promise`\<`Omit`\<`Action`, `"data"`\>[]\> + +Defined in: ogmios.ts:26 + +Evaluates the resources required to execute the transaction + +#### Parameters + +##### tx + +`string` + +The transaction to evaluate + +#### Returns + +`Promise`\<`Omit`\<`Action`, `"data"`\>[]\> + +#### Implementation of + +`IEvaluator.evaluateTx` + +*** + +### onNextTx() + +> **onNextTx**(`callback`): `Promise`\<() => `void`\> + +Defined in: ogmios.ts:68 + +#### Parameters + +##### callback + +(`tx`) => `void` + +#### Returns + +`Promise`\<() => `void`\> + +*** + +### submitTx() + +> **submitTx**(`tx`): `Promise`\<`string`\> + +Defined in: ogmios.ts:98 + +Submit a serialized transaction to the network. + +#### Parameters + +##### tx + +`string` + +The serialized transaction in hex to submit + +#### Returns + +`Promise`\<`string`\> + +The transaction hash of the submitted transaction + +#### Implementation of + +`ISubmitter.submitTx` diff --git a/docs/markdown/mesh-providers/classes/U5CProvider.md b/docs/markdown/mesh-providers/classes/U5CProvider.md new file mode 100644 index 000000000..bf38edfa5 --- /dev/null +++ b/docs/markdown/mesh-providers/classes/U5CProvider.md @@ -0,0 +1,675 @@ +[**@meshsdk/provider**](../README.md) + +*** + +[@meshsdk/provider](../globals.md) / U5CProvider + +# Class: U5CProvider + +Defined in: utxo-rpc.ts:118 + +A UTxO RPC Provider for [MeshJS](https://meshjs.dev/) Transaction Builder Library. + +Example usage of how to use the UTxO RPC provider with Mesh to build and submit a transaction. +``` +// Step #1 +// Import Mesh SDK and UTxO RPC provider +import { Transaction, MeshWallet, U5CProvider } from "@meshsdk/core"; + +async function main() { + // Step #2 + // Create a new U5C provider + const provider = new U5CProvider({ + url: "http://localhost:50051", + headers: { + "dmtr-api-key": "", + }, + }); + + // Step #3 + // Create a new wallet from a mnemonic + const wallet = new MeshWallet({ + networkId: 0, // 0: testnet, 1: mainnet + fetcher: provider, + submitter: provider, + key: { + type: "mnemonic", + words: [ + "solution", + "solution", + "solution", + "solution", + "solution", + "solution", + "solution", + "solution", + "solution", + "solution", + "solution", + "solution", + "solution", + "solution", + "solution", + "solution", + "solution", + "solution", + "solution", + "solution", + "solution", + "solution", + "solution", + "solution", + ], + }, + }); + + // Optional: Print the wallet address + console.log(wallet.getChangeAddress()); + + // Optional: Print the wallet utxos + console.log(await provider.fetchAddressUTxOs(wallet.getChangeAddress())); + + // Step #4 + // Create an example transaction that sends 5 ADA to an address + const tx = new Transaction({ + initiator: wallet, + verbose: false, + }).sendLovelace( + "addr_test1vpvx0sacufuypa2k4sngk7q40zc5c4npl337uusdh64kv0c7e4cxr", + "5000000" + ); + const unsignedTx = await tx.build(); + + // Step #5 + // Sign the transaction + const signedTx = await wallet.signTx(unsignedTx); + + // Step #6 + // Submit the transaction to the blockchain network + const txId = await provider.submitTx(signedTx); + + // Optional: Print the transaction ID + console.log("Transaction ID", txId); +} + +main().catch(console.error); +``` + +## Implements + +- `IFetcher` +- `ISubmitter` +- `IEvaluator` +- `IListener` + +## Constructors + +### Constructor + +> **new U5CProvider**(`__namedParameters`): `U5CProvider` + +Defined in: utxo-rpc.ts:129 + +Constructor initializes the query and submit clients with provided URL and optional headers. + +#### Parameters + +##### \_\_namedParameters + +###### headers? + +`Record`\<`string`, `string`\> + +###### url + +`string` + +#### Returns + +`U5CProvider` + +## Methods + +### awaitTransactionConfirmation() + +> **awaitTransactionConfirmation**(`txId`, `timeout?`): `Promise`\<`boolean`\> + +Defined in: utxo-rpc.ts:419 + +Waits for transaction confirmation within a given timeout. + +#### Parameters + +##### txId + +`string` + +The transaction hash. + +##### timeout? + +`number` + +Optional timeout in milliseconds. + +#### Returns + +`Promise`\<`boolean`\> + +True if the transaction is confirmed within the timeout, otherwise false. + +*** + +### evaluateTx() + +> **evaluateTx**(`tx`): `Promise`\<`Omit`\<`Action`, `"data"`\>[]\> + +Defined in: utxo-rpc.ts:179 + +Evaluates the resources required to execute the transaction + +#### Parameters + +##### tx + +`string` + +The transaction to evaluate + +#### Returns + +`Promise`\<`Omit`\<`Action`, `"data"`\>[]\> + +#### Implementation of + +`IEvaluator.evaluateTx` + +*** + +### fetchAccountInfo() + +> **fetchAccountInfo**(`address`): `Promise`\<`AccountInfo`\> + +Defined in: utxo-rpc.ts:223 + +Obtain information about a specific stake account. + +#### Parameters + +##### address + +`string` + +Wallet address to fetch account information + +#### Returns + +`Promise`\<`AccountInfo`\> + +#### Implementation of + +`IFetcher.fetchAccountInfo` + +*** + +### fetchAddressAssets() + +> **fetchAddressAssets**(`address`): `Promise`\<\{[`key`: `string`]: `string`; \}\> + +Defined in: utxo-rpc.ts:227 + +#### Parameters + +##### address + +`string` + +#### Returns + +`Promise`\<\{[`key`: `string`]: `string`; \}\> + +*** + +### fetchAddressTxs() + +> **fetchAddressTxs**(`address`, `option`): `Promise`\<`TransactionInfo`[]\> + +Defined in: utxo-rpc.ts:274 + +Unimplemented - open for contribution + +Transactions for an address. The `TransactionInfo` would only return the `hash`, `inputs`, and `outputs`. + +#### Parameters + +##### address + +`string` + +The address to fetch transactions for + +##### option + +`IFetcherOptions` = `...` + +#### Returns + +`Promise`\<`TransactionInfo`[]\> + +- partial TransactionInfo + +#### Implementation of + +`IFetcher.fetchAddressTxs` + +*** + +### fetchAddressUTxOs() + +> **fetchAddressUTxOs**(`address`, `asset?`): `Promise`\<`UTxO`[]\> + +Defined in: utxo-rpc.ts:240 + +Fetches the UTxOs for a given address. + +#### Parameters + +##### address + +`string` + +The address to fetch UTxOs for + +##### asset? + +`string` + +The asset to filter UTxOs by (optional) + +#### Returns + +`Promise`\<`UTxO`[]\> + +UTxOs for the given address + +#### Implementation of + +`IFetcher.fetchAddressUTxOs` + +*** + +### fetchAssetAddresses() + +> **fetchAssetAddresses**(`asset`): `Promise`\<`object`[]\> + +Defined in: utxo-rpc.ts:288 + +Unimplemented - open for contribution + +Fetches the asset addresses for a given asset. + +#### Parameters + +##### asset + +`string` + +The asset to fetch addresses for + +#### Returns + +`Promise`\<`object`[]\> + +#### Implementation of + +`IFetcher.fetchAssetAddresses` + +*** + +### fetchAssetMetadata() + +> **fetchAssetMetadata**(`asset`): `Promise`\<`any`\> + +Defined in: utxo-rpc.ts:300 + +Unimplemented - open for contribution + +Fetches the metadata for a given asset. + +#### Parameters + +##### asset + +`string` + +The asset to fetch metadata for + +#### Returns + +`Promise`\<`any`\> + +#### Implementation of + +`IFetcher.fetchAssetMetadata` + +*** + +### fetchBlockInfo() + +> **fetchBlockInfo**(`hash`): `Promise`\<`BlockInfo`\> + +Defined in: utxo-rpc.ts:310 + +Unimplemented - open for contribution + +Fetches the block information for a given block hash. + +#### Parameters + +##### hash + +`string` + +The block hash to fetch block information for + +#### Returns + +`Promise`\<`BlockInfo`\> + +#### Implementation of + +`IFetcher.fetchBlockInfo` + +*** + +### fetchCollectionAssets() + +> **fetchCollectionAssets**(`policyId`, `cursor?`): `Promise`\<\{ `assets`: `Asset`[]; `next?`: `null` \| `string` \| `number`; \}\> + +Defined in: utxo-rpc.ts:321 + +Unimplemented - open for contribution + +Fetches the collection assets for a given policy ID. + +#### Parameters + +##### policyId + +`string` + +The policy ID to fetch collection assets for + +##### cursor? + +The cursor to fetch the next set of assets (optional) + +`string` | `number` + +#### Returns + +`Promise`\<\{ `assets`: `Asset`[]; `next?`: `null` \| `string` \| `number`; \}\> + +#### Implementation of + +`IFetcher.fetchCollectionAssets` + +*** + +### fetchGovernanceProposal() + +> **fetchGovernanceProposal**(`txHash`, `certIndex`): `Promise`\<`GovernanceProposalInfo`\> + +Defined in: utxo-rpc.ts:397 + +Unimplemented - open for contribution + +Fetches the governance proposal information. + +#### Parameters + +##### txHash + +`string` + +The transaction hash of the proposal + +##### certIndex + +`number` + +The certificate index of the proposal + +#### Returns + +`Promise`\<`GovernanceProposalInfo`\> + +The governance proposal information + +#### Implementation of + +`IFetcher.fetchGovernanceProposal` + +*** + +### fetchHandle() + +> **fetchHandle**(`handle`): `Promise`\<`object`\> + +Defined in: utxo-rpc.ts:334 + +Unimplemented - open for contribution + +Fetches the information (AssetMetadata) for a given handle. + +#### Parameters + +##### handle + +`string` + +The handle to fetch information for + +#### Returns + +`Promise`\<`object`\> + +*** + +### fetchHandleAddress() + +> **fetchHandleAddress**(`handle`): `Promise`\<`string`\> + +Defined in: utxo-rpc.ts:344 + +Unimplemented - open for contribution + +Resolve the handle's address from the handle. + +#### Parameters + +##### handle + +`string` + +The handle to resolve + +#### Returns + +`Promise`\<`string`\> + +*** + +### fetchProtocolParameters() + +> **fetchProtocolParameters**(`epoch`): `Promise`\<`Protocol`\> + +Defined in: utxo-rpc.ts:353 + +Unimplemented - open for contribution + +Fetches protocol parameters + +#### Parameters + +##### epoch + +`number` = `Number.NaN` + +#### Returns + +`Promise`\<`Protocol`\> + +#### Implementation of + +`IFetcher.fetchProtocolParameters` + +*** + +### fetchTxInfo() + +> **fetchTxInfo**(`hash`): `Promise`\<`TransactionInfo`\> + +Defined in: utxo-rpc.ts:367 + +Unimplemented - open for contribution + +Fetches transaction info for a given hash. + +#### Parameters + +##### hash + +`string` + +The transaction hash + +#### Returns + +`Promise`\<`TransactionInfo`\> + +#### Implementation of + +`IFetcher.fetchTxInfo` + +*** + +### fetchUTxOs() + +> **fetchUTxOs**(`hash`, `index?`): `Promise`\<`UTxO`[]\> + +Defined in: utxo-rpc.ts:377 + +Not complete - open for contribution + +Fetches output UTxOs of a given transaction hash. + +#### Parameters + +##### hash + +`string` + +The transaction hash + +##### index? + +`number` + +#### Returns + +`Promise`\<`UTxO`[]\> + +#### Implementation of + +`IFetcher.fetchUTxOs` + +*** + +### get() + +> **get**(`url`): `Promise`\<`any`\> + +Defined in: utxo-rpc.ts:409 + +Unimplemented - open for contribution + +#### Parameters + +##### url + +`string` + +#### Returns + +`Promise`\<`any`\> + +#### Implementation of + +`IFetcher.get` + +*** + +### onTxConfirmed() + +> **onTxConfirmed**(`txHash`, `callback`, `limit`): `void` + +Defined in: utxo-rpc.ts:153 + +Allow you to listen to a transaction confirmation. Upon confirmation, the callback will be called. + +#### Parameters + +##### txHash + +`string` + +The transaction hash to listen for confirmation + +##### callback + +() => `void` + +The callback function to call when the transaction is confirmed + +##### limit + +`number` = `100` + +The number of blocks to wait for confirmation + +#### Returns + +`void` + +#### Implementation of + +`IListener.onTxConfirmed` + +*** + +### submitTx() + +> **submitTx**(`tx`): `Promise`\<`string`\> + +Defined in: utxo-rpc.ts:213 + +Submit a serialized transaction to the network. + +#### Parameters + +##### tx + +`string` + +The serialized transaction in hex to submit + +#### Returns + +`Promise`\<`string`\> + +The transaction hash of the submitted transaction + +#### Implementation of + +`ISubmitter.submitTx` diff --git a/docs/markdown/mesh-providers/classes/YaciProvider.md b/docs/markdown/mesh-providers/classes/YaciProvider.md new file mode 100644 index 000000000..f8aadfd9d --- /dev/null +++ b/docs/markdown/mesh-providers/classes/YaciProvider.md @@ -0,0 +1,614 @@ +[**@meshsdk/provider**](../README.md) + +*** + +[@meshsdk/provider](../globals.md) / YaciProvider + +# Class: YaciProvider + +Defined in: yaci.ts:45 + +Yaci DevKit is a development tool designed for rapid and efficient Cardano blockchain development. It allows developers to create and destroy custom Cardano devnets in seconds, providing fast feedback loops and simplifying the iteration process. + +Get started: +```typescript +import { YaciProvider } from "@meshsdk/core"; +const provider = new YaciProvider('', ''); +``` + +## Implements + +- `IFetcher` +- `IListener` +- `ISubmitter` +- `IEvaluator` + +## Constructors + +### Constructor + +> **new YaciProvider**(`baseUrl`, `adminUrl?`): `YaciProvider` + +Defined in: yaci.ts:55 + +Set the URL of the instance. + +#### Parameters + +##### baseUrl + +`string` = `"https://yaci-node.meshjs.dev/api/v1/"` + +The base URL of the instance. + +##### adminUrl? + +`string` + +#### Returns + +`YaciProvider` + +## Methods + +### addressTopup() + +> **addressTopup**(`address`, `amount`): `Promise`\<`void`\> + +Defined in: yaci.ts:621 + +Topup address with ADA + +#### Parameters + +##### address + +`string` + +Address to topup + +##### amount + +`string` + +Amount to topup + +#### Returns + +`Promise`\<`void`\> + +*** + +### evaluateTx() + +> **evaluateTx**(`txHex`): `Promise`\<`Omit`\<`Action`, `"data"`\>[]\> + +Defined in: yaci.ts:543 + +Evaluates the resources required to execute the transaction + +#### Parameters + +##### txHex + +`string` + +#### Returns + +`Promise`\<`Omit`\<`Action`, `"data"`\>[]\> + +#### Implementation of + +`IEvaluator.evaluateTx` + +*** + +### fetchAccountInfo() + +> **fetchAccountInfo**(`address`): `Promise`\<`AccountInfo`\> + +Defined in: yaci.ts:73 + +Obtain information about a specific stake account. + +#### Parameters + +##### address + +`string` + +Wallet address to fetch account information + +#### Returns + +`Promise`\<`AccountInfo`\> + +#### Implementation of + +`IFetcher.fetchAccountInfo` + +*** + +### fetchAddressAssets() + +> **fetchAddressAssets**(`address`): `Promise`\<\{[`key`: `string`]: `string`; \}\> + +Defined in: yaci.ts:158 + +Fetches the assets for a given address. + +#### Parameters + +##### address + +`string` + +The address to fetch assets for + +#### Returns + +`Promise`\<\{[`key`: `string`]: `string`; \}\> + +A map of asset unit to quantity + +*** + +### fetchAddressTxs() + +> **fetchAddressTxs**(`address`, `option`): `Promise`\<`TransactionInfo`[]\> + +Defined in: yaci.ts:210 + +Unimplemented - open for contribution + +Transactions for an address. The `TransactionInfo` would only return the `hash`, `inputs`, and `outputs`. + +#### Parameters + +##### address + +`string` + +The address to fetch transactions for + +##### option + +`IFetcherOptions` = `...` + +#### Returns + +`Promise`\<`TransactionInfo`[]\> + +- partial TransactionInfo + +#### Implementation of + +`IFetcher.fetchAddressTxs` + +*** + +### fetchAddressUTxOs() + +> **fetchAddressUTxOs**(`address`, `asset?`): `Promise`\<`UTxO`[]\> + +Defined in: yaci.ts:171 + +UTXOs of the address. + +#### Parameters + +##### address + +`string` + +The address to fetch UTXO + +##### asset? + +`string` + +UTXOs of a given asset​ + +#### Returns + +`Promise`\<`UTxO`[]\> + +- Array of UTxOs + +#### Implementation of + +`IFetcher.fetchAddressUTxOs` + +*** + +### fetchAssetAddresses() + +> **fetchAssetAddresses**(`asset`): `Promise`\<`object`[]\> + +Defined in: yaci.ts:222 + +Fetches the asset addresses for a given asset. + +#### Parameters + +##### asset + +`string` + +The asset to fetch addresses for + +#### Returns + +`Promise`\<`object`[]\> + +#### Implementation of + +`IFetcher.fetchAssetAddresses` + +*** + +### fetchAssetMetadata() + +> **fetchAssetMetadata**(`asset`): `Promise`\<`any`\> + +Defined in: yaci.ts:254 + +Fetches the metadata for a given asset. + +#### Parameters + +##### asset + +`string` + +The asset to fetch metadata for + +#### Returns + +`Promise`\<`any`\> + +The metadata for the asset + +#### Implementation of + +`IFetcher.fetchAssetMetadata` + +*** + +### fetchBlockInfo() + +> **fetchBlockInfo**(`hash`): `Promise`\<`BlockInfo`\> + +Defined in: yaci.ts:277 + +Fetches the block information for a given block hash. + +#### Parameters + +##### hash + +`string` + +The block hash to fetch from + +#### Returns + +`Promise`\<`BlockInfo`\> + +The block information + +#### Implementation of + +`IFetcher.fetchBlockInfo` + +*** + +### fetchCollectionAssets() + +> **fetchCollectionAssets**(`policyId`, `cursor`): `Promise`\<\{ `assets`: `Asset`[]; `next`: `null` \| `string` \| `number`; \}\> + +Defined in: yaci.ts:312 + +Fetches the list of assets for a given policy ID. + +#### Parameters + +##### policyId + +`string` + +The policy ID to fetch assets for + +##### cursor + +`number` = `1` + +The cursor for pagination + +#### Returns + +`Promise`\<\{ `assets`: `Asset`[]; `next`: `null` \| `string` \| `number`; \}\> + +The list of assets and the next cursor + +#### Implementation of + +`IFetcher.fetchCollectionAssets` + +*** + +### fetchGovernanceProposal() + +> **fetchGovernanceProposal**(`txHash`, `certIndex`): `Promise`\<`GovernanceProposalInfo`\> + +Defined in: yaci.ts:463 + +Unimplemented - open for contribution + +Fetches the governance proposal information. + +#### Parameters + +##### txHash + +`string` + +The transaction hash of the proposal + +##### certIndex + +`number` + +The certificate index of the proposal + +#### Returns + +`Promise`\<`GovernanceProposalInfo`\> + +The governance proposal information + +#### Implementation of + +`IFetcher.fetchGovernanceProposal` + +*** + +### fetchHandle() + +> **fetchHandle**(`handle`): `Promise`\<`object`\> + +Defined in: yaci.ts:336 + +#### Parameters + +##### handle + +`string` + +#### Returns + +`Promise`\<`object`\> + +*** + +### fetchHandleAddress() + +> **fetchHandleAddress**(`handle`): `Promise`\<`string`\> + +Defined in: yaci.ts:340 + +#### Parameters + +##### handle + +`string` + +#### Returns + +`Promise`\<`string`\> + +*** + +### fetchProtocolParameters() + +> **fetchProtocolParameters**(`epoch`): `Promise`\<`Protocol`\> + +Defined in: yaci.ts:360 + +Fetch the latest protocol parameters. + +#### Parameters + +##### epoch + +`number` = `Number.NaN` + +Optional - The epoch to fetch protocol parameters for + +#### Returns + +`Promise`\<`Protocol`\> + +- Protocol parameters + +#### Implementation of + +`IFetcher.fetchProtocolParameters` + +*** + +### fetchTxInfo() + +> **fetchTxInfo**(`hash`): `Promise`\<`TransactionInfo`\> + +Defined in: yaci.ts:401 + +Fetches the transaction information for a given transaction hash. + +#### Parameters + +##### hash + +`string` + +The transaction hash to fetch + +#### Returns + +`Promise`\<`TransactionInfo`\> + +The transaction information + +#### Implementation of + +`IFetcher.fetchTxInfo` + +*** + +### fetchUTxOs() + +> **fetchUTxOs**(`hash`, `index?`): `Promise`\<`UTxO`[]\> + +Defined in: yaci.ts:430 + +Get UTxOs for a given hash. + +#### Parameters + +##### hash + +`string` + +The transaction hash + +##### index? + +`number` + +Optional - The output index for filtering post fetching + +#### Returns + +`Promise`\<`UTxO`[]\> + +- Array of UTxOs + +#### Implementation of + +`IFetcher.fetchUTxOs` + +*** + +### get() + +> **get**(`url`): `Promise`\<`any`\> + +Defined in: yaci.ts:470 + +#### Parameters + +##### url + +`string` + +#### Returns + +`Promise`\<`any`\> + +#### Implementation of + +`IFetcher.get` + +*** + +### getDevnetInfo() + +> **getDevnetInfo**(): `Promise`\<`void`\> + +Defined in: yaci.ts:582 + +#### Returns + +`Promise`\<`void`\> + +*** + +### getGenesisByEra() + +> **getGenesisByEra**(`era`): `Promise`\<`void`\> + +Defined in: yaci.ts:599 + +#### Parameters + +##### era + +`string` + +#### Returns + +`Promise`\<`void`\> + +*** + +### onTxConfirmed() + +> **onTxConfirmed**(`txHash`, `callback`, `limit`): `void` + +Defined in: yaci.ts:488 + +Allow you to listen to a transaction confirmation. Upon confirmation, the callback will be called. + +#### Parameters + +##### txHash + +`string` + +The transaction hash to listen for confirmation + +##### callback + +() => `void` + +The callback function to call when the transaction is confirmed + +##### limit + +`number` = `100` + +The number of blocks to wait for confirmation + +#### Returns + +`void` + +#### Implementation of + +`IListener.onTxConfirmed` + +*** + +### submitTx() + +> **submitTx**(`txHex`): `Promise`\<`string`\> + +Defined in: yaci.ts:518 + +Submit a serialized transaction to the network. + +#### Parameters + +##### txHex + +`string` + +#### Returns + +`Promise`\<`string`\> + +The transaction hash of the submitted transaction + +#### Implementation of + +`ISubmitter.submitTx` diff --git a/docs/markdown/mesh-providers/globals.md b/docs/markdown/mesh-providers/globals.md new file mode 100644 index 000000000..733f18391 --- /dev/null +++ b/docs/markdown/mesh-providers/globals.md @@ -0,0 +1,23 @@ +[**@meshsdk/provider**](README.md) + +*** + +# @meshsdk/provider + +## Classes + +- [BeginProvider](classes/BeginProvider.md) +- [BlockfrostProvider](classes/BlockfrostProvider.md) +- [KoiosProvider](classes/KoiosProvider.md) +- [MaestroProvider](classes/MaestroProvider.md) +- [OfflineFetcher](classes/OfflineFetcher.md) +- [OgmiosProvider](classes/OgmiosProvider.md) +- [U5CProvider](classes/U5CProvider.md) +- [YaciProvider](classes/YaciProvider.md) + +## Type Aliases + +- [BlockfrostCachingOptions](type-aliases/BlockfrostCachingOptions.md) +- [BlockfrostSupportedNetworks](type-aliases/BlockfrostSupportedNetworks.md) +- [KoiosSupportedNetworks](type-aliases/KoiosSupportedNetworks.md) +- [MaestroSupportedNetworks](type-aliases/MaestroSupportedNetworks.md) diff --git a/docs/markdown/mesh-providers/type-aliases/BlockfrostCachingOptions.md b/docs/markdown/mesh-providers/type-aliases/BlockfrostCachingOptions.md new file mode 100644 index 000000000..49c99c212 --- /dev/null +++ b/docs/markdown/mesh-providers/type-aliases/BlockfrostCachingOptions.md @@ -0,0 +1,27 @@ +[**@meshsdk/provider**](../README.md) + +*** + +[@meshsdk/provider](../globals.md) / BlockfrostCachingOptions + +# Type Alias: BlockfrostCachingOptions + +> **BlockfrostCachingOptions** = `object` + +Defined in: blockfrost.ts:39 + +## Properties + +### enableCaching? + +> `optional` **enableCaching**: `boolean` + +Defined in: blockfrost.ts:40 + +*** + +### offlineFetcher? + +> `optional` **offlineFetcher**: [`OfflineFetcher`](../classes/OfflineFetcher.md) + +Defined in: blockfrost.ts:41 diff --git a/docs/markdown/mesh-providers/type-aliases/BlockfrostSupportedNetworks.md b/docs/markdown/mesh-providers/type-aliases/BlockfrostSupportedNetworks.md new file mode 100644 index 000000000..bc8a2a16a --- /dev/null +++ b/docs/markdown/mesh-providers/type-aliases/BlockfrostSupportedNetworks.md @@ -0,0 +1,11 @@ +[**@meshsdk/provider**](../README.md) + +*** + +[@meshsdk/provider](../globals.md) / BlockfrostSupportedNetworks + +# Type Alias: BlockfrostSupportedNetworks + +> **BlockfrostSupportedNetworks** = `"mainnet"` \| `"preview"` \| `"preprod"` + +Defined in: blockfrost.ts:44 diff --git a/docs/markdown/mesh-providers/type-aliases/KoiosSupportedNetworks.md b/docs/markdown/mesh-providers/type-aliases/KoiosSupportedNetworks.md new file mode 100644 index 000000000..f65d9c60a --- /dev/null +++ b/docs/markdown/mesh-providers/type-aliases/KoiosSupportedNetworks.md @@ -0,0 +1,11 @@ +[**@meshsdk/provider**](../README.md) + +*** + +[@meshsdk/provider](../globals.md) / KoiosSupportedNetworks + +# Type Alias: KoiosSupportedNetworks + +> **KoiosSupportedNetworks** = `"api"` \| `"preview"` \| `"preprod"` \| `"guild"` + +Defined in: koios.ts:37 diff --git a/docs/markdown/mesh-providers/type-aliases/MaestroSupportedNetworks.md b/docs/markdown/mesh-providers/type-aliases/MaestroSupportedNetworks.md new file mode 100644 index 000000000..70866a0ae --- /dev/null +++ b/docs/markdown/mesh-providers/type-aliases/MaestroSupportedNetworks.md @@ -0,0 +1,11 @@ +[**@meshsdk/provider**](../README.md) + +*** + +[@meshsdk/provider](../globals.md) / MaestroSupportedNetworks + +# Type Alias: MaestroSupportedNetworks + +> **MaestroSupportedNetworks** = `"Mainnet"` \| `"Preprod"` \| `"Preview"` + +Defined in: maestro.ts:38 diff --git a/docs/markdown/mesh-transactions/README.md b/docs/markdown/mesh-transactions/README.md new file mode 100644 index 000000000..5bdc7ef3d --- /dev/null +++ b/docs/markdown/mesh-transactions/README.md @@ -0,0 +1,9 @@ +**@meshsdk/transaction** + +*** + +# mesh-transaction + +Transactions - [meshjs.dev/apis/transaction](https://meshjs.dev/apis/transaction) + +[meshjs.dev](https://meshjs.dev/) diff --git a/docs/markdown/mesh-transactions/classes/ForgeScript.md b/docs/markdown/mesh-transactions/classes/ForgeScript.md new file mode 100644 index 000000000..778bdf5d9 --- /dev/null +++ b/docs/markdown/mesh-transactions/classes/ForgeScript.md @@ -0,0 +1,55 @@ +[**@meshsdk/transaction**](../README.md) + +*** + +[@meshsdk/transaction](../globals.md) / ForgeScript + +# Class: ForgeScript + +Defined in: mesh-transaction/src/scripts/forge.script.ts:10 + +## Constructors + +### Constructor + +> **new ForgeScript**(): `ForgeScript` + +#### Returns + +`ForgeScript` + +## Methods + +### fromNativeScript() + +> `static` **fromNativeScript**(`script`): `string` + +Defined in: mesh-transaction/src/scripts/forge.script.ts:60 + +#### Parameters + +##### script + +`NativeScript` + +#### Returns + +`string` + +*** + +### withOneSignature() + +> `static` **withOneSignature**(`address`): `string` + +Defined in: mesh-transaction/src/scripts/forge.script.ts:11 + +#### Parameters + +##### address + +`string` + +#### Returns + +`string` diff --git a/docs/markdown/mesh-transactions/classes/MeshTxBuilder.md b/docs/markdown/mesh-transactions/classes/MeshTxBuilder.md new file mode 100644 index 000000000..4b03b26b8 --- /dev/null +++ b/docs/markdown/mesh-transactions/classes/MeshTxBuilder.md @@ -0,0 +1,3789 @@ +[**@meshsdk/transaction**](../README.md) + +*** + +[@meshsdk/transaction](../globals.md) / MeshTxBuilder + +# Class: MeshTxBuilder + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:59 + +## Extends + +- `MeshTxBuilderCore` + +## Constructors + +### Constructor + +> **new MeshTxBuilder**(`__namedParameters`): `MeshTxBuilder` + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:70 + +#### Parameters + +##### \_\_namedParameters + +[`MeshTxBuilderOptions`](../interfaces/MeshTxBuilderOptions.md) = `{}` + +#### Returns + +`MeshTxBuilder` + +#### Overrides + +`MeshTxBuilderCore.constructor` + +## Properties + +### \_protocolParams + +> `protected` **\_protocolParams**: `Protocol` = `DEFAULT_PROTOCOL_PARAMETERS` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:58 + +#### Inherited from + +`MeshTxBuilderCore._protocolParams` + +*** + +### collateralQueueItem? + +> `protected` `optional` **collateralQueueItem**: `PubKeyTxIn` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:68 + +#### Inherited from + +`MeshTxBuilderCore.collateralQueueItem` + +*** + +### evaluator? + +> `optional` **evaluator**: `IEvaluator` + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:63 + +*** + +### fetcher? + +> `optional` **fetcher**: `IFetcher` + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:61 + +*** + +### manualFee + +> `protected` **manualFee**: `undefined` \| `string` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:56 + +#### Inherited from + +`MeshTxBuilderCore.manualFee` + +*** + +### meshTxBuilderBody + +> **meshTxBuilderBody**: `MeshTxBuilderBody` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:72 + +#### Inherited from + +`MeshTxBuilderCore.meshTxBuilderBody` + +*** + +### mintItem? + +> `protected` `optional` **mintItem**: `MintItem` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:60 + +#### Inherited from + +`MeshTxBuilderCore.mintItem` + +*** + +### queriedTxHashes + +> `protected` **queriedTxHashes**: `Set`\<`string`\> + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:66 + +*** + +### queriedUTxOs + +> `protected` **queriedUTxOs**: `object` = `{}` + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:67 + +#### Index Signature + +\[`x`: `string`\]: `UTxO`[] + +*** + +### refScriptTxInQueueItem? + +> `protected` `optional` **refScriptTxInQueueItem**: `RefTxIn` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:70 + +#### Inherited from + +`MeshTxBuilderCore.refScriptTxInQueueItem` + +*** + +### serializer + +> **serializer**: `IMeshTxSerializer` + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:60 + +*** + +### submitter? + +> `optional` **submitter**: `ISubmitter` + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:62 + +*** + +### txEvaluationMultiplier + +> **txEvaluationMultiplier**: `number` = `1` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:45 + +#### Inherited from + +`MeshTxBuilderCore.txEvaluationMultiplier` + +*** + +### txHex + +> **txHex**: `string` = `""` + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:64 + +*** + +### txInQueueItem? + +> `protected` `optional` **txInQueueItem**: `TxIn` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:62 + +#### Inherited from + +`MeshTxBuilderCore.txInQueueItem` + +*** + +### utxosWithRefScripts + +> `protected` **utxosWithRefScripts**: `UTxO`[] = `[]` + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:68 + +*** + +### verbose + +> **verbose**: `boolean` + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:65 + +*** + +### voteItem? + +> `protected` `optional` **voteItem**: `Vote` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:66 + +#### Inherited from + +`MeshTxBuilderCore.voteItem` + +*** + +### withdrawalItem? + +> `protected` `optional` **withdrawalItem**: `Withdrawal` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:64 + +#### Inherited from + +`MeshTxBuilderCore.withdrawalItem` + +## Methods + +### \_cloneCore() + +> `protected` **\_cloneCore**\<`T`\>(`createInstance`): `T` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:2012 + +#### Type Parameters + +##### T + +`T` *extends* `MeshTxBuilderCore` + +#### Parameters + +##### createInstance + +() => `T` + +#### Returns + +`T` + +#### Inherited from + +`MeshTxBuilderCore._cloneCore` + +*** + +### addUtxosFromSelection() + +> **addUtxosFromSelection**(): `void` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:1853 + +#### Returns + +`void` + +#### Inherited from + +`MeshTxBuilderCore.addUtxosFromSelection` + +*** + +### calculateFee() + +> **calculateFee**(): `bigint` + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:1692 + +#### Returns + +`bigint` + +*** + +### calculateFeeForSerializedTx() + +> **calculateFeeForSerializedTx**(`txSize`): `bigint` + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:1697 + +#### Parameters + +##### txSize + +`number` + +#### Returns + +`bigint` + +*** + +### calculateMinLovelaceForOutput() + +> **calculateMinLovelaceForOutput**(`output`): `bigint` + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:1723 + +#### Parameters + +##### output + +`Output` + +#### Returns + +`bigint` + +*** + +### calculateRedeemersFee() + +> **calculateRedeemersFee**(): `bigint` + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:1712 + +#### Returns + +`bigint` + +*** + +### calculateRefScriptFee() + +> **calculateRefScriptFee**(): `bigint` + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:1706 + +#### Returns + +`bigint` + +*** + +### castBuilderDataToRedeemer() + +> `protected` **castBuilderDataToRedeemer**(`redeemer`, `type`, `exUnits`): `Redeemer` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:1713 + +#### Parameters + +##### redeemer + +`object` | `Data` + +##### type + +`"Mesh"` | `"JSON"` | `"CBOR"` + +##### exUnits + +###### mem + +`number` + +###### steps + +`number` + +#### Returns + +`Redeemer` + +#### Inherited from + +`MeshTxBuilderCore.castBuilderDataToRedeemer` + +*** + +### castRawDataToJsonString() + +> `protected` **castRawDataToJsonString**(`rawData`): `string` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:1705 + +#### Parameters + +##### rawData + +`string` | `object` + +#### Returns + +`string` + +#### Inherited from + +`MeshTxBuilderCore.castRawDataToJsonString` + +*** + +### certificateRedeemerValue() + +> **certificateRedeemerValue**(`redeemer`, `type`, `exUnits`): `MeshTxBuilder` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:1368 + +#### Parameters + +##### redeemer + +`object` | `Data` + +##### type + +`"Mesh"` | `"JSON"` | `"CBOR"` + +##### exUnits + +###### mem + +`number` + +###### steps + +`number` + +#### Returns + +`MeshTxBuilder` + +#### Inherited from + +`MeshTxBuilderCore.certificateRedeemerValue` + +*** + +### certificateScript() + +> **certificateScript**(`scriptCbor`, `version?`): `MeshTxBuilder` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:1279 + +Adds a script witness to the certificate + +#### Parameters + +##### scriptCbor + +`string` + +The CborHex of the script + +##### version? + +Optional - The plutus version of the script, null version implies Native Script + +`"V1"` | `"V2"` | `"V3"` + +#### Returns + +`MeshTxBuilder` + +#### Inherited from + +`MeshTxBuilderCore.certificateScript` + +*** + +### certificateTxInReference() + +> **certificateTxInReference**(`txHash`, `txIndex`, `scriptSize?`, `scriptHash?`, `version?`): `MeshTxBuilder` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:1323 + +Adds a script witness to the certificate + +#### Parameters + +##### txHash + +`string` + +The transaction hash of the reference UTxO + +##### txIndex + +`number` + +The transaction index of the reference UTxO + +##### scriptSize? + +`string` + +The size of the plutus script in bytes referenced (can be obtained by script hex length / 2) + +##### scriptHash? + +`string` + +The script hash of the spending script + +##### version? + +The plutus version of the script, null version implies Native Script + +`"V1"` | `"V2"` | `"V3"` + +#### Returns + +`MeshTxBuilder` + +#### Inherited from + +`MeshTxBuilderCore.certificateTxInReference` + +*** + +### chainTx() + +> **chainTx**(`txHex`): `this` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:1535 + +Add a transaction that is used as input, but not yet reflected on the global blockchain + +#### Parameters + +##### txHex + +`string` + +The transaction hex of chained transaction + +#### Returns + +`this` + +The MeshTxBuilderCore instance + +#### Inherited from + +`MeshTxBuilderCore.chainTx` + +*** + +### changeAddress() + +> **changeAddress**(`addr`): `MeshTxBuilder` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:1399 + +Configure the address to accept change UTxO + +#### Parameters + +##### addr + +`string` + +The address to accept change UTxO + +#### Returns + +`MeshTxBuilder` + +The MeshTxBuilder instance + +#### Inherited from + +`MeshTxBuilderCore.changeAddress` + +*** + +### clone() + +> `protected` **clone**(): `MeshTxBuilder` + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:1727 + +#### Returns + +`MeshTxBuilder` + +*** + +### collectAllRequiredSignatures() + +> `protected` **collectAllRequiredSignatures**(): `object` + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:969 + +#### Returns + +`object` + +##### byronAddresses + +> **byronAddresses**: `Set`\<`string`\> + +##### keyHashes + +> **keyHashes**: `Set`\<`string`\> + +*** + +### compareCredentials() + +> `protected` **compareCredentials**(`credentialA`, `credentialB`): `number` + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:349 + +#### Parameters + +##### credentialA + +`Credential` + +##### credentialB + +`Credential` + +#### Returns + +`number` + +*** + +### complete() + +> **complete**(`customizedTx?`): `Promise`\<`string`\> + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:151 + +It builds the transaction and query the blockchain for missing information + +#### Parameters + +##### customizedTx? + +`Partial`\<`MeshTxBuilderBody`\> + +The optional customized transaction body + +#### Returns + +`Promise`\<`string`\> + +The signed transaction in hex ready to submit / signed by client + +*** + +### completeInputInfo() + +> `protected` **completeInputInfo**(`input`): `void` + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:656 + +#### Parameters + +##### input + +`TxIn` + +#### Returns + +`void` + +*** + +### completeScriptInfo() + +> `protected` **completeScriptInfo**(`scriptSource`): `void` + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:682 + +#### Parameters + +##### scriptSource + +`ScriptSource` + +#### Returns + +`void` + +*** + +### completeSerialization() + +> `protected` **completeSerialization**(`customizedTx?`): `Promise`\<`string`\> + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:765 + +#### Parameters + +##### customizedTx? + +`Partial`\<`MeshTxBuilderBody`\> + +#### Returns + +`Promise`\<`string`\> + +*** + +### completeSigning() + +> **completeSigning**(): `string` + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:579 + +Complete the signing process + +#### Returns + +`string` + +The signed transaction in hex + +*** + +### completeSimpleScriptInfo() + +> `protected` **completeSimpleScriptInfo**(`simpleScript`): `void` + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:698 + +#### Parameters + +##### simpleScript + +`SimpleScriptSourceInfo` + +#### Returns + +`void` + +*** + +### completeSync() + +> **completeSync**(`customizedTx?`): `string` + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:131 + +#### Parameters + +##### customizedTx? + +`MeshTxBuilderBody` + +#### Returns + +`string` + +*** + +### completeTxInformation() + +> `protected` **completeTxInformation**(`input`): `void` + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:641 + +#### Parameters + +##### input + +`TxIn` + +#### Returns + +`void` + +*** + +### completeTxParts() + +> `protected` **completeTxParts**(): `Promise`\<`void`\> + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:812 + +#### Returns + +`Promise`\<`void`\> + +*** + +### completeUnbalanced() + +> **completeUnbalanced**(`customizedTx?`): `string` + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:117 + +It builds the transaction query the blockchain for missing information + +#### Parameters + +##### customizedTx? + +`MeshTxBuilderBody` + +The optional customized transaction body + +#### Returns + +`string` + +The transaction in hex, unbalanced + +*** + +### completeUnbalancedSync() + +> **completeUnbalancedSync**(`customizedTx?`): `string` + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:558 + +It builds the transaction without dependencies + +#### Parameters + +##### customizedTx? + +`MeshTxBuilderBody` + +The optional customized transaction body + +#### Returns + +`string` + +The transaction in hex, unbalanced + +*** + +### delegateStakeCertificate() + +> **delegateStakeCertificate**(`rewardAddress`, `poolId`): `MeshTxBuilder` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:1148 + +Creates a stake delegation certificate, and adds it to the transaction +This will delegate stake from the corresponding stake address to the pool + +#### Parameters + +##### rewardAddress + +`string` + +The bech32 reward address (i.e. start with `stake_xxxxx`) + +##### poolId + +`string` + +poolId can be in either bech32 or hex form + +#### Returns + +`MeshTxBuilder` + +The MeshTxBuilder instance + +#### Inherited from + +`MeshTxBuilderCore.delegateStakeCertificate` + +*** + +### deregisterStakeCertificate() + +> **deregisterStakeCertificate**(`rewardAddress`): `MeshTxBuilder` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:1165 + +Creates a stake deregister certificate, and adds it to the transaction + +#### Parameters + +##### rewardAddress + +`string` + +The bech32 reward address (i.e. start with `stake_xxxxx`) + +#### Returns + +`MeshTxBuilder` + +The MeshTxBuilder instance + +#### Inherited from + +`MeshTxBuilderCore.deregisterStakeCertificate` + +*** + +### drepDeregistrationCertificate() + +> **drepDeregistrationCertificate**(`drepId`, `coin`): `MeshTxBuilder` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:1224 + +Dregister DRep certificate, and adds it to the transaction + +#### Parameters + +##### drepId + +`string` + +The bech32 drep id (i.e. starts with `drep1xxxxx`) + +##### coin + +`string` = `DREP_DEPOSIT` + +DRep registration deposit + +#### Returns + +`MeshTxBuilder` + +The MeshTxBuilder instance + +#### Inherited from + +`MeshTxBuilderCore.drepDeregistrationCertificate` + +*** + +### drepRegistrationCertificate() + +> **drepRegistrationCertificate**(`drepId`, `anchor?`, `coin?`): `MeshTxBuilder` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:1201 + +Registers DRep certificate, and adds it to the transaction + +#### Parameters + +##### drepId + +`string` + +The bech32 drep id (i.e. starts with `drep1xxxxx`) + +##### anchor? + +`Anchor` + +The DRep anchor, consists of a URL and a hash of the doc + +##### coin? + +`string` = `DREP_DEPOSIT` + +DRep registration deposit + +#### Returns + +`MeshTxBuilder` + +The MeshTxBuilder instance + +#### Inherited from + +`MeshTxBuilderCore.drepRegistrationCertificate` + +*** + +### drepUpdateCertificate() + +> **drepUpdateCertificate**(`drepId`, `anchor?`): `MeshTxBuilder` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:1244 + +Update DRep certificate, and adds it to the transaction + +#### Parameters + +##### drepId + +`string` + +The bech32 drep id (i.e. starts with `drep1xxxxx`) + +##### anchor? + +`Anchor` + +The DRep anchor, consists of a URL and a hash of the doc + +#### Returns + +`MeshTxBuilder` + +#### Inherited from + +`MeshTxBuilderCore.drepUpdateCertificate` + +*** + +### emptyTxBuilderBody() + +> **emptyTxBuilderBody**(): () => `MeshTxBuilderBody` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:1987 + +#### Returns + +> (): `MeshTxBuilderBody` + +##### Returns + +`MeshTxBuilderBody` + +#### Inherited from + +`MeshTxBuilderCore.emptyTxBuilderBody` + +*** + +### evaluateRedeemers() + +> **evaluateRedeemers**(): `Promise`\<`void`\> + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:462 + +#### Returns + +`Promise`\<`void`\> + +*** + +### getActualFee() + +> **getActualFee**(): `bigint` + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:1684 + +#### Returns + +`bigint` + +*** + +### getAllReferenceInputsSizes() + +> `protected` **getAllReferenceInputsSizes**(): `Map`\<`string`, `bigint`\> + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:1483 + +#### Returns + +`Map`\<`string`, `bigint`\> + +*** + +### getBodyReferenceInputsSizes() + +> `protected` **getBodyReferenceInputsSizes**(): \[`string`, `bigint`\][] + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:1514 + +#### Returns + +\[`string`, `bigint`\][] + +*** + +### getCertificateNativeScript() + +> `protected` **getCertificateNativeScript**(`cert`): `undefined` \| `NativeScript` + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:1342 + +#### Parameters + +##### cert + +`Certificate` + +#### Returns + +`undefined` \| `NativeScript` + +*** + +### getCertificatesReferenceInputsSizes() + +> `protected` **getCertificatesReferenceInputsSizes**(): \[`string`, `bigint`\][] + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:1608 + +#### Returns + +\[`string`, `bigint`\][] + +*** + +### getCertificatesRequiredSignatures() + +> `protected` **getCertificatesRequiredSignatures**(): `Set`\<`string`\> + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:1083 + +#### Returns + +`Set`\<`string`\> + +*** + +### getCollateralRequiredSignatures() + +> `protected` **getCollateralRequiredSignatures**(): `object` + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:1032 + +#### Returns + +`object` + +##### collateralByronAddresses + +> **collateralByronAddresses**: `Set`\<`string`\> + +##### collateralPaymentCreds + +> **collateralPaymentCreds**: `Set`\<`string`\> + +*** + +### getInlinedNativeScript() + +> `protected` **getInlinedNativeScript**(`txHash`, `index`): `undefined` \| `NativeScript` + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:1451 + +#### Parameters + +##### txHash + +`string` + +##### index + +`number` + +#### Returns + +`undefined` \| `NativeScript` + +*** + +### getInputNativeScript() + +> `protected` **getInputNativeScript**(`txIn`): `undefined` \| `NativeScript` + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:1428 + +#### Parameters + +##### txIn + +`TxIn` + +#### Returns + +`undefined` \| `NativeScript` + +*** + +### getInputsReferenceInputsSizes() + +> `protected` **getInputsReferenceInputsSizes**(): \[`string`, `bigint`\][] + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:1525 + +#### Returns + +\[`string`, `bigint`\][] + +*** + +### getInputsRequiredSignatures() + +> `protected` **getInputsRequiredSignatures**(): `object` + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:997 + +#### Returns + +`object` + +##### byronAddresses + +> **byronAddresses**: `Set`\<`string`\> + +##### paymentCreds + +> **paymentCreds**: `Set`\<`string`\> + +*** + +### getMintNativeScript() + +> `protected` **getMintNativeScript**(`mint`): `undefined` \| `NativeScript` + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:1367 + +#### Parameters + +##### mint + +`MintParam` + +#### Returns + +`undefined` \| `NativeScript` + +*** + +### getMintRequiredSignatures() + +> `protected` **getMintRequiredSignatures**(): `Set`\<`string`\> + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:1204 + +#### Returns + +`Set`\<`string`\> + +*** + +### getMintsReferenceInputsSizes() + +> `protected` **getMintsReferenceInputsSizes**(): \[`string`, `bigint`\][] + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:1549 + +#### Returns + +\[`string`, `bigint`\][] + +*** + +### getNativeScriptPubKeys() + +> `protected` **getNativeScriptPubKeys**(`nativeScript`): `Set`\<`string`\> + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:1282 + +#### Parameters + +##### nativeScript + +`NativeScript` + +#### Returns + +`Set`\<`string`\> + +*** + +### getRedeemerCosts() + +> `protected` **getRedeemerCosts**(): `Omit`\<`Action`, `"data"`\>[] + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:497 + +#### Returns + +`Omit`\<`Action`, `"data"`\>[] + +*** + +### getSerializedSize() + +> **getSerializedSize**(): `number` + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:1680 + +#### Returns + +`number` + +*** + +### getTotalDeposit() + +> `protected` **getTotalDeposit**(): `bigint` + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:1228 + +#### Returns + +`bigint` + +*** + +### getTotalExecutionUnits() + +> **getTotalExecutionUnits**(): `object` + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:1632 + +#### Returns + +`object` + +##### memUnits + +> **memUnits**: `bigint` + +##### stepUnits + +> **stepUnits**: `bigint` + +*** + +### getTotalMint() + +> `protected` **getTotalMint**(): `Asset`[] + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:1266 + +#### Returns + +`Asset`[] + +*** + +### getTotalReferenceInputsSize() + +> `protected` **getTotalReferenceInputsSize**(): `bigint` + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:1474 + +#### Returns + +`bigint` + +*** + +### getTotalRefund() + +> `protected` **getTotalRefund**(): `bigint` + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:1251 + +#### Returns + +`bigint` + +*** + +### getTotalWithdrawal() + +> `protected` **getTotalWithdrawal**(): `bigint` + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:1220 + +#### Returns + +`bigint` + +*** + +### getUTxOInfo() + +> `protected` **getUTxOInfo**(`txHash`): `Promise`\<`void`\> + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:602 + +Get the UTxO information from the blockchain + +#### Parameters + +##### txHash + +`string` + +The TxIn object that contains the txHash and txIndex, while missing amount and address information + +#### Returns + +`Promise`\<`void`\> + +*** + +### getUtxosForSelection() + +> **getUtxosForSelection**(): `Promise`\<`UTxO`[]\> + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:310 + +#### Returns + +`Promise`\<`UTxO`[]\> + +*** + +### getVoteNativeScript() + +> `protected` **getVoteNativeScript**(`cert`): `undefined` \| `NativeScript` + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:1319 + +#### Parameters + +##### cert + +`Vote` + +#### Returns + +`undefined` \| `NativeScript` + +*** + +### getVoteRequiredSignatures() + +> `protected` **getVoteRequiredSignatures**(): `Set`\<`string`\> + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:1172 + +#### Returns + +`Set`\<`string`\> + +*** + +### getVotesReferenceInputsSizes() + +> `protected` **getVotesReferenceInputsSizes**(): \[`string`, `bigint`\][] + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:1584 + +#### Returns + +\[`string`, `bigint`\][] + +*** + +### getWithdrawalNativeScript() + +> `protected` **getWithdrawalNativeScript**(`withdrawal`): `undefined` \| `NativeScript` + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:1403 + +#### Parameters + +##### withdrawal + +`Withdrawal` + +#### Returns + +`undefined` \| `NativeScript` + +*** + +### getWithdrawalRequiredSignatures() + +> `protected` **getWithdrawalRequiredSignatures**(): `Set`\<`string`\> + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:1059 + +#### Returns + +`Set`\<`string`\> + +*** + +### getWithdrawalsReferenceInputsSizes() + +> `protected` **getWithdrawalsReferenceInputsSizes**(): \[`string`, `bigint`\][] + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:1565 + +#### Returns + +\[`string`, `bigint`\][] + +*** + +### inputForEvaluation() + +> **inputForEvaluation**(`input`): `MeshTxBuilder` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:1545 + +Add a transaction input to provide information for offline evaluation + +#### Parameters + +##### input + +`UTxO` + +The input to be added + +#### Returns + +`MeshTxBuilder` + +The MeshTxBuilderCore instance + +#### Inherited from + +`MeshTxBuilderCore.inputForEvaluation` + +*** + +### invalidBefore() + +> **invalidBefore**(`slot`): `MeshTxBuilder` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:1409 + +Set the transaction valid interval to be valid only after the slot + +#### Parameters + +##### slot + +`number` + +The transaction is valid only after this slot + +#### Returns + +`MeshTxBuilder` + +The MeshTxBuilder instance + +#### Inherited from + +`MeshTxBuilderCore.invalidBefore` + +*** + +### invalidHereafter() + +> **invalidHereafter**(`slot`): `MeshTxBuilder` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:1419 + +Set the transaction valid interval to be valid only before the slot + +#### Parameters + +##### slot + +`number` + +The transaction is valid only before this slot + +#### Returns + +`MeshTxBuilder` + +The MeshTxBuilder instance + +#### Inherited from + +`MeshTxBuilderCore.invalidHereafter` + +*** + +### isInputComplete() + +> `protected` **isInputComplete**(`txIn`): `boolean` + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:713 + +#### Parameters + +##### txIn + +`TxIn` + +#### Returns + +`boolean` + +*** + +### isInputInfoComplete() + +> `protected` **isInputInfoComplete**(`txIn`): `boolean` + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:725 + +#### Parameters + +##### txIn + +`TxIn` + +#### Returns + +`boolean` + +*** + +### isMintComplete() + +> `protected` **isMintComplete**(`mint`): `boolean` + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:731 + +#### Parameters + +##### mint + +`MintItem` + +#### Returns + +`boolean` + +*** + +### isRefScriptInfoComplete() + +> `protected` **isRefScriptInfoComplete**(`scriptSource`): `boolean` + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:745 + +#### Parameters + +##### scriptSource + +`ScriptSource` + +#### Returns + +`boolean` + +*** + +### isSimpleRefScriptInfoComplete() + +> `protected` **isSimpleRefScriptInfoComplete**(`simpleScriptSource`): `boolean` + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:752 + +#### Parameters + +##### simpleScriptSource + +`SimpleScriptSourceInfo` + +#### Returns + +`boolean` + +*** + +### makeTxId() + +> `protected` **makeTxId**(`txHash`, `index`): `string` + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:1470 + +#### Parameters + +##### txHash + +`string` + +##### index + +`number` + +#### Returns + +`string` + +*** + +### metadataValue() + +> **metadataValue**(`label`, `metadata`): `MeshTxBuilder` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:1430 + +Add metadata to the transaction + +#### Parameters + +##### label + +The label of the metadata, preferably number + +`string` | `number` | `bigint` + +##### metadata + +The metadata in any format + +`object` | `Metadatum` + +#### Returns + +`MeshTxBuilder` + +The MeshTxBuilder instance + +#### Inherited from + +`MeshTxBuilderCore.metadataValue` + +*** + +### mint() + +> **mint**(`quantity`, `policy`, `name`): `MeshTxBuilder` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:617 + +Set the minting value of transaction + +#### Parameters + +##### quantity + +`string` + +The quantity of asset to be minted + +##### policy + +`string` + +The policy id of the asset to be minted + +##### name + +`string` + +The hex of token name of the asset to be minted + +#### Returns + +`MeshTxBuilder` + +The MeshTxBuilder instance + +#### Inherited from + +`MeshTxBuilderCore.mint` + +*** + +### mintingScript() + +> **mintingScript**(`scriptCBOR`): `MeshTxBuilder` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:637 + +Set the minting script of current mint + +#### Parameters + +##### scriptCBOR + +`string` + +The CBOR hex of the minting policy script + +#### Returns + +`MeshTxBuilder` + +The MeshTxBuilder instance + +#### Inherited from + +`MeshTxBuilderCore.mintingScript` + +*** + +### mintPlutusScript() + +> **mintPlutusScript**(`languageVersion`): `MeshTxBuilder` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:577 + +Set the minting script for the current mint + +#### Parameters + +##### languageVersion + +The Plutus script version + +`"V1"` | `"V2"` | `"V3"` + +#### Returns + +`MeshTxBuilder` + +The MeshTxBuilder instance + +#### Inherited from + +`MeshTxBuilderCore.mintPlutusScript` + +*** + +### mintPlutusScriptV1() + +> **mintPlutusScriptV1**(): `MeshTxBuilder` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:586 + +Set the instruction that it is currently using V1 Plutus minting scripts + +#### Returns + +`MeshTxBuilder` + +The MeshTxBuilder instance + +#### Inherited from + +`MeshTxBuilderCore.mintPlutusScriptV1` + +*** + +### mintPlutusScriptV2() + +> **mintPlutusScriptV2**(): `MeshTxBuilder` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:595 + +Set the instruction that it is currently using V2 Plutus minting scripts + +#### Returns + +`MeshTxBuilder` + +The MeshTxBuilder instance + +#### Inherited from + +`MeshTxBuilderCore.mintPlutusScriptV2` + +*** + +### mintPlutusScriptV3() + +> **mintPlutusScriptV3**(): `MeshTxBuilder` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:604 + +Set the instruction that it is currently using V3 Plutus minting scripts + +#### Returns + +`MeshTxBuilder` + +The MeshTxBuilder instance + +#### Inherited from + +`MeshTxBuilderCore.mintPlutusScriptV3` + +*** + +### mintRedeemerValue() + +> **mintRedeemerValue**(`redeemer`, `type`, `exUnits`): `MeshTxBuilder` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:729 + +Set the redeemer for the reference input to be spent in same transaction + +#### Parameters + +##### redeemer + +The redeemer in Mesh Data type, JSON in raw constructor like format, or CBOR hex string + +`object` | `Data` + +##### type + +The redeemer data type, either Mesh Data type, JSON in raw constructor like format, or CBOR hex string. Default to be Mesh type + +`"Mesh"` | `"JSON"` | `"CBOR"` + +##### exUnits + +The execution units budget for the redeemer + +###### mem + +`number` + +###### steps + +`number` + +#### Returns + +`MeshTxBuilder` + +The MeshTxBuilder instance + +#### Inherited from + +`MeshTxBuilderCore.mintRedeemerValue` + +*** + +### mintReferenceTxInRedeemerValue() + +> **mintReferenceTxInRedeemerValue**(`redeemer`, `type`, `exUnits`): `MeshTxBuilder` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:700 + +Set the redeemer for minting + +#### Parameters + +##### redeemer + +The redeemer in Mesh Data type, JSON in raw constructor like format, or CBOR hex string + +`object` | `Data` + +##### type + +The redeemer data type, either Mesh Data type, JSON in raw constructor like format, or CBOR hex string. Default to be Mesh type + +`"Mesh"` | `"JSON"` | `"CBOR"` + +##### exUnits + +The execution units budget for the redeemer + +###### mem + +`number` + +###### steps + +`number` + +#### Returns + +`MeshTxBuilder` + +The MeshTxBuilder instance + +#### Inherited from + +`MeshTxBuilderCore.mintReferenceTxInRedeemerValue` + +*** + +### mintTxInReference() + +> **mintTxInReference**(`txHash`, `txIndex`, `scriptSize?`, `scriptHash?`): `MeshTxBuilder` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:667 + +Use reference script for minting + +#### Parameters + +##### txHash + +`string` + +The transaction hash of the UTxO + +##### txIndex + +`number` + +The transaction index of the UTxO + +##### scriptSize? + +`string` + +The script size in bytes of the script (can be obtained by script hex length / 2) + +##### scriptHash? + +`string` + +The script hash of the script + +#### Returns + +`MeshTxBuilder` + +The MeshTxBuilder instance + +#### Inherited from + +`MeshTxBuilderCore.mintTxInReference` + +*** + +### protocolParams() + +> **protocolParams**(`params`): `MeshTxBuilder` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:1482 + +Set the protocol parameters to be used for the transaction other than the default one + +#### Parameters + +##### params + +`Partial`\<`Protocol`\> + +(Part of) the protocol parameters to be used for the transaction + +#### Returns + +`MeshTxBuilder` + +The MeshTxBuilder instance + +#### Inherited from + +`MeshTxBuilderCore.protocolParams` + +*** + +### queryAllTxInfo() + +> `protected` **queryAllTxInfo**(`incompleteTxIns`, `incompleteScriptSources`, `incompleteSimpleScriptSources`): `Promise`\<`void`[]\> + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:611 + +#### Parameters + +##### incompleteTxIns + +`TxIn`[] + +##### incompleteScriptSources + +`ScriptSource`[] + +##### incompleteSimpleScriptSources + +`SimpleScriptSourceInfo`[] + +#### Returns + +`Promise`\<`void`[]\> + +*** + +### queueAllLastItem() + +> `protected` **queueAllLastItem**(): `void` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:1570 + +#### Returns + +`void` + +#### Inherited from + +`MeshTxBuilderCore.queueAllLastItem` + +*** + +### readOnlyTxInReference() + +> **readOnlyTxInReference**(`txHash`, `txIndex`, `scriptSize?`): `MeshTxBuilder` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:559 + +Specify a read only reference input. This reference input is not witnessing anything it is simply provided in the plutus script context. + +#### Parameters + +##### txHash + +`string` + +The transaction hash of the reference UTxO + +##### txIndex + +`number` + +The transaction index of the reference UTxO + +##### scriptSize? + +`number` + +#### Returns + +`MeshTxBuilder` + +The MeshTxBuilder instance + +#### Inherited from + +`MeshTxBuilderCore.readOnlyTxInReference` + +*** + +### registerPoolCertificate() + +> **registerPoolCertificate**(`poolParams`): `MeshTxBuilder` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:1114 + +Creates a pool registration certificate, and adds it to the transaction + +#### Parameters + +##### poolParams + +`PoolParams` + +Parameters for pool registration + +#### Returns + +`MeshTxBuilder` + +The MeshTxBuilder instance + +#### Inherited from + +`MeshTxBuilderCore.registerPoolCertificate` + +*** + +### registerStakeCertificate() + +> **registerStakeCertificate**(`rewardAddress`): `MeshTxBuilder` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:1130 + +Creates a stake registration certificate, and adds it to the transaction + +#### Parameters + +##### rewardAddress + +`string` + +The bech32 reward address (i.e. start with `stake_xxxxx`) + +#### Returns + +`MeshTxBuilder` + +The MeshTxBuilder instance + +#### Inherited from + +`MeshTxBuilderCore.registerStakeCertificate` + +*** + +### removeDuplicateInputs() + +> **removeDuplicateInputs**(): `void` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:1949 + +#### Returns + +`void` + +#### Inherited from + +`MeshTxBuilderCore.removeDuplicateInputs` + +*** + +### removeDuplicateRefInputs() + +> **removeDuplicateRefInputs**(): `void` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:1968 + +#### Returns + +`void` + +#### Inherited from + +`MeshTxBuilderCore.removeDuplicateRefInputs` + +*** + +### requiredSignerHash() + +> **requiredSignerHash**(`pubKeyHash`): `MeshTxBuilder` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:743 + +Set the required signer of the transaction + +#### Parameters + +##### pubKeyHash + +`string` + +The PubKeyHash of the required signer + +#### Returns + +`MeshTxBuilder` + +The MeshTxBuilder instance + +#### Inherited from + +`MeshTxBuilderCore.requiredSignerHash` + +*** + +### reset() + +> **reset**(): `void` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:1992 + +#### Returns + +`void` + +#### Inherited from + +`MeshTxBuilderCore.reset` + +*** + +### retirePoolCertificate() + +> **retirePoolCertificate**(`poolId`, `epoch`): `MeshTxBuilder` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:1182 + +Creates a pool retire certificate, and adds it to the transaction + +#### Parameters + +##### poolId + +`string` + +poolId can be in either bech32 or hex form + +##### epoch + +`number` + +The intended epoch to retire the pool + +#### Returns + +`MeshTxBuilder` + +The MeshTxBuilder instance + +#### Inherited from + +`MeshTxBuilderCore.retirePoolCertificate` + +*** + +### sanitizeOutputs() + +> `protected` **sanitizeOutputs**(): `Promise`\<`void`\> + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:951 + +#### Returns + +`Promise`\<`void`\> + +*** + +### selectUtxos() + +> **selectUtxos**(): `Promise`\<`TransactionPrototype`\> + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:205 + +#### Returns + +`Promise`\<`TransactionPrototype`\> + +*** + +### selectUtxosFrom() + +> **selectUtxosFrom**(`extraInputs`): `MeshTxBuilder` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:1457 + +Selects utxos to fill output value and puts them into inputs + +#### Parameters + +##### extraInputs + +`UTxO`[] + +The inputs already placed into the object will remain, these extra inputs will be used to fill the remaining value needed + +#### Returns + +`MeshTxBuilder` + +#### Inherited from + +`MeshTxBuilderCore.selectUtxosFrom` + +*** + +### serializeMockTx() + +> **serializeMockTx**(): `string` + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:101 + +#### Returns + +`string` + +*** + +### setCollateralReturnAddress() + +> **setCollateralReturnAddress**(`address`): `MeshTxBuilder` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:1515 + +Sets the collateral return address, if none is set, the change address will be used + +#### Parameters + +##### address + +`string` + +The address to use for collateral return + +#### Returns + +`MeshTxBuilder` + +The MeshTxBuilder instance + +#### Inherited from + +`MeshTxBuilderCore.setCollateralReturnAddress` + +*** + +### setFee() + +> **setFee**(`fee`): `MeshTxBuilder` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:1493 + +Sets a specific fee for the transaction to use + +#### Parameters + +##### fee + +`string` + +The specified fee + +#### Returns + +`MeshTxBuilder` + +The MeshTxBuilder instance + +#### Inherited from + +`MeshTxBuilderCore.setFee` + +*** + +### setNetwork() + +> **setNetwork**(`network`): `MeshTxBuilder` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:1525 + +Sets the network to use, this is mainly to know the cost models to be used to calculate script integrity hash + +#### Parameters + +##### network + +The specific network this transaction is being built for ("testnet" | "preview" | "preprod" | "mainnet") + +`"testnet"` | `"preview"` | `"preprod"` | `"mainnet"` | `number`[][] + +#### Returns + +`MeshTxBuilder` + +The MeshTxBuilder instance + +#### Inherited from + +`MeshTxBuilderCore.setNetwork` + +*** + +### setTotalCollateral() + +> **setTotalCollateral**(`collateral`): `MeshTxBuilder` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:1505 + +Sets a total collateral for the transaction to use, a collateral return +will be generated to either the change address or the specified collateral return address + +#### Parameters + +##### collateral + +`string` + +The specified collateral + +#### Returns + +`MeshTxBuilder` + +The MeshTxBuilder instance + +#### Inherited from + +`MeshTxBuilderCore.setTotalCollateral` + +*** + +### signingKey() + +> **signingKey**(`skeyHex`): `MeshTxBuilder` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:1448 + +Sign the transaction with the private key + +#### Parameters + +##### skeyHex + +`string` + +The private key in cborHex (with or without 5820 prefix, i.e. the format when generated from cardano-cli) + +#### Returns + +`MeshTxBuilder` + +#### Inherited from + +`MeshTxBuilderCore.signingKey` + +*** + +### simpleScriptTxInReference() + +> **simpleScriptTxInReference**(`txHash`, `txIndex`, `spendingScriptHash?`, `scriptSize?`): `MeshTxBuilder` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:231 + +Native script - Set the reference input where it would also be spent in the transaction + +#### Parameters + +##### txHash + +`string` + +The transaction hash of the reference UTxO + +##### txIndex + +`number` + +The transaction index of the reference UTxO + +##### spendingScriptHash? + +`string` + +The script hash of the spending script + +##### scriptSize? + +`string` + +#### Returns + +`MeshTxBuilder` + +The MeshTxBuilder instance + +#### Inherited from + +`MeshTxBuilderCore.simpleScriptTxInReference` + +*** + +### sortInputs() + +> **sortInputs**(): `void` + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:329 + +#### Returns + +`void` + +*** + +### sortMints() + +> **sortMints**(): `void` + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:340 + +#### Returns + +`void` + +*** + +### sortTxParts() + +> **sortTxParts**(): `void` + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:322 + +#### Returns + +`void` + +*** + +### sortVotes() + +> **sortVotes**(): `void` + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:390 + +#### Returns + +`void` + +*** + +### sortWithdrawals() + +> **sortWithdrawals**(): `void` + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:375 + +#### Returns + +`void` + +*** + +### spendingPlutusScript() + +> **spendingPlutusScript**(`languageVersion`): `MeshTxBuilder` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:443 + +Set the reference script to be attached with the output + +#### Parameters + +##### languageVersion + +The Plutus script version + +`"V1"` | `"V2"` | `"V3"` + +#### Returns + +`MeshTxBuilder` + +The MeshTxBuilder instance + +#### Inherited from + +`MeshTxBuilderCore.spendingPlutusScript` + +*** + +### spendingPlutusScriptV1() + +> **spendingPlutusScriptV1**(): `MeshTxBuilder` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:456 + +Set the instruction that it is currently using V1 Plutus spending scripts + +#### Returns + +`MeshTxBuilder` + +The MeshTxBuilder instance + +#### Inherited from + +`MeshTxBuilderCore.spendingPlutusScriptV1` + +*** + +### spendingPlutusScriptV2() + +> **spendingPlutusScriptV2**(): `MeshTxBuilder` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:469 + +Set the instruction that it is currently using V2 Plutus spending scripts + +#### Returns + +`MeshTxBuilder` + +The MeshTxBuilder instance + +#### Inherited from + +`MeshTxBuilderCore.spendingPlutusScriptV2` + +*** + +### spendingPlutusScriptV3() + +> **spendingPlutusScriptV3**(): `MeshTxBuilder` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:482 + +Set the instruction that it is currently using V3 Plutus spending scripts + +#### Returns + +`MeshTxBuilder` + +The MeshTxBuilder instance + +#### Inherited from + +`MeshTxBuilderCore.spendingPlutusScriptV3` + +*** + +### spendingReferenceTxInInlineDatumPresent() + +> **spendingReferenceTxInInlineDatumPresent**(): `MeshTxBuilder` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:532 + +[Alias of txInInlineDatumPresent] Set the instruction that the reference input has inline datum + +#### Returns + +`MeshTxBuilder` + +The MeshTxBuilder instance + +#### Inherited from + +`MeshTxBuilderCore.spendingReferenceTxInInlineDatumPresent` + +*** + +### spendingReferenceTxInRedeemerValue() + +> **spendingReferenceTxInRedeemerValue**(`redeemer`, `type`, `exUnits`): `MeshTxBuilder` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:544 + +[Alias of txInRedeemerValue] Set the redeemer for the reference input to be spent in same transaction + +#### Parameters + +##### redeemer + +The redeemer in Mesh Data type, JSON in raw constructor like format, or CBOR hex string + +`object` | `Data` + +##### type + +The redeemer data type, either Mesh Data type, JSON in raw constructor like format, or CBOR hex string. Default to be Mesh type + +`"Mesh"` | `"JSON"` | `"CBOR"` + +##### exUnits + +The execution units budget for the redeemer + +###### mem + +`number` + +###### steps + +`number` + +#### Returns + +`MeshTxBuilder` + +The MeshTxBuilder instance + +#### Inherited from + +`MeshTxBuilderCore.spendingReferenceTxInRedeemerValue` + +*** + +### spendingTxInReference() + +> **spendingTxInReference**(`txHash`, `txIndex`, `scriptSize?`, `scriptHash?`): `MeshTxBuilder` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:500 + +Set the reference input where it would also be spent in the transaction + +#### Parameters + +##### txHash + +`string` + +The transaction hash of the reference UTxO + +##### txIndex + +`number` + +The transaction index of the reference UTxO + +##### scriptSize? + +`string` + +The script size in bytes of the spending script (can be obtained by script hex length / 2) + +##### scriptHash? + +`string` + +The script hash of the spending script + +#### Returns + +`MeshTxBuilder` + +The MeshTxBuilder instance + +#### Inherited from + +`MeshTxBuilderCore.spendingTxInReference` + +*** + +### submitTx() + +> **submitTx**(`txHex`): `Promise`\<`undefined` \| `string`\> + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:593 + +Submit transactions to the blockchain using the fetcher instance + +#### Parameters + +##### txHex + +`string` + +The signed transaction in hex + +#### Returns + +`Promise`\<`undefined` \| `string`\> + +*** + +### txIn() + +> **txIn**(`txHash`, `txIndex`, `amount?`, `address?`, `scriptSize?`): `MeshTxBuilder` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:87 + +Set the input for transaction + +#### Parameters + +##### txHash + +`string` + +The transaction hash of the input UTxO + +##### txIndex + +`number` + +The transaction index of the input UTxO + +##### amount? + +`Asset`[] + +The asset amount of index of the input UTxO + +##### address? + +`string` + +The address of the input UTxO + +##### scriptSize? + +`number` + +The size of the ref script at this input (if there isn't one, explicitly put 0 as scriptSize for offline tx building) + +#### Returns + +`MeshTxBuilder` + +The MeshTxBuilder instance + +#### Inherited from + +`MeshTxBuilderCore.txIn` + +*** + +### txInCollateral() + +> **txInCollateral**(`txHash`, `txIndex`, `amount?`, `address?`): `MeshTxBuilder` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:756 + +Set the collateral UTxO for the transaction + +#### Parameters + +##### txHash + +`string` + +The transaction hash of the collateral UTxO + +##### txIndex + +`number` + +The transaction index of the collateral UTxO + +##### amount? + +`Asset`[] + +The asset amount of index of the collateral UTxO + +##### address? + +`string` + +The address of the collateral UTxO + +#### Returns + +`MeshTxBuilder` + +The MeshTxBuilder instance + +#### Inherited from + +`MeshTxBuilderCore.txInCollateral` + +*** + +### txInDatumValue() + +> **txInDatumValue**(`datum`, `type`): `MeshTxBuilder` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:163 + +Set the input datum for transaction input + +#### Parameters + +##### datum + +The datum in Mesh Data type, JSON in raw constructor like format, or CBOR hex string + +`object` | `Data` + +##### type + +The datum type, either Mesh Data type, JSON in raw constructor like format, or CBOR hex string. Default to be Mesh type + +`"Mesh"` | `"JSON"` | `"CBOR"` + +#### Returns + +`MeshTxBuilder` + +The MeshTxBuilder instance + +#### Inherited from + +`MeshTxBuilderCore.txInDatumValue` + +*** + +### txInInlineDatumPresent() + +> **txInInlineDatumPresent**(): `MeshTxBuilder` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:203 + +Tell the transaction builder that the input UTxO has inlined datum + +#### Returns + +`MeshTxBuilder` + +The MeshTxBuilder instance + +#### Inherited from + +`MeshTxBuilderCore.txInInlineDatumPresent` + +*** + +### txInRedeemerValue() + +> **txInRedeemerValue**(`redeemer`, `type`, `exUnits`): `MeshTxBuilder` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:273 + +Set the redeemer for the reference input to be spent in same transaction + +#### Parameters + +##### redeemer + +The redeemer in Mesh Data type, JSON in raw constructor like format, or CBOR hex string + +`object` | `Data` + +##### type + +The redeemer data type, either Mesh Data type, JSON in raw constructor like format, or CBOR hex string. Default to be Mesh type + +`"Mesh"` | `"JSON"` | `"CBOR"` + +##### exUnits + +The execution units budget for the redeemer + +###### mem + +`number` + +###### steps + +`number` + +#### Returns + +`MeshTxBuilder` + +The MeshTxBuilder instance + +#### Inherited from + +`MeshTxBuilderCore.txInRedeemerValue` + +*** + +### txInScript() + +> **txInScript**(`scriptCbor`): `MeshTxBuilder` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:131 + +Set the script for transaction input + +#### Parameters + +##### scriptCbor + +`string` + +The CborHex of the script + +#### Returns + +`MeshTxBuilder` + +The MeshTxBuilder instance + +#### Inherited from + +`MeshTxBuilderCore.txInScript` + +*** + +### txOut() + +> **txOut**(`address`, `amount`): `MeshTxBuilder` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:301 + +Set the output for transaction + +#### Parameters + +##### address + +`string` + +The recipient of the output + +##### amount + +`Asset`[] + +The amount of other native assets attached with UTxO + +#### Returns + +`MeshTxBuilder` + +The MeshTxBuilder instance + +#### Inherited from + +`MeshTxBuilderCore.txOut` + +*** + +### txOutDatumEmbedValue() + +> **txOutDatumEmbedValue**(`datum`, `type`): `MeshTxBuilder` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:392 + +Set the output embed datum for transaction + +#### Parameters + +##### datum + +The datum in Mesh Data type, JSON in raw constructor like format, or CBOR hex string + +`object` | `Data` + +##### type + +The datum type, either Mesh Data type, JSON in raw constructor like format, or CBOR hex string. Default to be Mesh type + +`"Mesh"` | `"JSON"` | `"CBOR"` + +#### Returns + +`MeshTxBuilder` + +The MeshTxBuilder instance + +#### Inherited from + +`MeshTxBuilderCore.txOutDatumEmbedValue` + +*** + +### txOutDatumHashValue() + +> **txOutDatumHashValue**(`datum`, `type`): `MeshTxBuilder` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:319 + +Set the output datum hash for transaction + +#### Parameters + +##### datum + +The datum in Mesh Data type, JSON in raw constructor like format, or CBOR hex string + +`object` | `Data` + +##### type + +The datum type, either Mesh Data type, JSON in raw constructor like format, or CBOR hex string. Default to be Mesh type + +`"Mesh"` | `"JSON"` | `"CBOR"` + +#### Returns + +`MeshTxBuilder` + +The MeshTxBuilder instance + +#### Inherited from + +`MeshTxBuilderCore.txOutDatumHashValue` + +*** + +### txOutInlineDatumValue() + +> **txOutInlineDatumValue**(`datum`, `type`): `MeshTxBuilder` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:355 + +Set the output inline datum for transaction + +#### Parameters + +##### datum + +The datum in Mesh Data type, JSON in raw constructor like format, or CBOR hex string + +`object` | `Data` + +##### type + +The datum type, either Mesh Data type, JSON in raw constructor like format, or CBOR hex string. Default to be Mesh type + +`"Mesh"` | `"JSON"` | `"CBOR"` + +#### Returns + +`MeshTxBuilder` + +The MeshTxBuilder instance + +#### Inherited from + +`MeshTxBuilderCore.txOutInlineDatumValue` + +*** + +### txOutReferenceScript() + +> **txOutReferenceScript**(`scriptCbor`, `version`): `MeshTxBuilder` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:428 + +Set the reference script to be attached with the output + +#### Parameters + +##### scriptCbor + +`string` + +The CBOR hex of the script to be attached to UTxO as reference script + +##### version + +Optional - The Plutus script version. Default to be V3 (Plutus V3) + +`"V1"` | `"V2"` | `"V3"` + +#### Returns + +`MeshTxBuilder` + +The MeshTxBuilder instance + +#### Inherited from + +`MeshTxBuilderCore.txOutReferenceScript` + +*** + +### updateByTxPrototype() + +> **updateByTxPrototype**(`selectionSkeleton`, `final`): `Promise`\<`void`\> + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:277 + +#### Parameters + +##### selectionSkeleton + +`TransactionPrototype` + +##### final + +`boolean` = `false` + +#### Returns + +`Promise`\<`void`\> + +*** + +### updateRedeemer() + +> `protected` **updateRedeemer**(`meshTxBuilderBody`, `txEvaluation`, `doNotUseMultiplier`): `void` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:1743 + +#### Parameters + +##### meshTxBuilderBody + +`MeshTxBuilderBody` + +##### txEvaluation + +`Omit`\<`Action`, `"data"`\>[] + +##### doNotUseMultiplier + +`boolean` = `false` + +#### Returns + +`void` + +#### Inherited from + +`MeshTxBuilderCore.updateRedeemer` + +*** + +### vote() + +> **vote**(`voter`, `govActionId`, `votingProcedure`): `MeshTxBuilder` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:982 + +Add a vote in the MeshTxBuilder instance + +#### Parameters + +##### voter + +`Voter` + +The voter, can be a ConstitutionalCommitee, a DRep or a StakePool + +##### govActionId + +`RefTxIn` + +The transaction hash and transaction id of the governance action + +##### votingProcedure + +`VotingProcedure` + +The voting kind (Yes, No, Abstain) with an optional anchor + +#### Returns + +`MeshTxBuilder` + +The MeshTxBuilder instance + +#### Inherited from + +`MeshTxBuilderCore.vote` + +*** + +### voteDelegationCertificate() + +> **voteDelegationCertificate**(`drep`, `rewardAddress`): `MeshTxBuilder` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:1262 + +Dregister DRep certificate, and adds it to the transaction + +#### Parameters + +##### drep + +`DRep` + +##### rewardAddress + +`string` + +The bech32 reward address (i.e. start with `stake_xxxxx`) + +#### Returns + +`MeshTxBuilder` + +The MeshTxBuilder instance + +#### Inherited from + +`MeshTxBuilderCore.voteDelegationCertificate` + +*** + +### votePlutusScript() + +> **votePlutusScript**(`languageVersion`): `MeshTxBuilder` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:940 + +Set the instruction that it is currently using a Plutus voting scripts + +#### Parameters + +##### languageVersion + +The Plutus script version + +`"V1"` | `"V2"` | `"V3"` + +#### Returns + +`MeshTxBuilder` + +The MeshTxBuilder instance + +#### Inherited from + +`MeshTxBuilderCore.votePlutusScript` + +*** + +### votePlutusScriptV1() + +> **votePlutusScriptV1**(): `MeshTxBuilder` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:949 + +Set the instruction that it is currently using V1 Plutus voting scripts + +#### Returns + +`MeshTxBuilder` + +The MeshTxBuilder instance + +#### Inherited from + +`MeshTxBuilderCore.votePlutusScriptV1` + +*** + +### votePlutusScriptV2() + +> **votePlutusScriptV2**(): `MeshTxBuilder` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:959 + +Set the instruction that it is currently using V2 Plutus voting scripts + +#### Returns + +`MeshTxBuilder` + +The MeshTxBuilder instance + +#### Inherited from + +`MeshTxBuilderCore.votePlutusScriptV2` + +*** + +### votePlutusScriptV3() + +> **votePlutusScriptV3**(): `MeshTxBuilder` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:969 + +Set the instruction that it is currently using V3 Plutus voting scripts + +#### Returns + +`MeshTxBuilder` + +The MeshTxBuilder instance + +#### Inherited from + +`MeshTxBuilderCore.votePlutusScriptV3` + +*** + +### voteRedeemerValue() + +> **voteRedeemerValue**(`redeemer`, `type`, `exUnits`): `MeshTxBuilder` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:1092 + +Set the transaction vote redeemer value in the MeshTxBuilder instance + +#### Parameters + +##### redeemer + +The redeemer in Mesh Data type, JSON in raw constructor like format, or CBOR hex string + +`object` | `Data` + +##### type + +The redeemer data type, either Mesh Data type, JSON in raw constructor like format, or CBOR hex string + +`"Mesh"` | `"JSON"` | `"CBOR"` + +##### exUnits + +The execution units budget for the redeemer + +###### mem + +`number` + +###### steps + +`number` + +#### Returns + +`MeshTxBuilder` + +The MeshTxBuilder instance + +#### Inherited from + +`MeshTxBuilderCore.voteRedeemerValue` + +*** + +### voteScript() + +> **voteScript**(`scriptCbor`): `MeshTxBuilder` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:1021 + +Add a voting script to the MeshTxBuilder instance + +#### Parameters + +##### scriptCbor + +`string` + +The script in CBOR format + +#### Returns + +`MeshTxBuilder` + +The MeshTxBuilder instance + +#### Inherited from + +`MeshTxBuilderCore.voteScript` + +*** + +### voteTxInReference() + +> **voteTxInReference**(`txHash`, `txIndex`, `scriptSize?`, `scriptHash?`): `MeshTxBuilder` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:1054 + +Add a vote reference to the MeshTxBuilder instance + +#### Parameters + +##### txHash + +`string` + +The transaction hash of reference UTxO + +##### txIndex + +`number` + +The transaction index of reference UTxO + +##### scriptSize? + +`string` + +The script size in bytes of the vote script (can be obtained by script hex length / 2) + +##### scriptHash? + +`string` + +The script hash of the vote script + +#### Returns + +`MeshTxBuilder` + +The MeshTxBuilder instance + +#### Inherited from + +`MeshTxBuilderCore.voteTxInReference` + +*** + +### withdrawal() + +> **withdrawal**(`rewardAddress`, `coin`): `MeshTxBuilder` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:823 + +Withdraw stake rewards in the MeshTxBuilder instance + +#### Parameters + +##### rewardAddress + +`string` + +The bech32 reward address (i.e. start with `stake_xxxxx`) + +##### coin + +`string` + +The amount of lovelaces in the withdrawal + +#### Returns + +`MeshTxBuilder` + +The MeshTxBuilder instance + +#### Inherited from + +`MeshTxBuilderCore.withdrawal` + +*** + +### withdrawalPlutusScript() + +> **withdrawalPlutusScript**(`languageVersion`): `MeshTxBuilder` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:782 + +Set the instruction that it is currently using V1 Plutus withdrawal scripts + +#### Parameters + +##### languageVersion + +The Plutus script version + +`"V1"` | `"V2"` | `"V3"` + +#### Returns + +`MeshTxBuilder` + +The MeshTxBuilder instance + +#### Inherited from + +`MeshTxBuilderCore.withdrawalPlutusScript` + +*** + +### withdrawalPlutusScriptV1() + +> **withdrawalPlutusScriptV1**(): `MeshTxBuilder` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:791 + +Set the instruction that it is currently using a Plutus withdrawal scripts + +#### Returns + +`MeshTxBuilder` + +The MeshTxBuilder instance + +#### Inherited from + +`MeshTxBuilderCore.withdrawalPlutusScriptV1` + +*** + +### withdrawalPlutusScriptV2() + +> **withdrawalPlutusScriptV2**(): `MeshTxBuilder` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:801 + +Set the instruction that it is currently using V2 Plutus withdrawal scripts + +#### Returns + +`MeshTxBuilder` + +The MeshTxBuilder instance + +#### Inherited from + +`MeshTxBuilderCore.withdrawalPlutusScriptV2` + +*** + +### withdrawalPlutusScriptV3() + +> **withdrawalPlutusScriptV3**(): `MeshTxBuilder` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:811 + +Set the instruction that it is currently using V3 Plutus withdrawal scripts + +#### Returns + +`MeshTxBuilder` + +The MeshTxBuilder instance + +#### Inherited from + +`MeshTxBuilderCore.withdrawalPlutusScriptV3` + +*** + +### withdrawalRedeemerValue() + +> **withdrawalRedeemerValue**(`redeemer`, `type`, `exUnits`): `MeshTxBuilder` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:915 + +Set the transaction withdrawal redeemer value in the MeshTxBuilder instance + +#### Parameters + +##### redeemer + +The redeemer in Mesh Data type, JSON in raw constructor like format, or CBOR hex string + +`object` | `Data` + +##### type + +The redeemer data type, either Mesh Data type, JSON in raw constructor like format, or CBOR hex string. Default to be Mesh type + +`"Mesh"` | `"JSON"` | `"CBOR"` + +##### exUnits + +The execution units budget for the redeemer + +###### mem + +`number` + +###### steps + +`number` + +#### Returns + +`MeshTxBuilder` + +The MeshTxBuilder instance + +#### Inherited from + +`MeshTxBuilderCore.withdrawalRedeemerValue` + +*** + +### withdrawalScript() + +> **withdrawalScript**(`scriptCbor`): `MeshTxBuilder` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:852 + +Add a withdrawal script to the MeshTxBuilder instance + +#### Parameters + +##### scriptCbor + +`string` + +The script in CBOR format + +#### Returns + +`MeshTxBuilder` + +The MeshTxBuilder instance + +#### Inherited from + +`MeshTxBuilderCore.withdrawalScript` + +*** + +### withdrawalTxInReference() + +> **withdrawalTxInReference**(`txHash`, `txIndex`, `scriptSize?`, `scriptHash?`): `MeshTxBuilder` + +Defined in: mesh-transaction/src/mesh-tx-builder/tx-builder-core.ts:885 + +Add a withdrawal reference to the MeshTxBuilder instance + +#### Parameters + +##### txHash + +`string` + +The transaction hash of reference UTxO + +##### txIndex + +`number` + +The transaction index of reference UTxO + +##### scriptSize? + +`string` + +The script size in bytes of the withdrawal script (can be obtained by script hex length / 2) + +##### scriptHash? + +`string` + +The script hash of the withdrawal script + +#### Returns + +`MeshTxBuilder` + +The MeshTxBuilder instance + +#### Inherited from + +`MeshTxBuilderCore.withdrawalTxInReference` diff --git a/docs/markdown/mesh-transactions/classes/Transaction.md b/docs/markdown/mesh-transactions/classes/Transaction.md new file mode 100644 index 000000000..3e77f00ca --- /dev/null +++ b/docs/markdown/mesh-transactions/classes/Transaction.md @@ -0,0 +1,889 @@ +[**@meshsdk/transaction**](../README.md) + +*** + +[@meshsdk/transaction](../globals.md) / Transaction + +# Class: Transaction + +Defined in: mesh-transaction/src/transaction/index.ts:46 + +Deprecated - Use `MeshTxBuilder` instead + +## Constructors + +### Constructor + +> **new Transaction**(`options`): `Transaction` + +Defined in: mesh-transaction/src/transaction/index.ts:51 + +#### Parameters + +##### options + +[`TransactionOptions`](../interfaces/TransactionOptions.md) + +#### Returns + +`Transaction` + +## Properties + +### initiator + +> **initiator**: `IInitiator` + +Defined in: mesh-transaction/src/transaction/index.ts:48 + +*** + +### isCollateralNeeded + +> **isCollateralNeeded**: `boolean` = `false` + +Defined in: mesh-transaction/src/transaction/index.ts:49 + +*** + +### txBuilder + +> **txBuilder**: [`MeshTxBuilder`](MeshTxBuilder.md) + +Defined in: mesh-transaction/src/transaction/index.ts:47 + +## Methods + +### build() + +> **build**(`balanced`): `Promise`\<`string`\> + +Defined in: mesh-transaction/src/transaction/index.ts:714 + +#### Parameters + +##### balanced + +`Boolean` = `true` + +#### Returns + +`Promise`\<`string`\> + +*** + +### burnAsset() + +> **burnAsset**(`forgeScript`, `asset`, `redeemer?`): `Transaction` + +Defined in: mesh-transaction/src/transaction/index.ts:524 + +[Deprecated] - `Transaction` class is on planning for V2. +Use `MeshTxBuilder` instead for tx-building for now. + +#### Parameters + +##### forgeScript + +`string` | `UTxO` | `PlutusScript` + +##### asset + +`Asset` + +##### redeemer? + +`Pick`\<`Action`, `"data"`\> & `object` + +#### Returns + +`Transaction` + +*** + +### delegateStake() + +> **delegateStake**(`rewardAddress`, `poolId`): `Transaction` + +Defined in: mesh-transaction/src/transaction/index.ts:670 + +[Deprecated] - `Transaction` class is on planning for V2. +Use `MeshTxBuilder` instead for tx-building for now. + +#### Parameters + +##### rewardAddress + +`string` + +##### poolId + +`string` + +#### Returns + +`Transaction` + +*** + +### deregisterStake() + +> **deregisterStake**(`rewardAddress`): `Transaction` + +Defined in: mesh-transaction/src/transaction/index.ts:682 + +[Deprecated] - `Transaction` class is on planning for V2. +Use `MeshTxBuilder` instead for tx-building for now. + +#### Parameters + +##### rewardAddress + +`string` + +#### Returns + +`Transaction` + +*** + +### mintAsset() + +> **mintAsset**(`forgeScript`, `mint`, `redeemer?`): `Transaction` + +Defined in: mesh-transaction/src/transaction/index.ts:367 + +[Deprecated] - `Transaction` class is on planning for V2. +Use `MeshTxBuilder` instead for tx-building for now. + +#### Parameters + +##### forgeScript + +`string` | `UTxO` | `PlutusScript` + +##### mint + +`Mint` + +##### redeemer? + +`Pick`\<`Action`, `"data"`\> & `object` + +#### Returns + +`Transaction` + +*** + +### mintPlutusScript() + +> `protected` **mintPlutusScript**(`script`): [`MeshTxBuilder`](MeshTxBuilder.md) + +Defined in: mesh-transaction/src/transaction/index.ts:731 + +#### Parameters + +##### script + +`PlutusScript` + +#### Returns + +[`MeshTxBuilder`](MeshTxBuilder.md) + +*** + +### redeemValue() + +> **redeemValue**(`options`): `Transaction` + +Defined in: mesh-transaction/src/transaction/index.ts:291 + +[Deprecated] - `Transaction` class is on planning for V2. +Use `MeshTxBuilder` instead for tx-building for now. + +#### Parameters + +##### options + +###### datum? + +`UTxO` \| `Data` + +###### redeemer? + +`Pick`\<`Action`, `"data"`\> & `object` + +###### script + +`UTxO` \| `PlutusScript` + +###### value + +`UTxO` + +#### Returns + +`Transaction` + +*** + +### registerPool() + +> **registerPool**(`params`): `Transaction` + +Defined in: mesh-transaction/src/transaction/index.ts:700 + +[Deprecated] - `Transaction` class is on planning for V2. +Use `MeshTxBuilder` instead for tx-building for now. + +#### Parameters + +##### params + +`PoolParams` + +#### Returns + +`Transaction` + +*** + +### registerStake() + +> **registerStake**(`rewardAddress`): `Transaction` + +Defined in: mesh-transaction/src/transaction/index.ts:691 + +[Deprecated] - `Transaction` class is on planning for V2. +Use `MeshTxBuilder` instead for tx-building for now. + +#### Parameters + +##### rewardAddress + +`string` + +#### Returns + +`Transaction` + +*** + +### retirePool() + +> **retirePool**(`poolId`, `epochNo`): `Transaction` + +Defined in: mesh-transaction/src/transaction/index.ts:709 + +[Deprecated] - `Transaction` class is on planning for V2. +Use `MeshTxBuilder` instead for tx-building for now. + +#### Parameters + +##### poolId + +`string` + +##### epochNo + +`number` + +#### Returns + +`Transaction` + +*** + +### sendAssets() + +> **sendAssets**(`recipient`, `assets`): `Transaction` + +Defined in: mesh-transaction/src/transaction/index.ts:133 + +[Deprecated] - `Transaction` class is on planning for V2. +Use `MeshTxBuilder` instead for tx-building for now. + +#### Parameters + +##### recipient + +`Recipient` + +The recipient of the output. + +##### assets + +The assets to send. Provide string for lovelace and Asset[] for tokens and/or lovelace. + +`string` | `Asset`[] + +#### Returns + +`Transaction` + +The transaction builder. + +#### See + +[https://meshjs.dev/apis/transaction#sendAssets](https://meshjs.dev/apis/transaction#sendAssets) + +*** + +### sendLovelace() + +> **sendLovelace**(`recipient`, `lovelace`): `Transaction` + +Defined in: mesh-transaction/src/transaction/index.ts:175 + +[Deprecated] - `Transaction` class is on planning for V2. +Use `MeshTxBuilder` instead for tx-building for now. + +Use sendAssets instead: +```ts +this.sendAssets(recipient, lovelace); +``` + +Deprecation reason - Unnecessary implementation which might cause confusion. + +#### Parameters + +##### recipient + +`Recipient` + +The recipient of the transaction. + +##### lovelace + +`string` + +The amount of lovelace to send. + +#### Returns + +`Transaction` + +The Transaction object. + +#### See + +[https://meshjs.dev/apis/transaction#sendAda](https://meshjs.dev/apis/transaction#sendAda) + +*** + +### sendToken() + +> **sendToken**(`recipient`, `ticker`, `amount`): `Transaction` + +Defined in: mesh-transaction/src/transaction/index.ts:197 + +[Deprecated] - `Transaction` class is on planning for V2. +Use `MeshTxBuilder` instead for tx-building for now. + +Please use sendAssets with helper function to obtain token unit instead: +```ts +const assets = [{ unit: SUPPORTED_TOKENS.GIMBAL, quantity: "100" }] +transaction.sendAssets(recipient, assets) +``` + +Deprecation reason - Required maintenance on tokens. + +#### Parameters + +##### recipient + +`Recipient` + +The recipient of the transaction. + +##### ticker + +The ticker of the token to send. + +`"LQ"` | `"MIN"` | `"NTX"` | `"iBTC"` | `"iETH"` | `"iUSD"` | `"MILK"` | `"AGIX"` | `"MELD"` | `"INDY"` | `"CLAY"` | `"MCOS"` | `"DING"` | `"GERO"` | `"NMKR"` | `"PAVIA"` | `"HOSKY"` | `"YUMMI"` | `"C3"` | `"GIMBAL"` | `"SUNDAE"` | `"GREENS"` | `"GENS"` | `"SOCIETY"` | `"DJED"` | `"SHEN"` | `"WMT"` | `"COPI"` + +##### amount + +`string` + +The amount of the token to send. + +#### Returns + +`Transaction` + +The Transaction object. + +#### See + +[https://meshjs.dev/apis/transaction#sendToken](https://meshjs.dev/apis/transaction#sendToken) + +*** + +### sendValue() + +> **sendValue**(`recipient`, `value`): `Transaction` + +Defined in: mesh-transaction/src/transaction/index.ts:216 + +[Deprecated] - `Transaction` class is on planning for V2. +Use `MeshTxBuilder` instead for tx-building for now. + +```ts +const assets = value.output.amount; +this.sendAssets(recipient, assets); +``` +Deprecation reason - Unnecessary implementation which might cause confusion. + +#### Parameters + +##### recipient + +`Recipient` + +The recipient of the output. + +##### value + +`UTxO` + +The UTxO value of the output. + +#### Returns + +`Transaction` + +The Transaction object. + +*** + +### setChangeAddress() + +> **setChangeAddress**(`changeAddress`): `Transaction` + +Defined in: mesh-transaction/src/transaction/index.ts:552 + +[Deprecated] - `Transaction` class is on planning for V2. +Use `MeshTxBuilder` instead for tx-building for now. + +Sets the change address for the transaction. + +#### Parameters + +##### changeAddress + +`string` + +The change address. + +#### Returns + +`Transaction` + +The Transaction object. + +*** + +### setCollateral() + +> **setCollateral**(`collateral`): `Transaction` + +Defined in: mesh-transaction/src/transaction/index.ts:566 + +[Deprecated] - `Transaction` class is on planning for V2. +Use `MeshTxBuilder` instead for tx-building for now. + +Sets the collateral for the transaction. + +#### Parameters + +##### collateral + +`UTxO`[] + +Set the UTxO for collateral. + +#### Returns + +`Transaction` + +The Transaction object. + +*** + +### setMetadata() + +> **setMetadata**(`label`, `metadata`): `Transaction` + +Defined in: mesh-transaction/src/transaction/index.ts:652 + +[Deprecated] - `Transaction` class is on planning for V2. +Use `MeshTxBuilder` instead for tx-building for now. + + Add a JSON metadata entry to the transaction. + +#### Parameters + +##### label + +`number` + +The label to use for the metadata entry. + +##### metadata + +The value to use for the metadata entry. + +`object` | `Metadatum` + +#### Returns + +`Transaction` + +The Transaction object. + +#### See + +[https://meshjs.dev/apis/transaction#setMetadata](https://meshjs.dev/apis/transaction#setMetadata) + +*** + +### setNativeScriptInput() + +> **setNativeScriptInput**(`script`, `utxo`): `Transaction` + +Defined in: mesh-transaction/src/transaction/index.ts:269 + +[Deprecated] - `Transaction` class is on planning for V2. +Use `MeshTxBuilder` instead for tx-building for now. + +Sets the native script for the transaction. + +#### Parameters + +##### script + +`NativeScript` + +The native script to spend from. + +##### utxo + +`UTxO` + +The UTxO attached to the script. + +#### Returns + +`Transaction` + +The Transaction object. + +*** + +### setNetwork() + +> **setNetwork**(`network`): `Transaction` + +Defined in: mesh-transaction/src/transaction/index.ts:587 + +[Deprecated] - `Transaction` class is on planning for V2. +Use `MeshTxBuilder` instead for tx-building for now. + +Sets the network to use, this is mainly to know the cost models to be used to calculate script integrity hash + +#### Parameters + +##### network + +The specific network this transaction is being built for ("testnet" | "preview" | "preprod" | "mainnet") + +`"testnet"` | `"preview"` | `"preprod"` | `"mainnet"` + +#### Returns + +`Transaction` + +The Transaction object. + +*** + +### setRequiredSigners() + +> **setRequiredSigners**(`addresses`): `Transaction` + +Defined in: mesh-transaction/src/transaction/index.ts:601 + +[Deprecated] - `Transaction` class is on planning for V2. +Use `MeshTxBuilder` instead for tx-building for now. + +Sets the required signers for the transaction. + +#### Parameters + +##### addresses + +`string`[] + +The addresses of the required signers. + +#### Returns + +`Transaction` + +The Transaction object. + +*** + +### setTimeToExpire() + +> **setTimeToExpire**(`slot`): `Transaction` + +Defined in: mesh-transaction/src/transaction/index.ts:621 + +[Deprecated] - `Transaction` class is on planning for V2. +Use `MeshTxBuilder` instead for tx-building for now. + + Set the time to live for the transaction. + +#### Parameters + +##### slot + +`string` + +The slot number to expire the transaction at. + +#### Returns + +`Transaction` + +The Transaction object. + +#### See + +[https://meshjs.dev/apis/transaction#setTimeLimit](https://meshjs.dev/apis/transaction#setTimeLimit) + +*** + +### setTimeToStart() + +> **setTimeToStart**(`slot`): `Transaction` + +Defined in: mesh-transaction/src/transaction/index.ts:636 + +[Deprecated] - `Transaction` class is on planning for V2. +Use `MeshTxBuilder` instead for tx-building for now. + + Sets the start slot for the transaction. + +#### Parameters + +##### slot + +`string` + +The start slot for the transaction. + +#### Returns + +`Transaction` + +The Transaction object. + +#### See + +[https://meshjs.dev/apis/transaction#setTimeLimit](https://meshjs.dev/apis/transaction#setTimeLimit) + +*** + +### setTxInputs() + +> **setTxInputs**(`inputs`): `Transaction` + +Defined in: mesh-transaction/src/transaction/index.ts:228 + +[Deprecated] - `Transaction` class is on planning for V2. +Use `MeshTxBuilder` instead for tx-building for now. + +#### Parameters + +##### inputs + +`UTxO`[] + +The inputs to set. + +#### Returns + +`Transaction` + +The transaction. + +*** + +### setTxRefInputs() + +> **setTxRefInputs**(`inputs`): `Transaction` + +Defined in: mesh-transaction/src/transaction/index.ts:249 + +[Deprecated] - `Transaction` class is on planning for V2. +Use `MeshTxBuilder` instead for tx-building for now. + +#### Parameters + +##### inputs + +`UTxO`[] + +The reference inputs to set. + +#### Returns + +`Transaction` + +The transaction. + +*** + +### spendingPlutusScript() + +> `protected` **spendingPlutusScript**(`script`): [`MeshTxBuilder`](MeshTxBuilder.md) + +Defined in: mesh-transaction/src/transaction/index.ts:746 + +#### Parameters + +##### script + +`PlutusScript` + +#### Returns + +[`MeshTxBuilder`](MeshTxBuilder.md) + +*** + +### withdrawRewards() + +> **withdrawRewards**(`rewardAddress`, `lovelace`): `Transaction` + +Defined in: mesh-transaction/src/transaction/index.ts:661 + +[Deprecated] - `Transaction` class is on planning for V2. +Use `MeshTxBuilder` instead for tx-building for now. + +#### Parameters + +##### rewardAddress + +`string` + +##### lovelace + +`string` + +#### Returns + +`Transaction` + +*** + +### attachMetadata() + +> `static` **attachMetadata**(`cborTx`, `cborTxMetadata`): `string` + +Defined in: mesh-transaction/src/transaction/index.ts:56 + +#### Parameters + +##### cborTx + +`string` + +##### cborTxMetadata + +`string` + +#### Returns + +`string` + +*** + +### deattachMetadata() + +> `static` **deattachMetadata**(`cborTx`): `string` + +Defined in: mesh-transaction/src/transaction/index.ts:78 + +#### Parameters + +##### cborTx + +`string` + +#### Returns + +`string` + +*** + +### maskMetadata() + +> `static` **maskMetadata**(`cborTx`): `string` + +Defined in: mesh-transaction/src/transaction/index.ts:83 + +#### Parameters + +##### cborTx + +`string` + +#### Returns + +`string` + +*** + +### readMetadata() + +> `static` **readMetadata**(`cborTx`): `string` + +Defined in: mesh-transaction/src/transaction/index.ts:106 + +#### Parameters + +##### cborTx + +`string` + +#### Returns + +`string` + +*** + +### writeMetadata() + +> `static` **writeMetadata**(`cborTx`, `cborTxMetadata`): `string` + +Defined in: mesh-transaction/src/transaction/index.ts:111 + +#### Parameters + +##### cborTx + +`string` + +##### cborTxMetadata + +`string` + +#### Returns + +`string` diff --git a/docs/markdown/mesh-transactions/classes/TxParser.md b/docs/markdown/mesh-transactions/classes/TxParser.md new file mode 100644 index 000000000..6e6dded91 --- /dev/null +++ b/docs/markdown/mesh-transactions/classes/TxParser.md @@ -0,0 +1,109 @@ +[**@meshsdk/transaction**](../README.md) + +*** + +[@meshsdk/transaction](../globals.md) / TxParser + +# Class: TxParser + +Defined in: mesh-transaction/src/tx-parser/index.ts:8 + +TxParser class to parse transaction hex strings and resolve UTxOs. + +It is used for either manipulating transactions or for unit testing transaction buildings. + +## Constructors + +### Constructor + +> **new TxParser**(`serializer`, `fetcher?`): `TxParser` + +Defined in: mesh-transaction/src/tx-parser/index.ts:9 + +#### Parameters + +##### serializer + +`IMeshTxSerializer` + +##### fetcher? + +`IFetcher` + +#### Returns + +`TxParser` + +## Properties + +### fetcher? + +> `optional` **fetcher**: `IFetcher` + +Defined in: mesh-transaction/src/tx-parser/index.ts:11 + +*** + +### serializer + +> **serializer**: `IMeshTxSerializer` + +Defined in: mesh-transaction/src/tx-parser/index.ts:10 + +## Methods + +### getBuilderBody() + +> **getBuilderBody**(): `MeshTxBuilderBody` + +Defined in: mesh-transaction/src/tx-parser/index.ts:59 + +#### Returns + +`MeshTxBuilderBody` + +*** + +### getBuilderBodyWithoutChange() + +> **getBuilderBodyWithoutChange**(): `MeshTxBuilderBody` + +Defined in: mesh-transaction/src/tx-parser/index.ts:61 + +#### Returns + +`MeshTxBuilderBody` + +*** + +### parse() + +> **parse**(`txHex`, `providedUtxos`): `Promise`\<`MeshTxBuilderBody`\> + +Defined in: mesh-transaction/src/tx-parser/index.ts:14 + +#### Parameters + +##### txHex + +`string` + +##### providedUtxos + +`UTxO`[] = `[]` + +#### Returns + +`Promise`\<`MeshTxBuilderBody`\> + +*** + +### toTester() + +> **toTester**(): `TxTester` + +Defined in: mesh-transaction/src/tx-parser/index.ts:64 + +#### Returns + +`TxTester` diff --git a/docs/markdown/mesh-transactions/functions/cloneOutput.md b/docs/markdown/mesh-transactions/functions/cloneOutput.md new file mode 100644 index 000000000..038ad2f09 --- /dev/null +++ b/docs/markdown/mesh-transactions/functions/cloneOutput.md @@ -0,0 +1,21 @@ +[**@meshsdk/transaction**](../README.md) + +*** + +[@meshsdk/transaction](../globals.md) / cloneOutput + +# Function: cloneOutput() + +> **cloneOutput**(`output`): `Output` + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:1799 + +## Parameters + +### output + +`Output` + +## Returns + +`Output` diff --git a/docs/markdown/mesh-transactions/functions/getLovelace.md b/docs/markdown/mesh-transactions/functions/getLovelace.md new file mode 100644 index 000000000..afa538288 --- /dev/null +++ b/docs/markdown/mesh-transactions/functions/getLovelace.md @@ -0,0 +1,21 @@ +[**@meshsdk/transaction**](../README.md) + +*** + +[@meshsdk/transaction](../globals.md) / getLovelace + +# Function: getLovelace() + +> **getLovelace**(`output`): `bigint` + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:1822 + +## Parameters + +### output + +`Output` + +## Returns + +`bigint` diff --git a/docs/markdown/mesh-transactions/functions/getOutputMinLovelace.md b/docs/markdown/mesh-transactions/functions/getOutputMinLovelace.md new file mode 100644 index 000000000..dee5e1b32 --- /dev/null +++ b/docs/markdown/mesh-transactions/functions/getOutputMinLovelace.md @@ -0,0 +1,25 @@ +[**@meshsdk/transaction**](../README.md) + +*** + +[@meshsdk/transaction](../globals.md) / getOutputMinLovelace + +# Function: getOutputMinLovelace() + +> **getOutputMinLovelace**(`output`, `coinsPerUtxoSize`): `bigint` + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:1831 + +## Parameters + +### output + +`Output` + +### coinsPerUtxoSize + +`number` = `DEFAULT_PROTOCOL_PARAMETERS.coinsPerUtxoSize` + +## Returns + +`bigint` diff --git a/docs/markdown/mesh-transactions/functions/getUtxoMinLovelace.md b/docs/markdown/mesh-transactions/functions/getUtxoMinLovelace.md new file mode 100644 index 000000000..e80937c23 --- /dev/null +++ b/docs/markdown/mesh-transactions/functions/getUtxoMinLovelace.md @@ -0,0 +1,33 @@ +[**@meshsdk/transaction**](../README.md) + +*** + +[@meshsdk/transaction](../globals.md) / getUtxoMinLovelace + +# Function: getUtxoMinLovelace() + +> **getUtxoMinLovelace**(`utxo`, `coinsPerUtxoSize`): `bigint` + +Defined in: mesh-transaction/src/mesh-tx-builder/utils.ts:34 + +Calculate minimum lovelace required for a UTxO output + +## Parameters + +### utxo + +`TxOutput` + +Output of utxo + +### coinsPerUtxoSize + +`number` = `DEFAULT_PROTOCOL_PARAMETERS.coinsPerUtxoSize` + +From protocol parameters + +## Returns + +`bigint` + +Minimum lovelace required for the UTxO diff --git a/docs/markdown/mesh-transactions/functions/mergeContents.md b/docs/markdown/mesh-transactions/functions/mergeContents.md new file mode 100644 index 000000000..d1b4e618f --- /dev/null +++ b/docs/markdown/mesh-transactions/functions/mergeContents.md @@ -0,0 +1,54 @@ +[**@meshsdk/transaction**](../README.md) + +*** + +[@meshsdk/transaction](../globals.md) / mergeContents + +# Function: mergeContents() + +> **mergeContents**(`a`, `b`, `currentDepth`): `Metadatum` + +Defined in: mesh-transaction/src/utils/metadata.ts:62 + +Recursively merge two metadata. Returns the 2nd item if the maximum allowed +merge depth has passed. + +Merging maps ({ key: value }): +Two maps are merged by recursively including the (key, value) pairs from both the maps. +When further merge isn't allowed (by currentDepth), the 2nd item is preferred, +replacing the 1st item. + +Merging arrays: +Two arrays are merged by concatenating them. +When merge isn't allowed (by currentDepth), the 2nd array is returned. + +Merging primitive types (number, string, etc.): +Primitive types are not merged in the sense of concatenating. In case they are the same, +either of them can be considered as the "merged value". 2nd item is returned here. +When merge isn't allowed (by currentDepth), the 2nd item is returned. + +## Parameters + +### a + +`Metadatum` + +first item + +### b + +`Metadatum` + +second item + +### currentDepth + +`number` + +the current merge depth; decreases in a recursive call + +## Returns + +`Metadatum` + +merged item or a preferred item, chosen according to currentDepth diff --git a/docs/markdown/mesh-transactions/functions/metadataObjToMap.md b/docs/markdown/mesh-transactions/functions/metadataObjToMap.md new file mode 100644 index 000000000..98a48538e --- /dev/null +++ b/docs/markdown/mesh-transactions/functions/metadataObjToMap.md @@ -0,0 +1,21 @@ +[**@meshsdk/transaction**](../README.md) + +*** + +[@meshsdk/transaction](../globals.md) / metadataObjToMap + +# Function: metadataObjToMap() + +> **metadataObjToMap**(`metadata`): `Metadatum` + +Defined in: mesh-transaction/src/utils/metadata.ts:7 + +## Parameters + +### metadata + +`any` + +## Returns + +`Metadatum` diff --git a/docs/markdown/mesh-transactions/functions/setLoveLace.md b/docs/markdown/mesh-transactions/functions/setLoveLace.md new file mode 100644 index 000000000..924bee0ea --- /dev/null +++ b/docs/markdown/mesh-transactions/functions/setLoveLace.md @@ -0,0 +1,25 @@ +[**@meshsdk/transaction**](../README.md) + +*** + +[@meshsdk/transaction](../globals.md) / setLoveLace + +# Function: setLoveLace() + +> **setLoveLace**(`output`, `lovelace`): `Output` + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:1803 + +## Parameters + +### output + +`Output` + +### lovelace + +`bigint` + +## Returns + +`Output` diff --git a/docs/markdown/mesh-transactions/functions/utxoToTxIn.md b/docs/markdown/mesh-transactions/functions/utxoToTxIn.md new file mode 100644 index 000000000..5188a2a07 --- /dev/null +++ b/docs/markdown/mesh-transactions/functions/utxoToTxIn.md @@ -0,0 +1,27 @@ +[**@meshsdk/transaction**](../README.md) + +*** + +[@meshsdk/transaction](../globals.md) / utxoToTxIn + +# Function: utxoToTxIn() + +> **utxoToTxIn**(`utxo`): \[`string`, `number`, `Asset`[], `string`\] + +Defined in: mesh-transaction/src/mesh-tx-builder/utils.ts:19 + +Convert UTxO to TxIn parameters in array for MeshTxBuilder + +## Parameters + +### utxo + +`UTxO` + +UTxO + +## Returns + +\[`string`, `number`, `Asset`[], `string`\] + +[txHash, outputIndex, amount, address] diff --git a/docs/markdown/mesh-transactions/globals.md b/docs/markdown/mesh-transactions/globals.md new file mode 100644 index 000000000..599ee7695 --- /dev/null +++ b/docs/markdown/mesh-transactions/globals.md @@ -0,0 +1,32 @@ +[**@meshsdk/transaction**](README.md) + +*** + +# @meshsdk/transaction + +## Classes + +- [ForgeScript](classes/ForgeScript.md) +- [MeshTxBuilder](classes/MeshTxBuilder.md) +- [Transaction](classes/Transaction.md) +- [TxParser](classes/TxParser.md) + +## Interfaces + +- [MeshTxBuilderOptions](interfaces/MeshTxBuilderOptions.md) +- [TransactionOptions](interfaces/TransactionOptions.md) + +## Type Aliases + +- [MetadataMergeLevel](type-aliases/MetadataMergeLevel.md) + +## Functions + +- [cloneOutput](functions/cloneOutput.md) +- [getLovelace](functions/getLovelace.md) +- [getOutputMinLovelace](functions/getOutputMinLovelace.md) +- [getUtxoMinLovelace](functions/getUtxoMinLovelace.md) +- [mergeContents](functions/mergeContents.md) +- [metadataObjToMap](functions/metadataObjToMap.md) +- [setLoveLace](functions/setLoveLace.md) +- [utxoToTxIn](functions/utxoToTxIn.md) diff --git a/docs/markdown/mesh-transactions/interfaces/MeshTxBuilderOptions.md b/docs/markdown/mesh-transactions/interfaces/MeshTxBuilderOptions.md new file mode 100644 index 000000000..2f2b7b5c7 --- /dev/null +++ b/docs/markdown/mesh-transactions/interfaces/MeshTxBuilderOptions.md @@ -0,0 +1,69 @@ +[**@meshsdk/transaction**](../README.md) + +*** + +[@meshsdk/transaction](../globals.md) / MeshTxBuilderOptions + +# Interface: MeshTxBuilderOptions + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:49 + +## Extended by + +- [`TransactionOptions`](TransactionOptions.md) + +## Properties + +### evaluator? + +> `optional` **evaluator**: `IEvaluator` + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:52 + +*** + +### fetcher? + +> `optional` **fetcher**: `IFetcher` + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:50 + +*** + +### isHydra? + +> `optional` **isHydra**: `boolean` + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:54 + +*** + +### params? + +> `optional` **params**: `Partial`\<`Protocol`\> + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:55 + +*** + +### serializer? + +> `optional` **serializer**: `IMeshTxSerializer` + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:53 + +*** + +### submitter? + +> `optional` **submitter**: `ISubmitter` + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:51 + +*** + +### verbose? + +> `optional` **verbose**: `boolean` + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:56 diff --git a/docs/markdown/mesh-transactions/interfaces/TransactionOptions.md b/docs/markdown/mesh-transactions/interfaces/TransactionOptions.md new file mode 100644 index 000000000..5a5ded4a3 --- /dev/null +++ b/docs/markdown/mesh-transactions/interfaces/TransactionOptions.md @@ -0,0 +1,105 @@ +[**@meshsdk/transaction**](../README.md) + +*** + +[@meshsdk/transaction](../globals.md) / TransactionOptions + +# Interface: TransactionOptions + +Defined in: mesh-transaction/src/transaction/index.ts:39 + +## Extends + +- [`MeshTxBuilderOptions`](MeshTxBuilderOptions.md) + +## Properties + +### evaluator? + +> `optional` **evaluator**: `IEvaluator` + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:52 + +#### Inherited from + +[`MeshTxBuilderOptions`](MeshTxBuilderOptions.md).[`evaluator`](MeshTxBuilderOptions.md#evaluator) + +*** + +### fetcher? + +> `optional` **fetcher**: `IFetcher` + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:50 + +#### Inherited from + +[`MeshTxBuilderOptions`](MeshTxBuilderOptions.md).[`fetcher`](MeshTxBuilderOptions.md#fetcher) + +*** + +### initiator + +> **initiator**: `IInitiator` + +Defined in: mesh-transaction/src/transaction/index.ts:40 + +*** + +### isHydra? + +> `optional` **isHydra**: `boolean` + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:54 + +#### Inherited from + +[`MeshTxBuilderOptions`](MeshTxBuilderOptions.md).[`isHydra`](MeshTxBuilderOptions.md#ishydra) + +*** + +### params? + +> `optional` **params**: `Partial`\<`Protocol`\> + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:55 + +#### Inherited from + +[`MeshTxBuilderOptions`](MeshTxBuilderOptions.md).[`params`](MeshTxBuilderOptions.md#params) + +*** + +### serializer? + +> `optional` **serializer**: `IMeshTxSerializer` + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:53 + +#### Inherited from + +[`MeshTxBuilderOptions`](MeshTxBuilderOptions.md).[`serializer`](MeshTxBuilderOptions.md#serializer) + +*** + +### submitter? + +> `optional` **submitter**: `ISubmitter` + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:51 + +#### Inherited from + +[`MeshTxBuilderOptions`](MeshTxBuilderOptions.md).[`submitter`](MeshTxBuilderOptions.md#submitter) + +*** + +### verbose? + +> `optional` **verbose**: `boolean` + +Defined in: mesh-transaction/src/mesh-tx-builder/index.ts:56 + +#### Inherited from + +[`MeshTxBuilderOptions`](MeshTxBuilderOptions.md).[`verbose`](MeshTxBuilderOptions.md#verbose) diff --git a/docs/markdown/mesh-transactions/type-aliases/MetadataMergeLevel.md b/docs/markdown/mesh-transactions/type-aliases/MetadataMergeLevel.md new file mode 100644 index 000000000..2e8471d85 --- /dev/null +++ b/docs/markdown/mesh-transactions/type-aliases/MetadataMergeLevel.md @@ -0,0 +1,11 @@ +[**@meshsdk/transaction**](../README.md) + +*** + +[@meshsdk/transaction](../globals.md) / MetadataMergeLevel + +# Type Alias: MetadataMergeLevel + +> **MetadataMergeLevel** = `boolean` \| `number` + +Defined in: mesh-transaction/src/utils/metadata.ts:5 diff --git a/docs/markdown/mesh-wallets/README.md b/docs/markdown/mesh-wallets/README.md new file mode 100644 index 000000000..a10799d74 --- /dev/null +++ b/docs/markdown/mesh-wallets/README.md @@ -0,0 +1,9 @@ +**@meshsdk/wallet** + +*** + +# mesh-wallet + +Wallets - [meshjs.dev/apis/wallets](https://meshjs.dev/apis/wallets) + +[meshjs.dev](https://meshjs.dev/) diff --git a/docs/markdown/mesh-wallets/classes/AppWallet.md b/docs/markdown/mesh-wallets/classes/AppWallet.md new file mode 100644 index 000000000..e382bb35e --- /dev/null +++ b/docs/markdown/mesh-wallets/classes/AppWallet.md @@ -0,0 +1,366 @@ +[**@meshsdk/wallet**](../README.md) + +*** + +[@meshsdk/wallet](../globals.md) / AppWallet + +# Class: AppWallet + +Defined in: app/index.ts:35 + +## Implements + +- `ISigner` +- `ISubmitter` + +## Constructors + +### Constructor + +> **new AppWallet**(`options`): `AppWallet` + +Defined in: app/index.ts:40 + +#### Parameters + +##### options + +[`CreateAppWalletOptions`](../type-aliases/CreateAppWalletOptions.md) + +#### Returns + +`AppWallet` + +## Methods + +### getCollateralUnspentOutput() + +> **getCollateralUnspentOutput**(`accountIndex`, `addressType`): `Promise`\<`TransactionUnspentOutput`[]\> + +Defined in: app/index.ts:92 + +Get a list of UTXOs to be used as collateral inputs for transactions with plutus script inputs. + +This is used in transaction building. + +#### Parameters + +##### accountIndex + +`number` = `0` + +##### addressType + +`GetAddressType` = `"payment"` + +#### Returns + +`Promise`\<`TransactionUnspentOutput`[]\> + +a list of UTXOs + +*** + +### getEnterpriseAddress() + +> **getEnterpriseAddress**(`accountIndex`, `keyIndex`): `string` + +Defined in: app/index.ts:120 + +#### Parameters + +##### accountIndex + +`number` = `0` + +##### keyIndex + +`number` = `0` + +#### Returns + +`string` + +*** + +### getNetworkId() + +> **getNetworkId**(): `number` + +Defined in: app/index.ts:135 + +#### Returns + +`number` + +*** + +### getPaymentAddress() + +> **getPaymentAddress**(`accountIndex`, `keyIndex`): `string` + +Defined in: app/index.ts:125 + +#### Parameters + +##### accountIndex + +`number` = `0` + +##### keyIndex + +`number` = `0` + +#### Returns + +`string` + +*** + +### getRewardAddress() + +> **getRewardAddress**(`accountIndex`, `keyIndex`): `string` + +Defined in: app/index.ts:130 + +#### Parameters + +##### accountIndex + +`number` = `0` + +##### keyIndex + +`number` = `0` + +#### Returns + +`string` + +*** + +### getUnspentOutputs() + +> **getUnspentOutputs**(`accountIndex`, `addressType`): `Promise`\<`TransactionUnspentOutput`[]\> + +Defined in: app/index.ts:151 + +#### Parameters + +##### accountIndex + +`number` = `0` + +##### addressType + +`GetAddressType` = `"payment"` + +#### Returns + +`Promise`\<`TransactionUnspentOutput`[]\> + +*** + +### getUsedAddress() + +> **getUsedAddress**(`accountIndex`, `keyIndex`, `addressType`): `Address` + +Defined in: app/index.ts:139 + +#### Parameters + +##### accountIndex + +`number` = `0` + +##### keyIndex + +`number` = `0` + +##### addressType + +`GetAddressType` = `"payment"` + +#### Returns + +`Address` + +*** + +### init() + +> **init**(): `Promise`\<`void`\> + +Defined in: app/index.ts:79 + +Initializes the wallet. This is a required call as fetching addresses from the wallet is an async operation. + +#### Returns + +`Promise`\<`void`\> + +void + +*** + +### signData() + +> **signData**(`address`, `payload`, `accountIndex`, `keyIndex`): `Promise`\<`DataSignature`\> + +Defined in: app/index.ts:171 + +#### Parameters + +##### address + +`string` + +##### payload + +`string` + +##### accountIndex + +`number` = `0` + +##### keyIndex + +`number` = `0` + +#### Returns + +`Promise`\<`DataSignature`\> + +#### Implementation of + +`ISigner.signData` + +*** + +### signTx() + +> **signTx**(`unsignedTx`, `partialSign`, `accountIndex`, `keyIndex`): `Promise`\<`string`\> + +Defined in: app/index.ts:186 + +#### Parameters + +##### unsignedTx + +`string` + +##### partialSign + +`boolean` = `false` + +##### accountIndex + +`number` = `0` + +##### keyIndex + +`number` = `0` + +#### Returns + +`Promise`\<`string`\> + +#### Implementation of + +`ISigner.signTx` + +*** + +### signTxs() + +> **signTxs**(`unsignedTxs`, `partialSign`): `Promise`\<`string`[]\> + +Defined in: app/index.ts:229 + +#### Parameters + +##### unsignedTxs + +`string`[] + +##### partialSign + +`boolean` + +#### Returns + +`Promise`\<`string`[]\> + +#### Implementation of + +`ISigner.signTxs` + +*** + +### signTxSync() + +> **signTxSync**(`unsignedTx`, `partialSign`, `accountIndex`, `keyIndex`): `string` + +Defined in: app/index.ts:216 + +#### Parameters + +##### unsignedTx + +`string` + +##### partialSign + +`boolean` = `false` + +##### accountIndex + +`number` = `0` + +##### keyIndex + +`number` = `0` + +#### Returns + +`string` + +*** + +### submitTx() + +> **submitTx**(`tx`): `Promise`\<`string`\> + +Defined in: app/index.ts:236 + +#### Parameters + +##### tx + +`string` + +#### Returns + +`Promise`\<`string`\> + +#### Implementation of + +`ISubmitter.submitTx` + +*** + +### brew() + +> `static` **brew**(`strength`): `string`[] + +Defined in: app/index.ts:245 + +#### Parameters + +##### strength + +`number` = `256` + +#### Returns + +`string`[] diff --git a/docs/markdown/mesh-wallets/classes/BrowserWallet.md b/docs/markdown/mesh-wallets/classes/BrowserWallet.md new file mode 100644 index 000000000..edb87367f --- /dev/null +++ b/docs/markdown/mesh-wallets/classes/BrowserWallet.md @@ -0,0 +1,698 @@ +[**@meshsdk/wallet**](../README.md) + +*** + +[@meshsdk/wallet](../globals.md) / BrowserWallet + +# Class: BrowserWallet + +Defined in: browser/browser-wallet.ts:58 + +Browser Wallet provides a set of APIs to interact with the blockchain. This wallet is compatible with Mesh transaction builders. + +These wallets APIs are in accordance to CIP-30, which defines the API for apps to communicate with the user's wallet. Additional utility functions provided for developers that are useful for building applications. +```javascript +import { BrowserWallet } from '@meshsdk/core'; + +const wallet = await BrowserWallet.enable('eternl'); +``` + +## Implements + +- `IWallet` + +## Properties + +### \_walletInstance + +> `readonly` **\_walletInstance**: `WalletInstance` + +Defined in: browser/browser-wallet.ts:62 + +*** + +### \_walletName + +> `readonly` **\_walletName**: `string` + +Defined in: browser/browser-wallet.ts:63 + +*** + +### walletInstance + +> **walletInstance**: `WalletInstance` + +Defined in: browser/browser-wallet.ts:59 + +## Methods + +### getAssets() + +> **getAssets**(): `Promise`\<`AssetExtended`[]\> + +Defined in: browser/browser-wallet.ts:423 + +A helper function to get the assets in the wallet. + +#### Returns + +`Promise`\<`AssetExtended`[]\> + +a list of assets + +#### Implementation of + +`IWallet.getAssets` + +*** + +### getBalance() + +> **getBalance**(): `Promise`\<`Asset`[]\> + +Defined in: browser/browser-wallet.ts:159 + +Returns a list of assets in the wallet. This API will return every assets in the wallet. Each asset is an object with the following properties: +- A unit is provided to display asset's name on the user interface. +- A quantity is provided to display asset's quantity on the user interface. + +#### Returns + +`Promise`\<`Asset`[]\> + +a list of assets and their quantities + +#### Implementation of + +`IWallet.getBalance` + +*** + +### getChangeAddress() + +> **getChangeAddress**(): `Promise`\<`string`\> + +Defined in: browser/browser-wallet.ts:169 + +Returns an address owned by the wallet that should be used as a change address to return leftover assets during transaction creation back to the connected wallet. + +#### Returns + +`Promise`\<`string`\> + +an address + +#### Implementation of + +`IWallet.getChangeAddress` + +*** + +### getCollateral() + +> **getCollateral**(): `Promise`\<`UTxO`[]\> + +Defined in: browser/browser-wallet.ts:182 + +This function shall return a list of one or more UTXOs (unspent transaction outputs) controlled by the wallet that are required to reach AT LEAST the combined ADA value target specified in amount AND the best suitable to be used as collateral inputs for transactions with plutus script inputs (pure ADA-only UTXOs). + +If this cannot be attained, an error message with an explanation of the blocking problem shall be returned. NOTE: wallets are free to return UTXOs that add up to a greater total ADA value than requested in the amount parameter, but wallets must never return any result where UTXOs would sum up to a smaller total ADA value, instead in a case like that an error message must be returned. + +#### Returns + +`Promise`\<`UTxO`[]\> + +a list of UTXOs + +#### Implementation of + +`IWallet.getCollateral` + +*** + +### getCollateralUnspentOutput() + +> **getCollateralUnspentOutput**(`limit`): `Promise`\<`TransactionUnspentOutput`[]\> + +Defined in: browser/browser-wallet.ts:389 + +Get a list of UTXOs to be used as collateral inputs for transactions with plutus script inputs. + +This is used in transaction building. + +#### Parameters + +##### limit + +`number` = `DEFAULT_PROTOCOL_PARAMETERS.maxCollateralInputs` + +#### Returns + +`Promise`\<`TransactionUnspentOutput`[]\> + +a list of UTXOs + +*** + +### getDRep() + +> **getDRep**(): `Promise`\<`undefined` \| \{ `dRepIDCip105`: `string`; `publicKey`: `string`; `publicKeyHash`: `string`; \}\> + +Defined in: browser/browser-wallet.ts:483 + +The connected wallet account provides the account's public DRep Key, derivation as described in CIP-0105. +These are used by the client to identify the user's on-chain CIP-1694 interactions, i.e. if a user has registered to be a DRep. + +#### Returns + +`Promise`\<`undefined` \| \{ `dRepIDCip105`: `string`; `publicKey`: `string`; `publicKeyHash`: `string`; \}\> + +DRep object + +#### Implementation of + +`IWallet.getDRep` + +*** + +### getExtensions() + +> **getExtensions**(): `Promise`\<`number`[]\> + +Defined in: browser/browser-wallet.ts:192 + +Return a list of supported CIPs of the wallet. + +#### Returns + +`Promise`\<`number`[]\> + +a list of CIPs + +#### Implementation of + +`IWallet.getExtensions` + +*** + +### getLovelace() + +> **getLovelace**(): `Promise`\<`string`\> + +Defined in: browser/browser-wallet.ts:447 + +A helper function to get the lovelace balance in the wallet. + +#### Returns + +`Promise`\<`string`\> + +lovelace balance + +#### Implementation of + +`IWallet.getLovelace` + +*** + +### getNetworkId() + +> **getNetworkId**(): `Promise`\<`number`\> + +Defined in: browser/browser-wallet.ts:207 + +Returns the network ID of the currently connected account. 0 is testnet and 1 is mainnet but other networks can possibly be returned by wallets. Those other network ID values are not governed by CIP-30. This result will stay the same unless the connected account has changed. + +#### Returns + +`Promise`\<`number`\> + +network ID + +#### Implementation of + +`IWallet.getNetworkId` + +*** + +### getPolicyIdAssets() + +> **getPolicyIdAssets**(`policyId`): `Promise`\<`AssetExtended`[]\> + +Defined in: browser/browser-wallet.ts:460 + +A helper function to get the assets of a specific policy ID in the wallet. + +#### Parameters + +##### policyId + +`string` + +#### Returns + +`Promise`\<`AssetExtended`[]\> + +a list of assets + +#### Implementation of + +`IWallet.getPolicyIdAssets` + +*** + +### getPolicyIds() + +> **getPolicyIds**(): `Promise`\<`string`[]\> + +Defined in: browser/browser-wallet.ts:470 + +A helper function to get the policy IDs of all the assets in the wallet. + +#### Returns + +`Promise`\<`string`[]\> + +a list of policy IDs + +#### Implementation of + +`IWallet.getPolicyIds` + +*** + +### getPubDRepKey() + +> **getPubDRepKey**(): `Promise`\<`undefined` \| `string`\> + +Defined in: browser/browser-wallet.ts:519 + +The connected wallet account provides the account's public DRep Key, derivation as described in CIP-0105. +These are used by the client to identify the user's on-chain CIP-1694 interactions, i.e. if a user has registered to be a DRep. + +#### Returns + +`Promise`\<`undefined` \| `string`\> + +wallet account's public DRep Key + +*** + +### getRegisteredPubStakeKeys() + +> **getRegisteredPubStakeKeys**(): `Promise`\<`undefined` \| \{ `pubStakeKeyHashes`: `string`[]; `pubStakeKeys`: `string`[]; \}\> + +Defined in: browser/browser-wallet.ts:531 + +#### Returns + +`Promise`\<`undefined` \| \{ `pubStakeKeyHashes`: `string`[]; `pubStakeKeys`: `string`[]; \}\> + +#### Implementation of + +`IWallet.getRegisteredPubStakeKeys` + +*** + +### getRewardAddresses() + +> **getRewardAddresses**(): `Promise`\<`string`[]\> + +Defined in: browser/browser-wallet.ts:216 + +Returns a list of reward addresses owned by the wallet. A reward address is a stake address that is used to receive rewards from staking, generally starts from `stake` prefix. + +#### Returns + +`Promise`\<`string`[]\> + +a list of reward addresses + +#### Implementation of + +`IWallet.getRewardAddresses` + +*** + +### getUnregisteredPubStakeKeys() + +> **getUnregisteredPubStakeKeys**(): `Promise`\<`undefined` \| \{ `pubStakeKeyHashes`: `string`[]; `pubStakeKeys`: `string`[]; \}\> + +Defined in: browser/browser-wallet.ts:562 + +#### Returns + +`Promise`\<`undefined` \| \{ `pubStakeKeyHashes`: `string`[]; `pubStakeKeys`: `string`[]; \}\> + +#### Implementation of + +`IWallet.getUnregisteredPubStakeKeys` + +*** + +### getUnusedAddresses() + +> **getUnusedAddresses**(): `Promise`\<`string`[]\> + +Defined in: browser/browser-wallet.ts:226 + +Returns a list of unused addresses controlled by the wallet. + +#### Returns + +`Promise`\<`string`[]\> + +a list of unused addresses + +#### Implementation of + +`IWallet.getUnusedAddresses` + +*** + +### getUsedAddress() + +> **getUsedAddress**(): `Promise`\<`Address`\> + +Defined in: browser/browser-wallet.ts:376 + +Get a used address of type Address from the wallet. + +This is used in transaction building. + +#### Returns + +`Promise`\<`Address`\> + +an Address object + +*** + +### getUsedAddresses() + +> **getUsedAddresses**(): `Promise`\<`string`[]\> + +Defined in: browser/browser-wallet.ts:238 + +Returns a list of used addresses controlled by the wallet. + +#### Returns + +`Promise`\<`string`[]\> + +a list of used addresses + +#### Implementation of + +`IWallet.getUsedAddresses` + +*** + +### getUsedUTxOs() + +> **getUsedUTxOs**(): `Promise`\<`TransactionUnspentOutput`[]\> + +Defined in: browser/browser-wallet.ts:413 + +Get a list of UTXOs to be used for transaction building. + +This is used in transaction building. + +#### Returns + +`Promise`\<`TransactionUnspentOutput`[]\> + +a list of UTXOs + +*** + +### getUtxos() + +> **getUtxos**(): `Promise`\<`UTxO`[]\> + +Defined in: browser/browser-wallet.ts:248 + +Return a list of all UTXOs (unspent transaction outputs) controlled by the wallet. + +#### Returns + +`Promise`\<`UTxO`[]\> + +a list of UTXOs + +#### Implementation of + +`IWallet.getUtxos` + +*** + +### signData() + +> **signData**(`payload`, `address?`, `convertFromUTF8?`): `Promise`\<`DataSignature`\> + +Defined in: browser/browser-wallet.ts:260 + +This endpoint utilizes the [CIP-8 - Message Signing](https://cips.cardano.org/cips/cip8/) to sign arbitrary data, to verify the data was signed by the owner of the private key. + +#### Parameters + +##### payload + +`string` + +the data to be signed + +##### address? + +`string` + +optional, if not provided, the first staking address will be used + +##### convertFromUTF8? + +`boolean` = `true` + +#### Returns + +`Promise`\<`DataSignature`\> + +a signature + +#### Implementation of + +`IWallet.signData` + +*** + +### signTx() + +> **signTx**(`unsignedTx`, `partialSign`): `Promise`\<`string`\> + +Defined in: browser/browser-wallet.ts:289 + +Requests user to sign the provided transaction (tx). The wallet should ask the user for permission, and if given, try to sign the supplied body and return a signed transaction. partialSign should be true if the transaction provided requires multiple signatures. + +#### Parameters + +##### unsignedTx + +`string` + +a transaction in CBOR + +##### partialSign + +`boolean` = `false` + +if the transaction is signed partially + +#### Returns + +`Promise`\<`string`\> + +a signed transaction in CBOR + +#### Implementation of + +`IWallet.signTx` + +*** + +### signTxs() + +> **signTxs**(`unsignedTxs`, `partialSign`): `Promise`\<`string`[]\> + +Defined in: browser/browser-wallet.ts:304 + +Experimental feature - sign multiple transactions at once (Supported wallet(s): Typhon) + +#### Parameters + +##### unsignedTxs + +`string`[] + +array of unsigned transactions in CborHex string + +##### partialSign + +`boolean` = `false` + +if the transactions are signed partially + +#### Returns + +`Promise`\<`string`[]\> + +array of signed transactions CborHex string + +#### Implementation of + +`IWallet.signTxs` + +*** + +### submitTx() + +> **submitTx**(`tx`): `Promise`\<`string`\> + +Defined in: browser/browser-wallet.ts:365 + +Submits the signed transaction to the blockchain network. + +As wallets should already have this ability to submit transaction, we allow apps to request that a transaction be sent through it. If the wallet accepts the transaction and tries to send it, it shall return the transaction ID for the app to track. The wallet can return error messages or failure if there was an error in sending it. + +#### Parameters + +##### tx + +`string` + +#### Returns + +`Promise`\<`string`\> + +a transaction hash + +#### Implementation of + +`IWallet.submitTx` + +*** + +### addBrowserWitnesses() + +> `static` **addBrowserWitnesses**(`unsignedTx`, `witnesses`): `string` + +Defined in: browser/browser-wallet.ts:624 + +#### Parameters + +##### unsignedTx + +`string` + +##### witnesses + +`string` + +#### Returns + +`string` + +*** + +### enable() + +> `static` **enable**(`walletName`, `extensions`): `Promise`\<`BrowserWallet`\> + +Defined in: browser/browser-wallet.ts:129 + +This is the entrypoint to start communication with the user's wallet. The wallet should request the user's permission to connect the web page to the user's wallet, and if permission has been granted, the wallet will be returned and exposing the full API for the app to use. + +Query BrowserWallet.getInstalledWallets() to get a list of available wallets, then provide the wallet name for which wallet the user would like to connect with. + +#### Parameters + +##### walletName + +`string` + +the name of the wallet to enable (e.g. "eternl", "begin") + +##### extensions + +`Extension`[] = `[]` + +optional, a list of CIPs that the wallet should support + +#### Returns + +`Promise`\<`BrowserWallet`\> + +WalletInstance + +*** + +### getAvailableWallets() + +> `static` **getAvailableWallets**(`__namedParameters`): `Promise`\<`Wallet`[]\> + +Defined in: browser/browser-wallet.ts:76 + +Returns a list of wallets installed on user's device. Each wallet is an object with the following properties: +- A name is provided to display wallet's name on the user interface. +- A version is provided to display wallet's version on the user interface. +- An icon is provided to display wallet's icon on the user interface. + +#### Parameters + +##### \_\_namedParameters + +###### injectFn? + +() => `Promise`\<`void`\> = `undefined` + +#### Returns + +`Promise`\<`Wallet`[]\> + +a list of wallet names + +*** + +### getInstalledWallets() + +> `static` **getInstalledWallets**(): `Wallet`[] + +Defined in: browser/browser-wallet.ts:96 + +Returns a list of wallets installed on user's device. Each wallet is an object with the following properties: +- A name is provided to display wallet's name on the user interface. +- A version is provided to display wallet's version on the user interface. +- An icon is provided to display wallet's icon on the user interface. + +#### Returns + +`Wallet`[] + +a list of wallet names + +*** + +### getSupportedExtensions() + +> `static` **getSupportedExtensions**(`wallet`): `object`[] + +Defined in: browser/browser-wallet.ts:652 + +#### Parameters + +##### wallet + +`string` + +#### Returns + +`object`[] diff --git a/docs/markdown/mesh-wallets/classes/EmbeddedWallet.md b/docs/markdown/mesh-wallets/classes/EmbeddedWallet.md new file mode 100644 index 000000000..baac92474 --- /dev/null +++ b/docs/markdown/mesh-wallets/classes/EmbeddedWallet.md @@ -0,0 +1,399 @@ +[**@meshsdk/wallet**](../README.md) + +*** + +[@meshsdk/wallet](../globals.md) / EmbeddedWallet + +# Class: EmbeddedWallet + +Defined in: embedded/index.ts:199 + +## Extends + +- [`WalletStaticMethods`](WalletStaticMethods.md) + +## Constructors + +### Constructor + +> **new EmbeddedWallet**(`options`): `EmbeddedWallet` + +Defined in: embedded/index.ts:204 + +#### Parameters + +##### options + +[`CreateEmbeddedWalletOptions`](../type-aliases/CreateEmbeddedWalletOptions.md) + +#### Returns + +`EmbeddedWallet` + +#### Overrides + +[`WalletStaticMethods`](WalletStaticMethods.md).[`constructor`](WalletStaticMethods.md#constructor) + +## Properties + +### cryptoIsReady + +> **cryptoIsReady**: `boolean` = `false` + +Defined in: embedded/index.ts:202 + +## Methods + +### getAccount() + +> **getAccount**(`accountIndex`, `keyIndex`): [`Account`](../type-aliases/Account.md) + +Defined in: embedded/index.ts:239 + +#### Parameters + +##### accountIndex + +`number` = `0` + +##### keyIndex + +`number` = `0` + +#### Returns + +[`Account`](../type-aliases/Account.md) + +*** + +### getNetworkId() + +> **getNetworkId**(): `number` + +Defined in: embedded/index.ts:285 + +Get wallet network ID. + +#### Returns + +`number` + +network ID + +*** + +### init() + +> **init**(): `Promise`\<`void`\> + +Defined in: embedded/index.ts:234 + +#### Returns + +`Promise`\<`void`\> + +*** + +### signData() + +> **signData**(`address`, `payload`, `accountIndex`, `keyIndex`): `DataSignature` + +Defined in: embedded/index.ts:297 + +This endpoint utilizes the [CIP-8 - Message Signing](https://cips.cardano.org/cips/cip8/) to sign arbitrary data, to verify the data was signed by the owner of the private key. + +#### Parameters + +##### address + +`string` + +bech32 address to sign the data with + +##### payload + +`string` + +the data to be signed + +##### accountIndex + +`number` = `0` + +account index (default: 0) + +##### keyIndex + +`number` = `0` + +#### Returns + +`DataSignature` + +a signature + +*** + +### signTx() + +> **signTx**(`unsignedTx`, `accountIndex`, `keyIndex`, `accountType`): `VkeyWitness` + +Defined in: embedded/index.ts:337 + +This endpoints sign the provided transaction (unsignedTx) with the private key of the owner. + +#### Parameters + +##### unsignedTx + +`string` + +a transaction in CBOR + +##### accountIndex + +`number` = `0` + +account index (default: 0) + +##### keyIndex + +`number` = `0` + +key index (default: 0) + +##### accountType + +[`AccountType`](../type-aliases/AccountType.md) = `"payment"` + +type of the account (default: payment) + +#### Returns + +`VkeyWitness` + +VkeyWitness + +*** + +### addWitnessSets() + +> `static` **addWitnessSets**(`txHex`, `witnesses`): `string` + +Defined in: embedded/index.ts:182 + +#### Parameters + +##### txHex + +`string` + +##### witnesses + +`VkeyWitness`[] + +#### Returns + +`string` + +#### Inherited from + +[`WalletStaticMethods`](WalletStaticMethods.md).[`addWitnessSets`](WalletStaticMethods.md#addwitnesssets) + +*** + +### bip32BytesToPrivateKeyHex() + +> `static` **bip32BytesToPrivateKeyHex**(`bip32Bytes`): `string` + +Defined in: embedded/index.ts:104 + +#### Parameters + +##### bip32Bytes + +`Uint8Array` + +#### Returns + +`string` + +#### Inherited from + +[`WalletStaticMethods`](WalletStaticMethods.md).[`bip32BytesToPrivateKeyHex`](WalletStaticMethods.md#bip32bytestoprivatekeyhex) + +*** + +### generateMnemonic() + +> `static` **generateMnemonic**(`strength`): `string`[] + +Defined in: embedded/index.ts:177 + +#### Parameters + +##### strength + +`number` = `256` + +#### Returns + +`string`[] + +#### Inherited from + +[`WalletStaticMethods`](WalletStaticMethods.md).[`generateMnemonic`](WalletStaticMethods.md#generatemnemonic) + +*** + +### getAddresses() + +> `static` **getAddresses**(`paymentKey`, `stakingKey`, `networkId`): `object` + +Defined in: embedded/index.ts:109 + +#### Parameters + +##### paymentKey + +`Ed25519PrivateKey` + +##### stakingKey + +`Ed25519PrivateKey` + +##### networkId + +`number` = `0` + +#### Returns + +`object` + +##### baseAddress + +> **baseAddress**: `Address` + +##### enterpriseAddress + +> **enterpriseAddress**: `Address` + +##### rewardAddress + +> **rewardAddress**: `Address` + +#### Inherited from + +[`WalletStaticMethods`](WalletStaticMethods.md).[`getAddresses`](WalletStaticMethods.md#getaddresses) + +*** + +### getDRepKey() + +> `static` **getDRepKey**(`dRepKey`, `networkId`): `object` + +Defined in: embedded/index.ts:149 + +#### Parameters + +##### dRepKey + +`Ed25519PrivateKey` + +##### networkId + +`number` = `0` + +#### Returns + +`object` + +##### dRepIDBech32 + +> **dRepIDBech32**: `DRepID` + +##### dRepIDCip105 + +> **dRepIDCip105**: `string` + +##### dRepIDHash + +> **dRepIDHash**: `Ed25519KeyHashHex` + +##### pubDRepKey + +> **pubDRepKey**: `string` + +#### Inherited from + +[`WalletStaticMethods`](WalletStaticMethods.md).[`getDRepKey`](WalletStaticMethods.md#getdrepkey) + +*** + +### mnemonicToPrivateKeyHex() + +> `static` **mnemonicToPrivateKeyHex**(`words`): `string` + +Defined in: embedded/index.ts:88 + +#### Parameters + +##### words + +`string`[] + +#### Returns + +`string` + +#### Inherited from + +[`WalletStaticMethods`](WalletStaticMethods.md).[`mnemonicToPrivateKeyHex`](WalletStaticMethods.md#mnemonictoprivatekeyhex) + +*** + +### privateKeyBech32ToPrivateKeyHex() + +> `static` **privateKeyBech32ToPrivateKeyHex**(`_bech32`): `string` + +Defined in: embedded/index.ts:82 + +#### Parameters + +##### \_bech32 + +`string` + +#### Returns + +`string` + +#### Inherited from + +[`WalletStaticMethods`](WalletStaticMethods.md).[`privateKeyBech32ToPrivateKeyHex`](WalletStaticMethods.md#privatekeybech32toprivatekeyhex) + +*** + +### signingKeyToHexes() + +> `static` **signingKeyToHexes**(`paymentKey`, `stakeKey`): \[`string`, `string`\] + +Defined in: embedded/index.ts:94 + +#### Parameters + +##### paymentKey + +`string` + +##### stakeKey + +`string` + +#### Returns + +\[`string`, `string`\] + +#### Inherited from + +[`WalletStaticMethods`](WalletStaticMethods.md).[`signingKeyToHexes`](WalletStaticMethods.md#signingkeytohexes) diff --git a/docs/markdown/mesh-wallets/classes/MeshWallet.md b/docs/markdown/mesh-wallets/classes/MeshWallet.md new file mode 100644 index 000000000..4ee97fc3b --- /dev/null +++ b/docs/markdown/mesh-wallets/classes/MeshWallet.md @@ -0,0 +1,830 @@ +[**@meshsdk/wallet**](../README.md) + +*** + +[@meshsdk/wallet](../globals.md) / MeshWallet + +# Class: MeshWallet + +Defined in: mesh/index.ts:93 + +Mesh Wallet provides a set of APIs to interact with the blockchain. This wallet is compatible with Mesh transaction builders. + +There are 4 types of keys that can be used to create a wallet: +- root: A private key in bech32 format, generally starts with `xprv1` +- cli: CLI generated keys starts with `5820`. Payment key is required, and the stake key is optional. +- mnemonic: A list of 24 words +- address: A bech32 address that can be used to create a read-only wallet, generally starts with `addr` or `addr_test1` + +```javascript +import { MeshWallet, BlockfrostProvider } from '@meshsdk/core'; + +const provider = new BlockfrostProvider(''); + +const wallet = new MeshWallet({ + networkId: 0, + fetcher: provider, + submitter: provider, + key: { + type: 'mnemonic', + words: ["solution","solution","solution","solution","solution",","solution","solution","solution","solution","solution","solution","solution","solution","solution","solution","solution","solution","solution","solution","solution","solution","solution","solution"], + }, +}); +``` + +Please call `await wallet.init()` after creating the wallet to fetch the addresses from the wallet. + +## Implements + +- `IWallet` + +## Constructors + +### Constructor + +> **new MeshWallet**(`options`): `MeshWallet` + +Defined in: mesh/index.ts:115 + +#### Parameters + +##### options + +[`CreateMeshWalletOptions`](../type-aliases/CreateMeshWalletOptions.md) + +#### Returns + +`MeshWallet` + +## Properties + +### addresses + +> **addresses**: `object` = `{}` + +Defined in: mesh/index.ts:102 + +#### baseAddress? + +> `optional` **baseAddress**: `Address` + +#### baseAddressBech32? + +> `optional` **baseAddressBech32**: `string` + +#### dRepIDBech32? + +> `optional` **dRepIDBech32**: `DRepID` + +#### dRepIDCip105? + +> `optional` **dRepIDCip105**: `string` + +#### dRepIDHash? + +> `optional` **dRepIDHash**: `Ed25519KeyHashHex` + +#### enterpriseAddress? + +> `optional` **enterpriseAddress**: `Address` + +#### enterpriseAddressBech32? + +> `optional` **enterpriseAddressBech32**: `string` + +#### pubDRepKey? + +> `optional` **pubDRepKey**: `string` + +#### rewardAddress? + +> `optional` **rewardAddress**: `Address` + +#### rewardAddressBech32? + +> `optional` **rewardAddressBech32**: `string` + +## Methods + +### createCollateral() + +> **createCollateral**(): `Promise`\<`string`\> + +Defined in: mesh/index.ts:631 + +A helper function to create a collateral input for a transaction. + +#### Returns + +`Promise`\<`string`\> + +a transaction hash + +*** + +### getAddresses() + +> **getAddresses**(): `object` + +Defined in: mesh/index.ts:185 + +Returns all derived addresses from the wallet. + +#### Returns + +`object` + +a list of addresses + +##### baseAddress? + +> `optional` **baseAddress**: `Address` + +##### baseAddressBech32? + +> `optional` **baseAddressBech32**: `string` + +##### dRepIDBech32? + +> `optional` **dRepIDBech32**: `DRepID` + +##### dRepIDCip105? + +> `optional` **dRepIDCip105**: `string` + +##### dRepIDHash? + +> `optional` **dRepIDHash**: `Ed25519KeyHashHex` + +##### enterpriseAddress? + +> `optional` **enterpriseAddress**: `Address` + +##### enterpriseAddressBech32? + +> `optional` **enterpriseAddressBech32**: `string` + +##### pubDRepKey? + +> `optional` **pubDRepKey**: `string` + +##### rewardAddress? + +> `optional` **rewardAddress**: `Address` + +##### rewardAddressBech32? + +> `optional` **rewardAddressBech32**: `string` + +*** + +### getAssets() + +> **getAssets**(): `Promise`\<`AssetExtended`[]\> + +Defined in: mesh/index.ts:550 + +A helper function to get the assets in the wallet. + +#### Returns + +`Promise`\<`AssetExtended`[]\> + +a list of assets + +#### Implementation of + +`IWallet.getAssets` + +*** + +### getBalance() + +> **getBalance**(): `Promise`\<`Asset`[]\> + +Defined in: mesh/index.ts:196 + +Returns a list of assets in the wallet. This API will return every assets in the wallet. Each asset is an object with the following properties: +- A unit is provided to display asset's name on the user interface. +- A quantity is provided to display asset's quantity on the user interface. + +#### Returns + +`Promise`\<`Asset`[]\> + +a list of assets and their quantities + +#### Implementation of + +`IWallet.getBalance` + +*** + +### getChangeAddress() + +> **getChangeAddress**(`addressType`): `Promise`\<`string`\> + +Defined in: mesh/index.ts:229 + +Returns an address owned by the wallet that should be used as a change address to return leftover assets during transaction creation back to the connected wallet. + +#### Parameters + +##### addressType + +`GetAddressType` = `"payment"` + +#### Returns + +`Promise`\<`string`\> + +an address + +#### Implementation of + +`IWallet.getChangeAddress` + +*** + +### getCollateral() + +> **getCollateral**(`addressType`): `Promise`\<`UTxO`[]\> + +Defined in: mesh/index.ts:249 + +This function shall return a list of one or more UTXOs (unspent transaction outputs) controlled by the wallet that are required to reach AT LEAST the combined ADA value target specified in amount AND the best suitable to be used as collateral inputs for transactions with plutus script inputs (pure ADA-only UTXOs). + +If this cannot be attained, an error message with an explanation of the blocking problem shall be returned. NOTE: wallets are free to return UTXOs that add up to a greater total ADA value than requested in the amount parameter, but wallets must never return any result where UTXOs would sum up to a smaller total ADA value, instead in a case like that an error message must be returned. + +#### Parameters + +##### addressType + +`GetAddressType` = `"payment"` + +the type of address to fetch UTXOs from (default: payment) + +#### Returns + +`Promise`\<`UTxO`[]\> + +a list of UTXOs + +#### Implementation of + +`IWallet.getCollateral` + +*** + +### getCollateralUnspentOutput() + +> **getCollateralUnspentOutput**(`addressType`): `Promise`\<`TransactionUnspentOutput`[]\> + +Defined in: mesh/index.ts:277 + +Get a list of UTXOs to be used as collateral inputs for transactions with plutus script inputs. + +This is used in transaction building. + +#### Parameters + +##### addressType + +`GetAddressType` = `"payment"` + +the type of address to fetch UTXOs from (default: payment) + +#### Returns + +`Promise`\<`TransactionUnspentOutput`[]\> + +a list of UTXOs + +*** + +### getDRep() + +> **getDRep**(): `Promise`\<`undefined` \| \{ `dRepIDCip105`: `string`; `publicKey`: `string`; `publicKeyHash`: `string`; \}\> + +Defined in: mesh/index.ts:312 + +The connected wallet account provides the account's public DRep Key, derivation as described in CIP-0105. +These are used by the client to identify the user's on-chain CIP-1694 interactions, i.e. if a user has registered to be a DRep. + +#### Returns + +`Promise`\<`undefined` \| \{ `dRepIDCip105`: `string`; `publicKey`: `string`; `publicKeyHash`: `string`; \}\> + +DRep object + +#### Implementation of + +`IWallet.getDRep` + +*** + +### getExtensions() + +> **getExtensions**(): `Promise`\<`number`[]\> + +Defined in: mesh/index.ts:265 + +Return a list of supported CIPs of the wallet. + +#### Returns + +`Promise`\<`number`[]\> + +a list of CIPs + +#### Implementation of + +`IWallet.getExtensions` + +*** + +### getLovelace() + +> **getLovelace**(): `Promise`\<`string`\> + +Defined in: mesh/index.ts:574 + +A helper function to get the lovelace balance in the wallet. + +#### Returns + +`Promise`\<`string`\> + +lovelace balance + +#### Implementation of + +`IWallet.getLovelace` + +*** + +### getNetworkId() + +> **getNetworkId**(): `Promise`\<`number`\> + +Defined in: mesh/index.ts:340 + +Returns the network ID of the currently connected account. 0 is testnet and 1 is mainnet but other networks can possibly be returned by wallets. Those other network ID values are not governed by CIP-30. This result will stay the same unless the connected account has changed. + +#### Returns + +`Promise`\<`number`\> + +network ID + +#### Implementation of + +`IWallet.getNetworkId` + +*** + +### getPolicyIdAssets() + +> **getPolicyIdAssets**(`policyId`): `Promise`\<`AssetExtended`[]\> + +Defined in: mesh/index.ts:587 + +A helper function to get the assets of a specific policy ID in the wallet. + +#### Parameters + +##### policyId + +`string` + +#### Returns + +`Promise`\<`AssetExtended`[]\> + +a list of assets + +#### Implementation of + +`IWallet.getPolicyIdAssets` + +*** + +### getPolicyIds() + +> **getPolicyIds**(): `Promise`\<`string`[]\> + +Defined in: mesh/index.ts:597 + +A helper function to get the policy IDs of all the assets in the wallet. + +#### Returns + +`Promise`\<`string`[]\> + +a list of policy IDs + +#### Implementation of + +`IWallet.getPolicyIds` + +*** + +### getPubDRepKey() + +> **getPubDRepKey**(): `object` + +Defined in: mesh/index.ts:640 + +#### Returns + +`object` + +##### dRepIDBech32 + +> **dRepIDBech32**: `undefined` \| `string` + +##### dRepIDCip105 + +> **dRepIDCip105**: `undefined` \| `string` + +##### dRepIDHash + +> **dRepIDHash**: `undefined` \| `string` + +##### pubDRepKey + +> **pubDRepKey**: `undefined` \| `string` + +*** + +### getRegisteredPubStakeKeys() + +> **getRegisteredPubStakeKeys**(): `Promise`\<`undefined` \| \{ `pubStakeKeyHashes`: `string`[]; `pubStakeKeys`: `string`[]; \}\> + +Defined in: mesh/index.ts:604 + +#### Returns + +`Promise`\<`undefined` \| \{ `pubStakeKeyHashes`: `string`[]; `pubStakeKeys`: `string`[]; \}\> + +#### Implementation of + +`IWallet.getRegisteredPubStakeKeys` + +*** + +### getRewardAddresses() + +> **getRewardAddresses**(): `Promise`\<`string`[]\> + +Defined in: mesh/index.ts:349 + +Returns a list of reward addresses owned by the wallet. A reward address is a stake address that is used to receive rewards from staking, generally starts from `stake` prefix. + +#### Returns + +`Promise`\<`string`[]\> + +a list of reward addresses + +#### Implementation of + +`IWallet.getRewardAddresses` + +*** + +### getUnregisteredPubStakeKeys() + +> **getUnregisteredPubStakeKeys**(): `Promise`\<`undefined` \| \{ `pubStakeKeyHashes`: `string`[]; `pubStakeKeys`: `string`[]; \}\> + +Defined in: mesh/index.ts:615 + +#### Returns + +`Promise`\<`undefined` \| \{ `pubStakeKeyHashes`: `string`[]; `pubStakeKeys`: `string`[]; \}\> + +#### Implementation of + +`IWallet.getUnregisteredPubStakeKeys` + +*** + +### getUnspentOutputs() + +> **getUnspentOutputs**(`addressType`): `Promise`\<`TransactionUnspentOutput`[]\> + +Defined in: mesh/index.ts:527 + +Get a list of UTXOs to be used for transaction building. + +This is used in transaction building. + +#### Parameters + +##### addressType + +`GetAddressType` = `"payment"` + +the type of address to fetch UTXOs from (default: payment) + +#### Returns + +`Promise`\<`TransactionUnspentOutput`[]\> + +a list of UTXOs + +*** + +### getUnusedAddresses() + +> **getUnusedAddresses**(): `Promise`\<`string`[]\> + +Defined in: mesh/index.ts:358 + +Returns a list of unused addresses controlled by the wallet. + +#### Returns + +`Promise`\<`string`[]\> + +a list of unused addresses + +#### Implementation of + +`IWallet.getUnusedAddresses` + +*** + +### getUsedAddress() + +> **getUsedAddress**(`addressType`): `Address` + +Defined in: mesh/index.ts:511 + +Get a used address of type Address from the wallet. + +This is used in transaction building. + +#### Parameters + +##### addressType + +`GetAddressType` = `"payment"` + +the type of address to fetch UTXOs from (default: payment) + +#### Returns + +`Address` + +an Address object + +*** + +### getUsedAddresses() + +> **getUsedAddresses**(): `Promise`\<`string`[]\> + +Defined in: mesh/index.ts:367 + +Returns a list of used addresses controlled by the wallet. + +#### Returns + +`Promise`\<`string`[]\> + +a list of used addresses + +#### Implementation of + +`IWallet.getUsedAddresses` + +*** + +### getUsedUTxOs() + +> **getUsedUTxOs**(`addressType`): `Promise`\<`TransactionUnspentOutput`[]\> + +Defined in: mesh/index.ts:379 + +Get a list of UTXOs to be used for transaction building. + +This is used in transaction building. + +#### Parameters + +##### addressType + +`GetAddressType` = `"payment"` + +the type of address to fetch UTXOs from (default: payment) + +#### Returns + +`Promise`\<`TransactionUnspentOutput`[]\> + +a list of UTXOs + +*** + +### getUtxos() + +> **getUtxos**(`addressType`): `Promise`\<`UTxO`[]\> + +Defined in: mesh/index.ts:392 + +Return a list of all UTXOs (unspent transaction outputs) controlled by the wallet. + +#### Parameters + +##### addressType + +`GetAddressType` = `"payment"` + +the type of address to fetch UTXOs from (default: payment) + +#### Returns + +`Promise`\<`UTxO`[]\> + +a list of UTXOs + +#### Implementation of + +`IWallet.getUtxos` + +*** + +### init() + +> **init**(): `Promise`\<`void`\> + +Defined in: mesh/index.ts:174 + +Initializes the wallet. This is a required call as fetching addresses from the wallet is an async operation. + +#### Returns + +`Promise`\<`void`\> + +void + +*** + +### signData() + +> **signData**(`payload`, `address?`): `Promise`\<`DataSignature`\> + +Defined in: mesh/index.ts:404 + +This endpoint utilizes the [CIP-8 - Message Signing](https://cips.cardano.org/cips/cip8/) to sign arbitrary data, to verify the data was signed by the owner of the private key. + +#### Parameters + +##### payload + +`string` + +the payload to sign + +##### address? + +`string` + +the address to use for signing (optional) + +#### Returns + +`Promise`\<`DataSignature`\> + +a signature + +#### Implementation of + +`IWallet.signData` + +*** + +### signTx() + +> **signTx**(`unsignedTx`, `partialSign`): `Promise`\<`string`\> + +Defined in: mesh/index.ts:430 + +Requests user to sign the provided transaction (tx). The wallet should ask the user for permission, and if given, try to sign the supplied body and return a signed transaction. partialSign should be true if the transaction provided requires multiple signatures. + +#### Parameters + +##### unsignedTx + +`string` + +a transaction in CBOR + +##### partialSign + +`boolean` = `false` + +if the transaction is partially signed (default: false) + +#### Returns + +`Promise`\<`string`\> + +a signed transaction in CBOR + +#### Implementation of + +`IWallet.signTx` + +*** + +### signTxs() + +> **signTxs**(`unsignedTxs`, `partialSign`): `Promise`\<`string`[]\> + +Defined in: mesh/index.ts:467 + +Experimental feature - sign multiple transactions at once. + +#### Parameters + +##### unsignedTxs + +`string`[] + +array of unsigned transactions in CborHex string + +##### partialSign + +`boolean` = `false` + +if the transactions are signed partially + +#### Returns + +`Promise`\<`string`[]\> + +array of signed transactions CborHex string + +#### Implementation of + +`IWallet.signTxs` + +*** + +### submitTx() + +> **submitTx**(`tx`): `Promise`\<`string`\> + +Defined in: mesh/index.ts:494 + +Submits the signed transaction to the blockchain network. + +As wallets should already have this ability to submit transaction, we allow apps to request that a transaction be sent through it. If the wallet accepts the transaction and tries to send it, it shall return the transaction ID for the app to track. The wallet can return error messages or failure if there was an error in sending it. + +#### Parameters + +##### tx + +`string` + +a signed transaction in CBOR + +#### Returns + +`Promise`\<`string`\> + +a transaction hash + +#### Implementation of + +`IWallet.submitTx` + +*** + +### brew() + +> `static` **brew**(`privateKey`, `strength`): `string` \| `string`[] + +Defined in: mesh/index.ts:660 + +Generate mnemonic or private key + +#### Parameters + +##### privateKey + +`boolean` = `false` + +return private key if true + +##### strength + +`number` = `256` + +#### Returns + +`string` \| `string`[] + +a transaction hash diff --git a/docs/markdown/mesh-wallets/classes/WalletStaticMethods.md b/docs/markdown/mesh-wallets/classes/WalletStaticMethods.md new file mode 100644 index 000000000..9048e97fa --- /dev/null +++ b/docs/markdown/mesh-wallets/classes/WalletStaticMethods.md @@ -0,0 +1,215 @@ +[**@meshsdk/wallet**](../README.md) + +*** + +[@meshsdk/wallet](../globals.md) / WalletStaticMethods + +# Class: WalletStaticMethods + +Defined in: embedded/index.ts:81 + +## Extended by + +- [`EmbeddedWallet`](EmbeddedWallet.md) + +## Constructors + +### Constructor + +> **new WalletStaticMethods**(): `WalletStaticMethods` + +#### Returns + +`WalletStaticMethods` + +## Methods + +### addWitnessSets() + +> `static` **addWitnessSets**(`txHex`, `witnesses`): `string` + +Defined in: embedded/index.ts:182 + +#### Parameters + +##### txHex + +`string` + +##### witnesses + +`VkeyWitness`[] + +#### Returns + +`string` + +*** + +### bip32BytesToPrivateKeyHex() + +> `static` **bip32BytesToPrivateKeyHex**(`bip32Bytes`): `string` + +Defined in: embedded/index.ts:104 + +#### Parameters + +##### bip32Bytes + +`Uint8Array` + +#### Returns + +`string` + +*** + +### generateMnemonic() + +> `static` **generateMnemonic**(`strength`): `string`[] + +Defined in: embedded/index.ts:177 + +#### Parameters + +##### strength + +`number` = `256` + +#### Returns + +`string`[] + +*** + +### getAddresses() + +> `static` **getAddresses**(`paymentKey`, `stakingKey`, `networkId`): `object` + +Defined in: embedded/index.ts:109 + +#### Parameters + +##### paymentKey + +`Ed25519PrivateKey` + +##### stakingKey + +`Ed25519PrivateKey` + +##### networkId + +`number` = `0` + +#### Returns + +`object` + +##### baseAddress + +> **baseAddress**: `Address` + +##### enterpriseAddress + +> **enterpriseAddress**: `Address` + +##### rewardAddress + +> **rewardAddress**: `Address` + +*** + +### getDRepKey() + +> `static` **getDRepKey**(`dRepKey`, `networkId`): `object` + +Defined in: embedded/index.ts:149 + +#### Parameters + +##### dRepKey + +`Ed25519PrivateKey` + +##### networkId + +`number` = `0` + +#### Returns + +`object` + +##### dRepIDBech32 + +> **dRepIDBech32**: `DRepID` + +##### dRepIDCip105 + +> **dRepIDCip105**: `string` + +##### dRepIDHash + +> **dRepIDHash**: `Ed25519KeyHashHex` + +##### pubDRepKey + +> **pubDRepKey**: `string` + +*** + +### mnemonicToPrivateKeyHex() + +> `static` **mnemonicToPrivateKeyHex**(`words`): `string` + +Defined in: embedded/index.ts:88 + +#### Parameters + +##### words + +`string`[] + +#### Returns + +`string` + +*** + +### privateKeyBech32ToPrivateKeyHex() + +> `static` **privateKeyBech32ToPrivateKeyHex**(`_bech32`): `string` + +Defined in: embedded/index.ts:82 + +#### Parameters + +##### \_bech32 + +`string` + +#### Returns + +`string` + +*** + +### signingKeyToHexes() + +> `static` **signingKeyToHexes**(`paymentKey`, `stakeKey`): \[`string`, `string`\] + +Defined in: embedded/index.ts:94 + +#### Parameters + +##### paymentKey + +`string` + +##### stakeKey + +`string` + +#### Returns + +\[`string`, `string`\] diff --git a/docs/markdown/mesh-wallets/functions/connect.md b/docs/markdown/mesh-wallets/functions/connect.md new file mode 100644 index 000000000..03b8541fd --- /dev/null +++ b/docs/markdown/mesh-wallets/functions/connect.md @@ -0,0 +1,31 @@ +[**@meshsdk/wallet**](../README.md) + +*** + +[@meshsdk/wallet](../globals.md) / connect + +# Function: connect() + +> **connect**(`__namedParameters`): `Promise`\<\{ `error?`: `undefined`; `success`: `boolean`; `wallet`: \{ `bech32PrivateKey`: `string`; \}; \} \| \{ `error`: `any`; `success`: `boolean`; `wallet?`: `undefined`; \}\> + +Defined in: browser/webauthn/auth/connect.ts:6 + +## Parameters + +### \_\_namedParameters + +#### password + +`string` + +#### serverUrl + +`string` + +#### username + +`string` + +## Returns + +`Promise`\<\{ `error?`: `undefined`; `success`: `boolean`; `wallet`: \{ `bech32PrivateKey`: `string`; \}; \} \| \{ `error`: `any`; `success`: `boolean`; `wallet?`: `undefined`; \}\> diff --git a/docs/markdown/mesh-wallets/functions/login.md b/docs/markdown/mesh-wallets/functions/login.md new file mode 100644 index 000000000..4c148815b --- /dev/null +++ b/docs/markdown/mesh-wallets/functions/login.md @@ -0,0 +1,27 @@ +[**@meshsdk/wallet**](../README.md) + +*** + +[@meshsdk/wallet](../globals.md) / login + +# Function: login() + +> **login**(`__namedParameters`): `Promise`\<\{ `authJSON?`: `undefined`; `error`: `any`; `errorCode`: `any`; `success`: `boolean`; \} \| \{ `authJSON?`: `undefined`; `error`: `any`; `errorCode?`: `undefined`; `success`: `boolean`; \} \| \{ `authJSON`: `AuthenticationResponseJSON`; `error?`: `undefined`; `errorCode?`: `undefined`; `success`: `boolean`; \}\> + +Defined in: browser/webauthn/auth/login.ts:3 + +## Parameters + +### \_\_namedParameters + +#### serverUrl + +`string` + +#### username + +`string` + +## Returns + +`Promise`\<\{ `authJSON?`: `undefined`; `error`: `any`; `errorCode`: `any`; `success`: `boolean`; \} \| \{ `authJSON?`: `undefined`; `error`: `any`; `errorCode?`: `undefined`; `success`: `boolean`; \} \| \{ `authJSON`: `AuthenticationResponseJSON`; `error?`: `undefined`; `errorCode?`: `undefined`; `success`: `boolean`; \}\> diff --git a/docs/markdown/mesh-wallets/functions/register.md b/docs/markdown/mesh-wallets/functions/register.md new file mode 100644 index 000000000..bb1723be4 --- /dev/null +++ b/docs/markdown/mesh-wallets/functions/register.md @@ -0,0 +1,27 @@ +[**@meshsdk/wallet**](../README.md) + +*** + +[@meshsdk/wallet](../globals.md) / register + +# Function: register() + +> **register**(`__namedParameters`): `Promise`\<\{ `error`: `any`; `errorCode`: `any`; `success`: `boolean`; \} \| \{ `error?`: `undefined`; `errorCode?`: `undefined`; `success`: `boolean`; \}\> + +Defined in: browser/webauthn/auth/register.ts:3 + +## Parameters + +### \_\_namedParameters + +#### serverUrl + +`string` + +#### username + +`string` + +## Returns + +`Promise`\<\{ `error`: `any`; `errorCode`: `any`; `success`: `boolean`; \} \| \{ `error?`: `undefined`; `errorCode?`: `undefined`; `success`: `boolean`; \}\> diff --git a/docs/markdown/mesh-wallets/globals.md b/docs/markdown/mesh-wallets/globals.md new file mode 100644 index 000000000..4a0da433f --- /dev/null +++ b/docs/markdown/mesh-wallets/globals.md @@ -0,0 +1,29 @@ +[**@meshsdk/wallet**](README.md) + +*** + +# @meshsdk/wallet + +## Classes + +- [AppWallet](classes/AppWallet.md) +- [BrowserWallet](classes/BrowserWallet.md) +- [EmbeddedWallet](classes/EmbeddedWallet.md) +- [MeshWallet](classes/MeshWallet.md) +- [WalletStaticMethods](classes/WalletStaticMethods.md) + +## Type Aliases + +- [Account](type-aliases/Account.md) +- [AccountType](type-aliases/AccountType.md) +- [AppWalletKeyType](type-aliases/AppWalletKeyType.md) +- [CreateAppWalletOptions](type-aliases/CreateAppWalletOptions.md) +- [CreateEmbeddedWalletOptions](type-aliases/CreateEmbeddedWalletOptions.md) +- [CreateMeshWalletOptions](type-aliases/CreateMeshWalletOptions.md) +- [EmbeddedWalletKeyType](type-aliases/EmbeddedWalletKeyType.md) + +## Functions + +- [connect](functions/connect.md) +- [login](functions/login.md) +- [register](functions/register.md) diff --git a/docs/markdown/mesh-wallets/type-aliases/Account.md b/docs/markdown/mesh-wallets/type-aliases/Account.md new file mode 100644 index 000000000..eaa65110b --- /dev/null +++ b/docs/markdown/mesh-wallets/type-aliases/Account.md @@ -0,0 +1,131 @@ +[**@meshsdk/wallet**](../README.md) + +*** + +[@meshsdk/wallet](../globals.md) / Account + +# Type Alias: Account + +> **Account** = `object` + +Defined in: embedded/index.ts:38 + +## Properties + +### baseAddress + +> **baseAddress**: `Address` + +Defined in: embedded/index.ts:39 + +*** + +### baseAddressBech32 + +> **baseAddressBech32**: `string` + +Defined in: embedded/index.ts:42 + +*** + +### dRepIDBech32? + +> `optional` **dRepIDBech32**: `DRepID` + +Defined in: embedded/index.ts:52 + +*** + +### dRepIDCip105? + +> `optional` **dRepIDCip105**: `string` + +Defined in: embedded/index.ts:54 + +*** + +### dRepIDHash? + +> `optional` **dRepIDHash**: `Ed25519KeyHashHex` + +Defined in: embedded/index.ts:53 + +*** + +### drepKey? + +> `optional` **drepKey**: `Ed25519PrivateKey` + +Defined in: embedded/index.ts:50 + +*** + +### enterpriseAddress + +> **enterpriseAddress**: `Address` + +Defined in: embedded/index.ts:40 + +*** + +### enterpriseAddressBech32 + +> **enterpriseAddressBech32**: `string` + +Defined in: embedded/index.ts:43 + +*** + +### paymentKey + +> **paymentKey**: `Ed25519PrivateKey` + +Defined in: embedded/index.ts:45 + +*** + +### paymentKeyHex + +> **paymentKeyHex**: `string` + +Defined in: embedded/index.ts:47 + +*** + +### pubDRepKey? + +> `optional` **pubDRepKey**: `string` + +Defined in: embedded/index.ts:51 + +*** + +### rewardAddress + +> **rewardAddress**: `Address` + +Defined in: embedded/index.ts:41 + +*** + +### rewardAddressBech32 + +> **rewardAddressBech32**: `string` + +Defined in: embedded/index.ts:44 + +*** + +### stakeKey + +> **stakeKey**: `Ed25519PrivateKey` + +Defined in: embedded/index.ts:46 + +*** + +### stakeKeyHex + +> **stakeKeyHex**: `string` + +Defined in: embedded/index.ts:48 diff --git a/docs/markdown/mesh-wallets/type-aliases/AccountType.md b/docs/markdown/mesh-wallets/type-aliases/AccountType.md new file mode 100644 index 000000000..cacdf0dad --- /dev/null +++ b/docs/markdown/mesh-wallets/type-aliases/AccountType.md @@ -0,0 +1,11 @@ +[**@meshsdk/wallet**](../README.md) + +*** + +[@meshsdk/wallet](../globals.md) / AccountType + +# Type Alias: AccountType + +> **AccountType** = `"payment"` \| `"stake"` \| `"drep"` + +Defined in: embedded/index.ts:36 diff --git a/docs/markdown/mesh-wallets/type-aliases/AppWalletKeyType.md b/docs/markdown/mesh-wallets/type-aliases/AppWalletKeyType.md new file mode 100644 index 000000000..13166e7dc --- /dev/null +++ b/docs/markdown/mesh-wallets/type-aliases/AppWalletKeyType.md @@ -0,0 +1,11 @@ +[**@meshsdk/wallet**](../README.md) + +*** + +[@meshsdk/wallet](../globals.md) / AppWalletKeyType + +# Type Alias: AppWalletKeyType + +> **AppWalletKeyType** = \{ `bech32`: `string`; `type`: `"root"`; \} \| \{ `payment`: `string`; `stake?`: `string`; `type`: `"cli"`; \} \| \{ `type`: `"mnemonic"`; `words`: `string`[]; \} + +Defined in: app/index.ts:13 diff --git a/docs/markdown/mesh-wallets/type-aliases/CreateAppWalletOptions.md b/docs/markdown/mesh-wallets/type-aliases/CreateAppWalletOptions.md new file mode 100644 index 000000000..ec62802dc --- /dev/null +++ b/docs/markdown/mesh-wallets/type-aliases/CreateAppWalletOptions.md @@ -0,0 +1,43 @@ +[**@meshsdk/wallet**](../README.md) + +*** + +[@meshsdk/wallet](../globals.md) / CreateAppWalletOptions + +# Type Alias: CreateAppWalletOptions + +> **CreateAppWalletOptions** = `object` + +Defined in: app/index.ts:28 + +## Properties + +### fetcher? + +> `optional` **fetcher**: `IFetcher` + +Defined in: app/index.ts:30 + +*** + +### key + +> **key**: [`AppWalletKeyType`](AppWalletKeyType.md) + +Defined in: app/index.ts:32 + +*** + +### networkId + +> **networkId**: `number` + +Defined in: app/index.ts:29 + +*** + +### submitter? + +> `optional` **submitter**: `ISubmitter` + +Defined in: app/index.ts:31 diff --git a/docs/markdown/mesh-wallets/type-aliases/CreateEmbeddedWalletOptions.md b/docs/markdown/mesh-wallets/type-aliases/CreateEmbeddedWalletOptions.md new file mode 100644 index 000000000..5982d1a94 --- /dev/null +++ b/docs/markdown/mesh-wallets/type-aliases/CreateEmbeddedWalletOptions.md @@ -0,0 +1,27 @@ +[**@meshsdk/wallet**](../README.md) + +*** + +[@meshsdk/wallet](../globals.md) / CreateEmbeddedWalletOptions + +# Type Alias: CreateEmbeddedWalletOptions + +> **CreateEmbeddedWalletOptions** = `object` + +Defined in: embedded/index.ts:76 + +## Properties + +### key + +> **key**: [`EmbeddedWalletKeyType`](EmbeddedWalletKeyType.md) + +Defined in: embedded/index.ts:78 + +*** + +### networkId + +> **networkId**: `number` + +Defined in: embedded/index.ts:77 diff --git a/docs/markdown/mesh-wallets/type-aliases/CreateMeshWalletOptions.md b/docs/markdown/mesh-wallets/type-aliases/CreateMeshWalletOptions.md new file mode 100644 index 000000000..e2fecd7e9 --- /dev/null +++ b/docs/markdown/mesh-wallets/type-aliases/CreateMeshWalletOptions.md @@ -0,0 +1,67 @@ +[**@meshsdk/wallet**](../README.md) + +*** + +[@meshsdk/wallet](../globals.md) / CreateMeshWalletOptions + +# Type Alias: CreateMeshWalletOptions + +> **CreateMeshWalletOptions** = `object` + +Defined in: mesh/index.ts:35 + +## Properties + +### accountIndex? + +> `optional` **accountIndex**: `number` + +Defined in: mesh/index.ts:61 + +*** + +### accountType? + +> `optional` **accountType**: [`AccountType`](AccountType.md) + +Defined in: mesh/index.ts:63 + +*** + +### fetcher? + +> `optional` **fetcher**: `IFetcher` + +Defined in: mesh/index.ts:37 + +*** + +### key + +> **key**: \{ `bech32`: `string`; `type`: `"root"`; \} \| \{ `payment`: `string`; `stake?`: `string`; `type`: `"cli"`; \} \| \{ `type`: `"mnemonic"`; `words`: `string`[]; \} \| \{ `bip32Bytes`: `Uint8Array`; `type`: `"bip32Bytes"`; \} \| \{ `address`: `string`; `type`: `"address"`; \} + +Defined in: mesh/index.ts:39 + +*** + +### keyIndex? + +> `optional` **keyIndex**: `number` + +Defined in: mesh/index.ts:62 + +*** + +### networkId + +> **networkId**: `0` \| `1` + +Defined in: mesh/index.ts:36 + +*** + +### submitter? + +> `optional` **submitter**: `ISubmitter` + +Defined in: mesh/index.ts:38 diff --git a/docs/markdown/mesh-wallets/type-aliases/EmbeddedWalletKeyType.md b/docs/markdown/mesh-wallets/type-aliases/EmbeddedWalletKeyType.md new file mode 100644 index 000000000..0f42f6d80 --- /dev/null +++ b/docs/markdown/mesh-wallets/type-aliases/EmbeddedWalletKeyType.md @@ -0,0 +1,11 @@ +[**@meshsdk/wallet**](../README.md) + +*** + +[@meshsdk/wallet](../globals.md) / EmbeddedWalletKeyType + +# Type Alias: EmbeddedWalletKeyType + +> **EmbeddedWalletKeyType** = \{ `bech32`: `string`; `type`: `"root"`; \} \| \{ `payment`: `string`; `stake?`: `string`; `type`: `"cli"`; \} \| \{ `type`: `"mnemonic"`; `words`: `string`[]; \} \| \{ `bip32Bytes`: `Uint8Array`; `type`: `"bip32Bytes"`; \} + +Defined in: embedded/index.ts:57 diff --git a/package-lock.json b/package-lock.json index ddba2daab..77dade866 100644 --- a/package-lock.json +++ b/package-lock.json @@ -22,7 +22,9 @@ "patch-package": "^8.0.0", "prettier": "^3.2.5", "ts-node": "^10.9.2", - "turbo": "latest" + "turbo": "latest", + "typedoc": "^0.28.7", + "typedoc-plugin-markdown": "^4.7.0" }, "engines": { "node": ">=18" @@ -14385,6 +14387,20 @@ "resolved": "https://registry.npmjs.org/@foxglove/crc/-/crc-0.0.3.tgz", "integrity": "sha512-DjIZsnL3CyP/yQ/vUYA9cjrD0a/8YXejI5ZmsaOiT16cLfZcTwaCxIN01/ys4jsy+dZCQ/9DnWFn7AEFbiMDaA==" }, + "node_modules/@gerrit0/mini-shiki": { + "version": "3.7.0", + "resolved": "https://registry.npmjs.org/@gerrit0/mini-shiki/-/mini-shiki-3.7.0.tgz", + "integrity": "sha512-7iY9wg4FWXmeoFJpUL2u+tsmh0d0jcEJHAIzVxl3TG4KL493JNnisdLAILZ77zcD+z3J0keEXZ+lFzUgzQzPDg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@shikijs/engine-oniguruma": "^3.7.0", + "@shikijs/langs": "^3.7.0", + "@shikijs/themes": "^3.7.0", + "@shikijs/types": "^3.7.0", + "@shikijs/vscode-textmate": "^10.0.2" + } + }, "node_modules/@harmoniclabs/bigint-utils": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/@harmoniclabs/bigint-utils/-/bigint-utils-1.0.0.tgz", @@ -17151,66 +17167,45 @@ "resolved": "https://registry.npmjs.org/@sec-ant/readable-stream/-/readable-stream-0.4.1.tgz", "integrity": "sha512-831qok9r2t8AlxLko40y2ebgSDhenenCatLVeW/uBtnHPyhHOvG0C7TvfgecV+wHzIm5KUICgzmVpWS+IMEAeg==" }, - "node_modules/@shikijs/core": { - "version": "1.29.2", - "resolved": "https://registry.npmjs.org/@shikijs/core/-/core-1.29.2.tgz", - "integrity": "sha512-vju0lY9r27jJfOY4Z7+Rt/nIOjzJpZ3y+nYpqtUZInVoXQ/TJZcfGnNOGnKjFdVZb8qexiCuSlZRKcGfhhTTZQ==", - "dev": true, - "dependencies": { - "@shikijs/engine-javascript": "1.29.2", - "@shikijs/engine-oniguruma": "1.29.2", - "@shikijs/types": "1.29.2", - "@shikijs/vscode-textmate": "^10.0.1", - "@types/hast": "^3.0.4", - "hast-util-to-html": "^9.0.4" - } - }, - "node_modules/@shikijs/engine-javascript": { - "version": "1.29.2", - "resolved": "https://registry.npmjs.org/@shikijs/engine-javascript/-/engine-javascript-1.29.2.tgz", - "integrity": "sha512-iNEZv4IrLYPv64Q6k7EPpOCE/nuvGiKl7zxdq0WFuRPF5PAE9PRo2JGq/d8crLusM59BRemJ4eOqrFrC4wiQ+A==", - "dev": true, - "dependencies": { - "@shikijs/types": "1.29.2", - "@shikijs/vscode-textmate": "^10.0.1", - "oniguruma-to-es": "^2.2.0" - } - }, "node_modules/@shikijs/engine-oniguruma": { - "version": "1.29.2", - "resolved": "https://registry.npmjs.org/@shikijs/engine-oniguruma/-/engine-oniguruma-1.29.2.tgz", - "integrity": "sha512-7iiOx3SG8+g1MnlzZVDYiaeHe7Ez2Kf2HrJzdmGwkRisT7r4rak0e655AcM/tF9JG/kg5fMNYlLLKglbN7gBqA==", + "version": "3.7.0", + "resolved": "https://registry.npmjs.org/@shikijs/engine-oniguruma/-/engine-oniguruma-3.7.0.tgz", + "integrity": "sha512-5BxcD6LjVWsGu4xyaBC5bu8LdNgPCVBnAkWTtOCs/CZxcB22L8rcoWfv7Hh/3WooVjBZmFtyxhgvkQFedPGnFw==", "dev": true, + "license": "MIT", "dependencies": { - "@shikijs/types": "1.29.2", - "@shikijs/vscode-textmate": "^10.0.1" + "@shikijs/types": "3.7.0", + "@shikijs/vscode-textmate": "^10.0.2" } }, "node_modules/@shikijs/langs": { - "version": "1.29.2", - "resolved": "https://registry.npmjs.org/@shikijs/langs/-/langs-1.29.2.tgz", - "integrity": "sha512-FIBA7N3LZ+223U7cJDUYd5shmciFQlYkFXlkKVaHsCPgfVLiO+e12FmQE6Tf9vuyEsFe3dIl8qGWKXgEHL9wmQ==", + "version": "3.7.0", + "resolved": "https://registry.npmjs.org/@shikijs/langs/-/langs-3.7.0.tgz", + "integrity": "sha512-1zYtdfXLr9xDKLTGy5kb7O0zDQsxXiIsw1iIBcNOO8Yi5/Y1qDbJ+0VsFoqTlzdmneO8Ij35g7QKF8kcLyznCQ==", "dev": true, + "license": "MIT", "dependencies": { - "@shikijs/types": "1.29.2" + "@shikijs/types": "3.7.0" } }, "node_modules/@shikijs/themes": { - "version": "1.29.2", - "resolved": "https://registry.npmjs.org/@shikijs/themes/-/themes-1.29.2.tgz", - "integrity": "sha512-i9TNZlsq4uoyqSbluIcZkmPL9Bfi3djVxRnofUHwvx/h6SRW3cwgBC5SML7vsDcWyukY0eCzVN980rqP6qNl9g==", + "version": "3.7.0", + "resolved": "https://registry.npmjs.org/@shikijs/themes/-/themes-3.7.0.tgz", + "integrity": "sha512-VJx8497iZPy5zLiiCTSIaOChIcKQwR0FebwE9S3rcN0+J/GTWwQ1v/bqhTbpbY3zybPKeO8wdammqkpXc4NVjQ==", "dev": true, + "license": "MIT", "dependencies": { - "@shikijs/types": "1.29.2" + "@shikijs/types": "3.7.0" } }, "node_modules/@shikijs/types": { - "version": "1.29.2", - "resolved": "https://registry.npmjs.org/@shikijs/types/-/types-1.29.2.tgz", - "integrity": "sha512-VJjK0eIijTZf0QSTODEXCqinjBn0joAHQ+aPSBzrv4O2d/QSbsMw+ZeSRx03kV34Hy7NzUvV/7NqfYGRLrASmw==", + "version": "3.7.0", + "resolved": "https://registry.npmjs.org/@shikijs/types/-/types-3.7.0.tgz", + "integrity": "sha512-MGaLeaRlSWpnP0XSAum3kP3a8vtcTsITqoEPYdt3lQG3YCdQH4DnEhodkYcNMcU0uW0RffhoD1O3e0vG5eSBBg==", "dev": true, + "license": "MIT", "dependencies": { - "@shikijs/vscode-textmate": "^10.0.1", + "@shikijs/vscode-textmate": "^10.0.2", "@types/hast": "^3.0.4" } }, @@ -17218,7 +17213,8 @@ "version": "10.0.2", "resolved": "https://registry.npmjs.org/@shikijs/vscode-textmate/-/vscode-textmate-10.0.2.tgz", "integrity": "sha512-83yeghZ2xxin3Nj8z1NMd/NCuca+gsYXswywDy5bHvwlWL8tpTQmzGeUuHd9FC3E/SBEMvzJRwWEOz5gGes9Qg==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/@shuding/opentype.js": { "version": "1.4.0-beta.0", @@ -22033,12 +22029,6 @@ "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-10.4.0.tgz", "integrity": "sha512-EC+0oUMY1Rqm4O6LLrgjtYDvcVYTy7chDnM4Q7030tP4Kwj3u/pR6gP9ygnp2CJMK5Gq+9Q2oqmrFJAz01DXjw==" }, - "node_modules/emoji-regex-xs": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/emoji-regex-xs/-/emoji-regex-xs-1.0.0.tgz", - "integrity": "sha512-LRlerrMYoIDrT6jgpeZ2YYl/L8EulRTt5hQcYjy5AInh7HWXKimpqx68aknBFpGL2+/IcogTcaydJEgaTmOpDg==", - "dev": true - }, "node_modules/emojis-list": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/emojis-list/-/emojis-list-3.0.0.tgz", @@ -22073,6 +22063,7 @@ "resolved": "https://registry.npmjs.org/entities/-/entities-4.5.0.tgz", "integrity": "sha512-V0hjH4dGPh9Ao5p0MoRY6BVqtwCjhz6vI5LT8AJ55H+4g9/4vbHx1I54fS0XuclLhDHArPQCiMjDxjaL8fPxhw==", "dev": true, + "license": "BSD-2-Clause", "engines": { "node": ">=0.12" }, @@ -24571,29 +24562,6 @@ "url": "https://opencollective.com/unified" } }, - "node_modules/hast-util-to-html": { - "version": "9.0.5", - "resolved": "https://registry.npmjs.org/hast-util-to-html/-/hast-util-to-html-9.0.5.tgz", - "integrity": "sha512-OguPdidb+fbHQSU4Q4ZiLKnzWo8Wwsf5bZfbvu7//a9oTYoqD/fWpe96NuHkoS9h0ccGOTe0C4NGXdtS0iObOw==", - "dev": true, - "dependencies": { - "@types/hast": "^3.0.0", - "@types/unist": "^3.0.0", - "ccount": "^2.0.0", - "comma-separated-tokens": "^2.0.0", - "hast-util-whitespace": "^3.0.0", - "html-void-elements": "^3.0.0", - "mdast-util-to-hast": "^13.0.0", - "property-information": "^7.0.0", - "space-separated-tokens": "^2.0.0", - "stringify-entities": "^4.0.0", - "zwitch": "^2.0.4" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, "node_modules/hast-util-to-jsx-runtime": { "version": "2.3.6", "resolved": "https://registry.npmjs.org/hast-util-to-jsx-runtime/-/hast-util-to-jsx-runtime-2.3.6.tgz", @@ -24688,16 +24656,6 @@ "url": "https://opencollective.com/unified" } }, - "node_modules/html-void-elements": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/html-void-elements/-/html-void-elements-3.0.0.tgz", - "integrity": "sha512-bEqo66MRXsUGxWHV5IP0PUiAWwoEjba4VCzg0LjFJBpchPaTfyfCKTG6bc5F8ucKec3q5y6qOdGyYTSBEvhCrg==", - "dev": true, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/wooorm" - } - }, "node_modules/http-cache-semantics": { "version": "4.2.0", "resolved": "https://registry.npmjs.org/http-cache-semantics/-/http-cache-semantics-4.2.0.tgz", @@ -26638,6 +26596,7 @@ "resolved": "https://registry.npmjs.org/linkify-it/-/linkify-it-5.0.0.tgz", "integrity": "sha512-5aHCbzQRADcdP+ATqnDuhhJ/MRIqDkZX5pyjFHRRysS8vZ5AbqGEoFIb6pYHPZ+L/OC2Lc+xT8uHVVR5CAK/wQ==", "dev": true, + "license": "MIT", "dependencies": { "uc.micro": "^2.0.0" } @@ -26839,7 +26798,8 @@ "version": "2.3.9", "resolved": "https://registry.npmjs.org/lunr/-/lunr-2.3.9.tgz", "integrity": "sha512-zTU3DaZaF3Rt9rhN3uBMGQD3dD2/vFQqnvZCDv4dl5iOzq2IZQqTxu90r4E5J+nP70J3ilqVCrbho2eWaeW8Ow==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/magic-string": { "version": "0.30.17", @@ -26934,6 +26894,7 @@ "resolved": "https://registry.npmjs.org/markdown-it/-/markdown-it-14.1.0.tgz", "integrity": "sha512-a54IwgWPaeBCAAsv13YgmALOF1elABB08FxO9i+r4VFk5Vl4pKokRPeX8u5TCgSsPi6ec1otfLjdOpVcgbpshg==", "dev": true, + "license": "MIT", "dependencies": { "argparse": "^2.0.1", "entities": "^4.4.0", @@ -27129,7 +27090,8 @@ "version": "2.0.0", "resolved": "https://registry.npmjs.org/mdurl/-/mdurl-2.0.0.tgz", "integrity": "sha512-Lf+9+2r+Tdp5wXDXC4PcIBjTDtq4UKjCPMQhKIuzpJNW0b96kVqSwW0bT7FhRSfmAiFYgP+SCRvdrDozfh0U5w==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/memoize-one": { "version": "4.0.3", @@ -31138,17 +31100,6 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/oniguruma-to-es": { - "version": "2.3.0", - "resolved": "https://registry.npmjs.org/oniguruma-to-es/-/oniguruma-to-es-2.3.0.tgz", - "integrity": "sha512-bwALDxriqfKGfUufKGGepCzu9x7nJQuoRoAFp4AnwehhC2crqrDIAP/uN2qdlsAvSMpeRC3+Yzhqc7hLmle5+g==", - "dev": true, - "dependencies": { - "emoji-regex-xs": "^1.0.0", - "regex": "^5.1.1", - "regex-recursion": "^5.1.1" - } - }, "node_modules/open": { "version": "7.4.2", "resolved": "https://registry.npmjs.org/open/-/open-7.4.2.tgz", @@ -32285,6 +32236,7 @@ "resolved": "https://registry.npmjs.org/punycode.js/-/punycode.js-2.3.1.tgz", "integrity": "sha512-uxFIHU0YlHYhDQtV4R9J6a52SLx28BCjT+4ieh7IGbgwVJWO+km431c4yRlREUAsAmt/uMjQUyQHNEPf0M39CA==", "dev": true, + "license": "MIT", "engines": { "node": ">=6" } @@ -32885,31 +32837,6 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/regex": { - "version": "5.1.1", - "resolved": "https://registry.npmjs.org/regex/-/regex-5.1.1.tgz", - "integrity": "sha512-dN5I359AVGPnwzJm2jN1k0W9LPZ+ePvoOeVMMfqIMFz53sSwXkxaJoxr50ptnsC771lK95BnTrVSZxq0b9yCGw==", - "dev": true, - "dependencies": { - "regex-utilities": "^2.3.0" - } - }, - "node_modules/regex-recursion": { - "version": "5.1.1", - "resolved": "https://registry.npmjs.org/regex-recursion/-/regex-recursion-5.1.1.tgz", - "integrity": "sha512-ae7SBCbzVNrIjgSbh7wMznPcQel1DNlDtzensnFxpiNpXt1U2ju/bHugH422r+4LAVS1FpW1YCwilmnNsjum9w==", - "dev": true, - "dependencies": { - "regex": "^5.1.1", - "regex-utilities": "^2.3.0" - } - }, - "node_modules/regex-utilities": { - "version": "2.3.0", - "resolved": "https://registry.npmjs.org/regex-utilities/-/regex-utilities-2.3.0.tgz", - "integrity": "sha512-8VhliFJAWRaUiVvREIiW2NXXTmHs4vMNnSzuJVhscgmGav3g9VDxLrQndI3dZZVVdp0ZO/5v0xmX516/7M9cng==", - "dev": true - }, "node_modules/regexp-tree": { "version": "0.1.27", "resolved": "https://registry.npmjs.org/regexp-tree/-/regexp-tree-0.1.27.tgz", @@ -33546,22 +33473,6 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/shiki": { - "version": "1.29.2", - "resolved": "https://registry.npmjs.org/shiki/-/shiki-1.29.2.tgz", - "integrity": "sha512-njXuliz/cP+67jU2hukkxCNuH1yUi4QfdZZY+sMr5PPrIyXSu5iTb/qYC4BiWWB0vZ+7TbdvYUCeL23zpwCfbg==", - "dev": true, - "dependencies": { - "@shikijs/core": "1.29.2", - "@shikijs/engine-javascript": "1.29.2", - "@shikijs/engine-oniguruma": "1.29.2", - "@shikijs/langs": "1.29.2", - "@shikijs/themes": "1.29.2", - "@shikijs/types": "1.29.2", - "@shikijs/vscode-textmate": "^10.0.1", - "@types/hast": "^3.0.4" - } - }, "node_modules/side-channel": { "version": "1.1.0", "resolved": "https://registry.npmjs.org/side-channel/-/side-channel-1.1.0.tgz", @@ -35583,25 +35494,40 @@ } }, "node_modules/typedoc": { - "version": "0.26.11", - "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.26.11.tgz", - "integrity": "sha512-sFEgRRtrcDl2FxVP58Ze++ZK2UQAEvtvvH8rRlig1Ja3o7dDaMHmaBfvJmdGnNEFaLTpQsN8dpvZaTqJSu/Ugw==", + "version": "0.28.7", + "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.28.7.tgz", + "integrity": "sha512-lpz0Oxl6aidFkmS90VQDQjk/Qf2iw0IUvFqirdONBdj7jPSN9mGXhy66BcGNDxx5ZMyKKiBVAREvPEzT6Uxipw==", "dev": true, + "license": "Apache-2.0", "dependencies": { + "@gerrit0/mini-shiki": "^3.7.0", "lunr": "^2.3.9", "markdown-it": "^14.1.0", "minimatch": "^9.0.5", - "shiki": "^1.16.2", - "yaml": "^2.5.1" + "yaml": "^2.8.0" }, "bin": { "typedoc": "bin/typedoc" }, + "engines": { + "node": ">= 18", + "pnpm": ">= 10" + }, + "peerDependencies": { + "typescript": "5.0.x || 5.1.x || 5.2.x || 5.3.x || 5.4.x || 5.5.x || 5.6.x || 5.7.x || 5.8.x" + } + }, + "node_modules/typedoc-plugin-markdown": { + "version": "4.7.0", + "resolved": "https://registry.npmjs.org/typedoc-plugin-markdown/-/typedoc-plugin-markdown-4.7.0.tgz", + "integrity": "sha512-PitbnAps2vpcqK2gargKoiFXLWFttvwUbyns/E6zGIFG5Gz8ZQJGttHnYR9csOlcSjB/uyjd8tnoayrtsXG17w==", + "dev": true, + "license": "MIT", "engines": { "node": ">= 18" }, "peerDependencies": { - "typescript": "4.6.x || 4.7.x || 4.8.x || 4.9.x || 5.0.x || 5.1.x || 5.2.x || 5.3.x || 5.4.x || 5.5.x || 5.6.x" + "typedoc": "0.28.x" } }, "node_modules/typedoc/node_modules/brace-expansion": { @@ -35609,6 +35535,7 @@ "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.2.tgz", "integrity": "sha512-Jt0vHyM+jmUBqojB7E1NIYadt0vI0Qxjxd2TErW94wDz+E2LAm5vKMXXwg6ZZBTHPuUlDgQHKXvjGBdfcF1ZDQ==", "dev": true, + "license": "MIT", "dependencies": { "balanced-match": "^1.0.0" } @@ -35618,6 +35545,7 @@ "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.5.tgz", "integrity": "sha512-G6T0ZX48xgozx7587koeX9Ys2NYy6Gmv//P89sEte9V9whIapMNF4idKxnW2QtCcLiTWlb/wfCabAtAFWhhBow==", "dev": true, + "license": "ISC", "dependencies": { "brace-expansion": "^2.0.1" }, @@ -35649,7 +35577,8 @@ "version": "2.1.0", "resolved": "https://registry.npmjs.org/uc.micro/-/uc.micro-2.1.0.tgz", "integrity": "sha512-ARDJmphmdvUk6Glw7y9DQ2bFkKBHwQHLi2lsaH6PPmz/Ka9sFOBsBluozhDltWmnv9u/cF6Rt87znRTPV+yp/A==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/ufo": { "version": "1.6.1", @@ -37443,7 +37372,7 @@ }, "packages/bitcoin": { "name": "@meshsdk/bitcoin", - "version": "1.9.0-beta.60", + "version": "1.9.0-beta.62", "dependencies": { "@bitcoin-js/tiny-secp256k1-asmjs": "^2.2.3", "bip174": "^3.0.0-rc.1", @@ -37728,7 +37657,7 @@ }, "packages/mesh-common": { "name": "@meshsdk/common", - "version": "1.9.0-beta.60", + "version": "1.9.0-beta.62", "license": "Apache-2.0", "dependencies": { "bech32": "^2.0.0", @@ -37746,11 +37675,11 @@ }, "packages/mesh-contract": { "name": "@meshsdk/contract", - "version": "1.9.0-beta.60", + "version": "1.9.0-beta.62", "license": "Apache-2.0", "dependencies": { - "@meshsdk/common": "1.9.0-beta.60", - "@meshsdk/core": "1.9.0-beta.60" + "@meshsdk/common": "1.9.0-beta.62", + "@meshsdk/core": "1.9.0-beta.62" }, "devDependencies": { "@meshsdk/configs": "*", @@ -37761,15 +37690,15 @@ }, "packages/mesh-core": { "name": "@meshsdk/core", - "version": "1.9.0-beta.60", + "version": "1.9.0-beta.62", "license": "Apache-2.0", "dependencies": { - "@meshsdk/common": "1.9.0-beta.60", - "@meshsdk/core-cst": "1.9.0-beta.60", - "@meshsdk/provider": "1.9.0-beta.60", - "@meshsdk/react": "1.9.0-beta.60", - "@meshsdk/transaction": "1.9.0-beta.60", - "@meshsdk/wallet": "1.9.0-beta.60" + "@meshsdk/common": "1.9.0-beta.62", + "@meshsdk/core-cst": "1.9.0-beta.62", + "@meshsdk/provider": "1.9.0-beta.62", + "@meshsdk/react": "1.9.0-beta.62", + "@meshsdk/transaction": "1.9.0-beta.62", + "@meshsdk/wallet": "1.9.0-beta.62" }, "devDependencies": { "@meshsdk/configs": "*", @@ -37780,10 +37709,10 @@ }, "packages/mesh-core-csl": { "name": "@meshsdk/core-csl", - "version": "1.9.0-beta.60", + "version": "1.9.0-beta.62", "license": "Apache-2.0", "dependencies": { - "@meshsdk/common": "1.9.0-beta.60", + "@meshsdk/common": "1.9.0-beta.62", "@sidan-lab/whisky-js-browser": "^1.0.5", "@sidan-lab/whisky-js-nodejs": "^1.0.5", "@types/base32-encoding": "^1.0.2", @@ -37793,7 +37722,7 @@ }, "devDependencies": { "@meshsdk/configs": "*", - "@meshsdk/provider": "1.9.0-beta.60", + "@meshsdk/provider": "1.9.0-beta.62", "@types/json-bigint": "^1.0.4", "eslint": "^8.57.0", "ts-jest": "^29.1.4", @@ -37803,7 +37732,7 @@ }, "packages/mesh-core-cst": { "name": "@meshsdk/core-cst", - "version": "1.9.0-beta.60", + "version": "1.9.0-beta.62", "license": "Apache-2.0", "dependencies": { "@cardano-sdk/core": "^0.45.5", @@ -37814,7 +37743,7 @@ "@harmoniclabs/pair": "^1.0.0", "@harmoniclabs/plutus-data": "1.2.4", "@harmoniclabs/uplc": "1.2.4", - "@meshsdk/common": "1.9.0-beta.60", + "@meshsdk/common": "1.9.0-beta.62", "@types/base32-encoding": "^1.0.2", "base32-encoding": "^1.0.0", "bech32": "^2.0.0", @@ -37827,16 +37756,15 @@ "eslint": "^8.57.0", "ts-jest": "^29.1.4", "tsup": "^8.0.2", - "typedoc": "^0.26.3", "typescript": "^5.3.3" } }, "packages/mesh-hydra": { "name": "@meshsdk/hydra", - "version": "1.9.0-beta.60", + "version": "1.9.0-beta.62", "dependencies": { - "@meshsdk/common": "1.9.0-beta.60", - "@meshsdk/core-cst": "1.9.0-beta.60", + "@meshsdk/common": "1.9.0-beta.62", + "@meshsdk/core-cst": "1.9.0-beta.62", "axios": "^1.7.2" }, "devDependencies": { @@ -37898,11 +37826,11 @@ }, "packages/mesh-provider": { "name": "@meshsdk/provider", - "version": "1.9.0-beta.60", + "version": "1.9.0-beta.62", "license": "Apache-2.0", "dependencies": { - "@meshsdk/common": "1.9.0-beta.60", - "@meshsdk/core-cst": "1.9.0-beta.60", + "@meshsdk/common": "1.9.0-beta.62", + "@meshsdk/core-cst": "1.9.0-beta.62", "@utxorpc/sdk": "^0.6.7", "@utxorpc/spec": "^0.16.0", "axios": "^1.7.2" @@ -37917,14 +37845,14 @@ }, "packages/mesh-react": { "name": "@meshsdk/react", - "version": "1.9.0-beta.60", + "version": "1.9.0-beta.62", "license": "Apache-2.0", "dependencies": { "@fabianbormann/cardano-peer-connect": "^1.2.18", - "@meshsdk/bitcoin": "1.9.0-beta.60", - "@meshsdk/common": "1.9.0-beta.60", - "@meshsdk/transaction": "1.9.0-beta.60", - "@meshsdk/wallet": "1.9.0-beta.60", + "@meshsdk/bitcoin": "1.9.0-beta.62", + "@meshsdk/common": "1.9.0-beta.62", + "@meshsdk/transaction": "1.9.0-beta.62", + "@meshsdk/wallet": "1.9.0-beta.62", "@meshsdk/web3-sdk": "0.0.37", "@radix-ui/react-dialog": "^1.1.2", "@radix-ui/react-dropdown-menu": "^2.1.2", @@ -37961,10 +37889,10 @@ }, "packages/mesh-svelte": { "name": "@meshsdk/svelte", - "version": "1.9.0-beta.60", + "version": "1.9.0-beta.62", "license": "Apache-2.0", "dependencies": { - "@meshsdk/core": "1.9.0-beta.60", + "@meshsdk/core": "1.9.0-beta.62", "bits-ui": "1.0.0-next.65" }, "devDependencies": { @@ -37990,14 +37918,14 @@ }, "packages/mesh-transaction": { "name": "@meshsdk/transaction", - "version": "1.9.0-beta.60", + "version": "1.9.0-beta.62", "license": "Apache-2.0", "dependencies": { "@cardano-sdk/core": "^0.45.5", "@cardano-sdk/input-selection": "^0.13.33", "@cardano-sdk/util": "^0.15.5", - "@meshsdk/common": "1.9.0-beta.60", - "@meshsdk/core-cst": "1.9.0-beta.60", + "@meshsdk/common": "1.9.0-beta.62", + "@meshsdk/core-cst": "1.9.0-beta.62", "json-bigint": "^1.0.0" }, "devDependencies": { @@ -38010,25 +37938,24 @@ }, "packages/mesh-wallet": { "name": "@meshsdk/wallet", - "version": "1.9.0-beta.60", + "version": "1.9.0-beta.62", "license": "Apache-2.0", "dependencies": { - "@meshsdk/common": "1.9.0-beta.60", - "@meshsdk/core-cst": "1.9.0-beta.60", - "@meshsdk/transaction": "1.9.0-beta.60", + "@meshsdk/common": "1.9.0-beta.62", + "@meshsdk/core-cst": "1.9.0-beta.62", + "@meshsdk/transaction": "1.9.0-beta.62", "@simplewebauthn/browser": "^13.0.0" }, "devDependencies": { "@meshsdk/configs": "*", "eslint": "^8.57.0", "tsup": "^8.0.2", - "typedoc": "^0.26.3", "typescript": "^5.3.3" } }, "scripts/mesh-cli": { "name": "meshjs", - "version": "1.9.0-beta.60", + "version": "1.9.0-beta.62", "license": "Apache-2.0", "dependencies": { "chalk": "5.3.0", diff --git a/package.json b/package.json index ce0042bd0..03d1e08be 100644 --- a/package.json +++ b/package.json @@ -2,12 +2,13 @@ "name": "@meshsdk/root", "private": true, "scripts": { - "build": "turbo run build:mesh && turbo run build:docs && turbo run build:apps && turbo run build:scripts", + "build": "turbo run build:mesh && turbo run build:docs && turbo run build:docs:markdown && turbo run build:apps && turbo run build:scripts", "build2": "turbo build --concurrency 15 && npm run build:scripts", "build:apps": "turbo run build:apps", "build:docs": "turbo run build:docs", "build:mesh": "turbo run build:mesh", "build:scripts": "turbo run build:scripts", + "build:docs:markdown": "turbo run build:docs:markdown", "clean": "turbo run clean && rm -rf .turbo && rm -rf dist && rm -rf node_modules && rm package-lock.json", "dev": "turbo dev --concurrency 15", "format": "turbo run format --continue -- --cache --cache-location node_modules/.cache/.prettiercache", @@ -26,7 +27,9 @@ "patch-package": "^8.0.0", "prettier": "^3.2.5", "ts-node": "^10.9.2", - "turbo": "latest" + "turbo": "latest", + "typedoc": "^0.28.7", + "typedoc-plugin-markdown": "^4.7.0" }, "engines": { "node": ">=18" diff --git a/packages/mesh-common/package.json b/packages/mesh-common/package.json index cc450a060..1a3d5404b 100644 --- a/packages/mesh-common/package.json +++ b/packages/mesh-common/package.json @@ -19,6 +19,7 @@ ], "scripts": { "build:docs": "typedoc src/index.ts --json ../../apps/docs/src/data/mesh-common.json", + "build:docs:markdown": "typedoc src/index.ts --plugin typedoc-plugin-markdown --out ../../docs/markdown/mesh-common --excludePrivate --excludeExternals --hideGenerator", "build:mesh": "tsup src/index.ts --format esm,cjs --dts", "clean": "rm -rf .turbo && rm -rf dist && rm -rf node_modules", "dev": "tsup src/index.ts --format esm,cjs --watch --dts", diff --git a/packages/mesh-contract/package.json b/packages/mesh-contract/package.json index 36e091ad5..f3b3cd703 100644 --- a/packages/mesh-contract/package.json +++ b/packages/mesh-contract/package.json @@ -19,6 +19,7 @@ ], "scripts": { "build:docs": "typedoc src/index.ts --json ../../apps/docs/src/data/mesh-contracts.json", + "build:docs:markdown": "typedoc src/index.ts --plugin typedoc-plugin-markdown --out ../../docs/markdown/mesh-contracts --excludePrivate --excludeExternals --hideGenerator", "build:mesh": "tsup src/index.ts --format esm,cjs --dts", "clean": "rm -rf .turbo && rm -rf dist && rm -rf node_modules", "dev": "tsup src/index.ts --format esm,cjs --watch --dts", diff --git a/packages/mesh-core-cst/package.json b/packages/mesh-core-cst/package.json index 08f28f26d..9568f73c8 100644 --- a/packages/mesh-core-cst/package.json +++ b/packages/mesh-core-cst/package.json @@ -19,6 +19,7 @@ ], "scripts": { "build:mesh": "tsup src/index.ts --format esm,cjs --dts", + "build:docs:markdown": "typedoc src/index.ts --plugin typedoc-plugin-markdown --out ../../docs/markdown/mesh-core-cst --excludePrivate --excludeExternals --hideGenerator", "clean": "rm -rf .turbo && rm -rf dist && rm -rf node_modules", "dev": "tsup src/index.ts --format esm,cjs --watch --dts", "format": "prettier --check . --ignore-path ../../.gitignore", @@ -32,7 +33,6 @@ "eslint": "^8.57.0", "ts-jest": "^29.1.4", "tsup": "^8.0.2", - "typedoc": "^0.26.3", "typescript": "^5.3.3" }, "dependencies": { diff --git a/packages/mesh-provider/package.json b/packages/mesh-provider/package.json index 9e1cf6daf..f0eb6614b 100644 --- a/packages/mesh-provider/package.json +++ b/packages/mesh-provider/package.json @@ -19,6 +19,7 @@ ], "scripts": { "build:docs": "typedoc src/index.ts --json ../../apps/docs/src/data/mesh-providers.json", + "build:docs:markdown": "typedoc src/index.ts --plugin typedoc-plugin-markdown --out ../../docs/markdown/mesh-providers --excludePrivate --excludeExternals --hideGenerator", "build:mesh": "tsup src/index.ts --format esm,cjs --dts", "clean": "rm -rf .turbo && rm -rf dist && rm -rf node_modules", "dev": "tsup src/index.ts --format esm,cjs --watch --dts", diff --git a/packages/mesh-transaction/package.json b/packages/mesh-transaction/package.json index 47aa73035..7f02374f4 100644 --- a/packages/mesh-transaction/package.json +++ b/packages/mesh-transaction/package.json @@ -19,6 +19,7 @@ ], "scripts": { "build:docs": "typedoc src/index.ts --json ../../apps/docs/src/data/mesh-transactions.json", + "build:docs:markdown": "typedoc src/index.ts --plugin typedoc-plugin-markdown --out ../../docs/markdown/mesh-transactions --excludePrivate --excludeExternals --hideGenerator", "build:mesh": "tsup src/index.ts --format esm,cjs --dts", "clean": "rm -rf .turbo && rm -rf dist && rm -rf node_modules", "dev": "tsup src/index.ts --format esm,cjs --watch --dts", diff --git a/packages/mesh-wallet/package.json b/packages/mesh-wallet/package.json index 1c24131af..f91998bfa 100644 --- a/packages/mesh-wallet/package.json +++ b/packages/mesh-wallet/package.json @@ -19,6 +19,7 @@ ], "scripts": { "build:docs": "typedoc src/index.ts --json ../../apps/docs/src/data/mesh-wallets.json", + "build:docs:markdown": "typedoc src/index.ts --plugin typedoc-plugin-markdown --out ../../docs/markdown/mesh-wallets --excludePrivate --excludeExternals --hideGenerator", "build:mesh": "tsup src/index.ts --format esm,cjs --dts", "clean": "rm -rf .turbo && rm -rf dist && rm -rf node_modules", "dev": "tsup src/index.ts --format esm,cjs --watch --dts", @@ -31,7 +32,6 @@ "@meshsdk/configs": "*", "eslint": "^8.57.0", "tsup": "^8.0.2", - "typedoc": "^0.26.3", "typescript": "^5.3.3" }, "dependencies": { diff --git a/turbo.json b/turbo.json index 1010f53c1..0629b210c 100644 --- a/turbo.json +++ b/turbo.json @@ -14,6 +14,10 @@ "dependsOn": ["^build:mesh", "^build:docs"], "outputs": ["dist/**"] }, + "build:docs:markdown": { + "dependsOn": ["^build:mesh"], + "outputs": ["../../docs/markdown/**"] + }, "build:mesh": { "dependsOn": ["^build:mesh"], "outputs": ["dist/**"]