diff --git a/.github/workflows/upload-docs-to-aws.yml b/.github/workflows/upload-docs-to-aws.yml new file mode 100644 index 00000000000..38ff5147481 --- /dev/null +++ b/.github/workflows/upload-docs-to-aws.yml @@ -0,0 +1,57 @@ +name: Upload Docs to S3 + +on: + push: + branches: + - devnet + - testnet + +jobs: + build-and-upload-docs: + runs-on: ubuntu-latest + env: + S3_BUCKET: files.iota.org/iota-wiki/iota + + steps: + - name: Check out repository + uses: actions/checkout@v3 + + - name: Build Rust documentation + run: cargo test --manifest-path crates/iota-framework/Cargo.toml + + # ----------- Build TypeScript and GraphQL Docs with pnpm ----------- + - name: Set up Node + uses: actions/setup-node@v3 + with: + node-version: "22.x" + + - name: Install pnpm + run: corepack enable && corepack prepare pnpm@latest --activate + + - name: Install dependencies + run: pnpm install + + - name: Build SDK and BCS + run: pnpm sdk build && pnpm bcs build + + - name: Generate TypeScript docs + run: pnpm --filter iota-docs generate-ts-docs + + - name: Generate GraphQl docs + run: pnpm --filter iota-docs generate-graphql-docs + + - name: Compress generated docs + run: | + tar czvf ${{ github.ref_name }}.tar.gz generated-docs/* + + # ----------- Configure AWS Credentials ----------- + - name: Configure AWS Credentials + uses: aws-actions/configure-aws-credentials@v3 + with: + aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }} + aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }} + aws-region: eu-central-1 # Change if needed + + # ----------- Upload Docs to S3 ----------- + - name: Upload Rust docs to S3 + run: aws s3 sync ${{ github.ref_name }}.tar.gz s3://$S3_BUCKET/${{ github.ref_name }}.tar.gz --delete --acl public-read diff --git a/crates/iota-framework/tests/build-system-packages.rs b/crates/iota-framework/tests/build-system-packages.rs index aefc06ab5d7..b58a9feb194 100644 --- a/crates/iota-framework/tests/build-system-packages.rs +++ b/crates/iota-framework/tests/build-system-packages.rs @@ -17,7 +17,7 @@ use move_package::{BuildConfig as MoveBuildConfig, LintFlag}; const CRATE_ROOT: &str = env!("CARGO_MANIFEST_DIR"); const COMPILED_PACKAGES_DIR: &str = "packages_compiled"; -const DOCS_DIR: &str = "../../docs/content/references/framework/"; +const DOCS_DIR: &str = "../../generated-docs/framework"; const PUBLISHED_API_FILE: &str = "published_api.txt"; #[test] diff --git a/docs/content/references/.gitignore b/docs/content/references/.gitignore index 2b640da345a..b7c7b8474ce 100644 --- a/docs/content/references/.gitignore +++ b/docs/content/references/.gitignore @@ -1,3 +1 @@ iota-api/iota-graphql/* -framework/** -ts-sdk/api/** diff --git a/docs/content/references/framework/.gitignore b/docs/content/references/framework/.gitignore new file mode 100644 index 00000000000..fa29cdfff91 --- /dev/null +++ b/docs/content/references/framework/.gitignore @@ -0,0 +1 @@ +** \ No newline at end of file diff --git a/docs/content/ts-sdk/api/.gitignore b/docs/content/ts-sdk/api/.gitignore new file mode 100644 index 00000000000..fa29cdfff91 --- /dev/null +++ b/docs/content/ts-sdk/api/.gitignore @@ -0,0 +1 @@ +** \ No newline at end of file diff --git a/docs/content/ts-sdk/api/bcs/classes/BcsType.md b/docs/content/ts-sdk/api/bcs/classes/BcsType.md deleted file mode 100644 index 37bc2ca6fc2..00000000000 --- a/docs/content/ts-sdk/api/bcs/classes/BcsType.md +++ /dev/null @@ -1,186 +0,0 @@ -# Class: BcsType\ - -## Type Parameters - -- **T** -- **Input** = `T` - -## Constructors - -### new BcsType() - -> **new BcsType**\<`T`, `Input`\>(`options`): [`BcsType`](BcsType.md)\<`T`, `Input`\> - -#### Parameters - -- **options**: `object` & [`BcsTypeOptions`](../interfaces/BcsTypeOptions.md)\<`T`, `Input`\> - -#### Returns - -[`BcsType`](BcsType.md)\<`T`, `Input`\> - -## Properties - -### $inferType - -> **$inferType**: `T` - ---- - -### $inferInput - -> **$inferInput**: `Input` - ---- - -### name - -> **name**: `string` - ---- - -### read() - -> **read**: (`reader`) => `T` - -#### Parameters - -- **reader**: `BcsReader` - -#### Returns - -`T` - ---- - -### serializedSize() - -> **serializedSize**: (`value`, `options`?) => `null` \| `number` - -#### Parameters - -- **value**: `Input` -- **options?**: `BcsWriterOptions` - -#### Returns - -`null` \| `number` - ---- - -### validate() - -> **validate**: (`value`) => `void` - -#### Parameters - -- **value**: `Input` - -#### Returns - -`void` - -## Methods - -### write() - -> **write**(`value`, `writer`): `void` - -#### Parameters - -- **value**: `Input` -- **writer**: `BcsWriter` - -#### Returns - -`void` - ---- - -### serialize() - -> **serialize**(`value`, `options`?): `SerializedBcs`\<`T`, `Input`\> - -#### Parameters - -- **value**: `Input` -- **options?**: `BcsWriterOptions` - -#### Returns - -`SerializedBcs`\<`T`, `Input`\> - ---- - -### parse() - -> **parse**(`bytes`): `T` - -#### Parameters - -- **bytes**: `Uint8Array` - -#### Returns - -`T` - ---- - -### fromHex() - -> **fromHex**(`hex`): `T` - -#### Parameters - -- **hex**: `string` - -#### Returns - -`T` - ---- - -### fromBase58() - -> **fromBase58**(`b64`): `T` - -#### Parameters - -- **b64**: `string` - -#### Returns - -`T` - ---- - -### fromBase64() - -> **fromBase64**(`b64`): `T` - -#### Parameters - -- **b64**: `string` - -#### Returns - -`T` - ---- - -### transform() - -> **transform**\<`T2`, `Input2`\>(`__namedParameters`): [`BcsType`](BcsType.md)\<`T2`, `Input2`\> - -#### Type Parameters - -- **T2** -- **Input2** - -#### Parameters - -- **\_\_namedParameters**: `object` & [`BcsTypeOptions`](../interfaces/BcsTypeOptions.md)\<`T2`, `Input2`\> - -#### Returns - -[`BcsType`](BcsType.md)\<`T2`, `Input2`\> diff --git a/docs/content/ts-sdk/api/bcs/classes/TypeTagSerializer.md b/docs/content/ts-sdk/api/bcs/classes/TypeTagSerializer.md deleted file mode 100644 index b29c5013521..00000000000 --- a/docs/content/ts-sdk/api/bcs/classes/TypeTagSerializer.md +++ /dev/null @@ -1,57 +0,0 @@ -# Class: TypeTagSerializer - -## Constructors - -### new TypeTagSerializer() - -> **new TypeTagSerializer**(): [`TypeTagSerializer`](TypeTagSerializer.md) - -#### Returns - -[`TypeTagSerializer`](TypeTagSerializer.md) - -## Methods - -### parseFromStr() - -> `static` **parseFromStr**(`str`, `normalizeAddress`): [`TypeTag`](../type-aliases/TypeTag.md) - -#### Parameters - -• **str**: `string` - -• **normalizeAddress**: `boolean` = `false` - -#### Returns - -[`TypeTag`](../type-aliases/TypeTag.md) - ---- - -### parseStructTypeArgs() - -> `static` **parseStructTypeArgs**(`str`, `normalizeAddress`): [`TypeTag`](../type-aliases/TypeTag.md)[] - -#### Parameters - -• **str**: `string` - -• **normalizeAddress**: `boolean` = `false` - -#### Returns - -[`TypeTag`](../type-aliases/TypeTag.md)[] - ---- - -### tagToString() - -> `static` **tagToString**(`tag`): `string` - -#### Parameters - -• **tag**: [`TypeTag`](../type-aliases/TypeTag.md) - -#### Returns - -`string` diff --git a/docs/content/ts-sdk/api/bcs/index.md b/docs/content/ts-sdk/api/bcs/index.md deleted file mode 100644 index 524ad590c73..00000000000 --- a/docs/content/ts-sdk/api/bcs/index.md +++ /dev/null @@ -1,20 +0,0 @@ -# bcs - -## Index - -### Classes - -- [BcsType](classes/BcsType.md) -- [TypeTagSerializer](classes/TypeTagSerializer.md) - -### Interfaces - -- [BcsTypeOptions](interfaces/BcsTypeOptions.md) - -### Type Aliases - -- [TypeTag](type-aliases/TypeTag.md) - -### Variables - -- [bcs](variables/bcs.md) diff --git a/docs/content/ts-sdk/api/bcs/interfaces/BcsTypeOptions.md b/docs/content/ts-sdk/api/bcs/interfaces/BcsTypeOptions.md deleted file mode 100644 index 7b1a0011ae1..00000000000 --- a/docs/content/ts-sdk/api/bcs/interfaces/BcsTypeOptions.md +++ /dev/null @@ -1,27 +0,0 @@ -# Interface: BcsTypeOptions\ - -## Type Parameters - -• **T** - -• **Input** = `T` - -## Properties - -### name? - -> `optional` **name**: `string` - ---- - -### validate()? - -> `optional` **validate**: (`value`) => `void` - -#### Parameters - -• **value**: `Input` - -#### Returns - -`void` diff --git a/docs/content/ts-sdk/api/bcs/type-aliases/TypeTag.md b/docs/content/ts-sdk/api/bcs/type-aliases/TypeTag.md deleted file mode 100644 index a91445adba0..00000000000 --- a/docs/content/ts-sdk/api/bcs/type-aliases/TypeTag.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: TypeTag - -> **TypeTag**: `object` \| `object` \| `object` \| `object` \| `object` \| `object` \| `object` \| `object` \| `object` \| `object` \| `object` - -IOTA TypeTag object. A decoupled `0x...::module::Type` parameter. diff --git a/docs/content/ts-sdk/api/bcs/variables/bcs.md b/docs/content/ts-sdk/api/bcs/variables/bcs.md deleted file mode 100644 index 1e9047ef16d..00000000000 --- a/docs/content/ts-sdk/api/bcs/variables/bcs.md +++ /dev/null @@ -1,1455 +0,0 @@ -# Variable: bcs - -> `const` **bcs**: `object` - -## Type declaration - -### u8() - -Creates a BcsType that can be used to read and write an 8-bit unsigned integer. - -#### Parameters - -• **options?**: [`BcsTypeOptions`](../interfaces/BcsTypeOptions.md)\<`number`, `number`\> - -#### Returns - -[`BcsType`](../classes/BcsType.md)\<`number`, `number`\> - -#### Example - -```ts -bcs.u8().serialize(255).toBytes() // Uint8Array [ 255 ] -``` - -### u16() - -Creates a BcsType that can be used to read and write a 16-bit unsigned integer. - -#### Parameters - -• **options?**: [`BcsTypeOptions`](../interfaces/BcsTypeOptions.md)\<`number`, `number`\> - -#### Returns - -[`BcsType`](../classes/BcsType.md)\<`number`, `number`\> - -#### Example - -```ts -bcs.u16().serialize(65535).toBytes() // Uint8Array [ 255, 255 ] -``` - -### u32() - -Creates a BcsType that can be used to read and write a 32-bit unsigned integer. - -#### Parameters - -• **options?**: [`BcsTypeOptions`](../interfaces/BcsTypeOptions.md)\<`number`, `number`\> - -#### Returns - -[`BcsType`](../classes/BcsType.md)\<`number`, `number`\> - -#### Example - -```ts -bcs.u32().serialize(4294967295).toBytes() // Uint8Array [ 255, 255, 255, 255 ] -``` - -### u64() - -Creates a BcsType that can be used to read and write a 64-bit unsigned integer. - -#### Parameters - -• **options?**: [`BcsTypeOptions`](../interfaces/BcsTypeOptions.md)\<`string`, `string` \| `number` \| `bigint`\> - -#### Returns - -[`BcsType`](../classes/BcsType.md)\<`string`, `string` \| `number` \| `bigint`\> - -#### Example - -```ts -bcs.u64().serialize(1).toBytes() // Uint8Array [ 1, 0, 0, 0, 0, 0, 0, 0 ] -``` - -### u128() - -Creates a BcsType that can be used to read and write a 128-bit unsigned integer. - -#### Parameters - -• **options?**: [`BcsTypeOptions`](../interfaces/BcsTypeOptions.md)\<`string`, `string` \| `number` \| `bigint`\> - -#### Returns - -[`BcsType`](../classes/BcsType.md)\<`string`, `string` \| `number` \| `bigint`\> - -#### Example - -```ts -bcs.u128().serialize(1).toBytes() // Uint8Array [ 1, ..., 0 ] -``` - -### u256() - -Creates a BcsType that can be used to read and write a 256-bit unsigned integer. - -#### Parameters - -• **options?**: [`BcsTypeOptions`](../interfaces/BcsTypeOptions.md)\<`string`, `string` \| `number` \| `bigint`\> - -#### Returns - -[`BcsType`](../classes/BcsType.md)\<`string`, `string` \| `number` \| `bigint`\> - -#### Example - -```ts -bcs.u256().serialize(1).toBytes() // Uint8Array [ 1, ..., 0 ] -``` - -### bool() - -Creates a BcsType that can be used to read and write boolean values. - -#### Parameters - -• **options?**: [`BcsTypeOptions`](../interfaces/BcsTypeOptions.md)\<`boolean`, `boolean`\> - -#### Returns - -[`BcsType`](../classes/BcsType.md)\<`boolean`, `boolean`\> - -#### Example - -```ts -bcs.bool().serialize(true).toBytes() // Uint8Array [ 1 ] -``` - -### uleb128() - -Creates a BcsType that can be used to read and write unsigned LEB encoded integers - -#### Parameters - -• **options?**: [`BcsTypeOptions`](../interfaces/BcsTypeOptions.md)\<`number`, `number`\> - -#### Returns - -[`BcsType`](../classes/BcsType.md)\<`number`, `number`\> - -#### Example - -```ts -``` - -### bytes() - -Creates a BcsType representing a fixed length byte array - -#### Type Parameters - -• **T** _extends_ `number` - -#### Parameters - -• **size**: `T` - -The number of bytes this types represents - -• **options?**: [`BcsTypeOptions`](../interfaces/BcsTypeOptions.md)\<`Uint8Array`, `Iterable`\<`number`, `any`, `any`\>\> - -#### Returns - -[`BcsType`](../classes/BcsType.md)\<`Uint8Array`, `Uint8Array`\> - -#### Example - -```ts -bcs.bytes(3).serialize(new Uint8Array([1, 2, 3])).toBytes() // Uint8Array [1, 2, 3] -``` - -### string() - -Creates a BcsType that can ser/de string values. Strings will be UTF-8 encoded - -#### Parameters - -• **options?**: [`BcsTypeOptions`](../interfaces/BcsTypeOptions.md)\<`string`, `string`\> - -#### Returns - -[`BcsType`](../classes/BcsType.md)\<`string`, `string`\> - -#### Example - -```ts -bcs.string().serialize('a').toBytes() // Uint8Array [ 1, 97 ] -``` - -### fixedArray() - -Creates a BcsType that represents a fixed length array of a given type - -#### Type Parameters - -• **T** - -• **Input** - -#### Parameters - -• **size**: `number` - -The number of elements in the array - -• **type**: [`BcsType`](../classes/BcsType.md)\<`T`, `Input`\> - -The BcsType of each element in the array - -• **options?**: [`BcsTypeOptions`](../interfaces/BcsTypeOptions.md)\<`T`[], `Iterable`\<`Input`, `any`, `any`\> & `object`\> - -#### Returns - -[`BcsType`](../classes/BcsType.md)\<`T`[], `Iterable`\<`Input`, `any`, `any`\> & `object`\> - -#### Example - -```ts -bcs.fixedArray(3, bcs.u8()).serialize([1, 2, 3]).toBytes() // Uint8Array [ 1, 2, 3 ] -``` - -### option() - -Creates a BcsType representing an optional value - -#### Type Parameters - -• **T** - -• **Input** - -#### Parameters - -• **type**: [`BcsType`](../classes/BcsType.md)\<`T`, `Input`\> - -The BcsType of the optional value - -#### Returns - -[`BcsType`](../classes/BcsType.md)\<`null` \| `T`, `undefined` \| `null` \| `Input`\> - -#### Example - -```ts -bcs.option(bcs.u8()).serialize(null).toBytes() // Uint8Array [ 0 ] -bcs.option(bcs.u8()).serialize(1).toBytes() // Uint8Array [ 1, 1 ] -``` - -### vector() - -Creates a BcsType representing a variable length vector of a given type - -#### Type Parameters - -• **T** - -• **Input** - -#### Parameters - -• **type**: [`BcsType`](../classes/BcsType.md)\<`T`, `Input`\> - -The BcsType of each element in the vector - -• **options?**: [`BcsTypeOptions`](../interfaces/BcsTypeOptions.md)\<`T`[], `Iterable`\<`Input`, `any`, `any`\> & `object`\> - -#### Returns - -[`BcsType`](../classes/BcsType.md)\<`T`[], `Iterable`\<`Input`, `any`, `any`\> & `object`\> - -#### Example - -```ts -bcs.vector(bcs.u8()).toBytes([1, 2, 3]) // Uint8Array [ 3, 1, 2, 3 ] -``` - -### tuple() - -Creates a BcsType representing a tuple of a given set of types - -#### Type Parameters - -• **Types** _extends_ readonly [`BcsType`](../classes/BcsType.md)\<`any`, `any`\>[] - -#### Parameters - -• **types**: `Types` - -The BcsTypes for each element in the tuple - -• **options?**: [`BcsTypeOptions`](../interfaces/BcsTypeOptions.md)\<\{ -readonly \[K in string \| number \| symbol\]: Types\[K\\] extends BcsType\ ? T : never \}, \{ \[K in string \| number \| symbol\]: Types\[K\\] extends BcsType\ ? T : never \}\> - -#### Returns - -[`BcsType`](../classes/BcsType.md)\<\{ -readonly \[K in string \| number \| symbol\]: Types\[K\\] extends BcsType\ ? T : never \}, \{ \[K\_1 in string \| number \| symbol\]: Types\[K\_1\\] extends BcsType\ ? T\_1 : never \}\> - -#### Example - -```ts -const tuple = bcs.tuple([bcs.u8(), bcs.string(), bcs.bool()]) -tuple.serialize([1, 'a', true]).toBytes() // Uint8Array [ 1, 1, 97, 1 ] -``` - -### struct() - -Creates a BcsType representing a struct of a given set of fields - -#### Type Parameters - -• **T** _extends_ `Record`\<`string`, [`BcsType`](../classes/BcsType.md)\<`any`, `any`\>\> - -#### Parameters - -• **name**: `string` - -The name of the struct - -• **fields**: `T` - -The fields of the struct. The order of the fields affects how data is serialized and deserialized - -• **options?**: `Omit`\<[`BcsTypeOptions`](../interfaces/BcsTypeOptions.md)\<\{ \[K in string \| number \| symbol\]: T\[K\] extends BcsType\ ? U : never \}, \{ \[K in string \| number \| symbol\]: T\[K\] extends BcsType\ ? U : never \}\>, `"name"`\> - -#### Returns - -[`BcsType`](../classes/BcsType.md)\<\{ \[K in string \| number \| symbol\]: T\[K\] extends BcsType\ ? U : never \}, \{ \[K\_1 in string \| number \| symbol\]: T\[K\_1\] extends BcsType\ ? U\_1 : never \}\> - -#### Example - -```ts -const struct = bcs.struct('MyStruct', { - a: bcs.u8(), - b: bcs.string(), -}) -struct.serialize({ a: 1, b: 'a' }).toBytes() // Uint8Array [ 1, 1, 97 ] -``` - -### enum() - -Creates a BcsType representing an enum of a given set of options - -#### Type Parameters - -• **T** _extends_ `Record`\<`string`, `null` \| [`BcsType`](../classes/BcsType.md)\<`any`, `any`\>\> - -#### Parameters - -• **name**: `string` - -The name of the enum - -• **values**: `T` - -The values of the enum. The order of the values affects how data is serialized and deserialized. -null can be used to represent a variant with no data. - -• **options?**: `Omit`\<[`BcsTypeOptions`](../interfaces/BcsTypeOptions.md)\<`EnumOutputShape`\<\{ \[K in string \| number \| symbol\]: T\[K\] extends BcsType\ ? U : true \}\>, `EnumInputShape`\<\{ \[K in string \| number \| symbol\]: T\[K\] extends BcsType\ ? U : null \| boolean \| object \}\>\>, `"name"`\> - -#### Returns - -[`BcsType`](../classes/BcsType.md)\<`EnumOutputShape`\<\{ \[K in string \| number \| symbol\]: T\[K\] extends BcsType\ ? U : true \}\>, `EnumInputShape`\<\{ \[K\_1 in string \| number \| symbol\]: T\[K\_1\] extends BcsType\ ? U\_1 : null \| boolean \| object \}\>\> - -#### Example - -```ts -const enum = bcs.enum('MyEnum', { - A: bcs.u8(), - B: bcs.string(), - C: null, -}) -enum.serialize({ A: 1 }).toBytes() // Uint8Array [ 0, 1 ] -enum.serialize({ B: 'a' }).toBytes() // Uint8Array [ 1, 1, 97 ] -enum.serialize({ C: true }).toBytes() // Uint8Array [ 2 ] -``` - -### map() - -Creates a BcsType representing a map of a given key and value type - -#### Type Parameters - -• **K** - -• **V** - -• **InputK** = `K` - -• **InputV** = `V` - -#### Parameters - -• **keyType**: [`BcsType`](../classes/BcsType.md)\<`K`, `InputK`\> - -The BcsType of the key - -• **valueType**: [`BcsType`](../classes/BcsType.md)\<`V`, `InputV`\> - -The BcsType of the value - -#### Returns - -[`BcsType`](../classes/BcsType.md)\<`Map`\<`K`, `V`\>, `Map`\<`InputK`, `InputV`\>\> - -#### Example - -```ts -const map = bcs.map(bcs.u8(), bcs.string()) -map.serialize(new Map([[2, 'a']])).toBytes() // Uint8Array [ 1, 2, 1, 97 ] -``` - -### lazy() - -Creates a BcsType that wraps another BcsType which is lazily evaluated. This is useful for creating recursive types. - -#### Type Parameters - -• **T** _extends_ [`BcsType`](../classes/BcsType.md)\<`any`, `any`\> - -#### Parameters - -• **cb** - -A callback that returns the BcsType - -#### Returns - -`T` - -### U8 - -> **U8**: [`BcsType`](../classes/BcsType.md)\<`number`, `number`\> - -### U16 - -> **U16**: [`BcsType`](../classes/BcsType.md)\<`number`, `number`\> - -### U32 - -> **U32**: [`BcsType`](../classes/BcsType.md)\<`number`, `number`\> - -### U64 - -> **U64**: [`BcsType`](../classes/BcsType.md)\<`string`, `string` \| `number` \| `bigint`\> - -### U128 - -> **U128**: [`BcsType`](../classes/BcsType.md)\<`string`, `string` \| `number` \| `bigint`\> - -### U256 - -> **U256**: [`BcsType`](../classes/BcsType.md)\<`string`, `string` \| `number` \| `bigint`\> - -### ULEB128 - -> **ULEB128**: [`BcsType`](../classes/BcsType.md)\<`number`, `number`\> - -### Bool - -> **Bool**: [`BcsType`](../classes/BcsType.md)\<`boolean`, `boolean`\> - -### String - -> **String**: [`BcsType`](../classes/BcsType.md)\<`string`, `string`\> - -### Address - -> **Address**: [`BcsType`](../classes/BcsType.md)\<`string`, `string` \| `Uint8Array`\> - -### AppId - -> **AppId**: [`BcsType`](../classes/BcsType.md)\<`object`, `object`\> - -#### Type declaration - -##### $kind - -> **$kind**: `"Iota"` - -##### Iota - -> **Iota**: `true` = `null` - -### Argument - -> **Argument**: [`BcsType`](../classes/BcsType.md)\<`EnumOutputShapeWithKeys`\<`object`, `"GasCoin"` \| `"Input"` \| `"Result"` \| `"NestedResult"`\>, `EnumInputShape`\<`object`\>\> - -### CallArg - -> **CallArg**: [`BcsType`](../classes/BcsType.md)\<`EnumOutputShapeWithKeys`\<`object`, `"Pure"` \| `"Object"`\>, `EnumInputShape`\<`object`\>\> - -### CompressedSignature - -> **CompressedSignature**: [`BcsType`](../classes/BcsType.md)\<`EnumOutputShapeWithKeys`\<`object`, `"ED25519"` \| `"Secp256k1"` \| `"Secp256r1"`\>, `EnumInputShape`\<`object`\>\> - -### GasData - -> **GasData**: [`BcsType`](../classes/BcsType.md)\<`object`, `object`\> - -#### Type declaration - -##### payment - -> **payment**: `object`[] - -##### owner - -> **owner**: `string` = `Address` - -##### price - -> **price**: `string` - -##### budget - -> **budget**: `string` - -### Intent - -> **Intent**: [`BcsType`](../classes/BcsType.md)\<`object`, `object`\> - -#### Type declaration - -##### scope - -> **scope**: `EnumOutputShapeWithKeys`\<`object`, `"TransactionData"` \| `"TransactionEffects"` \| `"CheckpointSummary"` \| `"PersonalMessage"`\> = `IntentScope` - -###### Type declaration - -###### TransactionData - -> **TransactionData**: `true` = `null` - -###### TransactionEffects - -> **TransactionEffects**: `true` = `null` - -###### CheckpointSummary - -> **CheckpointSummary**: `true` = `null` - -###### PersonalMessage - -> **PersonalMessage**: `true` = `null` - -##### version - -> **version**: `object` = `IntentVersion` - -##### version.$kind - -> **$kind**: `"V0"` - -##### version.V0 - -> **V0**: `true` = `null` - -##### appId - -> **appId**: `object` = `AppId` - -##### appId.$kind - -> **$kind**: `"Iota"` - -##### appId.Iota - -> **Iota**: `true` = `null` - -### IntentMessage() - -> **IntentMessage**: \<`T`\>(`T`) => [`BcsType`](../classes/BcsType.md)\<`object`, `object`\> - -#### Type Parameters - -• **T** _extends_ [`BcsType`](../classes/BcsType.md)\<`any`, `any`\> - -#### Parameters - -• **T**: `T` - -#### Returns - -[`BcsType`](../classes/BcsType.md)\<`object`, `object`\> - -##### intent - -> **intent**: `object` = `Intent` - -##### intent.scope - -> **scope**: `EnumOutputShapeWithKeys`\<`object`, `"TransactionData"` \| `"TransactionEffects"` \| `"CheckpointSummary"` \| `"PersonalMessage"`\> = `IntentScope` - -###### Type declaration - -###### TransactionData - -> **TransactionData**: `true` = `null` - -###### TransactionEffects - -> **TransactionEffects**: `true` = `null` - -###### CheckpointSummary - -> **CheckpointSummary**: `true` = `null` - -###### PersonalMessage - -> **PersonalMessage**: `true` = `null` - -##### intent.version - -> **version**: `object` = `IntentVersion` - -##### intent.version.$kind - -> **$kind**: `"V0"` - -##### intent.version.V0 - -> **V0**: `true` = `null` - -##### intent.appId - -> **appId**: `object` = `AppId` - -##### intent.appId.$kind - -> **$kind**: `"Iota"` - -##### intent.appId.Iota - -> **Iota**: `true` = `null` - -##### value - -> **value**: `T` _extends_ [`BcsType`](../classes/BcsType.md)\<`U`, `any`\> ? `U` : `never` = `T` - -### IntentScope - -> **IntentScope**: [`BcsType`](../classes/BcsType.md)\<`EnumOutputShapeWithKeys`\<`object`, `"TransactionData"` \| `"TransactionEffects"` \| `"CheckpointSummary"` \| `"PersonalMessage"`\>, `EnumInputShape`\<`object`\>\> - -### IntentVersion - -> **IntentVersion**: [`BcsType`](../classes/BcsType.md)\<`object`, `object`\> - -#### Type declaration - -##### $kind - -> **$kind**: `"V0"` - -##### V0 - -> **V0**: `true` = `null` - -### MultiSig - -> **MultiSig**: [`BcsType`](../classes/BcsType.md)\<`object`, `object`\> - -#### Type declaration - -##### sigs - -> **sigs**: `EnumOutputShapeWithKeys`\<`object`, `"ED25519"` \| `"Secp256k1"` \| `"Secp256r1"`\>[] - -##### bitmap - -> **bitmap**: `number` - -##### multisig\_pk - -> **multisig\_pk**: `object` = `MultiSigPublicKey` - -##### multisig\_pk.pk\_map - -> **pk\_map**: `object`[] - -##### multisig\_pk.threshold - -> **threshold**: `number` - -### MultiSigPkMap - -> **MultiSigPkMap**: [`BcsType`](../classes/BcsType.md)\<`object`, `object`\> - -#### Type declaration - -##### pubKey - -> **pubKey**: `EnumOutputShapeWithKeys`\<`object`, `"ED25519"` \| `"Secp256k1"` \| `"Secp256r1"`\> = `PublicKey` - -###### Type declaration - -###### ED25519 - -> **ED25519**: `number`[] - -###### Secp256k1 - -> **Secp256k1**: `number`[] - -###### Secp256r1 - -> **Secp256r1**: `number`[] - -##### weight - -> **weight**: `number` - -### MultiSigPublicKey - -> **MultiSigPublicKey**: [`BcsType`](../classes/BcsType.md)\<`object`, `object`\> - -#### Type declaration - -##### pk\_map - -> **pk\_map**: `object`[] - -##### threshold - -> **threshold**: `number` - -### ObjectArg - -> **ObjectArg**: [`BcsType`](../classes/BcsType.md)\<`EnumOutputShapeWithKeys`\<`object`, `"ImmOrOwnedObject"` \| `"SharedObject"` \| `"Receiving"`\>, `EnumInputShape`\<`object`\>\> - -### ObjectDigest - -> **ObjectDigest**: [`BcsType`](../classes/BcsType.md)\<`string`, `string`\> - -### ProgrammableMoveCall - -> **ProgrammableMoveCall**: [`BcsType`](../classes/BcsType.md)\<`object`, `object`\> - -#### Type declaration - -##### package - -> **package**: `string` = `Address` - -##### module - -> **module**: `string` - -##### function - -> **function**: `string` - -##### typeArguments - -> **typeArguments**: `string`[] - -##### arguments - -> **arguments**: `EnumOutputShapeWithKeys`\<`object`, `"GasCoin"` \| `"Input"` \| `"Result"` \| `"NestedResult"`\>[] - -### ProgrammableTransaction - -> **ProgrammableTransaction**: [`BcsType`](../classes/BcsType.md)\<`object`, `object`\> - -#### Type declaration - -##### inputs - -> **inputs**: `EnumOutputShapeWithKeys`\<`object`, `"Pure"` \| `"Object"`\>[] - -##### commands - -> **commands**: `EnumOutputShapeWithKeys`\<`object`, `"MoveCall"` \| `"TransferObjects"` \| `"SplitCoins"` \| `"MergeCoins"` \| `"Publish"` \| `"MakeMoveVec"` \| `"Upgrade"`\>[] - -### PublicKey - -> **PublicKey**: [`BcsType`](../classes/BcsType.md)\<`EnumOutputShapeWithKeys`\<`object`, `"ED25519"` \| `"Secp256k1"` \| `"Secp256r1"`\>, `EnumInputShape`\<`object`\>\> - -### SenderSignedData - -> **SenderSignedData**: [`BcsType`](../classes/BcsType.md)\<`object`[], `Iterable`\<`object`, `any`, `any`\> & `object`\> - -### SenderSignedTransaction - -> **SenderSignedTransaction**: [`BcsType`](../classes/BcsType.md)\<`object`, `object`\> - -#### Type declaration - -##### intentMessage - -> **intentMessage**: `object` - -##### intentMessage.intent - -> **intent**: `object` = `Intent` - -##### intentMessage.intent.scope - -> **scope**: `EnumOutputShapeWithKeys`\<`object`, `"TransactionData"` \| `"TransactionEffects"` \| `"CheckpointSummary"` \| `"PersonalMessage"`\> = `IntentScope` - -###### Type declaration - -###### TransactionData - -> **TransactionData**: `true` = `null` - -###### TransactionEffects - -> **TransactionEffects**: `true` = `null` - -###### CheckpointSummary - -> **CheckpointSummary**: `true` = `null` - -###### PersonalMessage - -> **PersonalMessage**: `true` = `null` - -##### intentMessage.intent.version - -> **version**: `object` = `IntentVersion` - -##### intentMessage.intent.version.$kind - -> **$kind**: `"V0"` - -##### intentMessage.intent.version.V0 - -> **V0**: `true` = `null` - -##### intentMessage.intent.appId - -> **appId**: `object` = `AppId` - -##### intentMessage.intent.appId.$kind - -> **$kind**: `"Iota"` - -##### intentMessage.intent.appId.Iota - -> **Iota**: `true` = `null` - -##### intentMessage.value - -> **value**: `object` = `T` - -##### intentMessage.value.$kind - -> **$kind**: `"V1"` - -##### intentMessage.value.V1 - -> **V1**: `object` = `TransactionDataV1` - -##### intentMessage.value.V1.kind - -> **kind**: `EnumOutputShapeWithKeys`\<`object`, `"ProgrammableTransaction"` \| `"ChangeEpoch"` \| `"Genesis"` \| `"ConsensusCommitPrologue"`\> = `TransactionKind` - -###### Type declaration - -###### ProgrammableTransaction - -> **ProgrammableTransaction**: `object` - -###### ProgrammableTransaction.inputs - -> **inputs**: `EnumOutputShapeWithKeys`\<..., ...\>[] - -###### ProgrammableTransaction.commands - -> **commands**: `EnumOutputShapeWithKeys`\<..., ...\>[] - -###### ChangeEpoch - -> **ChangeEpoch**: `true` = `null` - -###### Genesis - -> **Genesis**: `true` = `null` - -###### ConsensusCommitPrologue - -> **ConsensusCommitPrologue**: `true` = `null` - -##### intentMessage.value.V1.sender - -> **sender**: `string` = `Address` - -##### intentMessage.value.V1.gasData - -> **gasData**: `object` = `GasData` - -##### intentMessage.value.V1.gasData.payment - -> **payment**: `object`[] - -##### intentMessage.value.V1.gasData.owner - -> **owner**: `string` = `Address` - -##### intentMessage.value.V1.gasData.price - -> **price**: `string` - -##### intentMessage.value.V1.gasData.budget - -> **budget**: `string` - -##### intentMessage.value.V1.expiration - -> **expiration**: `EnumOutputShapeWithKeys`\<`object`, `"None"` \| `"Epoch"`\> = `TransactionExpiration` - -###### Type declaration - -###### None - -> **None**: `true` = `null` - -###### Epoch - -> **Epoch**: `number` - -##### txSignatures - -> **txSignatures**: `string`[] - -### SharedObjectRef - -> **SharedObjectRef**: [`BcsType`](../classes/BcsType.md)\<`object`, `object`\> - -#### Type declaration - -##### objectId - -> **objectId**: `string` = `Address` - -##### initialSharedVersion - -> **initialSharedVersion**: `string` - -##### mutable - -> **mutable**: `boolean` - -### StructTag - -> **StructTag**: [`BcsType`](../classes/BcsType.md)\<`object`, `object`\> - -#### Type declaration - -##### address - -> **address**: `string` = `Address` - -##### module - -> **module**: `string` - -##### name - -> **name**: `string` - -##### typeParams - -> **typeParams**: [`TypeTag`](../type-aliases/TypeTag.md)[] - -### IotaObjectRef - -> **IotaObjectRef**: [`BcsType`](../classes/BcsType.md)\<`object`, `object`\> - -#### Type declaration - -##### objectId - -> **objectId**: `string` = `Address` - -##### version - -> **version**: `string` - -##### digest - -> **digest**: `string` = `ObjectDigest` - -### Command - -> **Command**: [`BcsType`](../classes/BcsType.md)\<`EnumOutputShapeWithKeys`\<`object`, `"MoveCall"` \| `"TransferObjects"` \| `"SplitCoins"` \| `"MergeCoins"` \| `"Publish"` \| `"MakeMoveVec"` \| `"Upgrade"`\>, `EnumInputShape`\<`object`\>\> - -### TransactionData - -> **TransactionData**: [`BcsType`](../classes/BcsType.md)\<`object`, `object`\> - -#### Type declaration - -##### $kind - -> **$kind**: `"V1"` - -##### V1 - -> **V1**: `object` = `TransactionDataV1` - -##### V1.kind - -> **kind**: `EnumOutputShapeWithKeys`\<`object`, `"ProgrammableTransaction"` \| `"ChangeEpoch"` \| `"Genesis"` \| `"ConsensusCommitPrologue"`\> = `TransactionKind` - -###### Type declaration - -###### ProgrammableTransaction - -> **ProgrammableTransaction**: `object` - -###### ProgrammableTransaction.inputs - -> **inputs**: `EnumOutputShapeWithKeys`\<`object`, `"Pure"` \| `"Object"`\>[] - -###### ProgrammableTransaction.commands - -> **commands**: `EnumOutputShapeWithKeys`\<`object`, `"MoveCall"` \| `"TransferObjects"` \| `"SplitCoins"` \| `"MergeCoins"` \| `"Publish"` \| `"MakeMoveVec"` \| `"Upgrade"`\>[] - -###### ChangeEpoch - -> **ChangeEpoch**: `true` = `null` - -###### Genesis - -> **Genesis**: `true` = `null` - -###### ConsensusCommitPrologue - -> **ConsensusCommitPrologue**: `true` = `null` - -##### V1.sender - -> **sender**: `string` = `Address` - -##### V1.gasData - -> **gasData**: `object` = `GasData` - -##### V1.gasData.payment - -> **payment**: `object`[] - -##### V1.gasData.owner - -> **owner**: `string` = `Address` - -##### V1.gasData.price - -> **price**: `string` - -##### V1.gasData.budget - -> **budget**: `string` - -##### V1.expiration - -> **expiration**: `EnumOutputShapeWithKeys`\<`object`, `"None"` \| `"Epoch"`\> = `TransactionExpiration` - -###### Type declaration - -###### None - -> **None**: `true` = `null` - -###### Epoch - -> **Epoch**: `number` - -### TransactionDataV1 - -> **TransactionDataV1**: [`BcsType`](../classes/BcsType.md)\<`object`, `object`\> - -#### Type declaration - -##### kind - -> **kind**: `EnumOutputShapeWithKeys`\<`object`, `"ProgrammableTransaction"` \| `"ChangeEpoch"` \| `"Genesis"` \| `"ConsensusCommitPrologue"`\> = `TransactionKind` - -###### Type declaration - -###### ProgrammableTransaction - -> **ProgrammableTransaction**: `object` - -###### ProgrammableTransaction.inputs - -> **inputs**: `EnumOutputShapeWithKeys`\<`object`, `"Pure"` \| `"Object"`\>[] - -###### ProgrammableTransaction.commands - -> **commands**: `EnumOutputShapeWithKeys`\<`object`, `"MoveCall"` \| `"TransferObjects"` \| `"SplitCoins"` \| `"MergeCoins"` \| `"Publish"` \| `"MakeMoveVec"` \| `"Upgrade"`\>[] - -###### ChangeEpoch - -> **ChangeEpoch**: `true` = `null` - -###### Genesis - -> **Genesis**: `true` = `null` - -###### ConsensusCommitPrologue - -> **ConsensusCommitPrologue**: `true` = `null` - -##### sender - -> **sender**: `string` = `Address` - -##### gasData - -> **gasData**: `object` = `GasData` - -##### gasData.payment - -> **payment**: `object`[] - -##### gasData.owner - -> **owner**: `string` = `Address` - -##### gasData.price - -> **price**: `string` - -##### gasData.budget - -> **budget**: `string` - -##### expiration - -> **expiration**: `EnumOutputShapeWithKeys`\<`object`, `"None"` \| `"Epoch"`\> = `TransactionExpiration` - -###### Type declaration - -###### None - -> **None**: `true` = `null` - -###### Epoch - -> **Epoch**: `number` - -### TransactionExpiration - -> **TransactionExpiration**: [`BcsType`](../classes/BcsType.md)\<`EnumOutputShapeWithKeys`\<`object`, `"None"` \| `"Epoch"`\>, `EnumInputShape`\<`object`\>\> - -### TransactionKind - -> **TransactionKind**: [`BcsType`](../classes/BcsType.md)\<`EnumOutputShapeWithKeys`\<`object`, `"ProgrammableTransaction"` \| `"ChangeEpoch"` \| `"Genesis"` \| `"ConsensusCommitPrologue"`\>, `EnumInputShape`\<`object`\>\> - -### TypeTag - -> **TypeTag**: [`BcsType`](../classes/BcsType.md)\<`string`, `string` \| [`TypeTag`](../type-aliases/TypeTag.md)\> - -### TransactionEffects - -> **TransactionEffects**: [`BcsType`](../classes/BcsType.md)\<`object`, `object`\> - -#### Type declaration - -##### $kind - -> **$kind**: `"V1"` - -##### V1 - -> **V1**: `object` = `TransactionEffectsV1` - -##### V1.status - -> **status**: `EnumOutputShapeWithKeys`\<`object`, `"Success"` \| `"Failed"`\> = `ExecutionStatus` - -###### Type declaration - -###### Success - -> **Success**: `true` = `null` - -###### Failed - -> **Failed**: `object` - -###### Failed.error - -> **error**: `EnumOutputShapeWithKeys`\<`object`, `"PackageUpgradeError"` \| `"SharedObjectOperationNotAllowed"` \| `"CommandArgumentError"` \| `"TypeArgumentError"` \| `"InsufficientGas"` \| `"InvalidGasObject"` \| `"InvariantViolation"` \| `"FeatureNotYetSupported"` \| `"MoveObjectTooBig"` \| `"MovePackageTooBig"` \| `"CircularObjectOwnership"` \| `"InsufficientCoinBalance"` \| `"CoinBalanceOverflow"` \| `"PublishErrorNonZeroAddress"` \| `"IotaMoveVerificationError"` \| `"MovePrimitiveRuntimeError"` \| `"MoveAbort"` \| `"VMVerificationOrDeserializationError"` \| `"VMInvariantViolation"` \| `"FunctionNotFound"` \| `"ArityMismatch"` \| `"TypeArityMismatch"` \| `"NonEntryFunctionInvoked"` \| `"UnusedValueWithoutDrop"` \| `"InvalidPublicFunctionReturnType"` \| `"InvalidTransferObject"` \| `"EffectsTooLarge"` \| `"PublishUpgradeMissingDependency"` \| `"PublishUpgradeDependencyDowngrade"` \| `"WrittenObjectsTooLarge"` \| `"CertificateDenied"` \| `"IotaMoveVerificationTimedout"` \| `"InputObjectDeleted"`\> = `ExecutionFailureStatus` - -###### Type declaration - -###### InsufficientGas - -> **InsufficientGas**: `true` = `null` - -###### InvalidGasObject - -> **InvalidGasObject**: `true` = `null` - -###### InvariantViolation - -> **InvariantViolation**: `true` = `null` - -###### FeatureNotYetSupported - -> **FeatureNotYetSupported**: `true` = `null` - -###### MoveObjectTooBig - -> **MoveObjectTooBig**: `object` - -###### MoveObjectTooBig.objectSize - -> **objectSize**: `string` - -###### MoveObjectTooBig.maxObjectSize - -> **maxObjectSize**: `string` - -###### MovePackageTooBig - -> **MovePackageTooBig**: `object` - -###### MovePackageTooBig.objectSize - -> **objectSize**: `string` - -###### MovePackageTooBig.maxObjectSize - -> **maxObjectSize**: `string` - -###### CircularObjectOwnership - -> **CircularObjectOwnership**: `object` - -###### CircularObjectOwnership.object - -> **object**: `string` = `Address` - -###### InsufficientCoinBalance - -> **InsufficientCoinBalance**: `true` = `null` - -###### CoinBalanceOverflow - -> **CoinBalanceOverflow**: `true` = `null` - -###### PublishErrorNonZeroAddress - -> **PublishErrorNonZeroAddress**: `true` = `null` - -###### IotaMoveVerificationError - -> **IotaMoveVerificationError**: `true` = `null` - -###### MovePrimitiveRuntimeError - -> **MovePrimitiveRuntimeError**: `null` \| `object` - -###### MoveAbort - -> **MoveAbort**: [`object`, `string`] - -###### VMVerificationOrDeserializationError - -> **VMVerificationOrDeserializationError**: `true` = `null` - -###### VMInvariantViolation - -> **VMInvariantViolation**: `true` = `null` - -###### FunctionNotFound - -> **FunctionNotFound**: `true` = `null` - -###### ArityMismatch - -> **ArityMismatch**: `true` = `null` - -###### TypeArityMismatch - -> **TypeArityMismatch**: `true` = `null` - -###### NonEntryFunctionInvoked - -> **NonEntryFunctionInvoked**: `true` = `null` - -###### CommandArgumentError - -> **CommandArgumentError**: `object` - -###### CommandArgumentError.argIdx - -> **argIdx**: `number` - -###### CommandArgumentError.kind - -> **kind**: `EnumOutputShapeWithKeys`\<..., ...\> = `CommandArgumentError` - -###### TypeArgumentError - -> **TypeArgumentError**: `object` - -###### TypeArgumentError.argumentIdx - -> **argumentIdx**: `number` - -###### TypeArgumentError.kind - -> **kind**: `EnumOutputShapeWithKeys`\<..., ...\> = `TypeArgumentError` - -###### UnusedValueWithoutDrop - -> **UnusedValueWithoutDrop**: `object` - -###### UnusedValueWithoutDrop.resultIdx - -> **resultIdx**: `number` - -###### UnusedValueWithoutDrop.secondaryIdx - -> **secondaryIdx**: `number` - -###### InvalidPublicFunctionReturnType - -> **InvalidPublicFunctionReturnType**: `object` - -###### InvalidPublicFunctionReturnType.idx - -> **idx**: `number` - -###### InvalidTransferObject - -> **InvalidTransferObject**: `true` = `null` - -###### EffectsTooLarge - -> **EffectsTooLarge**: `object` - -###### EffectsTooLarge.currentSize - -> **currentSize**: `string` - -###### EffectsTooLarge.maxSize - -> **maxSize**: `string` - -###### PublishUpgradeMissingDependency - -> **PublishUpgradeMissingDependency**: `true` = `null` - -###### PublishUpgradeDependencyDowngrade - -> **PublishUpgradeDependencyDowngrade**: `true` = `null` - -###### PackageUpgradeError - -> **PackageUpgradeError**: `object` - -###### PackageUpgradeError.upgradeError - -> **upgradeError**: `EnumOutputShapeWithKeys`\<..., ...\> = `PackageUpgradeError` - -###### WrittenObjectsTooLarge - -> **WrittenObjectsTooLarge**: `object` - -###### WrittenObjectsTooLarge.currentSize - -> **currentSize**: `string` - -###### WrittenObjectsTooLarge.maxSize - -> **maxSize**: `string` - -###### CertificateDenied - -> **CertificateDenied**: `true` = `null` - -###### IotaMoveVerificationTimedout - -> **IotaMoveVerificationTimedout**: `true` = `null` - -###### SharedObjectOperationNotAllowed - -> **SharedObjectOperationNotAllowed**: `true` = `null` - -###### InputObjectDeleted - -> **InputObjectDeleted**: `true` = `null` - -###### Failed.command - -> **command**: `null` \| `string` - -##### V1.executedEpoch - -> **executedEpoch**: `string` - -##### V1.gasUsed - -> **gasUsed**: `object` = `GasCostSummary` - -##### V1.gasUsed.computationCost - -> **computationCost**: `string` - -##### V1.gasUsed.computationCostBurned - -> **computationCostBurned**: `string` - -##### V1.gasUsed.storageCost - -> **storageCost**: `string` - -##### V1.gasUsed.storageRebate - -> **storageRebate**: `string` - -##### V1.gasUsed.nonRefundableStorageFee - -> **nonRefundableStorageFee**: `string` - -##### V1.transactionDigest - -> **transactionDigest**: `string` = `ObjectDigest` - -##### V1.gasObjectIndex - -> **gasObjectIndex**: `null` \| `number` - -##### V1.eventsDigest - -> **eventsDigest**: `null` \| `string` - -##### V1.dependencies - -> **dependencies**: `string`[] - -##### V1.lamportVersion - -> **lamportVersion**: `string` - -##### V1.changedObjects - -> **changedObjects**: [`string`, `object`][] - -##### V1.unchangedSharedObjects - -> **unchangedSharedObjects**: [`string`, `EnumOutputShapeWithKeys`\<`object`, `"ReadOnlyRoot"` \| `"MutateDeleted"` \| `"ReadDeleted"` \| `"Cancelled"` \| `"PerEpochConfig"`\>][] - -##### V1.auxDataDigest - -> **auxDataDigest**: `null` \| `string` diff --git a/docs/content/ts-sdk/api/client/classes/IotaClient.md b/docs/content/ts-sdk/api/client/classes/IotaClient.md deleted file mode 100644 index 11b535deb8f..00000000000 --- a/docs/content/ts-sdk/api/client/classes/IotaClient.md +++ /dev/null @@ -1,817 +0,0 @@ -# Class: IotaClient - -## Constructors - -### new IotaClient() - -> **new IotaClient**(`options`): [`IotaClient`](IotaClient.md) - -Establish a connection to an IOTA RPC endpoint - -#### Parameters - -• **options**: `NetworkOrTransport` - -configuration options for the API Client - -#### Returns - -[`IotaClient`](IotaClient.md) - -## Properties - -### transport - -> `protected` **transport**: [`IotaTransport`](../interfaces/IotaTransport.md) - -## Methods - -### getRpcApiVersion() - -> **getRpcApiVersion**(): `Promise`\<`undefined` \| `string`\> - -#### Returns - -`Promise`\<`undefined` \| `string`\> - ---- - -### getCoins() - -> **getCoins**(`input`): `Promise`\<[`PaginatedCoins`](../interfaces/PaginatedCoins.md)\> - -Get all Coin<`coin_type`> objects owned by an address. - -#### Parameters - -• **input**: [`GetCoinsParams`](../interfaces/GetCoinsParams.md) - -#### Returns - -`Promise`\<[`PaginatedCoins`](../interfaces/PaginatedCoins.md)\> - ---- - -### getAllCoins() - -> **getAllCoins**(`input`): `Promise`\<[`PaginatedCoins`](../interfaces/PaginatedCoins.md)\> - -Get all Coin objects owned by an address. - -#### Parameters - -• **input**: [`GetAllCoinsParams`](../interfaces/GetAllCoinsParams.md) - -#### Returns - -`Promise`\<[`PaginatedCoins`](../interfaces/PaginatedCoins.md)\> - ---- - -### getBalance() - -> **getBalance**(`input`): `Promise`\<[`CoinBalance`](../type-aliases/CoinBalance.md)\> - -Get the total coin balance for one coin type, owned by the address owner. - -#### Parameters - -• **input**: [`GetBalanceParams`](../interfaces/GetBalanceParams.md) - -#### Returns - -`Promise`\<[`CoinBalance`](../type-aliases/CoinBalance.md)\> - ---- - -### getAllBalances() - -> **getAllBalances**(`input`): `Promise`\<[`CoinBalance`](../type-aliases/CoinBalance.md)[]\> - -Get the total coin balance for all coin types, owned by the address owner. - -#### Parameters - -• **input**: [`GetAllBalancesParams`](../interfaces/GetAllBalancesParams.md) - -#### Returns - -`Promise`\<[`CoinBalance`](../type-aliases/CoinBalance.md)[]\> - ---- - -### getCoinMetadata() - -> **getCoinMetadata**(`input`): `Promise`\<`null` \| [`CoinMetadata`](../interfaces/CoinMetadata.md)\> - -Fetch CoinMetadata for a given coin type - -#### Parameters - -• **input**: [`GetCoinMetadataParams`](../interfaces/GetCoinMetadataParams.md) - -#### Returns - -`Promise`\<`null` \| [`CoinMetadata`](../interfaces/CoinMetadata.md)\> - ---- - -### getTotalSupply() - -> **getTotalSupply**(`input`): `Promise`\<[`CoinSupply`](../interfaces/CoinSupply.md)\> - -Fetch total supply for a coin - -#### Parameters - -• **input**: [`GetTotalSupplyParams`](../interfaces/GetTotalSupplyParams.md) - -#### Returns - -`Promise`\<[`CoinSupply`](../interfaces/CoinSupply.md)\> - ---- - -### call() - -> **call**\<`T`\>(`method`, `params`): `Promise`\<`T`\> - -Invoke any RPC method - -#### Type Parameters - -• **T** = `unknown` - -#### Parameters - -• **method**: `string` - -the method to be invoked - -• **params**: `unknown`[] - -#### Returns - -`Promise`\<`T`\> - ---- - -### getMoveFunctionArgTypes() - -> **getMoveFunctionArgTypes**(`input`): `Promise`\<[`IotaMoveFunctionArgType`](../type-aliases/IotaMoveFunctionArgType.md)[]\> - -Get Move function argument types like read, write and full access - -#### Parameters - -• **input**: [`GetMoveFunctionArgTypesParams`](../interfaces/GetMoveFunctionArgTypesParams.md) - -#### Returns - -`Promise`\<[`IotaMoveFunctionArgType`](../type-aliases/IotaMoveFunctionArgType.md)[]\> - ---- - -### getNormalizedMoveModulesByPackage() - -> **getNormalizedMoveModulesByPackage**(`input`): `Promise`\<[`IotaMoveNormalizedModules`](../type-aliases/IotaMoveNormalizedModules.md)\> - -Get a map from module name to -structured representations of Move modules - -#### Parameters - -• **input**: [`GetNormalizedMoveModulesByPackageParams`](../interfaces/GetNormalizedMoveModulesByPackageParams.md) - -#### Returns - -`Promise`\<[`IotaMoveNormalizedModules`](../type-aliases/IotaMoveNormalizedModules.md)\> - ---- - -### getNormalizedMoveModule() - -> **getNormalizedMoveModule**(`input`): `Promise`\<[`IotaMoveNormalizedModule`](../interfaces/IotaMoveNormalizedModule.md)\> - -Get a structured representation of Move module - -#### Parameters - -• **input**: [`GetNormalizedMoveModuleParams`](../interfaces/GetNormalizedMoveModuleParams.md) - -#### Returns - -`Promise`\<[`IotaMoveNormalizedModule`](../interfaces/IotaMoveNormalizedModule.md)\> - ---- - -### getNormalizedMoveFunction() - -> **getNormalizedMoveFunction**(`input`): `Promise`\<[`IotaMoveNormalizedFunction`](../interfaces/IotaMoveNormalizedFunction.md)\> - -Get a structured representation of Move function - -#### Parameters - -• **input**: [`GetNormalizedMoveFunctionParams`](../interfaces/GetNormalizedMoveFunctionParams.md) - -#### Returns - -`Promise`\<[`IotaMoveNormalizedFunction`](../interfaces/IotaMoveNormalizedFunction.md)\> - ---- - -### getNormalizedMoveStruct() - -> **getNormalizedMoveStruct**(`input`): `Promise`\<[`IotaMoveNormalizedStruct`](../interfaces/IotaMoveNormalizedStruct.md)\> - -Get a structured representation of Move struct - -#### Parameters - -• **input**: [`GetNormalizedMoveStructParams`](../interfaces/GetNormalizedMoveStructParams.md) - -#### Returns - -`Promise`\<[`IotaMoveNormalizedStruct`](../interfaces/IotaMoveNormalizedStruct.md)\> - ---- - -### getOwnedObjects() - -> **getOwnedObjects**(`input`): `Promise`\<[`PaginatedObjectsResponse`](../interfaces/PaginatedObjectsResponse.md)\> - -Get all objects owned by an address - -#### Parameters - -• **input**: [`GetOwnedObjectsParams`](../type-aliases/GetOwnedObjectsParams.md) - -#### Returns - -`Promise`\<[`PaginatedObjectsResponse`](../interfaces/PaginatedObjectsResponse.md)\> - ---- - -### getObject() - -> **getObject**(`input`): `Promise`\<[`IotaObjectResponse`](../interfaces/IotaObjectResponse.md)\> - -Get details about an object - -#### Parameters - -• **input**: [`GetObjectParams`](../interfaces/GetObjectParams.md) - -#### Returns - -`Promise`\<[`IotaObjectResponse`](../interfaces/IotaObjectResponse.md)\> - ---- - -### tryGetPastObject() - -> **tryGetPastObject**(`input`): `Promise`\<[`ObjectRead`](../type-aliases/ObjectRead.md)\> - -#### Parameters - -• **input**: [`TryGetPastObjectParams`](../interfaces/TryGetPastObjectParams.md) - -#### Returns - -`Promise`\<[`ObjectRead`](../type-aliases/ObjectRead.md)\> - ---- - -### multiGetObjects() - -> **multiGetObjects**(`input`): `Promise`\<[`IotaObjectResponse`](../interfaces/IotaObjectResponse.md)[]\> - -Batch get details about a list of objects. If any of the object ids are duplicates the call will fail - -#### Parameters - -• **input**: [`MultiGetObjectsParams`](../interfaces/MultiGetObjectsParams.md) - -#### Returns - -`Promise`\<[`IotaObjectResponse`](../interfaces/IotaObjectResponse.md)[]\> - ---- - -### queryTransactionBlocks() - -> **queryTransactionBlocks**(`input`): `Promise`\<[`PaginatedTransactionResponse`](../interfaces/PaginatedTransactionResponse.md)\> - -Get transaction blocks for a given query criteria - -#### Parameters - -• **input**: [`QueryTransactionBlocksParams`](../type-aliases/QueryTransactionBlocksParams.md) - -#### Returns - -`Promise`\<[`PaginatedTransactionResponse`](../interfaces/PaginatedTransactionResponse.md)\> - ---- - -### getTransactionBlock() - -> **getTransactionBlock**(`input`): `Promise`\<[`IotaTransactionBlockResponse`](../interfaces/IotaTransactionBlockResponse.md)\> - -#### Parameters - -• **input**: [`GetTransactionBlockParams`](../interfaces/GetTransactionBlockParams.md) - -#### Returns - -`Promise`\<[`IotaTransactionBlockResponse`](../interfaces/IotaTransactionBlockResponse.md)\> - ---- - -### multiGetTransactionBlocks() - -> **multiGetTransactionBlocks**(`input`): `Promise`\<[`IotaTransactionBlockResponse`](../interfaces/IotaTransactionBlockResponse.md)[]\> - -#### Parameters - -• **input**: [`MultiGetTransactionBlocksParams`](../interfaces/MultiGetTransactionBlocksParams.md) - -#### Returns - -`Promise`\<[`IotaTransactionBlockResponse`](../interfaces/IotaTransactionBlockResponse.md)[]\> - ---- - -### executeTransactionBlock() - -> **executeTransactionBlock**(`__namedParameters`): `Promise`\<[`IotaTransactionBlockResponse`](../interfaces/IotaTransactionBlockResponse.md)\> - -#### Parameters - -• **\_\_namedParameters**: [`ExecuteTransactionBlockParams`](../interfaces/ExecuteTransactionBlockParams.md) - -#### Returns - -`Promise`\<[`IotaTransactionBlockResponse`](../interfaces/IotaTransactionBlockResponse.md)\> - ---- - -### signAndExecuteTransaction() - -> **signAndExecuteTransaction**(`__namedParameters`): `Promise`\<[`IotaTransactionBlockResponse`](../interfaces/IotaTransactionBlockResponse.md)\> - -#### Parameters - -• **\_\_namedParameters**: `object` & `Omit`\<[`ExecuteTransactionBlockParams`](../interfaces/ExecuteTransactionBlockParams.md), `"signature"` \| `"transactionBlock"`\> - -#### Returns - -`Promise`\<[`IotaTransactionBlockResponse`](../interfaces/IotaTransactionBlockResponse.md)\> - ---- - -### getTotalTransactionBlocks() - -> **getTotalTransactionBlocks**(): `Promise`\<`bigint`\> - -Get total number of transactions - -#### Returns - -`Promise`\<`bigint`\> - ---- - -### getReferenceGasPrice() - -> **getReferenceGasPrice**(): `Promise`\<`bigint`\> - -Getting the reference gas price for the network - -#### Returns - -`Promise`\<`bigint`\> - ---- - -### getStakes() - -> **getStakes**(`input`): `Promise`\<[`DelegatedStake`](../interfaces/DelegatedStake.md)[]\> - -Return the delegated stakes for an address - -#### Parameters - -• **input**: [`GetStakesParams`](../interfaces/GetStakesParams.md) - -#### Returns - -`Promise`\<[`DelegatedStake`](../interfaces/DelegatedStake.md)[]\> - ---- - -### getTimelockedStakes() - -> **getTimelockedStakes**(`input`): `Promise`\<[`DelegatedTimelockedStake`](../interfaces/DelegatedTimelockedStake.md)[]\> - -Return the timelocked delegated stakes for an address - -#### Parameters - -• **input**: [`GetTimelockedStakesParams`](../interfaces/GetTimelockedStakesParams.md) - -#### Returns - -`Promise`\<[`DelegatedTimelockedStake`](../interfaces/DelegatedTimelockedStake.md)[]\> - ---- - -### getStakesByIds() - -> **getStakesByIds**(`input`): `Promise`\<[`DelegatedStake`](../interfaces/DelegatedStake.md)[]\> - -Return the delegated stakes queried by id. - -#### Parameters - -• **input**: [`GetStakesByIdsParams`](../interfaces/GetStakesByIdsParams.md) - -#### Returns - -`Promise`\<[`DelegatedStake`](../interfaces/DelegatedStake.md)[]\> - ---- - -### getTimelockedStakesByIds() - -> **getTimelockedStakesByIds**(`input`): `Promise`\<[`DelegatedTimelockedStake`](../interfaces/DelegatedTimelockedStake.md)[]\> - -Return the timelocked delegated stakes queried by id. - -#### Parameters - -• **input**: [`GetTimelockedStakesByIdsParams`](../interfaces/GetTimelockedStakesByIdsParams.md) - -#### Returns - -`Promise`\<[`DelegatedTimelockedStake`](../interfaces/DelegatedTimelockedStake.md)[]\> - ---- - -### getLatestIotaSystemState() - -> **getLatestIotaSystemState**(): `Promise`\<[`IotaSystemStateSummary`](../interfaces/IotaSystemStateSummary.md)\> - -Return the latest system state content. - -#### Returns - -`Promise`\<[`IotaSystemStateSummary`](../interfaces/IotaSystemStateSummary.md)\> - ---- - -### queryEvents() - -> **queryEvents**(`input`): `Promise`\<[`PaginatedEvents`](../interfaces/PaginatedEvents.md)\> - -Get events for a given query criteria - -#### Parameters - -• **input**: [`QueryEventsParams`](../interfaces/QueryEventsParams.md) - -#### Returns - -`Promise`\<[`PaginatedEvents`](../interfaces/PaginatedEvents.md)\> - ---- - -### ~~subscribeEvent()~~ - -> **subscribeEvent**(`input`): `Promise`\<[`Unsubscribe`](../type-aliases/Unsubscribe.md)\> - -Subscribe to get notifications whenever an event matching the filter occurs - -#### Parameters - -• **input**: [`SubscribeEventParams`](../interfaces/SubscribeEventParams.md) & `object` - -#### Returns - -`Promise`\<[`Unsubscribe`](../type-aliases/Unsubscribe.md)\> - -#### Deprecated - ---- - -### ~~subscribeTransaction()~~ - -> **subscribeTransaction**(`input`): `Promise`\<[`Unsubscribe`](../type-aliases/Unsubscribe.md)\> - -#### Parameters - -• **input**: [`SubscribeTransactionParams`](../interfaces/SubscribeTransactionParams.md) & `object` - -#### Returns - -`Promise`\<[`Unsubscribe`](../type-aliases/Unsubscribe.md)\> - -#### Deprecated - ---- - -### devInspectTransactionBlock() - -> **devInspectTransactionBlock**(`input`): `Promise`\<[`DevInspectResults`](../interfaces/DevInspectResults.md)\> - -Runs the transaction block in dev-inspect mode. Which allows for nearly any -transaction (or Move call) with any arguments. Detailed results are -provided, including both the transaction effects and any return values. - -#### Parameters - -• **input**: [`DevInspectTransactionBlockParams`](../interfaces/DevInspectTransactionBlockParams.md) - -#### Returns - -`Promise`\<[`DevInspectResults`](../interfaces/DevInspectResults.md)\> - ---- - -### dryRunTransactionBlock() - -> **dryRunTransactionBlock**(`input`): `Promise`\<[`DryRunTransactionBlockResponse`](../interfaces/DryRunTransactionBlockResponse.md)\> - -Dry run a transaction block and return the result. - -#### Parameters - -• **input**: [`DryRunTransactionBlockParams`](../interfaces/DryRunTransactionBlockParams.md) - -#### Returns - -`Promise`\<[`DryRunTransactionBlockResponse`](../interfaces/DryRunTransactionBlockResponse.md)\> - ---- - -### getDynamicFields() - -> **getDynamicFields**(`input`): `Promise`\<[`DynamicFieldPage`](../type-aliases/DynamicFieldPage.md)\> - -Return the list of dynamic field objects owned by an object - -#### Parameters - -• **input**: [`GetDynamicFieldsParams`](../interfaces/GetDynamicFieldsParams.md) - -#### Returns - -`Promise`\<[`DynamicFieldPage`](../type-aliases/DynamicFieldPage.md)\> - ---- - -### getDynamicFieldObject() - -> **getDynamicFieldObject**(`input`): `Promise`\<[`IotaObjectResponse`](../interfaces/IotaObjectResponse.md)\> - -Return the dynamic field object information for a specified object - -#### Parameters - -• **input**: [`GetDynamicFieldObjectParams`](../interfaces/GetDynamicFieldObjectParams.md) - -#### Returns - -`Promise`\<[`IotaObjectResponse`](../interfaces/IotaObjectResponse.md)\> - ---- - -### getLatestCheckpointSequenceNumber() - -> **getLatestCheckpointSequenceNumber**(): `Promise`\<`string`\> - -Get the sequence number of the latest checkpoint that has been executed - -#### Returns - -`Promise`\<`string`\> - ---- - -### getCheckpoint() - -> **getCheckpoint**(`input`): `Promise`\<[`Checkpoint`](../interfaces/Checkpoint.md)\> - -Returns information about a given checkpoint - -#### Parameters - -• **input**: [`GetCheckpointParams`](../interfaces/GetCheckpointParams.md) - -#### Returns - -`Promise`\<[`Checkpoint`](../interfaces/Checkpoint.md)\> - ---- - -### getCheckpoints() - -> **getCheckpoints**(`input`): `Promise`\<[`CheckpointPage`](../type-aliases/CheckpointPage.md)\> - -Returns historical checkpoints paginated - -#### Parameters - -• **input**: [`PaginationArguments`](../interfaces/PaginationArguments.md)\<`null` \| `string`\> & [`GetCheckpointsParams`](../interfaces/GetCheckpointsParams.md) - -#### Returns - -`Promise`\<[`CheckpointPage`](../type-aliases/CheckpointPage.md)\> - ---- - -### getCommitteeInfo() - -> **getCommitteeInfo**(`input`?): `Promise`\<[`CommitteeInfo`](../interfaces/CommitteeInfo.md)\> - -Return the committee information for the asked epoch - -#### Parameters - -• **input?**: [`GetCommitteeInfoParams`](../interfaces/GetCommitteeInfoParams.md) - -#### Returns - -`Promise`\<[`CommitteeInfo`](../interfaces/CommitteeInfo.md)\> - ---- - -### getNetworkMetrics() - -> **getNetworkMetrics**(): `Promise`\<[`NetworkMetrics`](../interfaces/NetworkMetrics.md)\> - -#### Returns - -`Promise`\<[`NetworkMetrics`](../interfaces/NetworkMetrics.md)\> - ---- - -### getAddressMetrics() - -> **getAddressMetrics**(): `Promise`\<[`AddressMetrics`](../interfaces/AddressMetrics.md)\> - -#### Returns - -`Promise`\<[`AddressMetrics`](../interfaces/AddressMetrics.md)\> - ---- - -### getEpochMetrics() - -> **getEpochMetrics**(`input`?): `Promise`\<[`EpochMetricsPage`](../type-aliases/EpochMetricsPage.md)\> - -#### Parameters - -• **input?**: `object` & [`PaginationArguments`](../interfaces/PaginationArguments.md)\<`null` \| `string`\> - -#### Returns - -`Promise`\<[`EpochMetricsPage`](../type-aliases/EpochMetricsPage.md)\> - ---- - -### getAllEpochAddressMetrics() - -> **getAllEpochAddressMetrics**(`input`?): `Promise`\<[`AllEpochsAddressMetrics`](../type-aliases/AllEpochsAddressMetrics.md)\> - -#### Parameters - -• **input?** - -• **input.descendingOrder?**: `boolean` - -#### Returns - -`Promise`\<[`AllEpochsAddressMetrics`](../type-aliases/AllEpochsAddressMetrics.md)\> - ---- - -### getCheckpointAddressMetrics() - -> **getCheckpointAddressMetrics**(`input`?): `Promise`\<[`AddressMetrics`](../interfaces/AddressMetrics.md)\> - -#### Parameters - -• **input?** - -• **input.checkpoint?**: `string` - -#### Returns - -`Promise`\<[`AddressMetrics`](../interfaces/AddressMetrics.md)\> - ---- - -### getEpochs() - -> **getEpochs**(`input`?): `Promise`\<[`EpochPage`](../type-aliases/EpochPage.md)\> - -Return the committee information for the asked epoch - -#### Parameters - -• **input?**: `object` & [`PaginationArguments`](../interfaces/PaginationArguments.md)\<`null` \| `string`\> - -#### Returns - -`Promise`\<[`EpochPage`](../type-aliases/EpochPage.md)\> - ---- - -### getMoveCallMetrics() - -> **getMoveCallMetrics**(): `Promise`\<[`MoveCallMetrics`](../interfaces/MoveCallMetrics.md)\> - -Returns list of top move calls by usage - -#### Returns - -`Promise`\<[`MoveCallMetrics`](../interfaces/MoveCallMetrics.md)\> - ---- - -### getCurrentEpoch() - -> **getCurrentEpoch**(): `Promise`\<[`EpochInfo`](../interfaces/EpochInfo.md)\> - -Return the committee information for the asked epoch - -#### Returns - -`Promise`\<[`EpochInfo`](../interfaces/EpochInfo.md)\> - ---- - -### getTotalTransactions() - -> **getTotalTransactions**(): `Promise`\<`string`\> - -#### Returns - -`Promise`\<`string`\> - ---- - -### getValidatorsApy() - -> **getValidatorsApy**(): `Promise`\<[`ValidatorsApy`](../interfaces/ValidatorsApy.md)\> - -Return the Validators APYs - -#### Returns - -`Promise`\<[`ValidatorsApy`](../interfaces/ValidatorsApy.md)\> - ---- - -### getChainIdentifier() - -> **getChainIdentifier**(): `Promise`\<`string`\> - -#### Returns - -`Promise`\<`string`\> - ---- - -### getProtocolConfig() - -> **getProtocolConfig**(`input`?): `Promise`\<[`ProtocolConfig`](../interfaces/ProtocolConfig.md)\> - -#### Parameters - -• **input?**: [`GetProtocolConfigParams`](../interfaces/GetProtocolConfigParams.md) - -#### Returns - -`Promise`\<[`ProtocolConfig`](../interfaces/ProtocolConfig.md)\> - ---- - -### waitForTransaction() - -> **waitForTransaction**(`__namedParameters`): `Promise`\<[`IotaTransactionBlockResponse`](../interfaces/IotaTransactionBlockResponse.md)\> - -Wait for a transaction block result to be available over the API. -This can be used in conjunction with `executeTransactionBlock` to wait for the transaction to -be available via the API. -This currently polls the `getTransactionBlock` API to check for the transaction. - -#### Parameters - -• **\_\_namedParameters**: `object` & [`GetTransactionBlockParams`](../interfaces/GetTransactionBlockParams.md) - -#### Returns - -`Promise`\<[`IotaTransactionBlockResponse`](../interfaces/IotaTransactionBlockResponse.md)\> diff --git a/docs/content/ts-sdk/api/client/classes/IotaHTTPStatusError.md b/docs/content/ts-sdk/api/client/classes/IotaHTTPStatusError.md deleted file mode 100644 index a8bff3d074e..00000000000 --- a/docs/content/ts-sdk/api/client/classes/IotaHTTPStatusError.md +++ /dev/null @@ -1,137 +0,0 @@ -# Class: IotaHTTPStatusError - -## Extends - -- [`IotaHTTPTransportError`](IotaHTTPTransportError.md) - -## Constructors - -### new IotaHTTPStatusError() - -> **new IotaHTTPStatusError**(`message`, `status`, `statusText`): [`IotaHTTPStatusError`](IotaHTTPStatusError.md) - -#### Parameters - -• **message**: `string` - -• **status**: `number` - -• **statusText**: `string` - -#### Returns - -[`IotaHTTPStatusError`](IotaHTTPStatusError.md) - -#### Overrides - -[`IotaHTTPTransportError`](IotaHTTPTransportError.md).[`constructor`](IotaHTTPTransportError.md#constructors) - -## Properties - -### prepareStackTrace()? - -> `static` `optional` **prepareStackTrace**: (`err`, `stackTraces`) => `any` - -Optional override for formatting stack traces - -#### Parameters - -• **err**: `Error` - -• **stackTraces**: `CallSite`[] - -#### Returns - -`any` - -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - -#### Inherited from - -[`IotaHTTPTransportError`](IotaHTTPTransportError.md).[`prepareStackTrace`](IotaHTTPTransportError.md#preparestacktrace) - ---- - -### stackTraceLimit - -> `static` **stackTraceLimit**: `number` - -#### Inherited from - -[`IotaHTTPTransportError`](IotaHTTPTransportError.md).[`stackTraceLimit`](IotaHTTPTransportError.md#stacktracelimit) - ---- - -### cause? - -> `optional` **cause**: `unknown` - -#### Inherited from - -[`IotaHTTPTransportError`](IotaHTTPTransportError.md).[`cause`](IotaHTTPTransportError.md#cause) - ---- - -### name - -> **name**: `string` - -#### Inherited from - -[`IotaHTTPTransportError`](IotaHTTPTransportError.md).[`name`](IotaHTTPTransportError.md#name) - ---- - -### message - -> **message**: `string` - -#### Inherited from - -[`IotaHTTPTransportError`](IotaHTTPTransportError.md).[`message`](IotaHTTPTransportError.md#message) - ---- - -### stack? - -> `optional` **stack**: `string` - -#### Inherited from - -[`IotaHTTPTransportError`](IotaHTTPTransportError.md).[`stack`](IotaHTTPTransportError.md#stack) - ---- - -### status - -> **status**: `number` - ---- - -### statusText - -> **statusText**: `string` - -## Methods - -### captureStackTrace() - -> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` - -Create .stack property on a target object - -#### Parameters - -• **targetObject**: `object` - -• **constructorOpt?**: `Function` - -#### Returns - -`void` - -#### Inherited from - -[`IotaHTTPTransportError`](IotaHTTPTransportError.md).[`captureStackTrace`](IotaHTTPTransportError.md#capturestacktrace) diff --git a/docs/content/ts-sdk/api/client/classes/IotaHTTPTransport.md b/docs/content/ts-sdk/api/client/classes/IotaHTTPTransport.md deleted file mode 100644 index cf9231e1c32..00000000000 --- a/docs/content/ts-sdk/api/client/classes/IotaHTTPTransport.md +++ /dev/null @@ -1,79 +0,0 @@ -# Class: IotaHTTPTransport - -## Implements - -- [`IotaTransport`](../interfaces/IotaTransport.md) - -## Constructors - -### new IotaHTTPTransport() - -> **new IotaHTTPTransport**(`options`): [`IotaHTTPTransport`](IotaHTTPTransport.md) - -#### Parameters - -• **options**: [`IotaHTTPTransportOptions`](../interfaces/IotaHTTPTransportOptions.md) - -#### Returns - -[`IotaHTTPTransport`](IotaHTTPTransport.md) - -## Methods - -### fetch() - -> **fetch**(`input`, `init`?): `Promise`\<`Response`\> - -#### Parameters - -• **input**: `RequestInfo` - -• **init?**: `RequestInit` - -#### Returns - -`Promise`\<`Response`\> - ---- - -### request() - -> **request**\<`T`\>(`input`): `Promise`\<`T`\> - -#### Type Parameters - -• **T** - -#### Parameters - -• **input**: [`IotaTransportRequestOptions`](../interfaces/IotaTransportRequestOptions.md) - -#### Returns - -`Promise`\<`T`\> - -#### Implementation of - -[`IotaTransport`](../interfaces/IotaTransport.md).[`request`](../interfaces/IotaTransport.md#request) - ---- - -### subscribe() - -> **subscribe**\<`T`\>(`input`): `Promise`\<() => `Promise`\<`boolean`\>\> - -#### Type Parameters - -• **T** - -#### Parameters - -• **input**: [`IotaTransportSubscribeOptions`](../interfaces/IotaTransportSubscribeOptions.md)\<`T`\> - -#### Returns - -`Promise`\<() => `Promise`\<`boolean`\>\> - -#### Implementation of - -[`IotaTransport`](../interfaces/IotaTransport.md).[`subscribe`](../interfaces/IotaTransport.md#subscribe) diff --git a/docs/content/ts-sdk/api/client/classes/IotaHTTPTransportError.md b/docs/content/ts-sdk/api/client/classes/IotaHTTPTransportError.md deleted file mode 100644 index 8b7b5540534..00000000000 --- a/docs/content/ts-sdk/api/client/classes/IotaHTTPTransportError.md +++ /dev/null @@ -1,144 +0,0 @@ -# Class: IotaHTTPTransportError - -## Extends - -- `Error` - -## Extended by - -- [`IotaHTTPStatusError`](IotaHTTPStatusError.md) -- [`JsonRpcError`](JsonRpcError.md) - -## Constructors - -### new IotaHTTPTransportError() - -> **new IotaHTTPTransportError**(`message`?): [`IotaHTTPTransportError`](IotaHTTPTransportError.md) - -#### Parameters - -• **message?**: `string` - -#### Returns - -[`IotaHTTPTransportError`](IotaHTTPTransportError.md) - -#### Inherited from - -`Error.constructor` - -### new IotaHTTPTransportError() - -> **new IotaHTTPTransportError**(`message`?, `options`?): [`IotaHTTPTransportError`](IotaHTTPTransportError.md) - -#### Parameters - -• **message?**: `string` - -• **options?**: `ErrorOptions` - -#### Returns - -[`IotaHTTPTransportError`](IotaHTTPTransportError.md) - -#### Inherited from - -`Error.constructor` - -## Properties - -### prepareStackTrace()? - -> `static` `optional` **prepareStackTrace**: (`err`, `stackTraces`) => `any` - -Optional override for formatting stack traces - -#### Parameters - -• **err**: `Error` - -• **stackTraces**: `CallSite`[] - -#### Returns - -`any` - -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - -#### Inherited from - -`Error.prepareStackTrace` - ---- - -### stackTraceLimit - -> `static` **stackTraceLimit**: `number` - -#### Inherited from - -`Error.stackTraceLimit` - ---- - -### cause? - -> `optional` **cause**: `unknown` - -#### Inherited from - -`Error.cause` - ---- - -### name - -> **name**: `string` - -#### Inherited from - -`Error.name` - ---- - -### message - -> **message**: `string` - -#### Inherited from - -`Error.message` - ---- - -### stack? - -> `optional` **stack**: `string` - -#### Inherited from - -`Error.stack` - -## Methods - -### captureStackTrace() - -> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` - -Create .stack property on a target object - -#### Parameters - -• **targetObject**: `object` - -• **constructorOpt?**: `Function` - -#### Returns - -`void` - -#### Inherited from - -`Error.captureStackTrace` diff --git a/docs/content/ts-sdk/api/client/classes/JsonRpcError.md b/docs/content/ts-sdk/api/client/classes/JsonRpcError.md deleted file mode 100644 index c8f021e7b97..00000000000 --- a/docs/content/ts-sdk/api/client/classes/JsonRpcError.md +++ /dev/null @@ -1,135 +0,0 @@ -# Class: JsonRpcError - -## Extends - -- [`IotaHTTPTransportError`](IotaHTTPTransportError.md) - -## Constructors - -### new JsonRpcError() - -> **new JsonRpcError**(`message`, `code`): [`JsonRpcError`](JsonRpcError.md) - -#### Parameters - -• **message**: `string` - -• **code**: `number` - -#### Returns - -[`JsonRpcError`](JsonRpcError.md) - -#### Overrides - -[`IotaHTTPTransportError`](IotaHTTPTransportError.md).[`constructor`](IotaHTTPTransportError.md#constructors) - -## Properties - -### prepareStackTrace()? - -> `static` `optional` **prepareStackTrace**: (`err`, `stackTraces`) => `any` - -Optional override for formatting stack traces - -#### Parameters - -• **err**: `Error` - -• **stackTraces**: `CallSite`[] - -#### Returns - -`any` - -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - -#### Inherited from - -[`IotaHTTPTransportError`](IotaHTTPTransportError.md).[`prepareStackTrace`](IotaHTTPTransportError.md#preparestacktrace) - ---- - -### stackTraceLimit - -> `static` **stackTraceLimit**: `number` - -#### Inherited from - -[`IotaHTTPTransportError`](IotaHTTPTransportError.md).[`stackTraceLimit`](IotaHTTPTransportError.md#stacktracelimit) - ---- - -### cause? - -> `optional` **cause**: `unknown` - -#### Inherited from - -[`IotaHTTPTransportError`](IotaHTTPTransportError.md).[`cause`](IotaHTTPTransportError.md#cause) - ---- - -### name - -> **name**: `string` - -#### Inherited from - -[`IotaHTTPTransportError`](IotaHTTPTransportError.md).[`name`](IotaHTTPTransportError.md#name) - ---- - -### message - -> **message**: `string` - -#### Inherited from - -[`IotaHTTPTransportError`](IotaHTTPTransportError.md).[`message`](IotaHTTPTransportError.md#message) - ---- - -### stack? - -> `optional` **stack**: `string` - -#### Inherited from - -[`IotaHTTPTransportError`](IotaHTTPTransportError.md).[`stack`](IotaHTTPTransportError.md#stack) - ---- - -### code - -> **code**: `number` - ---- - -### type - -> **type**: `string` - -## Methods - -### captureStackTrace() - -> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` - -Create .stack property on a target object - -#### Parameters - -• **targetObject**: `object` - -• **constructorOpt?**: `Function` - -#### Returns - -`void` - -#### Inherited from - -[`IotaHTTPTransportError`](IotaHTTPTransportError.md).[`captureStackTrace`](IotaHTTPTransportError.md#capturestacktrace) diff --git a/docs/content/ts-sdk/api/client/enumerations/Network.md b/docs/content/ts-sdk/api/client/enumerations/Network.md deleted file mode 100644 index 325fa73d1df..00000000000 --- a/docs/content/ts-sdk/api/client/enumerations/Network.md +++ /dev/null @@ -1,31 +0,0 @@ -# Enumeration: Network - -## Enumeration Members - -### Mainnet - -> **Mainnet**: `"mainnet"` - ---- - -### Devnet - -> **Devnet**: `"devnet"` - ---- - -### Testnet - -> **Testnet**: `"testnet"` - ---- - -### Localnet - -> **Localnet**: `"localnet"` - ---- - -### Custom - -> **Custom**: `"custom"` diff --git a/docs/content/ts-sdk/api/client/functions/getAllNetworks.md b/docs/content/ts-sdk/api/client/functions/getAllNetworks.md deleted file mode 100644 index ed7f0ecf2d8..00000000000 --- a/docs/content/ts-sdk/api/client/functions/getAllNetworks.md +++ /dev/null @@ -1,7 +0,0 @@ -# Function: getAllNetworks() - -> **getAllNetworks**(): `NetworksConfiguration` - -## Returns - -`NetworksConfiguration` diff --git a/docs/content/ts-sdk/api/client/functions/getAppsBackend.md b/docs/content/ts-sdk/api/client/functions/getAppsBackend.md deleted file mode 100644 index 03840c353a8..00000000000 --- a/docs/content/ts-sdk/api/client/functions/getAppsBackend.md +++ /dev/null @@ -1,7 +0,0 @@ -# Function: getAppsBackend() - -> **getAppsBackend**(): `string` - -## Returns - -`string` diff --git a/docs/content/ts-sdk/api/client/functions/getDefaultNetwork.md b/docs/content/ts-sdk/api/client/functions/getDefaultNetwork.md deleted file mode 100644 index 1b58aafd25a..00000000000 --- a/docs/content/ts-sdk/api/client/functions/getDefaultNetwork.md +++ /dev/null @@ -1,7 +0,0 @@ -# Function: getDefaultNetwork() - -> **getDefaultNetwork**(): [`Network`](../enumerations/Network.md) - -## Returns - -[`Network`](../enumerations/Network.md) diff --git a/docs/content/ts-sdk/api/client/functions/getFullnodeUrl.md b/docs/content/ts-sdk/api/client/functions/getFullnodeUrl.md deleted file mode 100644 index 0f385a6fc7e..00000000000 --- a/docs/content/ts-sdk/api/client/functions/getFullnodeUrl.md +++ /dev/null @@ -1,11 +0,0 @@ -# Function: getFullnodeUrl() - -> **getFullnodeUrl**(`network`): `string` - -## Parameters - -• **network**: `string` - -## Returns - -`string` diff --git a/docs/content/ts-sdk/api/client/functions/getNetwork.md b/docs/content/ts-sdk/api/client/functions/getNetwork.md deleted file mode 100644 index 1065cbb419f..00000000000 --- a/docs/content/ts-sdk/api/client/functions/getNetwork.md +++ /dev/null @@ -1,11 +0,0 @@ -# Function: getNetwork() - -> **getNetwork**(`network`): [`NetworkConfiguration`](../interfaces/NetworkConfiguration.md) - -## Parameters - -• **network**: `string` - -## Returns - -[`NetworkConfiguration`](../interfaces/NetworkConfiguration.md) diff --git a/docs/content/ts-sdk/api/client/functions/isIotaClient.md b/docs/content/ts-sdk/api/client/functions/isIotaClient.md deleted file mode 100644 index 5b3f572a1a4..00000000000 --- a/docs/content/ts-sdk/api/client/functions/isIotaClient.md +++ /dev/null @@ -1,11 +0,0 @@ -# Function: isIotaClient() - -> **isIotaClient**(`client`): `client is IotaClient` - -## Parameters - -• **client**: `unknown` - -## Returns - -`client is IotaClient` diff --git a/docs/content/ts-sdk/api/client/index.md b/docs/content/ts-sdk/api/client/index.md deleted file mode 100644 index 33be3f54b19..00000000000 --- a/docs/content/ts-sdk/api/client/index.md +++ /dev/null @@ -1,245 +0,0 @@ -# client - -## Index - -### Enumerations - -- [Network](enumerations/Network.md) - -### Classes - -- [IotaClient](classes/IotaClient.md) -- [IotaHTTPTransportError](classes/IotaHTTPTransportError.md) -- [JsonRpcError](classes/JsonRpcError.md) -- [IotaHTTPStatusError](classes/IotaHTTPStatusError.md) -- [IotaHTTPTransport](classes/IotaHTTPTransport.md) - -### Interfaces - -- [PaginationArguments](interfaces/PaginationArguments.md) -- [OrderArguments](interfaces/OrderArguments.md) -- [IotaHTTPTransportOptions](interfaces/IotaHTTPTransportOptions.md) -- [IotaTransportRequestOptions](interfaces/IotaTransportRequestOptions.md) -- [IotaTransportSubscribeOptions](interfaces/IotaTransportSubscribeOptions.md) -- [IotaTransport](interfaces/IotaTransport.md) -- [NetworkConfiguration](interfaces/NetworkConfiguration.md) -- [KioskConfiguration](interfaces/KioskConfiguration.md) -- [AddressMetrics](interfaces/AddressMetrics.md) -- [Balance](interfaces/Balance.md) -- [BalanceChange](interfaces/BalanceChange.md) -- [Checkpoint](interfaces/Checkpoint.md) -- [Claim](interfaces/Claim.md) -- [CoinStruct](interfaces/CoinStruct.md) -- [CommitteeInfo](interfaces/CommitteeInfo.md) -- [DelegatedStake](interfaces/DelegatedStake.md) -- [DelegatedTimelockedStake](interfaces/DelegatedTimelockedStake.md) -- [DevInspectArgs](interfaces/DevInspectArgs.md) -- [DevInspectResults](interfaces/DevInspectResults.md) -- [DisplayFieldsResponse](interfaces/DisplayFieldsResponse.md) -- [DryRunTransactionBlockResponse](interfaces/DryRunTransactionBlockResponse.md) -- [DynamicFieldInfo](interfaces/DynamicFieldInfo.md) -- [DynamicFieldName](interfaces/DynamicFieldName.md) -- [ECMHLiveObjectSetDigest](interfaces/ECMHLiveObjectSetDigest.md) -- [EndOfEpochData](interfaces/EndOfEpochData.md) -- [EndOfEpochInfo](interfaces/EndOfEpochInfo.md) -- [EpochInfo](interfaces/EpochInfo.md) -- [EpochMetrics](interfaces/EpochMetrics.md) -- [IotaEvent](interfaces/IotaEvent.md) -- [EventId](interfaces/EventId.md) -- [GasCostSummary](interfaces/GasCostSummary.md) -- [IotaGasData](interfaces/IotaGasData.md) -- [GetPastObjectRequest](interfaces/GetPastObjectRequest.md) -- [IotaActiveJwk](interfaces/IotaActiveJwk.md) -- [IotaAuthenticatorStateExpire](interfaces/IotaAuthenticatorStateExpire.md) -- [IotaChangeEpoch](interfaces/IotaChangeEpoch.md) -- [CoinMetadata](interfaces/CoinMetadata.md) -- [IotaExecutionResult](interfaces/IotaExecutionResult.md) -- [IotaJWK](interfaces/IotaJWK.md) -- [IotaJwkId](interfaces/IotaJwkId.md) -- [IotaMoveAbilitySet](interfaces/IotaMoveAbilitySet.md) -- [IotaMoveModuleId](interfaces/IotaMoveModuleId.md) -- [IotaMoveNormalizedField](interfaces/IotaMoveNormalizedField.md) -- [IotaMoveNormalizedFunction](interfaces/IotaMoveNormalizedFunction.md) -- [IotaMoveNormalizedModule](interfaces/IotaMoveNormalizedModule.md) -- [IotaMoveNormalizedStruct](interfaces/IotaMoveNormalizedStruct.md) -- [IotaMoveStructTypeParameter](interfaces/IotaMoveStructTypeParameter.md) -- [IotaObjectResponse](interfaces/IotaObjectResponse.md) -- [MoveCallIotaTransaction](interfaces/MoveCallIotaTransaction.md) -- [IotaSystemStateSummary](interfaces/IotaSystemStateSummary.md) -- [IotaValidatorSummary](interfaces/IotaValidatorSummary.md) -- [MoveCallMetrics](interfaces/MoveCallMetrics.md) -- [MoveCallParams](interfaces/MoveCallParams.md) -- [MoveFunctionName](interfaces/MoveFunctionName.md) -- [MoveVariant](interfaces/MoveVariant.md) -- [MultiSig](interfaces/MultiSig.md) -- [MultiSigPublicKey](interfaces/MultiSigPublicKey.md) -- [NetworkMetrics](interfaces/NetworkMetrics.md) -- [IotaObjectData](interfaces/IotaObjectData.md) -- [IotaObjectDataOptions](interfaces/IotaObjectDataOptions.md) -- [IotaObjectRef](interfaces/IotaObjectRef.md) -- [IotaObjectResponseQuery](interfaces/IotaObjectResponseQuery.md) -- [OwnedObjectRef](interfaces/OwnedObjectRef.md) -- [PaginatedCheckpoints](interfaces/PaginatedCheckpoints.md) -- [PaginatedCoins](interfaces/PaginatedCoins.md) -- [PaginatedDynamicFieldInfos](interfaces/PaginatedDynamicFieldInfos.md) -- [PaginatedEpochInfos](interfaces/PaginatedEpochInfos.md) -- [PaginatedEpochMetricss](interfaces/PaginatedEpochMetricss.md) -- [PaginatedEvents](interfaces/PaginatedEvents.md) -- [PaginatedObjectsResponse](interfaces/PaginatedObjectsResponse.md) -- [PaginatedTransactionResponse](interfaces/PaginatedTransactionResponse.md) -- [PasskeyAuthenticator](interfaces/PasskeyAuthenticator.md) -- [ProtocolConfig](interfaces/ProtocolConfig.md) -- [CoinSupply](interfaces/CoinSupply.md) -- [IotaTransactionBlock](interfaces/IotaTransactionBlock.md) -- [TransactionBlockBytes](interfaces/TransactionBlockBytes.md) -- [TransactionBlockEffectsModifiedAtVersions](interfaces/TransactionBlockEffectsModifiedAtVersions.md) -- [IotaTransactionBlockResponse](interfaces/IotaTransactionBlockResponse.md) -- [IotaTransactionBlockResponseOptions](interfaces/IotaTransactionBlockResponseOptions.md) -- [IotaTransactionBlockResponseQuery](interfaces/IotaTransactionBlockResponseQuery.md) -- [TransferObjectParams](interfaces/TransferObjectParams.md) -- [TypeOrigin](interfaces/TypeOrigin.md) -- [UpgradeInfo](interfaces/UpgradeInfo.md) -- [ValidatorApy](interfaces/ValidatorApy.md) -- [ValidatorsApy](interfaces/ValidatorsApy.md) -- [ZkLoginAuthenticator](interfaces/ZkLoginAuthenticator.md) -- [ZkLoginInputs](interfaces/ZkLoginInputs.md) -- [ZkLoginProof](interfaces/ZkLoginProof.md) -- [DevInspectTransactionBlockParams](interfaces/DevInspectTransactionBlockParams.md) -- [DryRunTransactionBlockParams](interfaces/DryRunTransactionBlockParams.md) -- [ExecuteTransactionBlockParams](interfaces/ExecuteTransactionBlockParams.md) -- [GetChainIdentifierParams](interfaces/GetChainIdentifierParams.md) -- [GetCheckpointParams](interfaces/GetCheckpointParams.md) -- [GetCheckpointsParams](interfaces/GetCheckpointsParams.md) -- [GetEventsParams](interfaces/GetEventsParams.md) -- [GetLatestCheckpointSequenceNumberParams](interfaces/GetLatestCheckpointSequenceNumberParams.md) -- [GetMoveFunctionArgTypesParams](interfaces/GetMoveFunctionArgTypesParams.md) -- [GetNormalizedMoveFunctionParams](interfaces/GetNormalizedMoveFunctionParams.md) -- [GetNormalizedMoveModuleParams](interfaces/GetNormalizedMoveModuleParams.md) -- [GetNormalizedMoveModulesByPackageParams](interfaces/GetNormalizedMoveModulesByPackageParams.md) -- [GetNormalizedMoveStructParams](interfaces/GetNormalizedMoveStructParams.md) -- [GetObjectParams](interfaces/GetObjectParams.md) -- [GetProtocolConfigParams](interfaces/GetProtocolConfigParams.md) -- [GetTotalTransactionBlocksParams](interfaces/GetTotalTransactionBlocksParams.md) -- [GetTransactionBlockParams](interfaces/GetTransactionBlockParams.md) -- [MultiGetObjectsParams](interfaces/MultiGetObjectsParams.md) -- [MultiGetTransactionBlocksParams](interfaces/MultiGetTransactionBlocksParams.md) -- [TryGetPastObjectParams](interfaces/TryGetPastObjectParams.md) -- [TryMultiGetPastObjectsParams](interfaces/TryMultiGetPastObjectsParams.md) -- [GetAllBalancesParams](interfaces/GetAllBalancesParams.md) -- [GetAllCoinsParams](interfaces/GetAllCoinsParams.md) -- [GetAllEpochAddressMetricsParams](interfaces/GetAllEpochAddressMetricsParams.md) -- [GetBalanceParams](interfaces/GetBalanceParams.md) -- [GetCheckpointAddressMetricsParams](interfaces/GetCheckpointAddressMetricsParams.md) -- [GetCoinMetadataParams](interfaces/GetCoinMetadataParams.md) -- [GetCoinsParams](interfaces/GetCoinsParams.md) -- [GetCommitteeInfoParams](interfaces/GetCommitteeInfoParams.md) -- [GetCurrentEpochParams](interfaces/GetCurrentEpochParams.md) -- [GetDynamicFieldObjectParams](interfaces/GetDynamicFieldObjectParams.md) -- [GetDynamicFieldsParams](interfaces/GetDynamicFieldsParams.md) -- [GetEpochMetricsParams](interfaces/GetEpochMetricsParams.md) -- [GetEpochsParams](interfaces/GetEpochsParams.md) -- [GetLatestAddressMetricsParams](interfaces/GetLatestAddressMetricsParams.md) -- [GetLatestIotaSystemStateParams](interfaces/GetLatestIotaSystemStateParams.md) -- [GetMoveCallMetricsParams](interfaces/GetMoveCallMetricsParams.md) -- [GetNetworkMetricsParams](interfaces/GetNetworkMetricsParams.md) -- [GetReferenceGasPriceParams](interfaces/GetReferenceGasPriceParams.md) -- [GetStakesParams](interfaces/GetStakesParams.md) -- [GetStakesByIdsParams](interfaces/GetStakesByIdsParams.md) -- [GetTimelockedStakesParams](interfaces/GetTimelockedStakesParams.md) -- [GetTimelockedStakesByIdsParams](interfaces/GetTimelockedStakesByIdsParams.md) -- [GetTotalSupplyParams](interfaces/GetTotalSupplyParams.md) -- [GetTotalTransactionsParams](interfaces/GetTotalTransactionsParams.md) -- [GetValidatorsApyParams](interfaces/GetValidatorsApyParams.md) -- [QueryEventsParams](interfaces/QueryEventsParams.md) -- [SubscribeEventParams](interfaces/SubscribeEventParams.md) -- [SubscribeTransactionParams](interfaces/SubscribeTransactionParams.md) -- [UnsafeBatchTransactionParams](interfaces/UnsafeBatchTransactionParams.md) -- [UnsafeMergeCoinsParams](interfaces/UnsafeMergeCoinsParams.md) -- [UnsafeMoveCallParams](interfaces/UnsafeMoveCallParams.md) -- [UnsafePayParams](interfaces/UnsafePayParams.md) -- [UnsafePayAllIotaParams](interfaces/UnsafePayAllIotaParams.md) -- [UnsafePayIotaParams](interfaces/UnsafePayIotaParams.md) -- [UnsafePublishParams](interfaces/UnsafePublishParams.md) -- [UnsafeRequestAddStakeParams](interfaces/UnsafeRequestAddStakeParams.md) -- [UnsafeRequestAddTimelockedStakeParams](interfaces/UnsafeRequestAddTimelockedStakeParams.md) -- [UnsafeRequestWithdrawStakeParams](interfaces/UnsafeRequestWithdrawStakeParams.md) -- [UnsafeRequestWithdrawTimelockedStakeParams](interfaces/UnsafeRequestWithdrawTimelockedStakeParams.md) -- [UnsafeSplitCoinParams](interfaces/UnsafeSplitCoinParams.md) -- [UnsafeSplitCoinEqualParams](interfaces/UnsafeSplitCoinEqualParams.md) -- [UnsafeTransferIotaParams](interfaces/UnsafeTransferIotaParams.md) -- [UnsafeTransferObjectParams](interfaces/UnsafeTransferObjectParams.md) - -### Type Aliases - -- [IotaClientOptions](type-aliases/IotaClientOptions.md) -- [HttpHeaders](type-aliases/HttpHeaders.md) -- [NetworkId](type-aliases/NetworkId.md) -- [ChainType](type-aliases/ChainType.md) -- [EpochPage](type-aliases/EpochPage.md) -- [EpochMetricsPage](type-aliases/EpochMetricsPage.md) -- [CheckpointPage](type-aliases/CheckpointPage.md) -- [AllEpochsAddressMetrics](type-aliases/AllEpochsAddressMetrics.md) -- [MoveCallMetric](type-aliases/MoveCallMetric.md) -- [DynamicFieldPage](type-aliases/DynamicFieldPage.md) -- [IotaMoveNormalizedModules](type-aliases/IotaMoveNormalizedModules.md) -- [IotaMoveObject](type-aliases/IotaMoveObject.md) -- [IotaMovePackage](type-aliases/IotaMovePackage.md) -- [ProgrammableTransaction](type-aliases/ProgrammableTransaction.md) -- [IotaObjectChangePublished](type-aliases/IotaObjectChangePublished.md) -- [IotaObjectChangeTransferred](type-aliases/IotaObjectChangeTransferred.md) -- [IotaObjectChangeMutated](type-aliases/IotaObjectChangeMutated.md) -- [IotaObjectChangeDeleted](type-aliases/IotaObjectChangeDeleted.md) -- [IotaObjectChangeWrapped](type-aliases/IotaObjectChangeWrapped.md) -- [IotaObjectChangeCreated](type-aliases/IotaObjectChangeCreated.md) -- [CoinBalance](type-aliases/CoinBalance.md) -- [Order](type-aliases/Order.md) -- [Unsubscribe](type-aliases/Unsubscribe.md) -- [CheckpointCommitment](type-aliases/CheckpointCommitment.md) -- [CheckpointId](type-aliases/CheckpointId.md) -- [CompressedSignature](type-aliases/CompressedSignature.md) -- [ConsensusDeterminedVersionAssignments](type-aliases/ConsensusDeterminedVersionAssignments.md) -- [IotaParsedData](type-aliases/IotaParsedData.md) -- [DynamicFieldType](type-aliases/DynamicFieldType.md) -- [IotaEventFilter](type-aliases/IotaEventFilter.md) -- [ExecuteTransactionRequestType](type-aliases/ExecuteTransactionRequestType.md) -- [ExecutionStatus](type-aliases/ExecutionStatus.md) -- [InputObjectKind](type-aliases/InputObjectKind.md) -- [IotaArgument](type-aliases/IotaArgument.md) -- [IotaCallArg](type-aliases/IotaCallArg.md) -- [IotaEndOfEpochTransactionKind](type-aliases/IotaEndOfEpochTransactionKind.md) -- [IotaMoveAbility](type-aliases/IotaMoveAbility.md) -- [IotaMoveNormalizedType](type-aliases/IotaMoveNormalizedType.md) -- [IotaMoveVisibility](type-aliases/IotaMoveVisibility.md) -- [IotaObjectDataFilter](type-aliases/IotaObjectDataFilter.md) -- [IotaTransaction](type-aliases/IotaTransaction.md) -- [IotaTransactionBlockBuilderMode](type-aliases/IotaTransactionBlockBuilderMode.md) -- [IotaMoveFunctionArgType](type-aliases/IotaMoveFunctionArgType.md) -- [MoveStruct](type-aliases/MoveStruct.md) -- [MoveValue](type-aliases/MoveValue.md) -- [IotaObjectChange](type-aliases/IotaObjectChange.md) -- [ObjectRead](type-aliases/ObjectRead.md) -- [ObjectResponseError](type-aliases/ObjectResponseError.md) -- [ObjectValueKind](type-aliases/ObjectValueKind.md) -- [ObjectOwner](type-aliases/ObjectOwner.md) -- [ProtocolConfigValue](type-aliases/ProtocolConfigValue.md) -- [PublicKey](type-aliases/PublicKey.md) -- [RPCTransactionRequestParams](type-aliases/RPCTransactionRequestParams.md) -- [RawData](type-aliases/RawData.md) -- [Signature](type-aliases/Signature.md) -- [StakeObject](type-aliases/StakeObject.md) -- [TimelockedStake](type-aliases/TimelockedStake.md) -- [TransactionBlockData](type-aliases/TransactionBlockData.md) -- [TransactionEffects](type-aliases/TransactionEffects.md) -- [IotaTransactionBlockKind](type-aliases/IotaTransactionBlockKind.md) -- [TransactionFilter](type-aliases/TransactionFilter.md) -- [GetOwnedObjectsParams](type-aliases/GetOwnedObjectsParams.md) -- [QueryTransactionBlocksParams](type-aliases/QueryTransactionBlocksParams.md) - -### Functions - -- [getAppsBackend](functions/getAppsBackend.md) -- [isIotaClient](functions/isIotaClient.md) -- [getAllNetworks](functions/getAllNetworks.md) -- [getNetwork](functions/getNetwork.md) -- [getDefaultNetwork](functions/getDefaultNetwork.md) -- [getFullnodeUrl](functions/getFullnodeUrl.md) diff --git a/docs/content/ts-sdk/api/client/interfaces/AddressMetrics.md b/docs/content/ts-sdk/api/client/interfaces/AddressMetrics.md deleted file mode 100644 index 418331ccc9d..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/AddressMetrics.md +++ /dev/null @@ -1,51 +0,0 @@ -# Interface: AddressMetrics - -Provides metrics about the addresses. - -## Properties - -### checkpoint - -> **checkpoint**: `string` - -The checkpoint sequence number at which the metrics were computed. - ---- - -### cumulativeActiveAddresses - -> **cumulativeActiveAddresses**: `string` - -The count of sender addresses. - ---- - -### cumulativeAddresses - -> **cumulativeAddresses**: `string` - -The count of sender and recipient addresses. - ---- - -### dailyActiveAddresses - -> **dailyActiveAddresses**: `string` - -The count of daily unique sender addresses. - ---- - -### epoch - -> **epoch**: `string` - -The epoch to which the checkpoint is assigned. - ---- - -### timestampMs - -> **timestampMs**: `string` - -The checkpoint timestamp. diff --git a/docs/content/ts-sdk/api/client/interfaces/Balance.md b/docs/content/ts-sdk/api/client/interfaces/Balance.md deleted file mode 100644 index e88bdc327c5..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/Balance.md +++ /dev/null @@ -1,19 +0,0 @@ -# Interface: Balance - -## Properties - -### coinObjectCount - -> **coinObjectCount**: `number` - ---- - -### coinType - -> **coinType**: `string` - ---- - -### totalBalance - -> **totalBalance**: `string` diff --git a/docs/content/ts-sdk/api/client/interfaces/BalanceChange.md b/docs/content/ts-sdk/api/client/interfaces/BalanceChange.md deleted file mode 100644 index 880b39f2e99..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/BalanceChange.md +++ /dev/null @@ -1,24 +0,0 @@ -# Interface: BalanceChange - -## Properties - -### amount - -> **amount**: `string` - -The amount indicate the balance value changes, negative amount means spending coin value and -positive means receiving coin value. - ---- - -### coinType - -> **coinType**: `string` - ---- - -### owner - -> **owner**: [`ObjectOwner`](../type-aliases/ObjectOwner.md) - -Owner of the balance change diff --git a/docs/content/ts-sdk/api/client/interfaces/Checkpoint.md b/docs/content/ts-sdk/api/client/interfaces/Checkpoint.md deleted file mode 100644 index 977f8292cf9..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/Checkpoint.md +++ /dev/null @@ -1,92 +0,0 @@ -# Interface: Checkpoint - -## Properties - -### checkpointCommitments - -> **checkpointCommitments**: [`CheckpointCommitment`](../type-aliases/CheckpointCommitment.md)[] - -Commitments to checkpoint state - ---- - -### digest - -> **digest**: `string` - -Checkpoint digest - ---- - -### endOfEpochData? - -> `optional` **endOfEpochData**: `null` \| [`EndOfEpochData`](EndOfEpochData.md) - -Present only on the final checkpoint of the epoch. - ---- - -### epoch - -> **epoch**: `string` - -Checkpoint's epoch ID - ---- - -### epochRollingGasCostSummary - -> **epochRollingGasCostSummary**: [`GasCostSummary`](GasCostSummary.md) - -The running total gas costs of all transactions included in the current epoch so far until this -checkpoint. - ---- - -### networkTotalTransactions - -> **networkTotalTransactions**: `string` - -Total number of transactions committed since genesis, including those in this checkpoint. - ---- - -### previousDigest? - -> `optional` **previousDigest**: `null` \| `string` - -Digest of the previous checkpoint - ---- - -### sequenceNumber - -> **sequenceNumber**: `string` - -Checkpoint sequence number - ---- - -### timestampMs - -> **timestampMs**: `string` - -Timestamp of the checkpoint - number of milliseconds from the Unix epoch Checkpoint timestamps are -monotonic, but not strongly monotonic - subsequent checkpoints can have same timestamp if they -originate from the same underlining consensus commit - ---- - -### transactions - -> **transactions**: `string`[] - -Transaction digests - ---- - -### validatorSignature - -> **validatorSignature**: `string` - -Validator Signature diff --git a/docs/content/ts-sdk/api/client/interfaces/Claim.md b/docs/content/ts-sdk/api/client/interfaces/Claim.md deleted file mode 100644 index 810e376f9ba..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/Claim.md +++ /dev/null @@ -1,15 +0,0 @@ -# Interface: Claim - -A claim consists of value and index_mod_4. - -## Properties - -### indexMod4 - -> **indexMod4**: `number` - ---- - -### value - -> **value**: `string` diff --git a/docs/content/ts-sdk/api/client/interfaces/CoinMetadata.md b/docs/content/ts-sdk/api/client/interfaces/CoinMetadata.md deleted file mode 100644 index 408e871dca0..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/CoinMetadata.md +++ /dev/null @@ -1,49 +0,0 @@ -# Interface: CoinMetadata - -## Properties - -### decimals - -> **decimals**: `number` - -Number of decimal places the coin uses. - ---- - -### description - -> **description**: `string` - -Description of the token - ---- - -### iconUrl? - -> `optional` **iconUrl**: `null` \| `string` - -URL for the token logo - ---- - -### id? - -> `optional` **id**: `null` \| `string` - -Object id for the CoinMetadata object - ---- - -### name - -> **name**: `string` - -Name for the token - ---- - -### symbol - -> **symbol**: `string` - -Symbol for the token diff --git a/docs/content/ts-sdk/api/client/interfaces/CoinStruct.md b/docs/content/ts-sdk/api/client/interfaces/CoinStruct.md deleted file mode 100644 index 9d772291688..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/CoinStruct.md +++ /dev/null @@ -1,37 +0,0 @@ -# Interface: CoinStruct - -## Properties - -### balance - -> **balance**: `string` - ---- - -### coinObjectId - -> **coinObjectId**: `string` - ---- - -### coinType - -> **coinType**: `string` - ---- - -### digest - -> **digest**: `string` - ---- - -### previousTransaction - -> **previousTransaction**: `string` - ---- - -### version - -> **version**: `string` diff --git a/docs/content/ts-sdk/api/client/interfaces/CoinSupply.md b/docs/content/ts-sdk/api/client/interfaces/CoinSupply.md deleted file mode 100644 index 3f3206cf892..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/CoinSupply.md +++ /dev/null @@ -1,7 +0,0 @@ -# Interface: CoinSupply - -## Properties - -### value - -> **value**: `string` diff --git a/docs/content/ts-sdk/api/client/interfaces/CommitteeInfo.md b/docs/content/ts-sdk/api/client/interfaces/CommitteeInfo.md deleted file mode 100644 index 55e5471a3ff..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/CommitteeInfo.md +++ /dev/null @@ -1,15 +0,0 @@ -# Interface: CommitteeInfo - -RPC representation of the [Committee] type. - -## Properties - -### epoch - -> **epoch**: `string` - ---- - -### validators - -> **validators**: [`string`, `string`][] diff --git a/docs/content/ts-sdk/api/client/interfaces/DelegatedStake.md b/docs/content/ts-sdk/api/client/interfaces/DelegatedStake.md deleted file mode 100644 index 1e24986e560..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/DelegatedStake.md +++ /dev/null @@ -1,23 +0,0 @@ -# Interface: DelegatedStake - -## Properties - -### stakes - -> **stakes**: [`StakeObject`](../type-aliases/StakeObject.md)[] - ---- - -### stakingPool - -> **stakingPool**: `string` - -Staking pool object id. - ---- - -### validatorAddress - -> **validatorAddress**: `string` - -Validator's Address. diff --git a/docs/content/ts-sdk/api/client/interfaces/DelegatedTimelockedStake.md b/docs/content/ts-sdk/api/client/interfaces/DelegatedTimelockedStake.md deleted file mode 100644 index 6c1ab4109b3..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/DelegatedTimelockedStake.md +++ /dev/null @@ -1,19 +0,0 @@ -# Interface: DelegatedTimelockedStake - -## Properties - -### stakes - -> **stakes**: [`TimelockedStake`](../type-aliases/TimelockedStake.md)[] - ---- - -### stakingPool - -> **stakingPool**: `string` - ---- - -### validatorAddress - -> **validatorAddress**: `string` diff --git a/docs/content/ts-sdk/api/client/interfaces/DevInspectArgs.md b/docs/content/ts-sdk/api/client/interfaces/DevInspectArgs.md deleted file mode 100644 index 2df1d1f8818..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/DevInspectArgs.md +++ /dev/null @@ -1,43 +0,0 @@ -# Interface: DevInspectArgs - -Additional arguments supplied to dev inspect beyond what is allowed in today's API. - -## Properties - -### gasBudget? - -> `optional` **gasBudget**: `null` \| `string` - -The gas budget for the transaction. - ---- - -### gasObjects? - -> `optional` **gasObjects**: `null` \| [`string`, `string`, `string`][] - -The gas objects used to pay for the transaction. - ---- - -### gasSponsor? - -> `optional` **gasSponsor**: `null` \| `string` - -The sponsor of the gas for the transaction, might be different from the sender. - ---- - -### showRawTxnDataAndEffects? - -> `optional` **showRawTxnDataAndEffects**: `null` \| `boolean` - -Whether to return the raw transaction data and effects. - ---- - -### skipChecks? - -> `optional` **skipChecks**: `null` \| `boolean` - -Whether to skip transaction checks for the transaction. diff --git a/docs/content/ts-sdk/api/client/interfaces/DevInspectResults.md b/docs/content/ts-sdk/api/client/interfaces/DevInspectResults.md deleted file mode 100644 index cf9d07e4f8e..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/DevInspectResults.md +++ /dev/null @@ -1,53 +0,0 @@ -# Interface: DevInspectResults - -The response from processing a dev inspect transaction - -## Properties - -### effects - -> **effects**: [`TransactionEffects`](../type-aliases/TransactionEffects.md) - -Summary of effects that likely would be generated if the transaction is actually run. Note however, -that not all dev-inspect transactions are actually usable as transactions so it might not be -possible actually generate these effects from a normal transaction. - ---- - -### error? - -> `optional` **error**: `null` \| `string` - -Execution error from executing the transactions - ---- - -### events - -> **events**: [`IotaEvent`](IotaEvent.md)[] - -Events that likely would be generated if the transaction is actually run. - ---- - -### rawEffects? - -> `optional` **rawEffects**: `number`[] - -The raw effects of the transaction that was dev inspected. - ---- - -### rawTxnData? - -> `optional` **rawTxnData**: `number`[] - -The raw transaction data that was dev inspected. - ---- - -### results? - -> `optional` **results**: `null` \| [`IotaExecutionResult`](IotaExecutionResult.md)[] - -Execution results (including return values) from executing the transactions diff --git a/docs/content/ts-sdk/api/client/interfaces/DevInspectTransactionBlockParams.md b/docs/content/ts-sdk/api/client/interfaces/DevInspectTransactionBlockParams.md deleted file mode 100644 index a04a8dfbded..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/DevInspectTransactionBlockParams.md +++ /dev/null @@ -1,43 +0,0 @@ -# Interface: DevInspectTransactionBlockParams - -Runs the transaction in dev-inspect mode. Which allows for nearly any transaction (or Move call) -with any arguments. Detailed results are provided, including both the transaction effects and any -return values. - -## Properties - -### sender - -> **sender**: `string` - ---- - -### transactionBlock - -> **transactionBlock**: `string` \| `Uint8Array` \| [`Transaction`](../../transactions/classes/Transaction.md) - -BCS encoded TransactionKind(as opposed to TransactionData, which include gasBudget and gasPrice) - ---- - -### gasPrice? - -> `optional` **gasPrice**: `null` \| `number` \| `bigint` - -Gas is not charged, but gas usage is still calculated. Default to use reference gas price - ---- - -### epoch? - -> `optional` **epoch**: `null` \| `string` - -The epoch to perform the call. Will be set from the system state object if not provided - ---- - -### additionalArgs? - -> `optional` **additionalArgs**: `null` \| [`DevInspectArgs`](DevInspectArgs.md) - -Additional arguments including gas_budget, gas_objects, gas_sponsor and skip_checks. diff --git a/docs/content/ts-sdk/api/client/interfaces/DisplayFieldsResponse.md b/docs/content/ts-sdk/api/client/interfaces/DisplayFieldsResponse.md deleted file mode 100644 index 686bbac8613..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/DisplayFieldsResponse.md +++ /dev/null @@ -1,13 +0,0 @@ -# Interface: DisplayFieldsResponse - -## Properties - -### data? - -> `optional` **data**: `null` \| `object` - ---- - -### error? - -> `optional` **error**: `null` \| [`ObjectResponseError`](../type-aliases/ObjectResponseError.md) diff --git a/docs/content/ts-sdk/api/client/interfaces/DryRunTransactionBlockParams.md b/docs/content/ts-sdk/api/client/interfaces/DryRunTransactionBlockParams.md deleted file mode 100644 index 7f8fb88a1bf..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/DryRunTransactionBlockParams.md +++ /dev/null @@ -1,10 +0,0 @@ -# Interface: DryRunTransactionBlockParams - -Return transaction execution effects including the gas cost summary, while the effects are not -committed to the chain. - -## Properties - -### transactionBlock - -> **transactionBlock**: `string` \| `Uint8Array` diff --git a/docs/content/ts-sdk/api/client/interfaces/DryRunTransactionBlockResponse.md b/docs/content/ts-sdk/api/client/interfaces/DryRunTransactionBlockResponse.md deleted file mode 100644 index 96c17c1fc4b..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/DryRunTransactionBlockResponse.md +++ /dev/null @@ -1,31 +0,0 @@ -# Interface: DryRunTransactionBlockResponse - -## Properties - -### balanceChanges - -> **balanceChanges**: [`BalanceChange`](BalanceChange.md)[] - ---- - -### effects - -> **effects**: [`TransactionEffects`](../type-aliases/TransactionEffects.md) - ---- - -### events - -> **events**: [`IotaEvent`](IotaEvent.md)[] - ---- - -### input - -> **input**: [`TransactionBlockData`](../type-aliases/TransactionBlockData.md) - ---- - -### objectChanges - -> **objectChanges**: [`IotaObjectChange`](../type-aliases/IotaObjectChange.md)[] diff --git a/docs/content/ts-sdk/api/client/interfaces/DynamicFieldInfo.md b/docs/content/ts-sdk/api/client/interfaces/DynamicFieldInfo.md deleted file mode 100644 index 55e71e3ea44..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/DynamicFieldInfo.md +++ /dev/null @@ -1,43 +0,0 @@ -# Interface: DynamicFieldInfo - -## Properties - -### bcsName - -> **bcsName**: `string` - ---- - -### digest - -> **digest**: `string` - ---- - -### name - -> **name**: [`DynamicFieldName`](DynamicFieldName.md) - ---- - -### objectId - -> **objectId**: `string` - ---- - -### objectType - -> **objectType**: `string` - ---- - -### type - -> **type**: [`DynamicFieldType`](../type-aliases/DynamicFieldType.md) - ---- - -### version - -> **version**: `string` diff --git a/docs/content/ts-sdk/api/client/interfaces/DynamicFieldName.md b/docs/content/ts-sdk/api/client/interfaces/DynamicFieldName.md deleted file mode 100644 index 8367d690352..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/DynamicFieldName.md +++ /dev/null @@ -1,13 +0,0 @@ -# Interface: DynamicFieldName - -## Properties - -### type - -> **type**: `string` - ---- - -### value - -> **value**: `unknown` diff --git a/docs/content/ts-sdk/api/client/interfaces/ECMHLiveObjectSetDigest.md b/docs/content/ts-sdk/api/client/interfaces/ECMHLiveObjectSetDigest.md deleted file mode 100644 index abca44e384f..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/ECMHLiveObjectSetDigest.md +++ /dev/null @@ -1,9 +0,0 @@ -# Interface: ECMHLiveObjectSetDigest - -The Sha256 digest of an EllipticCurveMultisetHash committing to the live object set. - -## Properties - -### digest - -> **digest**: `number`[] diff --git a/docs/content/ts-sdk/api/client/interfaces/EndOfEpochData.md b/docs/content/ts-sdk/api/client/interfaces/EndOfEpochData.md deleted file mode 100644 index 2e0db8ec574..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/EndOfEpochData.md +++ /dev/null @@ -1,39 +0,0 @@ -# Interface: EndOfEpochData - -## Properties - -### epochCommitments - -> **epochCommitments**: [`CheckpointCommitment`](../type-aliases/CheckpointCommitment.md)[] - -Commitments to epoch specific state (e.g. live object set) - ---- - -### epochSupplyChange - -> **epochSupplyChange**: `number` - -The number of tokens that were minted (if positive) or burnt (if negative) in this epoch. - ---- - -### nextEpochCommittee - -> **nextEpochCommittee**: [`string`, `string`][] - -next_epoch_committee is `Some` if and only if the current checkpoint is the last checkpoint of an -epoch. Therefore next_epoch_committee can be used to pick the last checkpoint of an epoch, which is -often useful to get epoch level summary stats like total gas cost of an epoch, or the total number -of transactions from genesis to the end of an epoch. The committee is stored as a vector of -validator pub key and stake pairs. The vector should be sorted based on the Committee data -structure. - ---- - -### nextEpochProtocolVersion - -> **nextEpochProtocolVersion**: `string` - -The protocol version that is in effect during the epoch that starts immediately after this -checkpoint. diff --git a/docs/content/ts-sdk/api/client/interfaces/EndOfEpochInfo.md b/docs/content/ts-sdk/api/client/interfaces/EndOfEpochInfo.md deleted file mode 100644 index 8e92b650662..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/EndOfEpochInfo.md +++ /dev/null @@ -1,75 +0,0 @@ -# Interface: EndOfEpochInfo - -## Properties - -### burntTokensAmount - -> **burntTokensAmount**: `string` - ---- - -### epochEndTimestamp - -> **epochEndTimestamp**: `string` - ---- - -### lastCheckpointId - -> **lastCheckpointId**: `string` - ---- - -### mintedTokensAmount - -> **mintedTokensAmount**: `string` - ---- - -### protocolVersion - -> **protocolVersion**: `string` - -existing fields from `SystemEpochInfoEventV1` (without epoch) - ---- - -### referenceGasPrice - -> **referenceGasPrice**: `string` - ---- - -### storageCharge - -> **storageCharge**: `string` - ---- - -### storageFundBalance - -> **storageFundBalance**: `string` - ---- - -### storageRebate - -> **storageRebate**: `string` - ---- - -### totalGasFees - -> **totalGasFees**: `string` - ---- - -### totalStake - -> **totalStake**: `string` - ---- - -### totalStakeRewardsDistributed - -> **totalStakeRewardsDistributed**: `string` diff --git a/docs/content/ts-sdk/api/client/interfaces/EpochInfo.md b/docs/content/ts-sdk/api/client/interfaces/EpochInfo.md deleted file mode 100644 index d71b6f05069..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/EpochInfo.md +++ /dev/null @@ -1,57 +0,0 @@ -# Interface: EpochInfo - -## Properties - -### endOfEpochInfo? - -> `optional` **endOfEpochInfo**: `null` \| [`EndOfEpochInfo`](EndOfEpochInfo.md) - -The end of epoch information. - ---- - -### epoch - -> **epoch**: `string` - -Epoch number - ---- - -### epochStartTimestamp - -> **epochStartTimestamp**: `string` - -The timestamp when the epoch started. - ---- - -### epochTotalTransactions - -> **epochTotalTransactions**: `string` - -Count of tx in epoch - ---- - -### firstCheckpointId - -> **firstCheckpointId**: `string` - -First, last checkpoint sequence numbers - ---- - -### referenceGasPrice? - -> `optional` **referenceGasPrice**: `null` \| `string` - -The reference gas price for the given epoch. - ---- - -### validators - -> **validators**: [`IotaValidatorSummary`](IotaValidatorSummary.md)[] - -List of validators included in epoch diff --git a/docs/content/ts-sdk/api/client/interfaces/EpochMetrics.md b/docs/content/ts-sdk/api/client/interfaces/EpochMetrics.md deleted file mode 100644 index 0e2dd8c0058..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/EpochMetrics.md +++ /dev/null @@ -1,43 +0,0 @@ -# Interface: EpochMetrics - -A light-weight version of `EpochInfo` for faster loading - -## Properties - -### endOfEpochInfo? - -> `optional` **endOfEpochInfo**: `null` \| [`EndOfEpochInfo`](EndOfEpochInfo.md) - -The end of epoch information. - ---- - -### epoch - -> **epoch**: `string` - -The current epoch ID. - ---- - -### epochStartTimestamp - -> **epochStartTimestamp**: `string` - -The timestamp when the epoch started. - ---- - -### epochTotalTransactions - -> **epochTotalTransactions**: `string` - -The total number of transactions in the epoch. - ---- - -### firstCheckpointId - -> **firstCheckpointId**: `string` - -The first checkpoint ID of the epoch. diff --git a/docs/content/ts-sdk/api/client/interfaces/EventId.md b/docs/content/ts-sdk/api/client/interfaces/EventId.md deleted file mode 100644 index 8e937a94b89..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/EventId.md +++ /dev/null @@ -1,16 +0,0 @@ -# Interface: EventId - -Unique ID of an IOTA Event, the ID is a combination of tx seq number and event seq number, the ID is -local to this particular fullnode and will be different from other fullnode. - -## Properties - -### eventSeq - -> **eventSeq**: `string` - ---- - -### txDigest - -> **txDigest**: `string` diff --git a/docs/content/ts-sdk/api/client/interfaces/ExecuteTransactionBlockParams.md b/docs/content/ts-sdk/api/client/interfaces/ExecuteTransactionBlockParams.md deleted file mode 100644 index 1cf7d422d44..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/ExecuteTransactionBlockParams.md +++ /dev/null @@ -1,45 +0,0 @@ -# Interface: ExecuteTransactionBlockParams - -Execute the transaction and wait for results if desired. Request types: 1. WaitForEffectsCert: waits -for TransactionEffectsCert and then return to client. This mode is a proxy for transaction -finality. 2. WaitForLocalExecution: waits for TransactionEffectsCert and make sure the node executed -the transaction locally before returning the client. The local execution makes sure this node is -aware of this transaction when client fires subsequent queries. However if the node fails to execute -the transaction locally in a timely manner, a bool type in the response is set to false to indicated -the case. request_type is default to be `WaitForEffectsCert` unless options.show_events or -options.show_effects is true - -## Properties - -### transactionBlock - -> **transactionBlock**: `string` \| `Uint8Array` - -BCS serialized transaction data bytes without its type tag, as base-64 encoded string. - ---- - -### signature - -> **signature**: `string` \| `string`[] - -A list of signatures (`flag || signature || pubkey` bytes, as base-64 encoded string). Signature is -committed to the intent message of the transaction data, as base-64 encoded string. - ---- - -### options? - -> `optional` **options**: `null` \| [`IotaTransactionBlockResponseOptions`](IotaTransactionBlockResponseOptions.md) - -options for specifying the content to be returned - ---- - -### ~~requestType?~~ - -> `optional` **requestType**: `null` \| [`ExecuteTransactionRequestType`](../type-aliases/ExecuteTransactionRequestType.md) - -#### Deprecated - -requestType will be ignored by JSON RPC in the future diff --git a/docs/content/ts-sdk/api/client/interfaces/GasCostSummary.md b/docs/content/ts-sdk/api/client/interfaces/GasCostSummary.md deleted file mode 100644 index 5f0e852e40c..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/GasCostSummary.md +++ /dev/null @@ -1,60 +0,0 @@ -# Interface: GasCostSummary - -Summary of the charges in a transaction. Storage is charged independently of computation. There are -3 parts to the storage charges: `storage_cost`: it is the charge of storage at the time the -transaction is executed. The cost of storage is the number of bytes of the objects being mutated -multiplied by a variable storage cost per byte `storage_rebate`: this is the amount a user gets back -when manipulating an object. The `storage_rebate` is the `storage_cost` for an object minus fees. -`non_refundable_storage_fee`: not all the value of the object storage cost is given back to user and -there is a small fraction that is kept by the system. This value tracks that charge. - -When looking at a gas cost summary the amount charged to the user is -`computation_cost + storage_cost - storage_rebate` and that is the amount that is deducted from the -gas coins. `non_refundable_storage_fee` is collected from the objects being mutated/deleted and it -is tracked by the system in storage funds. - -Objects deleted, including the older versions of objects mutated, have the storage field on the -objects added up to a pool of "potential rebate". This rebate then is reduced by the "nonrefundable -rate" such that: -`potential_rebate(storage cost of deleted/mutated objects) = storage_rebate + non_refundable_storage_fee` - -## Properties - -### computationCost - -> **computationCost**: `string` - -Cost of computation/execution - ---- - -### computationCostBurned - -> **computationCostBurned**: `string` - -The burned component of the computation/execution costs - ---- - -### nonRefundableStorageFee - -> **nonRefundableStorageFee**: `string` - -The fee for the rebate. The portion of the storage rebate kept by the system. - ---- - -### storageCost - -> **storageCost**: `string` - -Storage cost, it's the sum of all storage cost for all objects created or mutated. - ---- - -### storageRebate - -> **storageRebate**: `string` - -The amount of storage cost refunded to the user for all objects deleted or mutated in the -transaction. diff --git a/docs/content/ts-sdk/api/client/interfaces/GetAllBalancesParams.md b/docs/content/ts-sdk/api/client/interfaces/GetAllBalancesParams.md deleted file mode 100644 index 3b542772fc5..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/GetAllBalancesParams.md +++ /dev/null @@ -1,11 +0,0 @@ -# Interface: GetAllBalancesParams - -Return the total coin balance for all coin type, owned by the address owner. - -## Properties - -### owner - -> **owner**: `string` - -the owner's IOTA address diff --git a/docs/content/ts-sdk/api/client/interfaces/GetAllCoinsParams.md b/docs/content/ts-sdk/api/client/interfaces/GetAllCoinsParams.md deleted file mode 100644 index 8b5c917631b..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/GetAllCoinsParams.md +++ /dev/null @@ -1,27 +0,0 @@ -# Interface: GetAllCoinsParams - -Return all Coin objects owned by an address. - -## Properties - -### owner - -> **owner**: `string` - -the owner's IOTA address - ---- - -### cursor? - -> `optional` **cursor**: `null` \| `string` - -optional paging cursor - ---- - -### limit? - -> `optional` **limit**: `null` \| `number` - -maximum number of items per page diff --git a/docs/content/ts-sdk/api/client/interfaces/GetAllEpochAddressMetricsParams.md b/docs/content/ts-sdk/api/client/interfaces/GetAllEpochAddressMetricsParams.md deleted file mode 100644 index 26e7e26fa0d..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/GetAllEpochAddressMetricsParams.md +++ /dev/null @@ -1,7 +0,0 @@ -# Interface: GetAllEpochAddressMetricsParams - -## Properties - -### descendingOrder? - -> `optional` **descendingOrder**: `null` \| `boolean` diff --git a/docs/content/ts-sdk/api/client/interfaces/GetBalanceParams.md b/docs/content/ts-sdk/api/client/interfaces/GetBalanceParams.md deleted file mode 100644 index dec01139716..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/GetBalanceParams.md +++ /dev/null @@ -1,20 +0,0 @@ -# Interface: GetBalanceParams - -Return the total coin balance for one coin type, owned by the address owner. - -## Properties - -### owner - -> **owner**: `string` - -the owner's IOTA address - ---- - -### coinType? - -> `optional` **coinType**: `null` \| `string` - -optional type names for the coin (e.g., 0x168da5bf1f48dafc111b0a488fa454aca95e0b5e::usdc::USDC), -default to 0x2::iota::IOTA if not specified. diff --git a/docs/content/ts-sdk/api/client/interfaces/GetChainIdentifierParams.md b/docs/content/ts-sdk/api/client/interfaces/GetChainIdentifierParams.md deleted file mode 100644 index 8c4953d8483..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/GetChainIdentifierParams.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: GetChainIdentifierParams - -Return the first four bytes of the chain's genesis checkpoint digest. diff --git a/docs/content/ts-sdk/api/client/interfaces/GetCheckpointAddressMetricsParams.md b/docs/content/ts-sdk/api/client/interfaces/GetCheckpointAddressMetricsParams.md deleted file mode 100644 index 84279878c68..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/GetCheckpointAddressMetricsParams.md +++ /dev/null @@ -1,7 +0,0 @@ -# Interface: GetCheckpointAddressMetricsParams - -## Properties - -### checkpoint - -> **checkpoint**: `string` diff --git a/docs/content/ts-sdk/api/client/interfaces/GetCheckpointParams.md b/docs/content/ts-sdk/api/client/interfaces/GetCheckpointParams.md deleted file mode 100644 index 2198026d961..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/GetCheckpointParams.md +++ /dev/null @@ -1,11 +0,0 @@ -# Interface: GetCheckpointParams - -Return a checkpoint - -## Properties - -### id - -> **id**: `string` - -Checkpoint identifier, can use either checkpoint digest, or checkpoint sequence number as input. diff --git a/docs/content/ts-sdk/api/client/interfaces/GetCheckpointsParams.md b/docs/content/ts-sdk/api/client/interfaces/GetCheckpointsParams.md deleted file mode 100644 index d9636260ff0..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/GetCheckpointsParams.md +++ /dev/null @@ -1,28 +0,0 @@ -# Interface: GetCheckpointsParams - -Return paginated list of checkpoints - -## Properties - -### cursor? - -> `optional` **cursor**: `null` \| `string` - -An optional paging cursor. If provided, the query will start from the next item after the specified -cursor. Default to start from the first item if not specified. - ---- - -### limit? - -> `optional` **limit**: `null` \| `number` - -Maximum item returned per page, default to [QUERY_MAX_RESULT_LIMIT_CHECKPOINTS] if not specified. - ---- - -### descendingOrder - -> **descendingOrder**: `boolean` - -query result ordering, default to false (ascending order), oldest record first. diff --git a/docs/content/ts-sdk/api/client/interfaces/GetCoinMetadataParams.md b/docs/content/ts-sdk/api/client/interfaces/GetCoinMetadataParams.md deleted file mode 100644 index 1132256d456..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/GetCoinMetadataParams.md +++ /dev/null @@ -1,11 +0,0 @@ -# Interface: GetCoinMetadataParams - -Return metadata (e.g., symbol, decimals) for a coin. - -## Properties - -### coinType - -> **coinType**: `string` - -type name for the coin (e.g., 0x168da5bf1f48dafc111b0a488fa454aca95e0b5e::usdc::USDC) diff --git a/docs/content/ts-sdk/api/client/interfaces/GetCoinsParams.md b/docs/content/ts-sdk/api/client/interfaces/GetCoinsParams.md deleted file mode 100644 index c21e768bfb5..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/GetCoinsParams.md +++ /dev/null @@ -1,36 +0,0 @@ -# Interface: GetCoinsParams - -Return all Coin<`coin_type`> objects owned by an address. - -## Properties - -### owner - -> **owner**: `string` - -the owner's IOTA address - ---- - -### coinType? - -> `optional` **coinType**: `null` \| `string` - -optional type name for the coin (e.g., 0x168da5bf1f48dafc111b0a488fa454aca95e0b5e::usdc::USDC), -default to 0x2::iota::IOTA if not specified. - ---- - -### cursor? - -> `optional` **cursor**: `null` \| `string` - -optional paging cursor - ---- - -### limit? - -> `optional` **limit**: `null` \| `number` - -maximum number of items per page diff --git a/docs/content/ts-sdk/api/client/interfaces/GetCommitteeInfoParams.md b/docs/content/ts-sdk/api/client/interfaces/GetCommitteeInfoParams.md deleted file mode 100644 index 28734880cdc..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/GetCommitteeInfoParams.md +++ /dev/null @@ -1,11 +0,0 @@ -# Interface: GetCommitteeInfoParams - -Return the committee information for the asked `epoch`. - -## Properties - -### epoch? - -> `optional` **epoch**: `null` \| `string` - -The epoch of interest. If None, default to the latest epoch diff --git a/docs/content/ts-sdk/api/client/interfaces/GetCurrentEpochParams.md b/docs/content/ts-sdk/api/client/interfaces/GetCurrentEpochParams.md deleted file mode 100644 index 880377cae49..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/GetCurrentEpochParams.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: GetCurrentEpochParams - -Return current epoch info diff --git a/docs/content/ts-sdk/api/client/interfaces/GetDynamicFieldObjectParams.md b/docs/content/ts-sdk/api/client/interfaces/GetDynamicFieldObjectParams.md deleted file mode 100644 index 4f86b718daa..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/GetDynamicFieldObjectParams.md +++ /dev/null @@ -1,19 +0,0 @@ -# Interface: GetDynamicFieldObjectParams - -Return the dynamic field object information for a specified object - -## Properties - -### parentId - -> **parentId**: `string` - -The ID of the queried parent object - ---- - -### name - -> **name**: [`DynamicFieldName`](DynamicFieldName.md) - -The Name of the dynamic field diff --git a/docs/content/ts-sdk/api/client/interfaces/GetDynamicFieldsParams.md b/docs/content/ts-sdk/api/client/interfaces/GetDynamicFieldsParams.md deleted file mode 100644 index ffe4b64e5f7..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/GetDynamicFieldsParams.md +++ /dev/null @@ -1,28 +0,0 @@ -# Interface: GetDynamicFieldsParams - -Return the list of dynamic field objects owned by an object. - -## Properties - -### parentId - -> **parentId**: `string` - -The ID of the parent object - ---- - -### cursor? - -> `optional` **cursor**: `null` \| `string` - -An optional paging cursor. If provided, the query will start from the next item after the specified -cursor. Default to start from the first item if not specified. - ---- - -### limit? - -> `optional` **limit**: `null` \| `number` - -Maximum item returned per page, default to [QUERY_MAX_RESULT_LIMIT] if not specified. diff --git a/docs/content/ts-sdk/api/client/interfaces/GetEpochMetricsParams.md b/docs/content/ts-sdk/api/client/interfaces/GetEpochMetricsParams.md deleted file mode 100644 index 42c9c7ddeb7..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/GetEpochMetricsParams.md +++ /dev/null @@ -1,27 +0,0 @@ -# Interface: GetEpochMetricsParams - -Return a list of epoch metrics, which is a subset of epoch info - -## Properties - -### cursor? - -> `optional` **cursor**: `null` \| `string` - -Optional paging cursor - ---- - -### limit? - -> `optional` **limit**: `null` \| `number` - -Maximum number of items per page - ---- - -### descendingOrder? - -> `optional` **descendingOrder**: `null` \| `boolean` - -Flag to return results in descending order diff --git a/docs/content/ts-sdk/api/client/interfaces/GetEpochsParams.md b/docs/content/ts-sdk/api/client/interfaces/GetEpochsParams.md deleted file mode 100644 index a71efe0d58d..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/GetEpochsParams.md +++ /dev/null @@ -1,27 +0,0 @@ -# Interface: GetEpochsParams - -Return a list of epoch info - -## Properties - -### cursor? - -> `optional` **cursor**: `null` \| `string` - -Optional paging cursor - ---- - -### limit? - -> `optional` **limit**: `null` \| `number` - -Maximum number of items per page - ---- - -### descendingOrder? - -> `optional` **descendingOrder**: `null` \| `boolean` - -Flag to return results in descending order diff --git a/docs/content/ts-sdk/api/client/interfaces/GetEventsParams.md b/docs/content/ts-sdk/api/client/interfaces/GetEventsParams.md deleted file mode 100644 index 275a989ed85..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/GetEventsParams.md +++ /dev/null @@ -1,11 +0,0 @@ -# Interface: GetEventsParams - -Return transaction events. - -## Properties - -### transactionDigest - -> **transactionDigest**: `string` - -the event query criteria. diff --git a/docs/content/ts-sdk/api/client/interfaces/GetLatestAddressMetricsParams.md b/docs/content/ts-sdk/api/client/interfaces/GetLatestAddressMetricsParams.md deleted file mode 100644 index 487e885f696..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/GetLatestAddressMetricsParams.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: GetLatestAddressMetricsParams - -Address related metrics diff --git a/docs/content/ts-sdk/api/client/interfaces/GetLatestCheckpointSequenceNumberParams.md b/docs/content/ts-sdk/api/client/interfaces/GetLatestCheckpointSequenceNumberParams.md deleted file mode 100644 index 42747fcad47..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/GetLatestCheckpointSequenceNumberParams.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: GetLatestCheckpointSequenceNumberParams - -Return the sequence number of the latest checkpoint that has been executed diff --git a/docs/content/ts-sdk/api/client/interfaces/GetLatestIotaSystemStateParams.md b/docs/content/ts-sdk/api/client/interfaces/GetLatestIotaSystemStateParams.md deleted file mode 100644 index 60ec042acdd..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/GetLatestIotaSystemStateParams.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: GetLatestIotaSystemStateParams - -Return the latest IOTA system state object on-chain. diff --git a/docs/content/ts-sdk/api/client/interfaces/GetMoveCallMetricsParams.md b/docs/content/ts-sdk/api/client/interfaces/GetMoveCallMetricsParams.md deleted file mode 100644 index 435cf769e16..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/GetMoveCallMetricsParams.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: GetMoveCallMetricsParams - -Return move call metrics diff --git a/docs/content/ts-sdk/api/client/interfaces/GetMoveFunctionArgTypesParams.md b/docs/content/ts-sdk/api/client/interfaces/GetMoveFunctionArgTypesParams.md deleted file mode 100644 index 2cda001f228..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/GetMoveFunctionArgTypesParams.md +++ /dev/null @@ -1,21 +0,0 @@ -# Interface: GetMoveFunctionArgTypesParams - -Return the argument types of a Move function, based on normalized Type. - -## Properties - -### package - -> **package**: `string` - ---- - -### module - -> **module**: `string` - ---- - -### function - -> **function**: `string` diff --git a/docs/content/ts-sdk/api/client/interfaces/GetNetworkMetricsParams.md b/docs/content/ts-sdk/api/client/interfaces/GetNetworkMetricsParams.md deleted file mode 100644 index 94f16044ae3..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/GetNetworkMetricsParams.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: GetNetworkMetricsParams - -Return Network metrics diff --git a/docs/content/ts-sdk/api/client/interfaces/GetNormalizedMoveFunctionParams.md b/docs/content/ts-sdk/api/client/interfaces/GetNormalizedMoveFunctionParams.md deleted file mode 100644 index 148f75022ab..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/GetNormalizedMoveFunctionParams.md +++ /dev/null @@ -1,21 +0,0 @@ -# Interface: GetNormalizedMoveFunctionParams - -Return a structured representation of Move function - -## Properties - -### package - -> **package**: `string` - ---- - -### module - -> **module**: `string` - ---- - -### function - -> **function**: `string` diff --git a/docs/content/ts-sdk/api/client/interfaces/GetNormalizedMoveModuleParams.md b/docs/content/ts-sdk/api/client/interfaces/GetNormalizedMoveModuleParams.md deleted file mode 100644 index 67d95263a1f..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/GetNormalizedMoveModuleParams.md +++ /dev/null @@ -1,15 +0,0 @@ -# Interface: GetNormalizedMoveModuleParams - -Return a structured representation of Move module - -## Properties - -### package - -> **package**: `string` - ---- - -### module - -> **module**: `string` diff --git a/docs/content/ts-sdk/api/client/interfaces/GetNormalizedMoveModulesByPackageParams.md b/docs/content/ts-sdk/api/client/interfaces/GetNormalizedMoveModulesByPackageParams.md deleted file mode 100644 index d64eabe098a..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/GetNormalizedMoveModulesByPackageParams.md +++ /dev/null @@ -1,9 +0,0 @@ -# Interface: GetNormalizedMoveModulesByPackageParams - -Return structured representations of all modules in the given package - -## Properties - -### package - -> **package**: `string` diff --git a/docs/content/ts-sdk/api/client/interfaces/GetNormalizedMoveStructParams.md b/docs/content/ts-sdk/api/client/interfaces/GetNormalizedMoveStructParams.md deleted file mode 100644 index 6e70879d963..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/GetNormalizedMoveStructParams.md +++ /dev/null @@ -1,21 +0,0 @@ -# Interface: GetNormalizedMoveStructParams - -Return a structured representation of Move struct - -## Properties - -### package - -> **package**: `string` - ---- - -### module - -> **module**: `string` - ---- - -### struct - -> **struct**: `string` diff --git a/docs/content/ts-sdk/api/client/interfaces/GetObjectParams.md b/docs/content/ts-sdk/api/client/interfaces/GetObjectParams.md deleted file mode 100644 index 9425140b67d..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/GetObjectParams.md +++ /dev/null @@ -1,19 +0,0 @@ -# Interface: GetObjectParams - -Return the object information for a specified object - -## Properties - -### id - -> **id**: `string` - -the ID of the queried object - ---- - -### options? - -> `optional` **options**: `null` \| [`IotaObjectDataOptions`](IotaObjectDataOptions.md) - -options for specifying the content to be returned diff --git a/docs/content/ts-sdk/api/client/interfaces/GetPastObjectRequest.md b/docs/content/ts-sdk/api/client/interfaces/GetPastObjectRequest.md deleted file mode 100644 index b1027f6ede7..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/GetPastObjectRequest.md +++ /dev/null @@ -1,17 +0,0 @@ -# Interface: GetPastObjectRequest - -## Properties - -### objectId - -> **objectId**: `string` - -the ID of the queried object - ---- - -### version - -> **version**: `string` - -the version of the queried object. diff --git a/docs/content/ts-sdk/api/client/interfaces/GetProtocolConfigParams.md b/docs/content/ts-sdk/api/client/interfaces/GetProtocolConfigParams.md deleted file mode 100644 index 19224f6e0d8..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/GetProtocolConfigParams.md +++ /dev/null @@ -1,13 +0,0 @@ -# Interface: GetProtocolConfigParams - -Return the protocol config table for the given version number. If the version number is not -specified, If none is specified, the node uses the version of the latest epoch it has processed. - -## Properties - -### version? - -> `optional` **version**: `null` \| `string` - -An optional protocol version specifier. If omitted, the latest protocol config table for the node -will be returned. diff --git a/docs/content/ts-sdk/api/client/interfaces/GetReferenceGasPriceParams.md b/docs/content/ts-sdk/api/client/interfaces/GetReferenceGasPriceParams.md deleted file mode 100644 index 726f8f17aee..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/GetReferenceGasPriceParams.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: GetReferenceGasPriceParams - -Return the reference gas price for the network diff --git a/docs/content/ts-sdk/api/client/interfaces/GetStakesByIdsParams.md b/docs/content/ts-sdk/api/client/interfaces/GetStakesByIdsParams.md deleted file mode 100644 index 141035404c2..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/GetStakesByIdsParams.md +++ /dev/null @@ -1,9 +0,0 @@ -# Interface: GetStakesByIdsParams - -Return one or more [DelegatedStake]. If a Stake was withdrawn its status will be Unstaked. - -## Properties - -### stakedIotaIds - -> **stakedIotaIds**: `string`[] diff --git a/docs/content/ts-sdk/api/client/interfaces/GetStakesParams.md b/docs/content/ts-sdk/api/client/interfaces/GetStakesParams.md deleted file mode 100644 index 2a8b1dc9c9e..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/GetStakesParams.md +++ /dev/null @@ -1,9 +0,0 @@ -# Interface: GetStakesParams - -Return all [DelegatedStake]. - -## Properties - -### owner - -> **owner**: `string` diff --git a/docs/content/ts-sdk/api/client/interfaces/GetTimelockedStakesByIdsParams.md b/docs/content/ts-sdk/api/client/interfaces/GetTimelockedStakesByIdsParams.md deleted file mode 100644 index a632c0fc887..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/GetTimelockedStakesByIdsParams.md +++ /dev/null @@ -1,9 +0,0 @@ -# Interface: GetTimelockedStakesByIdsParams - -Return one or more [DelegatedTimelockedStake]. If a Stake was withdrawn its status will be Unstaked. - -## Properties - -### timelockedStakedIotaIds - -> **timelockedStakedIotaIds**: `string`[] diff --git a/docs/content/ts-sdk/api/client/interfaces/GetTimelockedStakesParams.md b/docs/content/ts-sdk/api/client/interfaces/GetTimelockedStakesParams.md deleted file mode 100644 index dfb0a20d4e0..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/GetTimelockedStakesParams.md +++ /dev/null @@ -1,9 +0,0 @@ -# Interface: GetTimelockedStakesParams - -Return all [DelegatedTimelockedStake]. - -## Properties - -### owner - -> **owner**: `string` diff --git a/docs/content/ts-sdk/api/client/interfaces/GetTotalSupplyParams.md b/docs/content/ts-sdk/api/client/interfaces/GetTotalSupplyParams.md deleted file mode 100644 index 56a28352d08..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/GetTotalSupplyParams.md +++ /dev/null @@ -1,11 +0,0 @@ -# Interface: GetTotalSupplyParams - -Return total supply for a coin. - -## Properties - -### coinType - -> **coinType**: `string` - -type name for the coin (e.g., 0x168da5bf1f48dafc111b0a488fa454aca95e0b5e::usdc::USDC) diff --git a/docs/content/ts-sdk/api/client/interfaces/GetTotalTransactionBlocksParams.md b/docs/content/ts-sdk/api/client/interfaces/GetTotalTransactionBlocksParams.md deleted file mode 100644 index 0a652fc5681..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/GetTotalTransactionBlocksParams.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: GetTotalTransactionBlocksParams - -Return the total number of transaction blocks known to the server. diff --git a/docs/content/ts-sdk/api/client/interfaces/GetTotalTransactionsParams.md b/docs/content/ts-sdk/api/client/interfaces/GetTotalTransactionsParams.md deleted file mode 100644 index fc4e2ee6e59..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/GetTotalTransactionsParams.md +++ /dev/null @@ -1 +0,0 @@ -# Interface: GetTotalTransactionsParams diff --git a/docs/content/ts-sdk/api/client/interfaces/GetTransactionBlockParams.md b/docs/content/ts-sdk/api/client/interfaces/GetTransactionBlockParams.md deleted file mode 100644 index 46e07f5fee7..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/GetTransactionBlockParams.md +++ /dev/null @@ -1,19 +0,0 @@ -# Interface: GetTransactionBlockParams - -Return the transaction response object. - -## Properties - -### digest - -> **digest**: `string` - -the digest of the queried transaction - ---- - -### options? - -> `optional` **options**: `null` \| [`IotaTransactionBlockResponseOptions`](IotaTransactionBlockResponseOptions.md) - -options for specifying the content to be returned diff --git a/docs/content/ts-sdk/api/client/interfaces/GetValidatorsApyParams.md b/docs/content/ts-sdk/api/client/interfaces/GetValidatorsApyParams.md deleted file mode 100644 index ae82c5de3e5..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/GetValidatorsApyParams.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: GetValidatorsApyParams - -Return the validator APY diff --git a/docs/content/ts-sdk/api/client/interfaces/IotaActiveJwk.md b/docs/content/ts-sdk/api/client/interfaces/IotaActiveJwk.md deleted file mode 100644 index 616901c4dd7..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/IotaActiveJwk.md +++ /dev/null @@ -1,19 +0,0 @@ -# Interface: IotaActiveJwk - -## Properties - -### epoch - -> **epoch**: `string` - ---- - -### jwk - -> **jwk**: [`IotaJWK`](IotaJWK.md) - ---- - -### jwk\_id - -> **jwk\_id**: [`IotaJwkId`](IotaJwkId.md) diff --git a/docs/content/ts-sdk/api/client/interfaces/IotaAuthenticatorStateExpire.md b/docs/content/ts-sdk/api/client/interfaces/IotaAuthenticatorStateExpire.md deleted file mode 100644 index 15c3c2fdbe7..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/IotaAuthenticatorStateExpire.md +++ /dev/null @@ -1,7 +0,0 @@ -# Interface: IotaAuthenticatorStateExpire - -## Properties - -### min\_epoch - -> **min\_epoch**: `string` diff --git a/docs/content/ts-sdk/api/client/interfaces/IotaChangeEpoch.md b/docs/content/ts-sdk/api/client/interfaces/IotaChangeEpoch.md deleted file mode 100644 index 9150be9478b..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/IotaChangeEpoch.md +++ /dev/null @@ -1,31 +0,0 @@ -# Interface: IotaChangeEpoch - -## Properties - -### computation\_charge - -> **computation\_charge**: `string` - ---- - -### epoch - -> **epoch**: `string` - ---- - -### epoch\_start\_timestamp\_ms - -> **epoch\_start\_timestamp\_ms**: `string` - ---- - -### storage\_charge - -> **storage\_charge**: `string` - ---- - -### storage\_rebate - -> **storage\_rebate**: `string` diff --git a/docs/content/ts-sdk/api/client/interfaces/IotaEvent.md b/docs/content/ts-sdk/api/client/interfaces/IotaEvent.md deleted file mode 100644 index 1d577e2af99..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/IotaEvent.md +++ /dev/null @@ -1,67 +0,0 @@ -# Interface: IotaEvent - -## Properties - -### bcs - -> **bcs**: `string` - -Base 58 encoded bcs bytes of the move event - ---- - -### id - -> **id**: [`EventId`](EventId.md) - -Sequential event ID, ie (transaction seq number, event seq number). 1) Serves as a unique event ID -for each fullnode 2) Also serves to sequence events for the purposes of pagination and querying. A -higher id is an event seen later by that fullnode. This ID is the "cursor" for event querying. - ---- - -### packageId - -> **packageId**: `string` - -Move package where this event was emitted. - ---- - -### parsedJson - -> **parsedJson**: `unknown` - -Parsed json value of the event - ---- - -### sender - -> **sender**: `string` - -Sender's IOTA address. - ---- - -### timestampMs? - -> `optional` **timestampMs**: `null` \| `string` - -UTC timestamp in milliseconds since epoch (1/1/1970) - ---- - -### transactionModule - -> **transactionModule**: `string` - -Move module where this event was emitted. - ---- - -### type - -> **type**: `string` - -Move event type. diff --git a/docs/content/ts-sdk/api/client/interfaces/IotaExecutionResult.md b/docs/content/ts-sdk/api/client/interfaces/IotaExecutionResult.md deleted file mode 100644 index ba33a7adf84..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/IotaExecutionResult.md +++ /dev/null @@ -1,17 +0,0 @@ -# Interface: IotaExecutionResult - -## Properties - -### mutableReferenceOutputs? - -> `optional` **mutableReferenceOutputs**: [[`IotaArgument`](../type-aliases/IotaArgument.md), `number`[], `string`][] - -The value of any arguments that were mutably borrowed. Non-mut borrowed values are not included - ---- - -### returnValues? - -> `optional` **returnValues**: [`number`[], `string`][] - -The return values from the transaction diff --git a/docs/content/ts-sdk/api/client/interfaces/IotaGasData.md b/docs/content/ts-sdk/api/client/interfaces/IotaGasData.md deleted file mode 100644 index b95801801e2..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/IotaGasData.md +++ /dev/null @@ -1,25 +0,0 @@ -# Interface: IotaGasData - -## Properties - -### budget - -> **budget**: `string` - ---- - -### owner - -> **owner**: `string` - ---- - -### payment - -> **payment**: [`IotaObjectRef`](IotaObjectRef.md)[] - ---- - -### price - -> **price**: `string` diff --git a/docs/content/ts-sdk/api/client/interfaces/IotaHTTPTransportOptions.md b/docs/content/ts-sdk/api/client/interfaces/IotaHTTPTransportOptions.md deleted file mode 100644 index 4e4f9bf5e15..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/IotaHTTPTransportOptions.md +++ /dev/null @@ -1,97 +0,0 @@ -# Interface: IotaHTTPTransportOptions - -## Properties - -### fetch()? - -> `optional` **fetch**: (`input`, `init`?) => `Promise`\<`Response`\>(`input`, `init`?) => `Promise`\<`Response`\> - -[MDN Reference](https://developer.mozilla.org/docs/Web/API/fetch) - -#### Parameters - -• **input**: `URL` \| `RequestInfo` - -• **init?**: `RequestInit` - -#### Returns - -`Promise`\<`Response`\> - -#### Parameters - -• **input**: `string` \| `URL` \| `Request` - -• **init?**: `RequestInit` - -#### Returns - -`Promise`\<`Response`\> - ---- - -### WebSocketConstructor()? - -> `optional` **WebSocketConstructor**: (`url`, `protocols`?) => `WebSocket` - -#### Parameters - -• **url**: `string` \| `URL` - -• **protocols?**: `string` \| `string`[] - -#### Returns - -`WebSocket` - -#### prototype - -> **prototype**: `WebSocket` - -#### CONNECTING - -> `readonly` **CONNECTING**: `0` - -#### OPEN - -> `readonly` **OPEN**: `1` - -#### CLOSING - -> `readonly` **CLOSING**: `2` - -#### CLOSED - -> `readonly` **CLOSED**: `3` - ---- - -### url - -> **url**: `string` - ---- - -### rpc? - -> `optional` **rpc**: `object` - -#### headers? - -> `optional` **headers**: [`HttpHeaders`](../type-aliases/HttpHeaders.md) - -#### url? - -> `optional` **url**: `string` - ---- - -### websocket? - -> `optional` **websocket**: `WebsocketClientOptions` & `object` - -#### Type declaration - -##### url? - -> `optional` **url**: `string` diff --git a/docs/content/ts-sdk/api/client/interfaces/IotaJWK.md b/docs/content/ts-sdk/api/client/interfaces/IotaJWK.md deleted file mode 100644 index 0de351c914e..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/IotaJWK.md +++ /dev/null @@ -1,25 +0,0 @@ -# Interface: IotaJWK - -## Properties - -### alg - -> **alg**: `string` - ---- - -### e - -> **e**: `string` - ---- - -### kty - -> **kty**: `string` - ---- - -### n - -> **n**: `string` diff --git a/docs/content/ts-sdk/api/client/interfaces/IotaJwkId.md b/docs/content/ts-sdk/api/client/interfaces/IotaJwkId.md deleted file mode 100644 index 7bdc005d104..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/IotaJwkId.md +++ /dev/null @@ -1,13 +0,0 @@ -# Interface: IotaJwkId - -## Properties - -### iss - -> **iss**: `string` - ---- - -### kid - -> **kid**: `string` diff --git a/docs/content/ts-sdk/api/client/interfaces/IotaMoveAbilitySet.md b/docs/content/ts-sdk/api/client/interfaces/IotaMoveAbilitySet.md deleted file mode 100644 index 99dbd56a4c1..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/IotaMoveAbilitySet.md +++ /dev/null @@ -1,7 +0,0 @@ -# Interface: IotaMoveAbilitySet - -## Properties - -### abilities - -> **abilities**: [`IotaMoveAbility`](../type-aliases/IotaMoveAbility.md)[] diff --git a/docs/content/ts-sdk/api/client/interfaces/IotaMoveModuleId.md b/docs/content/ts-sdk/api/client/interfaces/IotaMoveModuleId.md deleted file mode 100644 index 52f844004ec..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/IotaMoveModuleId.md +++ /dev/null @@ -1,13 +0,0 @@ -# Interface: IotaMoveModuleId - -## Properties - -### address - -> **address**: `string` - ---- - -### name - -> **name**: `string` diff --git a/docs/content/ts-sdk/api/client/interfaces/IotaMoveNormalizedField.md b/docs/content/ts-sdk/api/client/interfaces/IotaMoveNormalizedField.md deleted file mode 100644 index f3e61999179..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/IotaMoveNormalizedField.md +++ /dev/null @@ -1,13 +0,0 @@ -# Interface: IotaMoveNormalizedField - -## Properties - -### name - -> **name**: `string` - ---- - -### type - -> **type**: [`IotaMoveNormalizedType`](../type-aliases/IotaMoveNormalizedType.md) diff --git a/docs/content/ts-sdk/api/client/interfaces/IotaMoveNormalizedFunction.md b/docs/content/ts-sdk/api/client/interfaces/IotaMoveNormalizedFunction.md deleted file mode 100644 index fbd5df5baa8..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/IotaMoveNormalizedFunction.md +++ /dev/null @@ -1,31 +0,0 @@ -# Interface: IotaMoveNormalizedFunction - -## Properties - -### isEntry - -> **isEntry**: `boolean` - ---- - -### parameters - -> **parameters**: [`IotaMoveNormalizedType`](../type-aliases/IotaMoveNormalizedType.md)[] - ---- - -### return - -> **return**: [`IotaMoveNormalizedType`](../type-aliases/IotaMoveNormalizedType.md)[] - ---- - -### typeParameters - -> **typeParameters**: [`IotaMoveAbilitySet`](IotaMoveAbilitySet.md)[] - ---- - -### visibility - -> **visibility**: [`IotaMoveVisibility`](../type-aliases/IotaMoveVisibility.md) diff --git a/docs/content/ts-sdk/api/client/interfaces/IotaMoveNormalizedModule.md b/docs/content/ts-sdk/api/client/interfaces/IotaMoveNormalizedModule.md deleted file mode 100644 index ee2f40a67e5..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/IotaMoveNormalizedModule.md +++ /dev/null @@ -1,45 +0,0 @@ -# Interface: IotaMoveNormalizedModule - -## Properties - -### address - -> **address**: `string` - ---- - -### exposedFunctions - -> **exposedFunctions**: `object` - -#### Index Signature - -\[`key`: `string`\]: [`IotaMoveNormalizedFunction`](IotaMoveNormalizedFunction.md) - ---- - -### fileFormatVersion - -> **fileFormatVersion**: `number` - ---- - -### friends - -> **friends**: [`IotaMoveModuleId`](IotaMoveModuleId.md)[] - ---- - -### name - -> **name**: `string` - ---- - -### structs - -> **structs**: `object` - -#### Index Signature - -\[`key`: `string`\]: [`IotaMoveNormalizedStruct`](IotaMoveNormalizedStruct.md) diff --git a/docs/content/ts-sdk/api/client/interfaces/IotaMoveNormalizedStruct.md b/docs/content/ts-sdk/api/client/interfaces/IotaMoveNormalizedStruct.md deleted file mode 100644 index d1b33f6803b..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/IotaMoveNormalizedStruct.md +++ /dev/null @@ -1,19 +0,0 @@ -# Interface: IotaMoveNormalizedStruct - -## Properties - -### abilities - -> **abilities**: [`IotaMoveAbilitySet`](IotaMoveAbilitySet.md) - ---- - -### fields - -> **fields**: [`IotaMoveNormalizedField`](IotaMoveNormalizedField.md)[] - ---- - -### typeParameters - -> **typeParameters**: [`IotaMoveStructTypeParameter`](IotaMoveStructTypeParameter.md)[] diff --git a/docs/content/ts-sdk/api/client/interfaces/IotaMoveStructTypeParameter.md b/docs/content/ts-sdk/api/client/interfaces/IotaMoveStructTypeParameter.md deleted file mode 100644 index a7648fc96d2..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/IotaMoveStructTypeParameter.md +++ /dev/null @@ -1,13 +0,0 @@ -# Interface: IotaMoveStructTypeParameter - -## Properties - -### constraints - -> **constraints**: [`IotaMoveAbilitySet`](IotaMoveAbilitySet.md) - ---- - -### isPhantom - -> **isPhantom**: `boolean` diff --git a/docs/content/ts-sdk/api/client/interfaces/IotaObjectData.md b/docs/content/ts-sdk/api/client/interfaces/IotaObjectData.md deleted file mode 100644 index 1d2105593ef..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/IotaObjectData.md +++ /dev/null @@ -1,85 +0,0 @@ -# Interface: IotaObjectData - -## Properties - -### bcs? - -> `optional` **bcs**: `null` \| [`RawData`](../type-aliases/RawData.md) - -Move object content or package content in BCS, default to be None unless -IotaObjectDataOptions.showBcs is set to true - ---- - -### content? - -> `optional` **content**: `null` \| [`IotaParsedData`](../type-aliases/IotaParsedData.md) - -Move object content or package content, default to be None unless IotaObjectDataOptions.showContent -is set to true - ---- - -### digest - -> **digest**: `string` - -Base64 string representing the object digest - ---- - -### display? - -> `optional` **display**: `null` \| [`DisplayFieldsResponse`](DisplayFieldsResponse.md) - -The Display metadata for frontend UI rendering, default to be None unless -IotaObjectDataOptions.showContent is set to true This can also be None if the struct type does not -have Display defined - ---- - -### objectId - -> **objectId**: `string` - ---- - -### owner? - -> `optional` **owner**: `null` \| [`ObjectOwner`](../type-aliases/ObjectOwner.md) - -The owner of this object. Default to be None unless IotaObjectDataOptions.showOwner is set to true - ---- - -### previousTransaction? - -> `optional` **previousTransaction**: `null` \| `string` - -The digest of the transaction that created or last mutated this object. Default to be None unless -IotaObjectDataOptions. showPreviousTransaction is set to true - ---- - -### storageRebate? - -> `optional` **storageRebate**: `null` \| `string` - -The amount of IOTA we would rebate if this object gets deleted. This number is re-calculated each -time the object is mutated based on the present storage gas price. - ---- - -### type? - -> `optional` **type**: `null` \| `string` - -The type of the object. Default to be None unless IotaObjectDataOptions.showType is set to true - ---- - -### version - -> **version**: `string` - -Object version. diff --git a/docs/content/ts-sdk/api/client/interfaces/IotaObjectDataOptions.md b/docs/content/ts-sdk/api/client/interfaces/IotaObjectDataOptions.md deleted file mode 100644 index ee6b3a8e9b0..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/IotaObjectDataOptions.md +++ /dev/null @@ -1,58 +0,0 @@ -# Interface: IotaObjectDataOptions - -## Properties - -### showBcs? - -> `optional` **showBcs**: `boolean` - -Whether to show the content in BCS format. Default to be False - ---- - -### showContent? - -> `optional` **showContent**: `boolean` - -Whether to show the content(i.e., package content or Move struct content) of the object. Default to -be False - ---- - -### showDisplay? - -> `optional` **showDisplay**: `boolean` - -Whether to show the Display metadata of the object for frontend rendering. Default to be False - ---- - -### showOwner? - -> `optional` **showOwner**: `boolean` - -Whether to show the owner of the object. Default to be False - ---- - -### showPreviousTransaction? - -> `optional` **showPreviousTransaction**: `boolean` - -Whether to show the previous transaction digest of the object. Default to be False - ---- - -### showStorageRebate? - -> `optional` **showStorageRebate**: `boolean` - -Whether to show the storage rebate of the object. Default to be False - ---- - -### showType? - -> `optional` **showType**: `boolean` - -Whether to show the type of the object. Default to be False diff --git a/docs/content/ts-sdk/api/client/interfaces/IotaObjectRef.md b/docs/content/ts-sdk/api/client/interfaces/IotaObjectRef.md deleted file mode 100644 index 929957478b6..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/IotaObjectRef.md +++ /dev/null @@ -1,25 +0,0 @@ -# Interface: IotaObjectRef - -## Properties - -### digest - -> **digest**: `string` - -Base64 string representing the object digest - ---- - -### objectId - -> **objectId**: `string` - -Hex code as string representing the object id - ---- - -### version - -> **version**: `string` - -Object version. diff --git a/docs/content/ts-sdk/api/client/interfaces/IotaObjectResponse.md b/docs/content/ts-sdk/api/client/interfaces/IotaObjectResponse.md deleted file mode 100644 index d20f8477626..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/IotaObjectResponse.md +++ /dev/null @@ -1,13 +0,0 @@ -# Interface: IotaObjectResponse - -## Properties - -### data? - -> `optional` **data**: `null` \| [`IotaObjectData`](IotaObjectData.md) - ---- - -### error? - -> `optional` **error**: `null` \| [`ObjectResponseError`](../type-aliases/ObjectResponseError.md) diff --git a/docs/content/ts-sdk/api/client/interfaces/IotaObjectResponseQuery.md b/docs/content/ts-sdk/api/client/interfaces/IotaObjectResponseQuery.md deleted file mode 100644 index 36b3f1a28bb..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/IotaObjectResponseQuery.md +++ /dev/null @@ -1,17 +0,0 @@ -# Interface: IotaObjectResponseQuery - -## Properties - -### filter? - -> `optional` **filter**: `null` \| [`IotaObjectDataFilter`](../type-aliases/IotaObjectDataFilter.md) - -If None, no filter will be applied - ---- - -### options? - -> `optional` **options**: `null` \| [`IotaObjectDataOptions`](IotaObjectDataOptions.md) - -config which fields to include in the response, by default only digest is included diff --git a/docs/content/ts-sdk/api/client/interfaces/IotaSystemStateSummary.md b/docs/content/ts-sdk/api/client/interfaces/IotaSystemStateSummary.md deleted file mode 100644 index 61acf4eacbd..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/IotaSystemStateSummary.md +++ /dev/null @@ -1,288 +0,0 @@ -# Interface: IotaSystemStateSummary - -This is the JSON-RPC type for the IOTA system state object. It flattens all fields to make them -top-level fields such that it as minimum dependencies to the internal data structures of the IOTA -system state type. - -## Properties - -### activeValidators - -> **activeValidators**: [`IotaValidatorSummary`](IotaValidatorSummary.md)[] - -The list of active validators in the current epoch. - ---- - -### atRiskValidators - -> **atRiskValidators**: [`string`, `string`][] - -Map storing the number of epochs for which each validator has been below the low stake threshold. - ---- - -### epoch - -> **epoch**: `string` - -The current epoch ID, starting from 0. - ---- - -### epochDurationMs - -> **epochDurationMs**: `string` - -The duration of an epoch, in milliseconds. - ---- - -### epochStartTimestampMs - -> **epochStartTimestampMs**: `string` - -Unix timestamp of the current epoch start - ---- - -### inactivePoolsId - -> **inactivePoolsId**: `string` - -ID of the object that maps from a staking pool ID to the inactive validator that has that pool as -its staking pool. - ---- - -### inactivePoolsSize - -> **inactivePoolsSize**: `string` - -Number of inactive staking pools. - ---- - -### iotaTotalSupply - -> **iotaTotalSupply**: `string` - -The current IOTA supply. - ---- - -### iotaTreasuryCapId - -> **iotaTreasuryCapId**: `string` - -The `TreasuryCap` object ID. - ---- - -### maxValidatorCount - -> **maxValidatorCount**: `string` - -Maximum number of active validators at any moment. We do not allow the number of validators in any -epoch to go above this. - ---- - -### minValidatorCount - -> **minValidatorCount**: `string` - -Minimum number of active validators at any moment. We do not allow the number of validators in any -epoch to go under this. - ---- - -### minValidatorJoiningStake - -> **minValidatorJoiningStake**: `string` - -Lower-bound on the amount of stake required to become a validator. - ---- - -### pendingActiveValidatorsId - -> **pendingActiveValidatorsId**: `string` - -ID of the object that contains the list of new validators that will join at the end of the epoch. - ---- - -### pendingActiveValidatorsSize - -> **pendingActiveValidatorsSize**: `string` - -Number of new validators that will join at the end of the epoch. - ---- - -### pendingRemovals - -> **pendingRemovals**: `string`[] - -Removal requests from the validators. Each element is an index pointing to `active_validators`. - ---- - -### protocolVersion - -> **protocolVersion**: `string` - -The current protocol version, starting from 1. - ---- - -### referenceGasPrice - -> **referenceGasPrice**: `string` - -The reference gas price for the current epoch. - ---- - -### safeMode - -> **safeMode**: `boolean` - -Whether the system is running in a downgraded safe mode due to a non-recoverable bug. This is set -whenever we failed to execute advance_epoch, and ended up executing advance_epoch_safe_mode. It can -be reset once we are able to successfully execute advance_epoch. - ---- - -### safeModeComputationRewards - -> **safeModeComputationRewards**: `string` - -Amount of computation rewards accumulated (and not yet distributed) during safe mode. - ---- - -### safeModeNonRefundableStorageFee - -> **safeModeNonRefundableStorageFee**: `string` - -Amount of non-refundable storage fee accumulated during safe mode. - ---- - -### safeModeStorageCharges - -> **safeModeStorageCharges**: `string` - -Amount of storage charges accumulated (and not yet distributed) during safe mode. - ---- - -### safeModeStorageRebates - -> **safeModeStorageRebates**: `string` - -Amount of storage rebates accumulated (and not yet burned) during safe mode. - ---- - -### stakingPoolMappingsId - -> **stakingPoolMappingsId**: `string` - -ID of the object that maps from staking pool's ID to the iota address of a validator. - ---- - -### stakingPoolMappingsSize - -> **stakingPoolMappingsSize**: `string` - -Number of staking pool mappings. - ---- - -### storageFundNonRefundableBalance - -> **storageFundNonRefundableBalance**: `string` - -The non-refundable portion of the storage fund coming from non-refundable storage rebates and any -leftover staking rewards. - ---- - -### storageFundTotalObjectStorageRebates - -> **storageFundTotalObjectStorageRebates**: `string` - -The storage rebates of all the objects on-chain stored in the storage fund. - ---- - -### systemStateVersion - -> **systemStateVersion**: `string` - -The current version of the system state data structure type. - ---- - -### totalStake - -> **totalStake**: `string` - -Total amount of stake from all active validators at the beginning of the epoch. - ---- - -### validatorCandidatesId - -> **validatorCandidatesId**: `string` - -ID of the object that stores preactive validators, mapping their addresses to their `Validator` -structs. - ---- - -### validatorCandidatesSize - -> **validatorCandidatesSize**: `string` - -Number of preactive validators. - ---- - -### validatorLowStakeGracePeriod - -> **validatorLowStakeGracePeriod**: `string` - -A validator can have stake below `validator_low_stake_threshold` for this many epochs before being -kicked out. - ---- - -### validatorLowStakeThreshold - -> **validatorLowStakeThreshold**: `string` - -Validators with stake amount below `validator_low_stake_threshold` are considered to have low stake -and will be escorted out of the validator set after being below this threshold for more than -`validator_low_stake_grace_period` number of epochs. - ---- - -### validatorReportRecords - -> **validatorReportRecords**: [`string`, `string`[]][] - -A map storing the records of validator reporting each other. - ---- - -### validatorVeryLowStakeThreshold - -> **validatorVeryLowStakeThreshold**: `string` - -Validators with stake below `validator_very_low_stake_threshold` will be removed immediately at -epoch change, no grace period. diff --git a/docs/content/ts-sdk/api/client/interfaces/IotaTransactionBlock.md b/docs/content/ts-sdk/api/client/interfaces/IotaTransactionBlock.md deleted file mode 100644 index da80ed00cb9..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/IotaTransactionBlock.md +++ /dev/null @@ -1,13 +0,0 @@ -# Interface: IotaTransactionBlock - -## Properties - -### data - -> **data**: [`TransactionBlockData`](../type-aliases/TransactionBlockData.md) - ---- - -### txSignatures - -> **txSignatures**: `string`[] diff --git a/docs/content/ts-sdk/api/client/interfaces/IotaTransactionBlockResponse.md b/docs/content/ts-sdk/api/client/interfaces/IotaTransactionBlockResponse.md deleted file mode 100644 index ad39282bed1..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/IotaTransactionBlockResponse.md +++ /dev/null @@ -1,81 +0,0 @@ -# Interface: IotaTransactionBlockResponse - -## Properties - -### balanceChanges? - -> `optional` **balanceChanges**: `null` \| [`BalanceChange`](BalanceChange.md)[] - ---- - -### checkpoint? - -> `optional` **checkpoint**: `null` \| `string` - -The checkpoint number when this transaction was included and hence finalized. This is only returned -in the read api, not in the transaction execution api. - ---- - -### confirmedLocalExecution? - -> `optional` **confirmedLocalExecution**: `null` \| `boolean` - ---- - -### digest - -> **digest**: `string` - ---- - -### effects? - -> `optional` **effects**: `null` \| [`TransactionEffects`](../type-aliases/TransactionEffects.md) - ---- - -### errors? - -> `optional` **errors**: `string`[] - ---- - -### events? - -> `optional` **events**: `null` \| [`IotaEvent`](IotaEvent.md)[] - ---- - -### objectChanges? - -> `optional` **objectChanges**: `null` \| [`IotaObjectChange`](../type-aliases/IotaObjectChange.md)[] - ---- - -### rawEffects? - -> `optional` **rawEffects**: `number`[] - ---- - -### rawTransaction? - -> `optional` **rawTransaction**: `string` - -BCS encoded [SenderSignedData] that includes input object references returns empty array if -`show_raw_transaction` is false - ---- - -### timestampMs? - -> `optional` **timestampMs**: `null` \| `string` - ---- - -### transaction? - -> `optional` **transaction**: `null` \| [`IotaTransactionBlock`](IotaTransactionBlock.md) - -Transaction input data diff --git a/docs/content/ts-sdk/api/client/interfaces/IotaTransactionBlockResponseOptions.md b/docs/content/ts-sdk/api/client/interfaces/IotaTransactionBlockResponseOptions.md deleted file mode 100644 index 9d9e5fd4065..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/IotaTransactionBlockResponseOptions.md +++ /dev/null @@ -1,57 +0,0 @@ -# Interface: IotaTransactionBlockResponseOptions - -## Properties - -### showBalanceChanges? - -> `optional` **showBalanceChanges**: `boolean` - -Whether to show balance_changes. Default to be False - ---- - -### showEffects? - -> `optional` **showEffects**: `boolean` - -Whether to show transaction effects. Default to be False - ---- - -### showEvents? - -> `optional` **showEvents**: `boolean` - -Whether to show transaction events. Default to be False - ---- - -### showInput? - -> `optional` **showInput**: `boolean` - -Whether to show transaction input data. Default to be False - ---- - -### showObjectChanges? - -> `optional` **showObjectChanges**: `boolean` - -Whether to show object_changes. Default to be False - ---- - -### showRawEffects? - -> `optional` **showRawEffects**: `boolean` - -Whether to show raw transaction effects. Default to be False - ---- - -### showRawInput? - -> `optional` **showRawInput**: `boolean` - -Whether to show bcs-encoded transaction input data diff --git a/docs/content/ts-sdk/api/client/interfaces/IotaTransactionBlockResponseQuery.md b/docs/content/ts-sdk/api/client/interfaces/IotaTransactionBlockResponseQuery.md deleted file mode 100644 index a3ebf2cc2d1..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/IotaTransactionBlockResponseQuery.md +++ /dev/null @@ -1,17 +0,0 @@ -# Interface: IotaTransactionBlockResponseQuery - -## Properties - -### filter? - -> `optional` **filter**: `null` \| [`TransactionFilter`](../type-aliases/TransactionFilter.md) - -If None, no filter will be applied - ---- - -### options? - -> `optional` **options**: `null` \| [`IotaTransactionBlockResponseOptions`](IotaTransactionBlockResponseOptions.md) - -config which fields to include in the response, by default only digest is included diff --git a/docs/content/ts-sdk/api/client/interfaces/IotaTransport.md b/docs/content/ts-sdk/api/client/interfaces/IotaTransport.md deleted file mode 100644 index bf8540667e9..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/IotaTransport.md +++ /dev/null @@ -1,37 +0,0 @@ -# Interface: IotaTransport - -## Methods - -### request() - -> **request**\<`T`\>(`input`): `Promise`\<`T`\> - -#### Type Parameters - -• **T** = `unknown` - -#### Parameters - -• **input**: [`IotaTransportRequestOptions`](IotaTransportRequestOptions.md) - -#### Returns - -`Promise`\<`T`\> - ---- - -### subscribe() - -> **subscribe**\<`T`\>(`input`): `Promise`\<() => `Promise`\<`boolean`\>\> - -#### Type Parameters - -• **T** = `unknown` - -#### Parameters - -• **input**: [`IotaTransportSubscribeOptions`](IotaTransportSubscribeOptions.md)\<`T`\> - -#### Returns - -`Promise`\<() => `Promise`\<`boolean`\>\> diff --git a/docs/content/ts-sdk/api/client/interfaces/IotaTransportRequestOptions.md b/docs/content/ts-sdk/api/client/interfaces/IotaTransportRequestOptions.md deleted file mode 100644 index ee306cd816b..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/IotaTransportRequestOptions.md +++ /dev/null @@ -1,13 +0,0 @@ -# Interface: IotaTransportRequestOptions - -## Properties - -### method - -> **method**: `string` - ---- - -### params - -> **params**: `unknown`[] diff --git a/docs/content/ts-sdk/api/client/interfaces/IotaTransportSubscribeOptions.md b/docs/content/ts-sdk/api/client/interfaces/IotaTransportSubscribeOptions.md deleted file mode 100644 index 8e95b561428..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/IotaTransportSubscribeOptions.md +++ /dev/null @@ -1,37 +0,0 @@ -# Interface: IotaTransportSubscribeOptions\ - -## Type Parameters - -• **T** - -## Properties - -### method - -> **method**: `string` - ---- - -### unsubscribe - -> **unsubscribe**: `string` - ---- - -### params - -> **params**: `unknown`[] - ---- - -### onMessage() - -> **onMessage**: (`event`) => `void` - -#### Parameters - -• **event**: `T` - -#### Returns - -`void` diff --git a/docs/content/ts-sdk/api/client/interfaces/IotaValidatorSummary.md b/docs/content/ts-sdk/api/client/interfaces/IotaValidatorSummary.md deleted file mode 100644 index 441e9aa0a50..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/IotaValidatorSummary.md +++ /dev/null @@ -1,248 +0,0 @@ -# Interface: IotaValidatorSummary - -This is the JSON-RPC type for the IOTA validator. It flattens all inner structures to top-level -fields so that they are decoupled from the internal definitions. - -## Properties - -### authorityPubkeyBytes - -> **authorityPubkeyBytes**: `string` - ---- - -### commissionRate - -> **commissionRate**: `string` - ---- - -### description - -> **description**: `string` - ---- - -### exchangeRatesId - -> **exchangeRatesId**: `string` - -ID of the exchange rate table object. - ---- - -### exchangeRatesSize - -> **exchangeRatesSize**: `string` - -Number of exchange rates in the table. - ---- - -### gasPrice - -> **gasPrice**: `string` - ---- - -### imageUrl - -> **imageUrl**: `string` - ---- - -### iotaAddress - -> **iotaAddress**: `string` - ---- - -### name - -> **name**: `string` - ---- - -### netAddress - -> **netAddress**: `string` - ---- - -### networkPubkeyBytes - -> **networkPubkeyBytes**: `string` - ---- - -### nextEpochAuthorityPubkeyBytes? - -> `optional` **nextEpochAuthorityPubkeyBytes**: `null` \| `string` - ---- - -### nextEpochCommissionRate - -> **nextEpochCommissionRate**: `string` - ---- - -### nextEpochGasPrice - -> **nextEpochGasPrice**: `string` - ---- - -### nextEpochNetAddress? - -> `optional` **nextEpochNetAddress**: `null` \| `string` - ---- - -### nextEpochNetworkPubkeyBytes? - -> `optional` **nextEpochNetworkPubkeyBytes**: `null` \| `string` - ---- - -### nextEpochP2pAddress? - -> `optional` **nextEpochP2pAddress**: `null` \| `string` - ---- - -### nextEpochPrimaryAddress? - -> `optional` **nextEpochPrimaryAddress**: `null` \| `string` - ---- - -### nextEpochProofOfPossession? - -> `optional` **nextEpochProofOfPossession**: `null` \| `string` - ---- - -### nextEpochProtocolPubkeyBytes? - -> `optional` **nextEpochProtocolPubkeyBytes**: `null` \| `string` - ---- - -### nextEpochStake - -> **nextEpochStake**: `string` - ---- - -### operationCapId - -> **operationCapId**: `string` - ---- - -### p2pAddress - -> **p2pAddress**: `string` - ---- - -### pendingPoolTokenWithdraw - -> **pendingPoolTokenWithdraw**: `string` - -Pending pool token withdrawn during the current epoch, emptied at epoch boundaries. - ---- - -### pendingStake - -> **pendingStake**: `string` - -Pending stake amount for this epoch. - ---- - -### pendingTotalIotaWithdraw - -> **pendingTotalIotaWithdraw**: `string` - -Pending stake withdrawn during the current epoch, emptied at epoch boundaries. - ---- - -### poolTokenBalance - -> **poolTokenBalance**: `string` - -Total number of pool tokens issued by the pool. - ---- - -### primaryAddress - -> **primaryAddress**: `string` - ---- - -### projectUrl - -> **projectUrl**: `string` - ---- - -### proofOfPossessionBytes - -> **proofOfPossessionBytes**: `string` - ---- - -### protocolPubkeyBytes - -> **protocolPubkeyBytes**: `string` - ---- - -### rewardsPool - -> **rewardsPool**: `string` - -The epoch stake rewards will be added here at the end of each epoch. - ---- - -### stakingPoolActivationEpoch? - -> `optional` **stakingPoolActivationEpoch**: `null` \| `string` - -The epoch at which this pool became active. - ---- - -### stakingPoolDeactivationEpoch? - -> `optional` **stakingPoolDeactivationEpoch**: `null` \| `string` - -The epoch at which this staking pool ceased to be active. `None` = {pre-active, active}, - ---- - -### stakingPoolId - -> **stakingPoolId**: `string` - -ID of the staking pool object. - ---- - -### stakingPoolIotaBalance - -> **stakingPoolIotaBalance**: `string` - -The total number of IOTA tokens in this pool. - ---- - -### votingPower - -> **votingPower**: `string` diff --git a/docs/content/ts-sdk/api/client/interfaces/KioskConfiguration.md b/docs/content/ts-sdk/api/client/interfaces/KioskConfiguration.md deleted file mode 100644 index 467b17aeda4..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/KioskConfiguration.md +++ /dev/null @@ -1,25 +0,0 @@ -# Interface: KioskConfiguration - -## Properties - -### royaltyRulePackageId - -> **royaltyRulePackageId**: `string` - ---- - -### kioskLockRulePackageId - -> **kioskLockRulePackageId**: `string` - ---- - -### floorPriceRulePackageId - -> **floorPriceRulePackageId**: `string` - ---- - -### personalKioskRulePackageId - -> **personalKioskRulePackageId**: `string` diff --git a/docs/content/ts-sdk/api/client/interfaces/MoveCallIotaTransaction.md b/docs/content/ts-sdk/api/client/interfaces/MoveCallIotaTransaction.md deleted file mode 100644 index cc6d5e31d27..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/MoveCallIotaTransaction.md +++ /dev/null @@ -1,44 +0,0 @@ -# Interface: MoveCallIotaTransaction - -The transaction for calling a Move function, either an entry function or a public function (which -cannot return references). - -## Properties - -### arguments? - -> `optional` **arguments**: [`IotaArgument`](../type-aliases/IotaArgument.md)[] - -The arguments to the function. - ---- - -### function - -> **function**: `string` - -The function to be called. - ---- - -### module - -> **module**: `string` - -The specific module in the package containing the function. - ---- - -### package - -> **package**: `string` - -The package containing the module and function. - ---- - -### type\_arguments? - -> `optional` **type\_arguments**: `string`[] - -The type arguments to the function. diff --git a/docs/content/ts-sdk/api/client/interfaces/MoveCallMetrics.md b/docs/content/ts-sdk/api/client/interfaces/MoveCallMetrics.md deleted file mode 100644 index 9973d3f3e0c..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/MoveCallMetrics.md +++ /dev/null @@ -1,25 +0,0 @@ -# Interface: MoveCallMetrics - -## Properties - -### rank30Days - -> **rank30Days**: [[`MoveFunctionName`](MoveFunctionName.md), `string`][] - -The count of calls of each function in the last 30 days. - ---- - -### rank3Days - -> **rank3Days**: [[`MoveFunctionName`](MoveFunctionName.md), `string`][] - -The count of calls of each function in the last 3 days. - ---- - -### rank7Days - -> **rank7Days**: [[`MoveFunctionName`](MoveFunctionName.md), `string`][] - -The count of calls of each function in the last 7 days. diff --git a/docs/content/ts-sdk/api/client/interfaces/MoveCallParams.md b/docs/content/ts-sdk/api/client/interfaces/MoveCallParams.md deleted file mode 100644 index 0df4e11284b..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/MoveCallParams.md +++ /dev/null @@ -1,31 +0,0 @@ -# Interface: MoveCallParams - -## Properties - -### arguments - -> **arguments**: `unknown`[] - ---- - -### function - -> **function**: `string` - ---- - -### module - -> **module**: `string` - ---- - -### packageObjectId - -> **packageObjectId**: `string` - ---- - -### typeArguments? - -> `optional` **typeArguments**: `string`[] diff --git a/docs/content/ts-sdk/api/client/interfaces/MoveFunctionName.md b/docs/content/ts-sdk/api/client/interfaces/MoveFunctionName.md deleted file mode 100644 index b4611e5b520..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/MoveFunctionName.md +++ /dev/null @@ -1,27 +0,0 @@ -# Interface: MoveFunctionName - -Identifies a Move function. - -## Properties - -### function - -> **function**: `string` - -The function name. - ---- - -### module - -> **module**: `string` - -The module name to which the function belongs. - ---- - -### package - -> **package**: `string` - -The package ID to which the function belongs. diff --git a/docs/content/ts-sdk/api/client/interfaces/MoveVariant.md b/docs/content/ts-sdk/api/client/interfaces/MoveVariant.md deleted file mode 100644 index b5ec11a3d8f..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/MoveVariant.md +++ /dev/null @@ -1,23 +0,0 @@ -# Interface: MoveVariant - -## Properties - -### fields - -> **fields**: `object` - -#### Index Signature - -\[`key`: `string`\]: [`MoveValue`](../type-aliases/MoveValue.md) - ---- - -### type - -> **type**: `string` - ---- - -### variant - -> **variant**: `string` diff --git a/docs/content/ts-sdk/api/client/interfaces/MultiGetObjectsParams.md b/docs/content/ts-sdk/api/client/interfaces/MultiGetObjectsParams.md deleted file mode 100644 index bb4b886dc0f..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/MultiGetObjectsParams.md +++ /dev/null @@ -1,19 +0,0 @@ -# Interface: MultiGetObjectsParams - -Return the object data for a list of objects - -## Properties - -### ids - -> **ids**: `string`[] - -the IDs of the queried objects - ---- - -### options? - -> `optional` **options**: `null` \| [`IotaObjectDataOptions`](IotaObjectDataOptions.md) - -options for specifying the content to be returned diff --git a/docs/content/ts-sdk/api/client/interfaces/MultiGetTransactionBlocksParams.md b/docs/content/ts-sdk/api/client/interfaces/MultiGetTransactionBlocksParams.md deleted file mode 100644 index 1c9436be4be..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/MultiGetTransactionBlocksParams.md +++ /dev/null @@ -1,20 +0,0 @@ -# Interface: MultiGetTransactionBlocksParams - -Returns an ordered list of transaction responses The method will throw an error if the input -contains any duplicate or the input size exceeds QUERY_MAX_RESULT_LIMIT - -## Properties - -### digests - -> **digests**: `string`[] - -A list of transaction digests. - ---- - -### options? - -> `optional` **options**: `null` \| [`IotaTransactionBlockResponseOptions`](IotaTransactionBlockResponseOptions.md) - -config options to control which fields to fetch diff --git a/docs/content/ts-sdk/api/client/interfaces/MultiSig.md b/docs/content/ts-sdk/api/client/interfaces/MultiSig.md deleted file mode 100644 index b3f6150e610..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/MultiSig.md +++ /dev/null @@ -1,28 +0,0 @@ -# Interface: MultiSig - -The struct that contains signatures and public keys necessary for authenticating a MultiSig. - -## Properties - -### bitmap - -> **bitmap**: `number` - -A bitmap that indicates the position of which public key the signature should be authenticated with. - ---- - -### multisig\_pk - -> **multisig\_pk**: [`MultiSigPublicKey`](MultiSigPublicKey.md) - -The public key encoded with each public key with its signature scheme used along with the -corresponding weight. - ---- - -### sigs - -> **sigs**: [`CompressedSignature`](../type-aliases/CompressedSignature.md)[] - -The plain signature encoded with signature scheme. diff --git a/docs/content/ts-sdk/api/client/interfaces/MultiSigPublicKey.md b/docs/content/ts-sdk/api/client/interfaces/MultiSigPublicKey.md deleted file mode 100644 index 28f052a45e2..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/MultiSigPublicKey.md +++ /dev/null @@ -1,20 +0,0 @@ -# Interface: MultiSigPublicKey - -The struct that contains the public key used for authenticating a MultiSig. - -## Properties - -### pk\_map - -> **pk\_map**: [[`PublicKey`](../type-aliases/PublicKey.md), `number`][] - -A list of public key and its corresponding weight. - ---- - -### threshold - -> **threshold**: `number` - -If the total weight of the public keys corresponding to verified signatures is larger than -threshold, the MultiSig is verified. diff --git a/docs/content/ts-sdk/api/client/interfaces/NetworkConfiguration.md b/docs/content/ts-sdk/api/client/interfaces/NetworkConfiguration.md deleted file mode 100644 index d065dc211ff..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/NetworkConfiguration.md +++ /dev/null @@ -1,43 +0,0 @@ -# Interface: NetworkConfiguration - -## Properties - -### id - -> **id**: [`Network`](../enumerations/Network.md) - ---- - -### name - -> **name**: `string` - ---- - -### url - -> **url**: `string` - ---- - -### explorer - -> **explorer**: `string` - ---- - -### chain - -> **chain**: \`$\{string\}:$\{string\}\` - ---- - -### faucet? - -> `optional` **faucet**: `string` - ---- - -### kiosk? - -> `optional` **kiosk**: [`KioskConfiguration`](KioskConfiguration.md) diff --git a/docs/content/ts-sdk/api/client/interfaces/NetworkMetrics.md b/docs/content/ts-sdk/api/client/interfaces/NetworkMetrics.md deleted file mode 100644 index 3ab8ca92476..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/NetworkMetrics.md +++ /dev/null @@ -1,57 +0,0 @@ -# Interface: NetworkMetrics - -## Properties - -### currentCheckpoint - -> **currentCheckpoint**: `string` - -Current checkpoint number - ---- - -### currentEpoch - -> **currentEpoch**: `string` - -Current epoch number - ---- - -### currentTps - -> **currentTps**: `number` - -Current TPS - Transaction Blocks per Second. - ---- - -### totalAddresses - -> **totalAddresses**: `string` - -Total number of addresses seen in the network - ---- - -### totalObjects - -> **totalObjects**: `string` - -Total number of live objects in the network - ---- - -### totalPackages - -> **totalPackages**: `string` - -Total number of packages published in the network - ---- - -### tps30Days - -> **tps30Days**: `number` - -Peak TPS in the past 30 days diff --git a/docs/content/ts-sdk/api/client/interfaces/OrderArguments.md b/docs/content/ts-sdk/api/client/interfaces/OrderArguments.md deleted file mode 100644 index 2a7e253eee2..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/OrderArguments.md +++ /dev/null @@ -1,7 +0,0 @@ -# Interface: OrderArguments - -## Properties - -### order? - -> `optional` **order**: `null` \| [`Order`](../type-aliases/Order.md) diff --git a/docs/content/ts-sdk/api/client/interfaces/OwnedObjectRef.md b/docs/content/ts-sdk/api/client/interfaces/OwnedObjectRef.md deleted file mode 100644 index ab63f1639fa..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/OwnedObjectRef.md +++ /dev/null @@ -1,13 +0,0 @@ -# Interface: OwnedObjectRef - -## Properties - -### owner - -> **owner**: [`ObjectOwner`](../type-aliases/ObjectOwner.md) - ---- - -### reference - -> **reference**: [`IotaObjectRef`](IotaObjectRef.md) diff --git a/docs/content/ts-sdk/api/client/interfaces/PaginatedCheckpoints.md b/docs/content/ts-sdk/api/client/interfaces/PaginatedCheckpoints.md deleted file mode 100644 index acd0188123d..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/PaginatedCheckpoints.md +++ /dev/null @@ -1,23 +0,0 @@ -# Interface: PaginatedCheckpoints - -`next_cursor` points to the last item in the page; Reading with `next_cursor` will start from the -next item after `next_cursor` if `next_cursor` is `Some`, otherwise it will start from the first -item. - -## Properties - -### data - -> **data**: [`Checkpoint`](Checkpoint.md)[] - ---- - -### hasNextPage - -> **hasNextPage**: `boolean` - ---- - -### nextCursor? - -> `optional` **nextCursor**: `null` \| `string` diff --git a/docs/content/ts-sdk/api/client/interfaces/PaginatedCoins.md b/docs/content/ts-sdk/api/client/interfaces/PaginatedCoins.md deleted file mode 100644 index 0e3be66b2f3..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/PaginatedCoins.md +++ /dev/null @@ -1,23 +0,0 @@ -# Interface: PaginatedCoins - -`next_cursor` points to the last item in the page; Reading with `next_cursor` will start from the -next item after `next_cursor` if `next_cursor` is `Some`, otherwise it will start from the first -item. - -## Properties - -### data - -> **data**: [`CoinStruct`](CoinStruct.md)[] - ---- - -### hasNextPage - -> **hasNextPage**: `boolean` - ---- - -### nextCursor? - -> `optional` **nextCursor**: `null` \| `string` diff --git a/docs/content/ts-sdk/api/client/interfaces/PaginatedDynamicFieldInfos.md b/docs/content/ts-sdk/api/client/interfaces/PaginatedDynamicFieldInfos.md deleted file mode 100644 index 7c4bf33f4a6..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/PaginatedDynamicFieldInfos.md +++ /dev/null @@ -1,23 +0,0 @@ -# Interface: PaginatedDynamicFieldInfos - -`next_cursor` points to the last item in the page; Reading with `next_cursor` will start from the -next item after `next_cursor` if `next_cursor` is `Some`, otherwise it will start from the first -item. - -## Properties - -### data - -> **data**: [`DynamicFieldInfo`](DynamicFieldInfo.md)[] - ---- - -### hasNextPage - -> **hasNextPage**: `boolean` - ---- - -### nextCursor? - -> `optional` **nextCursor**: `null` \| `string` diff --git a/docs/content/ts-sdk/api/client/interfaces/PaginatedEpochInfos.md b/docs/content/ts-sdk/api/client/interfaces/PaginatedEpochInfos.md deleted file mode 100644 index d82329f9387..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/PaginatedEpochInfos.md +++ /dev/null @@ -1,23 +0,0 @@ -# Interface: PaginatedEpochInfos - -`next_cursor` points to the last item in the page; Reading with `next_cursor` will start from the -next item after `next_cursor` if `next_cursor` is `Some`, otherwise it will start from the first -item. - -## Properties - -### data - -> **data**: [`EpochInfo`](EpochInfo.md)[] - ---- - -### hasNextPage - -> **hasNextPage**: `boolean` - ---- - -### nextCursor? - -> `optional` **nextCursor**: `null` \| `string` diff --git a/docs/content/ts-sdk/api/client/interfaces/PaginatedEpochMetricss.md b/docs/content/ts-sdk/api/client/interfaces/PaginatedEpochMetricss.md deleted file mode 100644 index c4a4a7d697f..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/PaginatedEpochMetricss.md +++ /dev/null @@ -1,23 +0,0 @@ -# Interface: PaginatedEpochMetricss - -`next_cursor` points to the last item in the page; Reading with `next_cursor` will start from the -next item after `next_cursor` if `next_cursor` is `Some`, otherwise it will start from the first -item. - -## Properties - -### data - -> **data**: [`EpochMetrics`](EpochMetrics.md)[] - ---- - -### hasNextPage - -> **hasNextPage**: `boolean` - ---- - -### nextCursor? - -> `optional` **nextCursor**: `null` \| `string` diff --git a/docs/content/ts-sdk/api/client/interfaces/PaginatedEvents.md b/docs/content/ts-sdk/api/client/interfaces/PaginatedEvents.md deleted file mode 100644 index 300f3849c7e..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/PaginatedEvents.md +++ /dev/null @@ -1,23 +0,0 @@ -# Interface: PaginatedEvents - -`next_cursor` points to the last item in the page; Reading with `next_cursor` will start from the -next item after `next_cursor` if `next_cursor` is `Some`, otherwise it will start from the first -item. - -## Properties - -### data - -> **data**: [`IotaEvent`](IotaEvent.md)[] - ---- - -### hasNextPage - -> **hasNextPage**: `boolean` - ---- - -### nextCursor? - -> `optional` **nextCursor**: `null` \| [`EventId`](EventId.md) diff --git a/docs/content/ts-sdk/api/client/interfaces/PaginatedObjectsResponse.md b/docs/content/ts-sdk/api/client/interfaces/PaginatedObjectsResponse.md deleted file mode 100644 index 047de986799..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/PaginatedObjectsResponse.md +++ /dev/null @@ -1,23 +0,0 @@ -# Interface: PaginatedObjectsResponse - -`next_cursor` points to the last item in the page; Reading with `next_cursor` will start from the -next item after `next_cursor` if `next_cursor` is `Some`, otherwise it will start from the first -item. - -## Properties - -### data - -> **data**: [`IotaObjectResponse`](IotaObjectResponse.md)[] - ---- - -### hasNextPage - -> **hasNextPage**: `boolean` - ---- - -### nextCursor? - -> `optional` **nextCursor**: `null` \| `string` diff --git a/docs/content/ts-sdk/api/client/interfaces/PaginatedTransactionResponse.md b/docs/content/ts-sdk/api/client/interfaces/PaginatedTransactionResponse.md deleted file mode 100644 index 2a820321557..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/PaginatedTransactionResponse.md +++ /dev/null @@ -1,23 +0,0 @@ -# Interface: PaginatedTransactionResponse - -`next_cursor` points to the last item in the page; Reading with `next_cursor` will start from the -next item after `next_cursor` if `next_cursor` is `Some`, otherwise it will start from the first -item. - -## Properties - -### data - -> **data**: [`IotaTransactionBlockResponse`](IotaTransactionBlockResponse.md)[] - ---- - -### hasNextPage - -> **hasNextPage**: `boolean` - ---- - -### nextCursor? - -> `optional` **nextCursor**: `null` \| `string` diff --git a/docs/content/ts-sdk/api/client/interfaces/PaginationArguments.md b/docs/content/ts-sdk/api/client/interfaces/PaginationArguments.md deleted file mode 100644 index 48e3a007045..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/PaginationArguments.md +++ /dev/null @@ -1,21 +0,0 @@ -# Interface: PaginationArguments\ - -## Type Parameters - -• **Cursor** - -## Properties - -### cursor? - -> `optional` **cursor**: `Cursor` - -Optional paging cursor - ---- - -### limit? - -> `optional` **limit**: `null` \| `number` - -Maximum item returned per page diff --git a/docs/content/ts-sdk/api/client/interfaces/PasskeyAuthenticator.md b/docs/content/ts-sdk/api/client/interfaces/PasskeyAuthenticator.md deleted file mode 100644 index 2bba01e9c04..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/PasskeyAuthenticator.md +++ /dev/null @@ -1,24 +0,0 @@ -# Interface: PasskeyAuthenticator - -An passkey authenticator with parsed fields. See field definition below. Can be initialized from -[struct RawPasskeyAuthenticator]. - -## Properties - -### authenticator\_data - -> **authenticator\_data**: `number`[] - -`authenticatorData` is a bytearray that encodes -[Authenticator Data](https://www.w3.org/TR/webauthn-2/#sctn-authenticator-data) structure returned -by the authenticator attestation response as is. - ---- - -### client\_data\_json - -> **client\_data\_json**: `string` - -`clientDataJSON` contains a JSON-compatible UTF-8 encoded string of the client data which is passed -to the authenticator by the client during the authentication request (see -[CollectedClientData](https://www.w3.org/TR/webauthn-2/#dictdef-collectedclientdata)) diff --git a/docs/content/ts-sdk/api/client/interfaces/ProtocolConfig.md b/docs/content/ts-sdk/api/client/interfaces/ProtocolConfig.md deleted file mode 100644 index 86dd2b6510d..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/ProtocolConfig.md +++ /dev/null @@ -1,39 +0,0 @@ -# Interface: ProtocolConfig - -## Properties - -### attributes - -> **attributes**: `object` - -#### Index Signature - -\[`key`: `string`\]: [`ProtocolConfigValue`](../type-aliases/ProtocolConfigValue.md) \| `null` - ---- - -### featureFlags - -> **featureFlags**: `object` - -#### Index Signature - -\[`key`: `string`\]: `boolean` - ---- - -### maxSupportedProtocolVersion - -> **maxSupportedProtocolVersion**: `string` - ---- - -### minSupportedProtocolVersion - -> **minSupportedProtocolVersion**: `string` - ---- - -### protocolVersion - -> **protocolVersion**: `string` diff --git a/docs/content/ts-sdk/api/client/interfaces/QueryEventsParams.md b/docs/content/ts-sdk/api/client/interfaces/QueryEventsParams.md deleted file mode 100644 index 2ee5773831f..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/QueryEventsParams.md +++ /dev/null @@ -1,37 +0,0 @@ -# Interface: QueryEventsParams - -Return list of events for a specified query criteria. - -## Properties - -### query - -> **query**: [`IotaEventFilter`](../type-aliases/IotaEventFilter.md) - -The event query criteria. See -[Event filter](https://docs.iota.org/developer/iota-101/using-events#applying-event-filters) -documentation for examples. - ---- - -### cursor? - -> `optional` **cursor**: `null` \| [`EventId`](EventId.md) - -optional paging cursor - ---- - -### limit? - -> `optional` **limit**: `null` \| `number` - -maximum number of items per page, default to [QUERY_MAX_RESULT_LIMIT] if not specified. - ---- - -### order? - -> `optional` **order**: `null` \| `"ascending"` \| `"descending"` - -query result ordering, default to false (ascending order), oldest record first. diff --git a/docs/content/ts-sdk/api/client/interfaces/SubscribeEventParams.md b/docs/content/ts-sdk/api/client/interfaces/SubscribeEventParams.md deleted file mode 100644 index 723b48cfbe2..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/SubscribeEventParams.md +++ /dev/null @@ -1,13 +0,0 @@ -# Interface: SubscribeEventParams - -Subscribe to a stream of IOTA event - -## Properties - -### filter - -> **filter**: [`IotaEventFilter`](../type-aliases/IotaEventFilter.md) - -The filter criteria of the event stream. See -[Event filter](https://docs.iota.org/developer/iota-101/using-events#applying-event-filters) -documentation for examples. diff --git a/docs/content/ts-sdk/api/client/interfaces/SubscribeTransactionParams.md b/docs/content/ts-sdk/api/client/interfaces/SubscribeTransactionParams.md deleted file mode 100644 index 3052c615e28..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/SubscribeTransactionParams.md +++ /dev/null @@ -1,9 +0,0 @@ -# Interface: SubscribeTransactionParams - -Subscribe to a stream of IOTA transaction effects - -## Properties - -### filter - -> **filter**: [`TransactionFilter`](../type-aliases/TransactionFilter.md) diff --git a/docs/content/ts-sdk/api/client/interfaces/TransactionBlockBytes.md b/docs/content/ts-sdk/api/client/interfaces/TransactionBlockBytes.md deleted file mode 100644 index b85858cd1b6..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/TransactionBlockBytes.md +++ /dev/null @@ -1,25 +0,0 @@ -# Interface: TransactionBlockBytes - -## Properties - -### gas - -> **gas**: [`IotaObjectRef`](IotaObjectRef.md)[] - -the gas objects to be used - ---- - -### inputObjects - -> **inputObjects**: [`InputObjectKind`](../type-aliases/InputObjectKind.md)[] - -objects to be used in this transaction - ---- - -### txBytes - -> **txBytes**: `string` - -BCS serialized transaction data bytes without its type tag, as base-64 encoded string. diff --git a/docs/content/ts-sdk/api/client/interfaces/TransactionBlockEffectsModifiedAtVersions.md b/docs/content/ts-sdk/api/client/interfaces/TransactionBlockEffectsModifiedAtVersions.md deleted file mode 100644 index 4ddb17de766..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/TransactionBlockEffectsModifiedAtVersions.md +++ /dev/null @@ -1,13 +0,0 @@ -# Interface: TransactionBlockEffectsModifiedAtVersions - -## Properties - -### objectId - -> **objectId**: `string` - ---- - -### sequenceNumber - -> **sequenceNumber**: `string` diff --git a/docs/content/ts-sdk/api/client/interfaces/TransferObjectParams.md b/docs/content/ts-sdk/api/client/interfaces/TransferObjectParams.md deleted file mode 100644 index 3d1289d1796..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/TransferObjectParams.md +++ /dev/null @@ -1,13 +0,0 @@ -# Interface: TransferObjectParams - -## Properties - -### objectId - -> **objectId**: `string` - ---- - -### recipient - -> **recipient**: `string` diff --git a/docs/content/ts-sdk/api/client/interfaces/TryGetPastObjectParams.md b/docs/content/ts-sdk/api/client/interfaces/TryGetPastObjectParams.md deleted file mode 100644 index 3be99d62b98..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/TryGetPastObjectParams.md +++ /dev/null @@ -1,29 +0,0 @@ -# Interface: TryGetPastObjectParams - -Note there is no software-level guarantee/SLA that objects with past versions can be retrieved by -this API, even if the object and version exists/existed. The result may vary across nodes depending -on their pruning policies. Return the object information for a specified version - -## Properties - -### id - -> **id**: `string` - -the ID of the queried object - ---- - -### version - -> **version**: `number` - -the version of the queried object. If None, default to the latest known version - ---- - -### options? - -> `optional` **options**: `null` \| [`IotaObjectDataOptions`](IotaObjectDataOptions.md) - -options for specifying the content to be returned diff --git a/docs/content/ts-sdk/api/client/interfaces/TryMultiGetPastObjectsParams.md b/docs/content/ts-sdk/api/client/interfaces/TryMultiGetPastObjectsParams.md deleted file mode 100644 index 681a2aa78ff..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/TryMultiGetPastObjectsParams.md +++ /dev/null @@ -1,21 +0,0 @@ -# Interface: TryMultiGetPastObjectsParams - -Note there is no software-level guarantee/SLA that objects with past versions can be retrieved by -this API, even if the object and version exists/existed. The result may vary across nodes depending -on their pruning policies. Return the object information for a specified version - -## Properties - -### pastObjects - -> **pastObjects**: [`GetPastObjectRequest`](GetPastObjectRequest.md)[] - -a vector of object and versions to be queried - ---- - -### options? - -> `optional` **options**: `null` \| [`IotaObjectDataOptions`](IotaObjectDataOptions.md) - -options for specifying the content to be returned diff --git a/docs/content/ts-sdk/api/client/interfaces/TypeOrigin.md b/docs/content/ts-sdk/api/client/interfaces/TypeOrigin.md deleted file mode 100644 index 1c21b67dedd..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/TypeOrigin.md +++ /dev/null @@ -1,21 +0,0 @@ -# Interface: TypeOrigin - -Identifies a struct and the module it was defined in - -## Properties - -### datatype\_name - -> **datatype\_name**: `string` - ---- - -### module\_name - -> **module\_name**: `string` - ---- - -### package - -> **package**: `string` diff --git a/docs/content/ts-sdk/api/client/interfaces/UnsafeBatchTransactionParams.md b/docs/content/ts-sdk/api/client/interfaces/UnsafeBatchTransactionParams.md deleted file mode 100644 index d3bafbb8cec..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/UnsafeBatchTransactionParams.md +++ /dev/null @@ -1,44 +0,0 @@ -# Interface: UnsafeBatchTransactionParams - -Create an unsigned batched transaction. - -## Properties - -### signer - -> **signer**: `string` - -the transaction signer's IOTA address - ---- - -### singleTransactionParams - -> **singleTransactionParams**: [`RPCTransactionRequestParams`](../type-aliases/RPCTransactionRequestParams.md)[] - -list of transaction request parameters - ---- - -### gas? - -> `optional` **gas**: `null` \| `string` - -gas object to be used in this transaction, node will pick one from the signer's possession if not -provided - ---- - -### gasBudget - -> **gasBudget**: `string` - -the gas budget, the transaction will fail if the gas cost exceed the budget - ---- - -### txnBuilderMode? - -> `optional` **txnBuilderMode**: `null` \| [`IotaTransactionBlockBuilderMode`](../type-aliases/IotaTransactionBlockBuilderMode.md) - -Whether this is a regular transaction or a Dev Inspect Transaction diff --git a/docs/content/ts-sdk/api/client/interfaces/UnsafeMergeCoinsParams.md b/docs/content/ts-sdk/api/client/interfaces/UnsafeMergeCoinsParams.md deleted file mode 100644 index 20edde0b753..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/UnsafeMergeCoinsParams.md +++ /dev/null @@ -1,45 +0,0 @@ -# Interface: UnsafeMergeCoinsParams - -Create an unsigned transaction to merge multiple coins into one coin. - -## Properties - -### signer - -> **signer**: `string` - -the transaction signer's IOTA address - ---- - -### primaryCoin - -> **primaryCoin**: `string` - -the coin object to merge into, this coin will remain after the transaction - ---- - -### coinToMerge - -> **coinToMerge**: `string` - -the coin object to be merged, this coin will be destroyed, the balance will be added to -`primary_coin` - ---- - -### gas? - -> `optional` **gas**: `null` \| `string` - -gas object to be used in this transaction, node will pick one from the signer's possession if not -provided - ---- - -### gasBudget - -> **gasBudget**: `string` - -the gas budget, the transaction will fail if the gas cost exceed the budget diff --git a/docs/content/ts-sdk/api/client/interfaces/UnsafeMoveCallParams.md b/docs/content/ts-sdk/api/client/interfaces/UnsafeMoveCallParams.md deleted file mode 100644 index 86f81c33b76..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/UnsafeMoveCallParams.md +++ /dev/null @@ -1,79 +0,0 @@ -# Interface: UnsafeMoveCallParams - -Create an unsigned transaction to execute a Move call on the network, by calling the specified -function in the module of a given package. - -## Properties - -### signer - -> **signer**: `string` - -the transaction signer's IOTA address - ---- - -### packageObjectId - -> **packageObjectId**: `string` - -the Move package ID, e.g. `0x2` - ---- - -### module - -> **module**: `string` - -the Move module name, e.g. `pay` - ---- - -### function - -> **function**: `string` - -the move function name, e.g. `split` - ---- - -### typeArguments - -> **typeArguments**: `string`[] - -the type arguments of the Move function - ---- - -### arguments - -> **arguments**: `unknown`[] - -the arguments to be passed into the Move function, in -[IotaJson](https://docs.iota.org/references/iota-api) format - ---- - -### gas? - -> `optional` **gas**: `null` \| `string` - -gas object to be used in this transaction, node will pick one from the signer's possession if not -provided - ---- - -### gasBudget - -> **gasBudget**: `string` - -the gas budget, the transaction will fail if the gas cost exceed the budget - ---- - -### executionMode? - -> `optional` **executionMode**: `null` \| [`IotaTransactionBlockBuilderMode`](../type-aliases/IotaTransactionBlockBuilderMode.md) - -Whether this is a Normal transaction or a Dev Inspect Transaction. Default to be -`IotaTransactionBlockBuilderMode::Commit` when it's None. diff --git a/docs/content/ts-sdk/api/client/interfaces/UnsafePayAllIotaParams.md b/docs/content/ts-sdk/api/client/interfaces/UnsafePayAllIotaParams.md deleted file mode 100644 index de8d477ae04..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/UnsafePayAllIotaParams.md +++ /dev/null @@ -1,39 +0,0 @@ -# Interface: UnsafePayAllIotaParams - -Send all IOTA coins to one recipient. This is for IOTA coin only and does not require a separate gas -coin object. Specifically, what pay_all_iota does are: 1. accumulate all IOTA from input coins and -deposit all IOTA to the first input coin 2. transfer the updated first coin to the recipient and -also use this first coin as gas coin object. 3. the balance of the first input coin after tx is -sum(input_coins) - actual_gas_cost. 4. all other input coins other than the first are deleted. - -## Properties - -### signer - -> **signer**: `string` - -the transaction signer's IOTA address - ---- - -### inputCoins - -> **inputCoins**: `string`[] - -the IOTA coins to be used in this transaction, including the coin for gas payment. - ---- - -### recipient - -> **recipient**: `string` - -the recipient address, - ---- - -### gasBudget - -> **gasBudget**: `string` - -the gas budget, the transaction will fail if the gas cost exceed the budget diff --git a/docs/content/ts-sdk/api/client/interfaces/UnsafePayIotaParams.md b/docs/content/ts-sdk/api/client/interfaces/UnsafePayIotaParams.md deleted file mode 100644 index 0ba165f3954..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/UnsafePayIotaParams.md +++ /dev/null @@ -1,49 +0,0 @@ -# Interface: UnsafePayIotaParams - -Send IOTA coins to a list of addresses, following a list of amounts. This is for IOTA coin only and -does not require a separate gas coin object. Specifically, what pay_iota does are: 1. debit each -input_coin to create new coin following the order of amounts and assign it to the corresponding -recipient. 2. accumulate all residual IOTA from input coins left and deposit all IOTA to the first -input coin, then use the first input coin as the gas coin object. 3. the balance of the first input -coin after tx is sum(input_coins) - sum(amounts) - actual_gas_cost 4. all other input coints other -than the first one are deleted. - -## Properties - -### signer - -> **signer**: `string` - -the transaction signer's IOTA address - ---- - -### inputCoins - -> **inputCoins**: `string`[] - -the IOTA coins to be used in this transaction, including the coin for gas payment. - ---- - -### recipients - -> **recipients**: `string`[] - -the recipients' addresses, the length of this vector must be the same as amounts. - ---- - -### amounts - -> **amounts**: `string`[] - -the amounts to be transferred to recipients, following the same order - ---- - -### gasBudget - -> **gasBudget**: `string` - -the gas budget, the transaction will fail if the gas cost exceed the budget diff --git a/docs/content/ts-sdk/api/client/interfaces/UnsafePayParams.md b/docs/content/ts-sdk/api/client/interfaces/UnsafePayParams.md deleted file mode 100644 index e6c98218842..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/UnsafePayParams.md +++ /dev/null @@ -1,55 +0,0 @@ -# Interface: UnsafePayParams - -Send `Coin` to a list of addresses, where `T` can be any coin type, following a list of amounts, -The object specified in the `gas` field will be used to pay the gas fee for the transaction. The gas -object can not appear in `input_coins`. If the gas object is not specified, the RPC server will -auto-select one. - -## Properties - -### signer - -> **signer**: `string` - -the transaction signer's IOTA address - ---- - -### inputCoins - -> **inputCoins**: `string`[] - -the IOTA coins to be used in this transaction - ---- - -### recipients - -> **recipients**: `string`[] - -the recipients' addresses, the length of this vector must be the same as amounts. - ---- - -### amounts - -> **amounts**: `string`[] - -the amounts to be transferred to recipients, following the same order - ---- - -### gas? - -> `optional` **gas**: `null` \| `string` - -gas object to be used in this transaction, node will pick one from the signer's possession if not -provided - ---- - -### gasBudget - -> **gasBudget**: `string` - -the gas budget, the transaction will fail if the gas cost exceed the budget diff --git a/docs/content/ts-sdk/api/client/interfaces/UnsafePublishParams.md b/docs/content/ts-sdk/api/client/interfaces/UnsafePublishParams.md deleted file mode 100644 index 46b14042a65..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/UnsafePublishParams.md +++ /dev/null @@ -1,44 +0,0 @@ -# Interface: UnsafePublishParams - -Create an unsigned transaction to publish a Move package. - -## Properties - -### sender - -> **sender**: `string` - -the transaction signer's IOTA address - ---- - -### compiledModules - -> **compiledModules**: `string`[] - -the compiled bytes of a Move package - ---- - -### dependencies - -> **dependencies**: `string`[] - -a list of transitive dependency addresses that this set of modules depends on. - ---- - -### gas? - -> `optional` **gas**: `null` \| `string` - -gas object to be used in this transaction, node will pick one from the signer's possession if not -provided - ---- - -### gasBudget - -> **gasBudget**: `string` - -the gas budget, the transaction will fail if the gas cost exceed the budget diff --git a/docs/content/ts-sdk/api/client/interfaces/UnsafeRequestAddStakeParams.md b/docs/content/ts-sdk/api/client/interfaces/UnsafeRequestAddStakeParams.md deleted file mode 100644 index 7b160ac581d..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/UnsafeRequestAddStakeParams.md +++ /dev/null @@ -1,52 +0,0 @@ -# Interface: UnsafeRequestAddStakeParams - -Add stake to a validator's staking pool using multiple coins and amount. - -## Properties - -### signer - -> **signer**: `string` - -the transaction signer's IOTA address - ---- - -### coins - -> **coins**: `string`[] - -Coin object to stake - ---- - -### amount? - -> `optional` **amount**: `null` \| `string` - -stake amount - ---- - -### validator - -> **validator**: `string` - -the validator's IOTA address - ---- - -### gas? - -> `optional` **gas**: `null` \| `string` - -gas object to be used in this transaction, node will pick one from the signer's possession if not -provided - ---- - -### gasBudget - -> **gasBudget**: `string` - -the gas budget, the transaction will fail if the gas cost exceed the budget diff --git a/docs/content/ts-sdk/api/client/interfaces/UnsafeRequestAddTimelockedStakeParams.md b/docs/content/ts-sdk/api/client/interfaces/UnsafeRequestAddTimelockedStakeParams.md deleted file mode 100644 index 130fa86c2ec..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/UnsafeRequestAddTimelockedStakeParams.md +++ /dev/null @@ -1,43 +0,0 @@ -# Interface: UnsafeRequestAddTimelockedStakeParams - -Add timelocked stake to a validator's staking pool using multiple balances and amount. - -## Properties - -### signer - -> **signer**: `string` - -the transaction signer's IOTA address - ---- - -### lockedBalance - -> **lockedBalance**: `string` - -TimeLock> object to stake - ---- - -### validator - -> **validator**: `string` - -the validator's IOTA address - ---- - -### gas - -> **gas**: `string` - -gas object to be used in this transaction - ---- - -### gasBudget - -> **gasBudget**: `string` - -the gas budget, the transaction will fail if the gas cost exceed the budget diff --git a/docs/content/ts-sdk/api/client/interfaces/UnsafeRequestWithdrawStakeParams.md b/docs/content/ts-sdk/api/client/interfaces/UnsafeRequestWithdrawStakeParams.md deleted file mode 100644 index 44e248a901d..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/UnsafeRequestWithdrawStakeParams.md +++ /dev/null @@ -1,36 +0,0 @@ -# Interface: UnsafeRequestWithdrawStakeParams - -Withdraw stake from a validator's staking pool. - -## Properties - -### signer - -> **signer**: `string` - -the transaction signer's IOTA address - ---- - -### stakedIota - -> **stakedIota**: `string` - -StakedIota object ID - ---- - -### gas? - -> `optional` **gas**: `null` \| `string` - -gas object to be used in this transaction, node will pick one from the signer's possession if not -provided - ---- - -### gasBudget - -> **gasBudget**: `string` - -the gas budget, the transaction will fail if the gas cost exceed the budget diff --git a/docs/content/ts-sdk/api/client/interfaces/UnsafeRequestWithdrawTimelockedStakeParams.md b/docs/content/ts-sdk/api/client/interfaces/UnsafeRequestWithdrawTimelockedStakeParams.md deleted file mode 100644 index f9b6bc370dd..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/UnsafeRequestWithdrawTimelockedStakeParams.md +++ /dev/null @@ -1,35 +0,0 @@ -# Interface: UnsafeRequestWithdrawTimelockedStakeParams - -Withdraw timelocked stake from a validator's staking pool. - -## Properties - -### signer - -> **signer**: `string` - -the transaction signer's IOTA address - ---- - -### timelockedStakedIota - -> **timelockedStakedIota**: `string` - -TimelockedStakedIota object ID - ---- - -### gas - -> **gas**: `string` - -gas object to be used in this transaction - ---- - -### gasBudget - -> **gasBudget**: `string` - -the gas budget, the transaction will fail if the gas cost exceed the budget diff --git a/docs/content/ts-sdk/api/client/interfaces/UnsafeSplitCoinEqualParams.md b/docs/content/ts-sdk/api/client/interfaces/UnsafeSplitCoinEqualParams.md deleted file mode 100644 index b6166ab75f3..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/UnsafeSplitCoinEqualParams.md +++ /dev/null @@ -1,44 +0,0 @@ -# Interface: UnsafeSplitCoinEqualParams - -Create an unsigned transaction to split a coin object into multiple equal-size coins. - -## Properties - -### signer - -> **signer**: `string` - -the transaction signer's IOTA address - ---- - -### coinObjectId - -> **coinObjectId**: `string` - -the coin object to be spilt - ---- - -### splitCount - -> **splitCount**: `string` - -the number of coins to split into - ---- - -### gas? - -> `optional` **gas**: `null` \| `string` - -gas object to be used in this transaction, node will pick one from the signer's possession if not -provided - ---- - -### gasBudget - -> **gasBudget**: `string` - -the gas budget, the transaction will fail if the gas cost exceed the budget diff --git a/docs/content/ts-sdk/api/client/interfaces/UnsafeSplitCoinParams.md b/docs/content/ts-sdk/api/client/interfaces/UnsafeSplitCoinParams.md deleted file mode 100644 index e5d146ef17e..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/UnsafeSplitCoinParams.md +++ /dev/null @@ -1,44 +0,0 @@ -# Interface: UnsafeSplitCoinParams - -Create an unsigned transaction to split a coin object into multiple coins. - -## Properties - -### signer - -> **signer**: `string` - -the transaction signer's IOTA address - ---- - -### coinObjectId - -> **coinObjectId**: `string` - -the coin object to be spilt - ---- - -### splitAmounts - -> **splitAmounts**: `string`[] - -the amounts to split out from the coin - ---- - -### gas? - -> `optional` **gas**: `null` \| `string` - -gas object to be used in this transaction, node will pick one from the signer's possession if not -provided - ---- - -### gasBudget - -> **gasBudget**: `string` - -the gas budget, the transaction will fail if the gas cost exceed the budget diff --git a/docs/content/ts-sdk/api/client/interfaces/UnsafeTransferIotaParams.md b/docs/content/ts-sdk/api/client/interfaces/UnsafeTransferIotaParams.md deleted file mode 100644 index a8288bb8426..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/UnsafeTransferIotaParams.md +++ /dev/null @@ -1,44 +0,0 @@ -# Interface: UnsafeTransferIotaParams - -Create an unsigned transaction to send IOTA coin object to an IOTA address. The IOTA object is also -used as the gas object. - -## Properties - -### signer - -> **signer**: `string` - -the transaction signer's IOTA address - ---- - -### iotaObjectId - -> **iotaObjectId**: `string` - -the IOTA coin object to be used in this transaction - ---- - -### gasBudget - -> **gasBudget**: `string` - -the gas budget, the transaction will fail if the gas cost exceed the budget - ---- - -### recipient - -> **recipient**: `string` - -the recipient's IOTA address - ---- - -### amount? - -> `optional` **amount**: `null` \| `string` - -the amount to be split out and transferred diff --git a/docs/content/ts-sdk/api/client/interfaces/UnsafeTransferObjectParams.md b/docs/content/ts-sdk/api/client/interfaces/UnsafeTransferObjectParams.md deleted file mode 100644 index 03dfcf1c5f4..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/UnsafeTransferObjectParams.md +++ /dev/null @@ -1,45 +0,0 @@ -# Interface: UnsafeTransferObjectParams - -Create an unsigned transaction to transfer an object from one address to another. The object's type -must allow public transfers - -## Properties - -### signer - -> **signer**: `string` - -the transaction signer's IOTA address - ---- - -### objectId - -> **objectId**: `string` - -the ID of the object to be transferred - ---- - -### gas? - -> `optional` **gas**: `null` \| `string` - -gas object to be used in this transaction, node will pick one from the signer's possession if not -provided - ---- - -### gasBudget - -> **gasBudget**: `string` - -the gas budget, the transaction will fail if the gas cost exceed the budget - ---- - -### recipient - -> **recipient**: `string` - -the recipient's IOTA address diff --git a/docs/content/ts-sdk/api/client/interfaces/UpgradeInfo.md b/docs/content/ts-sdk/api/client/interfaces/UpgradeInfo.md deleted file mode 100644 index b101ea09001..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/UpgradeInfo.md +++ /dev/null @@ -1,19 +0,0 @@ -# Interface: UpgradeInfo - -Upgraded package info for the linkage table - -## Properties - -### upgraded\_id - -> **upgraded\_id**: `string` - -ID of the upgraded packages - ---- - -### upgraded\_version - -> **upgraded\_version**: `string` - -Version of the upgraded package diff --git a/docs/content/ts-sdk/api/client/interfaces/ValidatorApy.md b/docs/content/ts-sdk/api/client/interfaces/ValidatorApy.md deleted file mode 100644 index 2f273ef63b3..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/ValidatorApy.md +++ /dev/null @@ -1,13 +0,0 @@ -# Interface: ValidatorApy - -## Properties - -### address - -> **address**: `string` - ---- - -### apy - -> **apy**: `number` diff --git a/docs/content/ts-sdk/api/client/interfaces/ValidatorsApy.md b/docs/content/ts-sdk/api/client/interfaces/ValidatorsApy.md deleted file mode 100644 index fc7ae2867f3..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/ValidatorsApy.md +++ /dev/null @@ -1,13 +0,0 @@ -# Interface: ValidatorsApy - -## Properties - -### apys - -> **apys**: [`ValidatorApy`](ValidatorApy.md)[] - ---- - -### epoch - -> **epoch**: `string` diff --git a/docs/content/ts-sdk/api/client/interfaces/ZkLoginAuthenticator.md b/docs/content/ts-sdk/api/client/interfaces/ZkLoginAuthenticator.md deleted file mode 100644 index b7d56e93103..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/ZkLoginAuthenticator.md +++ /dev/null @@ -1,21 +0,0 @@ -# Interface: ZkLoginAuthenticator - -An zk login authenticator with all the necessary fields. - -## Properties - -### inputs - -> **inputs**: [`ZkLoginInputs`](ZkLoginInputs.md) - ---- - -### maxEpoch - -> **maxEpoch**: `string` - ---- - -### userSignature - -> **userSignature**: [`Signature`](../type-aliases/Signature.md) diff --git a/docs/content/ts-sdk/api/client/interfaces/ZkLoginInputs.md b/docs/content/ts-sdk/api/client/interfaces/ZkLoginInputs.md deleted file mode 100644 index e77e86206d2..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/ZkLoginInputs.md +++ /dev/null @@ -1,27 +0,0 @@ -# Interface: ZkLoginInputs - -All inputs required for the zk login proof verification and other public inputs. - -## Properties - -### addressSeed - -> **addressSeed**: `string` - ---- - -### headerBase64 - -> **headerBase64**: `string` - ---- - -### issBase64Details - -> **issBase64Details**: [`Claim`](Claim.md) - ---- - -### proofPoints - -> **proofPoints**: [`ZkLoginProof`](ZkLoginProof.md) diff --git a/docs/content/ts-sdk/api/client/interfaces/ZkLoginProof.md b/docs/content/ts-sdk/api/client/interfaces/ZkLoginProof.md deleted file mode 100644 index 4bbdb50a0c6..00000000000 --- a/docs/content/ts-sdk/api/client/interfaces/ZkLoginProof.md +++ /dev/null @@ -1,21 +0,0 @@ -# Interface: ZkLoginProof - -The struct for zk login proof. - -## Properties - -### a - -> **a**: `string`[] - ---- - -### b - -> **b**: `string`[][] - ---- - -### c - -> **c**: `string`[] diff --git a/docs/content/ts-sdk/api/client/type-aliases/AllEpochsAddressMetrics.md b/docs/content/ts-sdk/api/client/type-aliases/AllEpochsAddressMetrics.md deleted file mode 100644 index 66824162015..00000000000 --- a/docs/content/ts-sdk/api/client/type-aliases/AllEpochsAddressMetrics.md +++ /dev/null @@ -1,3 +0,0 @@ -# Type Alias: AllEpochsAddressMetrics - -> **AllEpochsAddressMetrics**: [`AddressMetrics`](../interfaces/AddressMetrics.md)[] diff --git a/docs/content/ts-sdk/api/client/type-aliases/ChainType.md b/docs/content/ts-sdk/api/client/type-aliases/ChainType.md deleted file mode 100644 index 0f161fc3552..00000000000 --- a/docs/content/ts-sdk/api/client/type-aliases/ChainType.md +++ /dev/null @@ -1,3 +0,0 @@ -# Type Alias: ChainType - -> **ChainType**: \`$\{string\}:$\{string\}\` diff --git a/docs/content/ts-sdk/api/client/type-aliases/CheckpointCommitment.md b/docs/content/ts-sdk/api/client/type-aliases/CheckpointCommitment.md deleted file mode 100644 index 7e3a5c89f1e..00000000000 --- a/docs/content/ts-sdk/api/client/type-aliases/CheckpointCommitment.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: CheckpointCommitment - -> **CheckpointCommitment**: `object` - -## Type declaration - -### ECMHLiveObjectSetDigest - -> **ECMHLiveObjectSetDigest**: [`ECMHLiveObjectSetDigest`](../interfaces/ECMHLiveObjectSetDigest.md) diff --git a/docs/content/ts-sdk/api/client/type-aliases/CheckpointId.md b/docs/content/ts-sdk/api/client/type-aliases/CheckpointId.md deleted file mode 100644 index ccd838ad71f..00000000000 --- a/docs/content/ts-sdk/api/client/type-aliases/CheckpointId.md +++ /dev/null @@ -1,3 +0,0 @@ -# Type Alias: CheckpointId - -> **CheckpointId**: `string` \| `string` diff --git a/docs/content/ts-sdk/api/client/type-aliases/CheckpointPage.md b/docs/content/ts-sdk/api/client/type-aliases/CheckpointPage.md deleted file mode 100644 index 37ceab5fa74..00000000000 --- a/docs/content/ts-sdk/api/client/type-aliases/CheckpointPage.md +++ /dev/null @@ -1,17 +0,0 @@ -# Type Alias: CheckpointPage - -> **CheckpointPage**: `object` - -## Type declaration - -### data - -> **data**: [`Checkpoint`](../interfaces/Checkpoint.md)[] - -### nextCursor - -> **nextCursor**: `string` \| `null` - -### hasNextPage - -> **hasNextPage**: `boolean` diff --git a/docs/content/ts-sdk/api/client/type-aliases/CoinBalance.md b/docs/content/ts-sdk/api/client/type-aliases/CoinBalance.md deleted file mode 100644 index d732ee8b9c4..00000000000 --- a/docs/content/ts-sdk/api/client/type-aliases/CoinBalance.md +++ /dev/null @@ -1,17 +0,0 @@ -# Type Alias: CoinBalance - -> **CoinBalance**: `object` - -## Type declaration - -### coinType - -> **coinType**: `string` - -### coinObjectCount - -> **coinObjectCount**: `number` - -### totalBalance - -> **totalBalance**: `string` diff --git a/docs/content/ts-sdk/api/client/type-aliases/CompressedSignature.md b/docs/content/ts-sdk/api/client/type-aliases/CompressedSignature.md deleted file mode 100644 index 8a5bdd2ac41..00000000000 --- a/docs/content/ts-sdk/api/client/type-aliases/CompressedSignature.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: CompressedSignature - -> **CompressedSignature**: `object` \| `object` \| `object` \| `object` - -Unlike [enum Signature], [enum CompressedSignature] does not contain public key. diff --git a/docs/content/ts-sdk/api/client/type-aliases/ConsensusDeterminedVersionAssignments.md b/docs/content/ts-sdk/api/client/type-aliases/ConsensusDeterminedVersionAssignments.md deleted file mode 100644 index c183c48de8d..00000000000 --- a/docs/content/ts-sdk/api/client/type-aliases/ConsensusDeterminedVersionAssignments.md +++ /dev/null @@ -1,11 +0,0 @@ -# Type Alias: ConsensusDeterminedVersionAssignments - -> **ConsensusDeterminedVersionAssignments**: `object` - -Uses an enum to allow for future expansion of the ConsensusDeterminedVersionAssignments. - -## Type declaration - -### CancelledTransactions - -> **CancelledTransactions**: [`string`, [`string`, `string`][]][] diff --git a/docs/content/ts-sdk/api/client/type-aliases/DynamicFieldPage.md b/docs/content/ts-sdk/api/client/type-aliases/DynamicFieldPage.md deleted file mode 100644 index 50cf6e7176c..00000000000 --- a/docs/content/ts-sdk/api/client/type-aliases/DynamicFieldPage.md +++ /dev/null @@ -1,17 +0,0 @@ -# Type Alias: DynamicFieldPage - -> **DynamicFieldPage**: `object` - -## Type declaration - -### data - -> **data**: [`DynamicFieldInfo`](../interfaces/DynamicFieldInfo.md)[] - -### nextCursor - -> **nextCursor**: `string` \| `null` - -### hasNextPage - -> **hasNextPage**: `boolean` diff --git a/docs/content/ts-sdk/api/client/type-aliases/DynamicFieldType.md b/docs/content/ts-sdk/api/client/type-aliases/DynamicFieldType.md deleted file mode 100644 index e5229fba910..00000000000 --- a/docs/content/ts-sdk/api/client/type-aliases/DynamicFieldType.md +++ /dev/null @@ -1,3 +0,0 @@ -# Type Alias: DynamicFieldType - -> **DynamicFieldType**: `"DynamicField"` \| `"DynamicObject"` diff --git a/docs/content/ts-sdk/api/client/type-aliases/EpochMetricsPage.md b/docs/content/ts-sdk/api/client/type-aliases/EpochMetricsPage.md deleted file mode 100644 index 5d4d5f7fd02..00000000000 --- a/docs/content/ts-sdk/api/client/type-aliases/EpochMetricsPage.md +++ /dev/null @@ -1,17 +0,0 @@ -# Type Alias: EpochMetricsPage - -> **EpochMetricsPage**: `object` - -## Type declaration - -### data - -> **data**: [`EpochMetrics`](../interfaces/EpochMetrics.md)[] - -### nextCursor - -> **nextCursor**: `string` \| `null` - -### hasNextPage - -> **hasNextPage**: `boolean` diff --git a/docs/content/ts-sdk/api/client/type-aliases/EpochPage.md b/docs/content/ts-sdk/api/client/type-aliases/EpochPage.md deleted file mode 100644 index 8ced10634fb..00000000000 --- a/docs/content/ts-sdk/api/client/type-aliases/EpochPage.md +++ /dev/null @@ -1,17 +0,0 @@ -# Type Alias: EpochPage - -> **EpochPage**: `object` - -## Type declaration - -### data - -> **data**: [`EpochInfo`](../interfaces/EpochInfo.md)[] - -### nextCursor - -> **nextCursor**: `string` \| `null` - -### hasNextPage - -> **hasNextPage**: `boolean` diff --git a/docs/content/ts-sdk/api/client/type-aliases/ExecuteTransactionRequestType.md b/docs/content/ts-sdk/api/client/type-aliases/ExecuteTransactionRequestType.md deleted file mode 100644 index 66c07a62f2a..00000000000 --- a/docs/content/ts-sdk/api/client/type-aliases/ExecuteTransactionRequestType.md +++ /dev/null @@ -1,3 +0,0 @@ -# Type Alias: ExecuteTransactionRequestType - -> **ExecuteTransactionRequestType**: `"WaitForEffectsCert"` \| `"WaitForLocalExecution"` diff --git a/docs/content/ts-sdk/api/client/type-aliases/ExecutionStatus.md b/docs/content/ts-sdk/api/client/type-aliases/ExecutionStatus.md deleted file mode 100644 index 9053a7504ab..00000000000 --- a/docs/content/ts-sdk/api/client/type-aliases/ExecutionStatus.md +++ /dev/null @@ -1,13 +0,0 @@ -# Type Alias: ExecutionStatus - -> **ExecutionStatus**: `object` - -## Type declaration - -### status - -> **status**: `"success"` \| `"failure"` - -### error? - -> `optional` **error**: `string` diff --git a/docs/content/ts-sdk/api/client/type-aliases/GetOwnedObjectsParams.md b/docs/content/ts-sdk/api/client/type-aliases/GetOwnedObjectsParams.md deleted file mode 100644 index 9eb08d9e563..00000000000 --- a/docs/content/ts-sdk/api/client/type-aliases/GetOwnedObjectsParams.md +++ /dev/null @@ -1,28 +0,0 @@ -# Type Alias: GetOwnedObjectsParams - -> **GetOwnedObjectsParams**: `object` & [`IotaObjectResponseQuery`](../interfaces/IotaObjectResponseQuery.md) - -Return the list of objects owned by an address. Note that if the address owns more than -`QUERY_MAX_RESULT_LIMIT` objects, the pagination is not accurate, because previous page may have -been updated when the next page is fetched. Please use iotax_queryObjects if this is a concern. - -## Type declaration - -### owner - -> **owner**: `string` - -the owner's IOTA address - -### cursor? - -> `optional` **cursor**: `string` \| `null` - -An optional paging cursor. If provided, the query will start from the next item after the specified -cursor. Default to start from the first item if not specified. - -### limit? - -> `optional` **limit**: `number` \| `null` - -Max number of items returned per page, default to [QUERY_MAX_RESULT_LIMIT] if not specified. diff --git a/docs/content/ts-sdk/api/client/type-aliases/HttpHeaders.md b/docs/content/ts-sdk/api/client/type-aliases/HttpHeaders.md deleted file mode 100644 index 66cbfed62dc..00000000000 --- a/docs/content/ts-sdk/api/client/type-aliases/HttpHeaders.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: HttpHeaders - -> **HttpHeaders**: `object` - -An object defining headers to be passed to the RPC server - -## Index Signature - -\[`header`: `string`\]: `string` diff --git a/docs/content/ts-sdk/api/client/type-aliases/InputObjectKind.md b/docs/content/ts-sdk/api/client/type-aliases/InputObjectKind.md deleted file mode 100644 index b6282ac6bac..00000000000 --- a/docs/content/ts-sdk/api/client/type-aliases/InputObjectKind.md +++ /dev/null @@ -1,3 +0,0 @@ -# Type Alias: InputObjectKind - -> **InputObjectKind**: `object` \| `object` \| `object` diff --git a/docs/content/ts-sdk/api/client/type-aliases/IotaArgument.md b/docs/content/ts-sdk/api/client/type-aliases/IotaArgument.md deleted file mode 100644 index 527b7c68812..00000000000 --- a/docs/content/ts-sdk/api/client/type-aliases/IotaArgument.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: IotaArgument - -> **IotaArgument**: `"GasCoin"` \| `object` \| `object` \| `object` - -An argument to a transaction in a programmable transaction block diff --git a/docs/content/ts-sdk/api/client/type-aliases/IotaCallArg.md b/docs/content/ts-sdk/api/client/type-aliases/IotaCallArg.md deleted file mode 100644 index 43b055efa61..00000000000 --- a/docs/content/ts-sdk/api/client/type-aliases/IotaCallArg.md +++ /dev/null @@ -1,3 +0,0 @@ -# Type Alias: IotaCallArg - -> **IotaCallArg**: `object` \| `object` \| `object` \| `object` diff --git a/docs/content/ts-sdk/api/client/type-aliases/IotaClientOptions.md b/docs/content/ts-sdk/api/client/type-aliases/IotaClientOptions.md deleted file mode 100644 index 90678e95f1a..00000000000 --- a/docs/content/ts-sdk/api/client/type-aliases/IotaClientOptions.md +++ /dev/null @@ -1,6 +0,0 @@ -# Type Alias: IotaClientOptions - -> **IotaClientOptions**: `NetworkOrTransport` - -Configuration options for the IotaClient -You must provide either a `url` or a `transport` diff --git a/docs/content/ts-sdk/api/client/type-aliases/IotaEndOfEpochTransactionKind.md b/docs/content/ts-sdk/api/client/type-aliases/IotaEndOfEpochTransactionKind.md deleted file mode 100644 index e4e87103982..00000000000 --- a/docs/content/ts-sdk/api/client/type-aliases/IotaEndOfEpochTransactionKind.md +++ /dev/null @@ -1,3 +0,0 @@ -# Type Alias: IotaEndOfEpochTransactionKind - -> **IotaEndOfEpochTransactionKind**: `"AuthenticatorStateCreate"` \| `object` \| `object` \| `object` \| `object` diff --git a/docs/content/ts-sdk/api/client/type-aliases/IotaEventFilter.md b/docs/content/ts-sdk/api/client/type-aliases/IotaEventFilter.md deleted file mode 100644 index 029499c5617..00000000000 --- a/docs/content/ts-sdk/api/client/type-aliases/IotaEventFilter.md +++ /dev/null @@ -1,3 +0,0 @@ -# Type Alias: IotaEventFilter - -> **IotaEventFilter**: `object` \| `object` \| `object` \| `object` \| `object` \| `object` \| `object` \| `object` \| `object` \| `object` \| `object` \| `object` diff --git a/docs/content/ts-sdk/api/client/type-aliases/IotaMoveAbility.md b/docs/content/ts-sdk/api/client/type-aliases/IotaMoveAbility.md deleted file mode 100644 index d3a71608f39..00000000000 --- a/docs/content/ts-sdk/api/client/type-aliases/IotaMoveAbility.md +++ /dev/null @@ -1,3 +0,0 @@ -# Type Alias: IotaMoveAbility - -> **IotaMoveAbility**: `"Copy"` \| `"Drop"` \| `"Store"` \| `"Key"` diff --git a/docs/content/ts-sdk/api/client/type-aliases/IotaMoveFunctionArgType.md b/docs/content/ts-sdk/api/client/type-aliases/IotaMoveFunctionArgType.md deleted file mode 100644 index eedf2ab093d..00000000000 --- a/docs/content/ts-sdk/api/client/type-aliases/IotaMoveFunctionArgType.md +++ /dev/null @@ -1,3 +0,0 @@ -# Type Alias: IotaMoveFunctionArgType - -> **IotaMoveFunctionArgType**: `"Pure"` \| `object` diff --git a/docs/content/ts-sdk/api/client/type-aliases/IotaMoveNormalizedModules.md b/docs/content/ts-sdk/api/client/type-aliases/IotaMoveNormalizedModules.md deleted file mode 100644 index 536db7d4d35..00000000000 --- a/docs/content/ts-sdk/api/client/type-aliases/IotaMoveNormalizedModules.md +++ /dev/null @@ -1,3 +0,0 @@ -# Type Alias: IotaMoveNormalizedModules - -> **IotaMoveNormalizedModules**: `Record`\<`string`, [`IotaMoveNormalizedModule`](../interfaces/IotaMoveNormalizedModule.md)\> diff --git a/docs/content/ts-sdk/api/client/type-aliases/IotaMoveNormalizedType.md b/docs/content/ts-sdk/api/client/type-aliases/IotaMoveNormalizedType.md deleted file mode 100644 index 511c6533d98..00000000000 --- a/docs/content/ts-sdk/api/client/type-aliases/IotaMoveNormalizedType.md +++ /dev/null @@ -1,3 +0,0 @@ -# Type Alias: IotaMoveNormalizedType - -> **IotaMoveNormalizedType**: `"Bool"` \| `"U8"` \| `"U16"` \| `"U32"` \| `"U64"` \| `"U128"` \| `"U256"` \| `"Address"` \| `"Signer"` \| `object` \| `object` \| `object` \| `object` \| `object` diff --git a/docs/content/ts-sdk/api/client/type-aliases/IotaMoveObject.md b/docs/content/ts-sdk/api/client/type-aliases/IotaMoveObject.md deleted file mode 100644 index 3fd6b213bde..00000000000 --- a/docs/content/ts-sdk/api/client/type-aliases/IotaMoveObject.md +++ /dev/null @@ -1,3 +0,0 @@ -# Type Alias: IotaMoveObject - -> **IotaMoveObject**: `Extract`\<[`IotaParsedData`](IotaParsedData.md), `object`\> diff --git a/docs/content/ts-sdk/api/client/type-aliases/IotaMovePackage.md b/docs/content/ts-sdk/api/client/type-aliases/IotaMovePackage.md deleted file mode 100644 index beb04366e33..00000000000 --- a/docs/content/ts-sdk/api/client/type-aliases/IotaMovePackage.md +++ /dev/null @@ -1,3 +0,0 @@ -# Type Alias: IotaMovePackage - -> **IotaMovePackage**: `Extract`\<[`IotaParsedData`](IotaParsedData.md), `object`\> diff --git a/docs/content/ts-sdk/api/client/type-aliases/IotaMoveVisibility.md b/docs/content/ts-sdk/api/client/type-aliases/IotaMoveVisibility.md deleted file mode 100644 index ce97a9ce264..00000000000 --- a/docs/content/ts-sdk/api/client/type-aliases/IotaMoveVisibility.md +++ /dev/null @@ -1,3 +0,0 @@ -# Type Alias: IotaMoveVisibility - -> **IotaMoveVisibility**: `"Private"` \| `"Public"` \| `"Friend"` diff --git a/docs/content/ts-sdk/api/client/type-aliases/IotaObjectChange.md b/docs/content/ts-sdk/api/client/type-aliases/IotaObjectChange.md deleted file mode 100644 index 2c4f6fd7553..00000000000 --- a/docs/content/ts-sdk/api/client/type-aliases/IotaObjectChange.md +++ /dev/null @@ -1,6 +0,0 @@ -# Type Alias: IotaObjectChange - -> **IotaObjectChange**: `object` \| `object` \| `object` \| `object` \| `object` \| `object` - -ObjectChange are derived from the object mutations in the TransactionEffect to provide richer object -information. diff --git a/docs/content/ts-sdk/api/client/type-aliases/IotaObjectChangeCreated.md b/docs/content/ts-sdk/api/client/type-aliases/IotaObjectChangeCreated.md deleted file mode 100644 index 6f15567b3d2..00000000000 --- a/docs/content/ts-sdk/api/client/type-aliases/IotaObjectChangeCreated.md +++ /dev/null @@ -1,3 +0,0 @@ -# Type Alias: IotaObjectChangeCreated - -> **IotaObjectChangeCreated**: `Extract`\<[`IotaObjectChange`](IotaObjectChange.md), `object`\> diff --git a/docs/content/ts-sdk/api/client/type-aliases/IotaObjectChangeDeleted.md b/docs/content/ts-sdk/api/client/type-aliases/IotaObjectChangeDeleted.md deleted file mode 100644 index 758abe5c7e5..00000000000 --- a/docs/content/ts-sdk/api/client/type-aliases/IotaObjectChangeDeleted.md +++ /dev/null @@ -1,3 +0,0 @@ -# Type Alias: IotaObjectChangeDeleted - -> **IotaObjectChangeDeleted**: `Extract`\<[`IotaObjectChange`](IotaObjectChange.md), `object`\> diff --git a/docs/content/ts-sdk/api/client/type-aliases/IotaObjectChangeMutated.md b/docs/content/ts-sdk/api/client/type-aliases/IotaObjectChangeMutated.md deleted file mode 100644 index 197bf328451..00000000000 --- a/docs/content/ts-sdk/api/client/type-aliases/IotaObjectChangeMutated.md +++ /dev/null @@ -1,3 +0,0 @@ -# Type Alias: IotaObjectChangeMutated - -> **IotaObjectChangeMutated**: `Extract`\<[`IotaObjectChange`](IotaObjectChange.md), `object`\> diff --git a/docs/content/ts-sdk/api/client/type-aliases/IotaObjectChangePublished.md b/docs/content/ts-sdk/api/client/type-aliases/IotaObjectChangePublished.md deleted file mode 100644 index e7b8dffc541..00000000000 --- a/docs/content/ts-sdk/api/client/type-aliases/IotaObjectChangePublished.md +++ /dev/null @@ -1,3 +0,0 @@ -# Type Alias: IotaObjectChangePublished - -> **IotaObjectChangePublished**: `Extract`\<[`IotaObjectChange`](IotaObjectChange.md), `object`\> diff --git a/docs/content/ts-sdk/api/client/type-aliases/IotaObjectChangeTransferred.md b/docs/content/ts-sdk/api/client/type-aliases/IotaObjectChangeTransferred.md deleted file mode 100644 index 3413123602b..00000000000 --- a/docs/content/ts-sdk/api/client/type-aliases/IotaObjectChangeTransferred.md +++ /dev/null @@ -1,3 +0,0 @@ -# Type Alias: IotaObjectChangeTransferred - -> **IotaObjectChangeTransferred**: `Extract`\<[`IotaObjectChange`](IotaObjectChange.md), `object`\> diff --git a/docs/content/ts-sdk/api/client/type-aliases/IotaObjectChangeWrapped.md b/docs/content/ts-sdk/api/client/type-aliases/IotaObjectChangeWrapped.md deleted file mode 100644 index 86f6372dce9..00000000000 --- a/docs/content/ts-sdk/api/client/type-aliases/IotaObjectChangeWrapped.md +++ /dev/null @@ -1,3 +0,0 @@ -# Type Alias: IotaObjectChangeWrapped - -> **IotaObjectChangeWrapped**: `Extract`\<[`IotaObjectChange`](IotaObjectChange.md), `object`\> diff --git a/docs/content/ts-sdk/api/client/type-aliases/IotaObjectDataFilter.md b/docs/content/ts-sdk/api/client/type-aliases/IotaObjectDataFilter.md deleted file mode 100644 index 5b0f3fefc67..00000000000 --- a/docs/content/ts-sdk/api/client/type-aliases/IotaObjectDataFilter.md +++ /dev/null @@ -1,3 +0,0 @@ -# Type Alias: IotaObjectDataFilter - -> **IotaObjectDataFilter**: `object` \| `object` \| `object` \| `object` \| `object` \| `object` \| `object` \| `object` \| `object` \| `object` \| `object` diff --git a/docs/content/ts-sdk/api/client/type-aliases/IotaParsedData.md b/docs/content/ts-sdk/api/client/type-aliases/IotaParsedData.md deleted file mode 100644 index f1d525a210b..00000000000 --- a/docs/content/ts-sdk/api/client/type-aliases/IotaParsedData.md +++ /dev/null @@ -1,3 +0,0 @@ -# Type Alias: IotaParsedData - -> **IotaParsedData**: `object` \| `object` diff --git a/docs/content/ts-sdk/api/client/type-aliases/IotaTransaction.md b/docs/content/ts-sdk/api/client/type-aliases/IotaTransaction.md deleted file mode 100644 index 29d0859477d..00000000000 --- a/docs/content/ts-sdk/api/client/type-aliases/IotaTransaction.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: IotaTransaction - -> **IotaTransaction**: `object` \| `object` \| `object` \| `object` \| `object` \| `object` \| `object` - -A single transaction in a programmable transaction block. diff --git a/docs/content/ts-sdk/api/client/type-aliases/IotaTransactionBlockBuilderMode.md b/docs/content/ts-sdk/api/client/type-aliases/IotaTransactionBlockBuilderMode.md deleted file mode 100644 index 46cf3da249f..00000000000 --- a/docs/content/ts-sdk/api/client/type-aliases/IotaTransactionBlockBuilderMode.md +++ /dev/null @@ -1,3 +0,0 @@ -# Type Alias: IotaTransactionBlockBuilderMode - -> **IotaTransactionBlockBuilderMode**: `"Commit"` \| `"DevInspect"` diff --git a/docs/content/ts-sdk/api/client/type-aliases/IotaTransactionBlockKind.md b/docs/content/ts-sdk/api/client/type-aliases/IotaTransactionBlockKind.md deleted file mode 100644 index a893a704a51..00000000000 --- a/docs/content/ts-sdk/api/client/type-aliases/IotaTransactionBlockKind.md +++ /dev/null @@ -1,3 +0,0 @@ -# Type Alias: IotaTransactionBlockKind - -> **IotaTransactionBlockKind**: `object` \| `object` \| `object` \| `object` \| `object` \| `object` diff --git a/docs/content/ts-sdk/api/client/type-aliases/MoveCallMetric.md b/docs/content/ts-sdk/api/client/type-aliases/MoveCallMetric.md deleted file mode 100644 index c3e0fe4d780..00000000000 --- a/docs/content/ts-sdk/api/client/type-aliases/MoveCallMetric.md +++ /dev/null @@ -1,3 +0,0 @@ -# Type Alias: MoveCallMetric - -> **MoveCallMetric**: [`object`, `string`] diff --git a/docs/content/ts-sdk/api/client/type-aliases/MoveStruct.md b/docs/content/ts-sdk/api/client/type-aliases/MoveStruct.md deleted file mode 100644 index 312003bc846..00000000000 --- a/docs/content/ts-sdk/api/client/type-aliases/MoveStruct.md +++ /dev/null @@ -1,3 +0,0 @@ -# Type Alias: MoveStruct - -> **MoveStruct**: [`MoveValue`](MoveValue.md)[] \| `object` \| `object` diff --git a/docs/content/ts-sdk/api/client/type-aliases/MoveValue.md b/docs/content/ts-sdk/api/client/type-aliases/MoveValue.md deleted file mode 100644 index 4cf8d12c405..00000000000 --- a/docs/content/ts-sdk/api/client/type-aliases/MoveValue.md +++ /dev/null @@ -1,3 +0,0 @@ -# Type Alias: MoveValue - -> **MoveValue**: `number` \| `boolean` \| `string` \| [`MoveValue`](MoveValue.md)[] \| `string` \| `object` \| [`MoveStruct`](MoveStruct.md) \| `null` \| [`MoveVariant`](../interfaces/MoveVariant.md) diff --git a/docs/content/ts-sdk/api/client/type-aliases/NetworkId.md b/docs/content/ts-sdk/api/client/type-aliases/NetworkId.md deleted file mode 100644 index 801f6e66072..00000000000 --- a/docs/content/ts-sdk/api/client/type-aliases/NetworkId.md +++ /dev/null @@ -1,3 +0,0 @@ -# Type Alias: NetworkId - -> **NetworkId**: [`Network`](../enumerations/Network.md) \| `string` diff --git a/docs/content/ts-sdk/api/client/type-aliases/ObjectOwner.md b/docs/content/ts-sdk/api/client/type-aliases/ObjectOwner.md deleted file mode 100644 index 92227cc8d12..00000000000 --- a/docs/content/ts-sdk/api/client/type-aliases/ObjectOwner.md +++ /dev/null @@ -1,3 +0,0 @@ -# Type Alias: ObjectOwner - -> **ObjectOwner**: `object` \| `object` \| `object` \| `"Immutable"` diff --git a/docs/content/ts-sdk/api/client/type-aliases/ObjectRead.md b/docs/content/ts-sdk/api/client/type-aliases/ObjectRead.md deleted file mode 100644 index 261496046e9..00000000000 --- a/docs/content/ts-sdk/api/client/type-aliases/ObjectRead.md +++ /dev/null @@ -1,3 +0,0 @@ -# Type Alias: ObjectRead - -> **ObjectRead**: `object` \| `object` \| `object` \| `object` \| `object` diff --git a/docs/content/ts-sdk/api/client/type-aliases/ObjectResponseError.md b/docs/content/ts-sdk/api/client/type-aliases/ObjectResponseError.md deleted file mode 100644 index 7d4a1eb309e..00000000000 --- a/docs/content/ts-sdk/api/client/type-aliases/ObjectResponseError.md +++ /dev/null @@ -1,3 +0,0 @@ -# Type Alias: ObjectResponseError - -> **ObjectResponseError**: `object` \| `object` \| `object` \| `object` \| `object` diff --git a/docs/content/ts-sdk/api/client/type-aliases/ObjectValueKind.md b/docs/content/ts-sdk/api/client/type-aliases/ObjectValueKind.md deleted file mode 100644 index d6a2fd3cc71..00000000000 --- a/docs/content/ts-sdk/api/client/type-aliases/ObjectValueKind.md +++ /dev/null @@ -1,3 +0,0 @@ -# Type Alias: ObjectValueKind - -> **ObjectValueKind**: `"ByImmutableReference"` \| `"ByMutableReference"` \| `"ByValue"` diff --git a/docs/content/ts-sdk/api/client/type-aliases/Order.md b/docs/content/ts-sdk/api/client/type-aliases/Order.md deleted file mode 100644 index 02d225e1e28..00000000000 --- a/docs/content/ts-sdk/api/client/type-aliases/Order.md +++ /dev/null @@ -1,3 +0,0 @@ -# Type Alias: Order - -> **Order**: `"ascending"` \| `"descending"` diff --git a/docs/content/ts-sdk/api/client/type-aliases/ProgrammableTransaction.md b/docs/content/ts-sdk/api/client/type-aliases/ProgrammableTransaction.md deleted file mode 100644 index 9e5c4dedd98..00000000000 --- a/docs/content/ts-sdk/api/client/type-aliases/ProgrammableTransaction.md +++ /dev/null @@ -1,13 +0,0 @@ -# Type Alias: ProgrammableTransaction - -> **ProgrammableTransaction**: `object` - -## Type declaration - -### transactions - -> **transactions**: [`IotaTransaction`](IotaTransaction.md)[] - -### inputs - -> **inputs**: [`IotaCallArg`](IotaCallArg.md)[] diff --git a/docs/content/ts-sdk/api/client/type-aliases/ProtocolConfigValue.md b/docs/content/ts-sdk/api/client/type-aliases/ProtocolConfigValue.md deleted file mode 100644 index 2736c43f41e..00000000000 --- a/docs/content/ts-sdk/api/client/type-aliases/ProtocolConfigValue.md +++ /dev/null @@ -1,3 +0,0 @@ -# Type Alias: ProtocolConfigValue - -> **ProtocolConfigValue**: `object` \| `object` \| `object` \| `object` \| `object` diff --git a/docs/content/ts-sdk/api/client/type-aliases/PublicKey.md b/docs/content/ts-sdk/api/client/type-aliases/PublicKey.md deleted file mode 100644 index 93198d6dc31..00000000000 --- a/docs/content/ts-sdk/api/client/type-aliases/PublicKey.md +++ /dev/null @@ -1,3 +0,0 @@ -# Type Alias: PublicKey - -> **PublicKey**: `object` \| `object` \| `object` \| `object` \| `object` diff --git a/docs/content/ts-sdk/api/client/type-aliases/QueryTransactionBlocksParams.md b/docs/content/ts-sdk/api/client/type-aliases/QueryTransactionBlocksParams.md deleted file mode 100644 index 6db24317834..00000000000 --- a/docs/content/ts-sdk/api/client/type-aliases/QueryTransactionBlocksParams.md +++ /dev/null @@ -1,26 +0,0 @@ -# Type Alias: QueryTransactionBlocksParams - -> **QueryTransactionBlocksParams**: `object` & [`IotaTransactionBlockResponseQuery`](../interfaces/IotaTransactionBlockResponseQuery.md) - -Return list of transactions for a specified query criteria. - -## Type declaration - -### cursor? - -> `optional` **cursor**: `string` \| `null` - -An optional paging cursor. If provided, the query will start from the next item after the specified -cursor. Default to start from the first item if not specified. - -### limit? - -> `optional` **limit**: `number` \| `null` - -Maximum item returned per page, default to QUERY_MAX_RESULT_LIMIT if not specified. - -### order? - -> `optional` **order**: `"ascending"` \| `"descending"` \| `null` - -query result ordering, default to false (ascending order), oldest record first. diff --git a/docs/content/ts-sdk/api/client/type-aliases/RPCTransactionRequestParams.md b/docs/content/ts-sdk/api/client/type-aliases/RPCTransactionRequestParams.md deleted file mode 100644 index 925786949c0..00000000000 --- a/docs/content/ts-sdk/api/client/type-aliases/RPCTransactionRequestParams.md +++ /dev/null @@ -1,3 +0,0 @@ -# Type Alias: RPCTransactionRequestParams - -> **RPCTransactionRequestParams**: `object` \| `object` diff --git a/docs/content/ts-sdk/api/client/type-aliases/RawData.md b/docs/content/ts-sdk/api/client/type-aliases/RawData.md deleted file mode 100644 index 31063b30e6d..00000000000 --- a/docs/content/ts-sdk/api/client/type-aliases/RawData.md +++ /dev/null @@ -1,3 +0,0 @@ -# Type Alias: RawData - -> **RawData**: `object` \| `object` diff --git a/docs/content/ts-sdk/api/client/type-aliases/Signature.md b/docs/content/ts-sdk/api/client/type-aliases/Signature.md deleted file mode 100644 index 2c0e8c35872..00000000000 --- a/docs/content/ts-sdk/api/client/type-aliases/Signature.md +++ /dev/null @@ -1,3 +0,0 @@ -# Type Alias: Signature - -> **Signature**: `object` \| `object` \| `object` diff --git a/docs/content/ts-sdk/api/client/type-aliases/StakeObject.md b/docs/content/ts-sdk/api/client/type-aliases/StakeObject.md deleted file mode 100644 index 4337569ac10..00000000000 --- a/docs/content/ts-sdk/api/client/type-aliases/StakeObject.md +++ /dev/null @@ -1,3 +0,0 @@ -# Type Alias: StakeObject - -> **StakeObject**: `object` \| `object` \| `object` diff --git a/docs/content/ts-sdk/api/client/type-aliases/TimelockedStake.md b/docs/content/ts-sdk/api/client/type-aliases/TimelockedStake.md deleted file mode 100644 index 9e5a77c5983..00000000000 --- a/docs/content/ts-sdk/api/client/type-aliases/TimelockedStake.md +++ /dev/null @@ -1,3 +0,0 @@ -# Type Alias: TimelockedStake - -> **TimelockedStake**: `object` \| `object` \| `object` diff --git a/docs/content/ts-sdk/api/client/type-aliases/TransactionBlockData.md b/docs/content/ts-sdk/api/client/type-aliases/TransactionBlockData.md deleted file mode 100644 index d8241f2a8df..00000000000 --- a/docs/content/ts-sdk/api/client/type-aliases/TransactionBlockData.md +++ /dev/null @@ -1,21 +0,0 @@ -# Type Alias: TransactionBlockData - -> **TransactionBlockData**: `object` - -## Type declaration - -### gasData - -> **gasData**: [`IotaGasData`](../interfaces/IotaGasData.md) - -### messageVersion - -> **messageVersion**: `"v1"` - -### sender - -> **sender**: `string` - -### transaction - -> **transaction**: [`IotaTransactionBlockKind`](IotaTransactionBlockKind.md) diff --git a/docs/content/ts-sdk/api/client/type-aliases/TransactionEffects.md b/docs/content/ts-sdk/api/client/type-aliases/TransactionEffects.md deleted file mode 100644 index ac07e60a246..00000000000 --- a/docs/content/ts-sdk/api/client/type-aliases/TransactionEffects.md +++ /dev/null @@ -1,102 +0,0 @@ -# Type Alias: TransactionEffects - -> **TransactionEffects**: `object` - -## Type declaration - -### created? - -> `optional` **created**: [`OwnedObjectRef`](../interfaces/OwnedObjectRef.md)[] - -ObjectRef and owner of new objects created. - -### deleted? - -> `optional` **deleted**: [`IotaObjectRef`](../interfaces/IotaObjectRef.md)[] - -Object Refs of objects now deleted (the old refs). - -### dependencies? - -> `optional` **dependencies**: `string`[] - -The set of transaction digests this transaction depends on. - -### eventsDigest? - -> `optional` **eventsDigest**: `string` \| `null` - -The digest of the events emitted during execution, can be None if the transaction does not emit any -event. - -### executedEpoch - -> **executedEpoch**: `string` - -The epoch when this transaction was executed. - -### gasObject - -> **gasObject**: [`OwnedObjectRef`](../interfaces/OwnedObjectRef.md) - -The updated gas object reference. Have a dedicated field for convenient access. It's also included -in mutated. - -### gasUsed - -> **gasUsed**: [`GasCostSummary`](../interfaces/GasCostSummary.md) - -### messageVersion - -> **messageVersion**: `"v1"` - -### modifiedAtVersions? - -> `optional` **modifiedAtVersions**: [`TransactionBlockEffectsModifiedAtVersions`](../interfaces/TransactionBlockEffectsModifiedAtVersions.md)[] - -The version that every modified (mutated or deleted) object had before it was modified by this -transaction. - -### mutated? - -> `optional` **mutated**: [`OwnedObjectRef`](../interfaces/OwnedObjectRef.md)[] - -ObjectRef and owner of mutated objects, including gas object. - -### sharedObjects? - -> `optional` **sharedObjects**: [`IotaObjectRef`](../interfaces/IotaObjectRef.md)[] - -The object references of the shared objects used in this transaction. Empty if no shared objects -were used. - -### status - -> **status**: [`ExecutionStatus`](ExecutionStatus.md) - -The status of the execution - -### transactionDigest - -> **transactionDigest**: `string` - -The transaction digest - -### unwrapped? - -> `optional` **unwrapped**: [`OwnedObjectRef`](../interfaces/OwnedObjectRef.md)[] - -ObjectRef and owner of objects that are unwrapped in this transaction. Unwrapped objects are objects -that were wrapped into other objects in the past, and just got extracted out. - -### unwrappedThenDeleted? - -> `optional` **unwrappedThenDeleted**: [`IotaObjectRef`](../interfaces/IotaObjectRef.md)[] - -Object refs of objects previously wrapped in other objects but now deleted. - -### wrapped? - -> `optional` **wrapped**: [`IotaObjectRef`](../interfaces/IotaObjectRef.md)[] - -Object refs of objects now wrapped in other objects. diff --git a/docs/content/ts-sdk/api/client/type-aliases/TransactionFilter.md b/docs/content/ts-sdk/api/client/type-aliases/TransactionFilter.md deleted file mode 100644 index 4800d811b4d..00000000000 --- a/docs/content/ts-sdk/api/client/type-aliases/TransactionFilter.md +++ /dev/null @@ -1,3 +0,0 @@ -# Type Alias: TransactionFilter - -> **TransactionFilter**: `object` \| `object` \| `object` \| `object` \| `object` \| `object` \| `object` \| `object` \| `object` \| `object` diff --git a/docs/content/ts-sdk/api/client/type-aliases/Unsubscribe.md b/docs/content/ts-sdk/api/client/type-aliases/Unsubscribe.md deleted file mode 100644 index 17b357f44fa..00000000000 --- a/docs/content/ts-sdk/api/client/type-aliases/Unsubscribe.md +++ /dev/null @@ -1,7 +0,0 @@ -# Type Alias: Unsubscribe() - -> **Unsubscribe**: () => `Promise`\<`boolean`\> - -## Returns - -`Promise`\<`boolean`\> diff --git a/docs/content/ts-sdk/api/cryptography/classes/Keypair.md b/docs/content/ts-sdk/api/cryptography/classes/Keypair.md deleted file mode 100644 index b2540b63eb7..00000000000 --- a/docs/content/ts-sdk/api/cryptography/classes/Keypair.md +++ /dev/null @@ -1,173 +0,0 @@ -# Class: `abstract` Keypair - -TODO: Document - -## Extends - -- [`Signer`](Signer.md) - -## Extended by - -- [`Ed25519Keypair`](../../keypairs/ed25519/classes/Ed25519Keypair.md) -- [`Secp256k1Keypair`](../../keypairs/secp256k1/classes/Secp256k1Keypair.md) - -## Constructors - -### new Keypair() - -> **new Keypair**(): [`Keypair`](Keypair.md) - -#### Returns - -[`Keypair`](Keypair.md) - -#### Inherited from - -[`Signer`](Signer.md).[`constructor`](Signer.md#constructors) - -## Methods - -### sign() - -> `abstract` **sign**(`bytes`): `Promise`\<`Uint8Array`\> - -#### Parameters - -• **bytes**: `Uint8Array` - -#### Returns - -`Promise`\<`Uint8Array`\> - -#### Inherited from - -[`Signer`](Signer.md).[`sign`](Signer.md#sign) - ---- - -### signWithIntent() - -> **signWithIntent**(`bytes`, `intent`): `Promise`\<[`SignatureWithBytes`](../interfaces/SignatureWithBytes.md)\> - -Sign messages with a specific intent. By combining the message bytes with the intent before hashing and signing, -it ensures that a signed message is tied to a specific purpose and domain separator is provided - -#### Parameters - -• **bytes**: `Uint8Array` - -• **intent**: [`IntentScope`](../type-aliases/IntentScope.md) - -#### Returns - -`Promise`\<[`SignatureWithBytes`](../interfaces/SignatureWithBytes.md)\> - -#### Inherited from - -[`Signer`](Signer.md).[`signWithIntent`](Signer.md#signwithintent) - ---- - -### signTransaction() - -> **signTransaction**(`bytes`): `Promise`\<[`SignatureWithBytes`](../interfaces/SignatureWithBytes.md)\> - -Signs provided transaction by calling `signWithIntent()` with a `TransactionData` provided as intent scope - -#### Parameters - -• **bytes**: `Uint8Array` - -#### Returns - -`Promise`\<[`SignatureWithBytes`](../interfaces/SignatureWithBytes.md)\> - -#### Inherited from - -[`Signer`](Signer.md).[`signTransaction`](Signer.md#signtransaction) - ---- - -### signPersonalMessage() - -> **signPersonalMessage**(`bytes`): `Promise`\<`object`\> - -Signs provided personal message by calling `signWithIntent()` with a `PersonalMessage` provided as intent scope - -#### Parameters - -• **bytes**: `Uint8Array` - -#### Returns - -`Promise`\<`object`\> - -##### bytes - -> **bytes**: `string` - -##### signature - -> **signature**: `string` - -#### Inherited from - -[`Signer`](Signer.md).[`signPersonalMessage`](Signer.md#signpersonalmessage) - ---- - -### toIotaAddress() - -> **toIotaAddress**(): `string` - -#### Returns - -`string` - -#### Inherited from - -[`Signer`](Signer.md).[`toIotaAddress`](Signer.md#toiotaaddress) - ---- - -### getKeyScheme() - -> `abstract` **getKeyScheme**(): [`SignatureScheme`](../type-aliases/SignatureScheme.md) - -Get the key scheme of the keypair: Secp256k1 or ED25519 - -#### Returns - -[`SignatureScheme`](../type-aliases/SignatureScheme.md) - -#### Inherited from - -[`Signer`](Signer.md).[`getKeyScheme`](Signer.md#getkeyscheme) - ---- - -### getPublicKey() - -> `abstract` **getPublicKey**(): [`PublicKey`](PublicKey.md) - -The public key for this keypair - -#### Returns - -[`PublicKey`](PublicKey.md) - -#### Inherited from - -[`Signer`](Signer.md).[`getPublicKey`](Signer.md#getpublickey) - ---- - -### getSecretKey() - -> `abstract` **getSecretKey**(): `string` - -This returns the Bech32 secret key string for this keypair. - -#### Returns - -`string` diff --git a/docs/content/ts-sdk/api/cryptography/classes/PublicKey.md b/docs/content/ts-sdk/api/cryptography/classes/PublicKey.md deleted file mode 100644 index b54b2bbb9a7..00000000000 --- a/docs/content/ts-sdk/api/cryptography/classes/PublicKey.md +++ /dev/null @@ -1,206 +0,0 @@ -# Class: `abstract` PublicKey - -A public key - -## Extended by - -- [`Ed25519PublicKey`](../../keypairs/ed25519/classes/Ed25519PublicKey.md) -- [`Secp256k1PublicKey`](../../keypairs/secp256k1/classes/Secp256k1PublicKey.md) -- [`MultiSigPublicKey`](../../multisig/classes/MultiSigPublicKey.md) - -## Constructors - -### new PublicKey() - -> **new PublicKey**(): [`PublicKey`](PublicKey.md) - -#### Returns - -[`PublicKey`](PublicKey.md) - -## Methods - -### equals() - -> **equals**(`publicKey`): `boolean` - -Checks if two public keys are equal - -#### Parameters - -• **publicKey**: [`PublicKey`](PublicKey.md) - -#### Returns - -`boolean` - ---- - -### toBase64() - -> **toBase64**(): `string` - -Return the base-64 representation of the public key - -#### Returns - -`string` - ---- - -### toString() - -> **toString**(): `never` - -#### Returns - -`never` - ---- - -### toIotaPublicKey() - -> **toIotaPublicKey**(): `string` - -Return the IOTA representation of the public key encoded in -base-64. An IOTA public key is formed by the concatenation -of the scheme flag with the raw bytes of the public key - -#### Returns - -`string` - ---- - -### verifyWithIntent() - -> **verifyWithIntent**(`bytes`, `signature`, `intent`): `Promise`\<`boolean`\> - -#### Parameters - -• **bytes**: `Uint8Array` - -• **signature**: `string` \| `Uint8Array` - -• **intent**: [`IntentScope`](../type-aliases/IntentScope.md) - -#### Returns - -`Promise`\<`boolean`\> - ---- - -### verifyPersonalMessage() - -> **verifyPersonalMessage**(`message`, `signature`): `Promise`\<`boolean`\> - -Verifies that the signature is valid for for the provided PersonalMessage - -#### Parameters - -• **message**: `Uint8Array` - -• **signature**: `string` \| `Uint8Array` - -#### Returns - -`Promise`\<`boolean`\> - ---- - -### verifyTransaction() - -> **verifyTransaction**(`transaction`, `signature`): `Promise`\<`boolean`\> - -Verifies that the signature is valid for for the provided Transaction - -#### Parameters - -• **transaction**: `Uint8Array` - -• **signature**: `string` \| `Uint8Array` - -#### Returns - -`Promise`\<`boolean`\> - ---- - -### toIotaBytes() - -> **toIotaBytes**(): `Uint8Array` - -Returns the bytes representation of the public key -prefixed with the signature scheme flag - -#### Returns - -`Uint8Array` - ---- - -### toIotaBytesForAddress() - -> **toIotaBytesForAddress**(): `Uint8Array` - -Returns the bytes representation of the public key -prefixed with the signature scheme flag. If the -signature scheme is ED25519, no prefix is set. - -#### Returns - -`Uint8Array` - ---- - -### toIotaAddress() - -> **toIotaAddress**(): `string` - -Return the IOTA address associated with this Ed25519 public key - -#### Returns - -`string` - ---- - -### toRawBytes() - -> `abstract` **toRawBytes**(): `Uint8Array` - -Return the byte array representation of the public key - -#### Returns - -`Uint8Array` - ---- - -### flag() - -> `abstract` **flag**(): `number` - -Return signature scheme flag of the public key - -#### Returns - -`number` - ---- - -### verify() - -> `abstract` **verify**(`data`, `signature`): `Promise`\<`boolean`\> - -Verifies that the signature is valid for for the provided message - -#### Parameters - -• **data**: `Uint8Array` - -• **signature**: `string` \| `Uint8Array` - -#### Returns - -`Promise`\<`boolean`\> diff --git a/docs/content/ts-sdk/api/cryptography/classes/Signer.md b/docs/content/ts-sdk/api/cryptography/classes/Signer.md deleted file mode 100644 index 7755ea9e1ff..00000000000 --- a/docs/content/ts-sdk/api/cryptography/classes/Signer.md +++ /dev/null @@ -1,125 +0,0 @@ -# Class: `abstract` Signer - -TODO: Document - -## Extended by - -- [`Keypair`](Keypair.md) -- [`MultiSigSigner`](../../multisig/classes/MultiSigSigner.md) - -## Constructors - -### new Signer() - -> **new Signer**(): [`Signer`](Signer.md) - -#### Returns - -[`Signer`](Signer.md) - -## Methods - -### sign() - -> `abstract` **sign**(`bytes`): `Promise`\<`Uint8Array`\> - -#### Parameters - -• **bytes**: `Uint8Array` - -#### Returns - -`Promise`\<`Uint8Array`\> - ---- - -### signWithIntent() - -> **signWithIntent**(`bytes`, `intent`): `Promise`\<[`SignatureWithBytes`](../interfaces/SignatureWithBytes.md)\> - -Sign messages with a specific intent. By combining the message bytes with the intent before hashing and signing, -it ensures that a signed message is tied to a specific purpose and domain separator is provided - -#### Parameters - -• **bytes**: `Uint8Array` - -• **intent**: [`IntentScope`](../type-aliases/IntentScope.md) - -#### Returns - -`Promise`\<[`SignatureWithBytes`](../interfaces/SignatureWithBytes.md)\> - ---- - -### signTransaction() - -> **signTransaction**(`bytes`): `Promise`\<[`SignatureWithBytes`](../interfaces/SignatureWithBytes.md)\> - -Signs provided transaction by calling `signWithIntent()` with a `TransactionData` provided as intent scope - -#### Parameters - -• **bytes**: `Uint8Array` - -#### Returns - -`Promise`\<[`SignatureWithBytes`](../interfaces/SignatureWithBytes.md)\> - ---- - -### signPersonalMessage() - -> **signPersonalMessage**(`bytes`): `Promise`\<`object`\> - -Signs provided personal message by calling `signWithIntent()` with a `PersonalMessage` provided as intent scope - -#### Parameters - -• **bytes**: `Uint8Array` - -#### Returns - -`Promise`\<`object`\> - -##### bytes - -> **bytes**: `string` - -##### signature - -> **signature**: `string` - ---- - -### toIotaAddress() - -> **toIotaAddress**(): `string` - -#### Returns - -`string` - ---- - -### getKeyScheme() - -> `abstract` **getKeyScheme**(): [`SignatureScheme`](../type-aliases/SignatureScheme.md) - -Get the key scheme of the keypair: Secp256k1 or ED25519 - -#### Returns - -[`SignatureScheme`](../type-aliases/SignatureScheme.md) - ---- - -### getPublicKey() - -> `abstract` **getPublicKey**(): [`PublicKey`](PublicKey.md) - -The public key for this keypair - -#### Returns - -[`PublicKey`](PublicKey.md) diff --git a/docs/content/ts-sdk/api/cryptography/functions/decodeIotaPrivateKey.md b/docs/content/ts-sdk/api/cryptography/functions/decodeIotaPrivateKey.md deleted file mode 100644 index 0318a390465..00000000000 --- a/docs/content/ts-sdk/api/cryptography/functions/decodeIotaPrivateKey.md +++ /dev/null @@ -1,15 +0,0 @@ -# Function: decodeIotaPrivateKey() - -> **decodeIotaPrivateKey**(`value`): [`ParsedKeypair`](../type-aliases/ParsedKeypair.md) - -This returns an ParsedKeypair object based by validating the -33-byte Bech32 encoded string starting with `iotaprivkey`, and -parse out the signature scheme and the private key in bytes. - -## Parameters - -• **value**: `string` - -## Returns - -[`ParsedKeypair`](../type-aliases/ParsedKeypair.md) diff --git a/docs/content/ts-sdk/api/cryptography/functions/encodeIotaPrivateKey.md b/docs/content/ts-sdk/api/cryptography/functions/encodeIotaPrivateKey.md deleted file mode 100644 index 4b7cffea7d8..00000000000 --- a/docs/content/ts-sdk/api/cryptography/functions/encodeIotaPrivateKey.md +++ /dev/null @@ -1,17 +0,0 @@ -# Function: encodeIotaPrivateKey() - -> **encodeIotaPrivateKey**(`bytes`, `scheme`): `string` - -This returns a Bech32 encoded string starting with `iotaprivkey`, -encoding 33-byte `flag || bytes` for the given the 32-byte private -key and its signature scheme. - -## Parameters - -• **bytes**: `Uint8Array` - -• **scheme**: [`SignatureScheme`](../type-aliases/SignatureScheme.md) - -## Returns - -`string` diff --git a/docs/content/ts-sdk/api/cryptography/functions/isValidBIP32Path.md b/docs/content/ts-sdk/api/cryptography/functions/isValidBIP32Path.md deleted file mode 100644 index e124c9a26e8..00000000000 --- a/docs/content/ts-sdk/api/cryptography/functions/isValidBIP32Path.md +++ /dev/null @@ -1,18 +0,0 @@ -# Function: isValidBIP32Path() - -> **isValidBIP32Path**(`path`): `boolean` - -Parse and validate a path that is compliant to BIP-32 in form m/54'/4218'/{account_index}'/{change_index}/{address_index} -for Secp256k1 and m/74'/4218'/{account_index}'/{change_index}/{address_index} for Secp256r1. - -Note that the purpose for Secp256k1 is registered as 54, to differentiate from Ed25519 with purpose 44. - -## Parameters - -• **path**: `string` - -path string (e.g. `m/54'/4218'/0'/0/0`). - -## Returns - -`boolean` diff --git a/docs/content/ts-sdk/api/cryptography/functions/isValidHardenedPath.md b/docs/content/ts-sdk/api/cryptography/functions/isValidHardenedPath.md deleted file mode 100644 index 9affc1bd7e7..00000000000 --- a/docs/content/ts-sdk/api/cryptography/functions/isValidHardenedPath.md +++ /dev/null @@ -1,15 +0,0 @@ -# Function: isValidHardenedPath() - -> **isValidHardenedPath**(`path`): `boolean` - -Parse and validate a path that is compliant to SLIP-0010 in form m/44'/4218'/{account_index}'/{change_index}'/{address_index}'. - -## Parameters - -• **path**: `string` - -path string (e.g. `m/44'/4218'/0'/0'/0'`). - -## Returns - -`boolean` diff --git a/docs/content/ts-sdk/api/cryptography/functions/messageWithIntent.md b/docs/content/ts-sdk/api/cryptography/functions/messageWithIntent.md deleted file mode 100644 index f0f96a48fc9..00000000000 --- a/docs/content/ts-sdk/api/cryptography/functions/messageWithIntent.md +++ /dev/null @@ -1,15 +0,0 @@ -# Function: messageWithIntent() - -> **messageWithIntent**(`scope`, `message`): `Uint8Array` - -Inserts a domain separator for a message that is being signed - -## Parameters - -• **scope**: [`IntentScope`](../type-aliases/IntentScope.md) - -• **message**: `Uint8Array` - -## Returns - -`Uint8Array` diff --git a/docs/content/ts-sdk/api/cryptography/functions/mnemonicToSeed.md b/docs/content/ts-sdk/api/cryptography/functions/mnemonicToSeed.md deleted file mode 100644 index 5681b851070..00000000000 --- a/docs/content/ts-sdk/api/cryptography/functions/mnemonicToSeed.md +++ /dev/null @@ -1,15 +0,0 @@ -# Function: mnemonicToSeed() - -> **mnemonicToSeed**(`mnemonics`): `Uint8Array` - -Uses KDF to derive 64 bytes of key data from mnemonic with empty password. - -## Parameters - -• **mnemonics**: `string` - -24 words string split by spaces. - -## Returns - -`Uint8Array` diff --git a/docs/content/ts-sdk/api/cryptography/functions/mnemonicToSeedHex.md b/docs/content/ts-sdk/api/cryptography/functions/mnemonicToSeedHex.md deleted file mode 100644 index 04e274a65b1..00000000000 --- a/docs/content/ts-sdk/api/cryptography/functions/mnemonicToSeedHex.md +++ /dev/null @@ -1,15 +0,0 @@ -# Function: mnemonicToSeedHex() - -> **mnemonicToSeedHex**(`mnemonics`): `string` - -Derive the seed in hex format from a 24-word mnemonic string. - -## Parameters - -• **mnemonics**: `string` - -24 words string split by spaces. - -## Returns - -`string` diff --git a/docs/content/ts-sdk/api/cryptography/functions/parseSerializedSignature.md b/docs/content/ts-sdk/api/cryptography/functions/parseSerializedSignature.md deleted file mode 100644 index 562ee77562e..00000000000 --- a/docs/content/ts-sdk/api/cryptography/functions/parseSerializedSignature.md +++ /dev/null @@ -1,13 +0,0 @@ -# Function: parseSerializedSignature() - -> **parseSerializedSignature**(`serializedSignature`): `object` \| `object` - -Decodes a serialized signature into its constituent components: the signature scheme, the actual signature, and the public key - -## Parameters - -• **serializedSignature**: `string` - -## Returns - -`object` \| `object` diff --git a/docs/content/ts-sdk/api/cryptography/functions/toSerializedSignature.md b/docs/content/ts-sdk/api/cryptography/functions/toSerializedSignature.md deleted file mode 100644 index 7dabe5495da..00000000000 --- a/docs/content/ts-sdk/api/cryptography/functions/toSerializedSignature.md +++ /dev/null @@ -1,13 +0,0 @@ -# Function: toSerializedSignature() - -> **toSerializedSignature**(`__namedParameters`): `string` - -Takes in a signature, its associated signing scheme and a public key, then serializes this data - -## Parameters - -• **\_\_namedParameters**: [`SerializeSignatureInput`](../type-aliases/SerializeSignatureInput.md) - -## Returns - -`string` diff --git a/docs/content/ts-sdk/api/cryptography/index.md b/docs/content/ts-sdk/api/cryptography/index.md deleted file mode 100644 index c13f775cd73..00000000000 --- a/docs/content/ts-sdk/api/cryptography/index.md +++ /dev/null @@ -1,42 +0,0 @@ -# cryptography - -## Index - -### Classes - -- [Signer](classes/Signer.md) -- [Keypair](classes/Keypair.md) -- [PublicKey](classes/PublicKey.md) - -### Interfaces - -- [SignatureWithBytes](interfaces/SignatureWithBytes.md) - -### Type Aliases - -- [IntentScope](type-aliases/IntentScope.md) -- [ParsedKeypair](type-aliases/ParsedKeypair.md) -- [SignatureScheme](type-aliases/SignatureScheme.md) -- [SignatureFlag](type-aliases/SignatureFlag.md) -- [SerializeSignatureInput](type-aliases/SerializeSignatureInput.md) - -### Variables - -- [PRIVATE\_KEY\_SIZE](variables/PRIVATE_KEY_SIZE.md) -- [LEGACY\_PRIVATE\_KEY\_SIZE](variables/LEGACY_PRIVATE_KEY_SIZE.md) -- [IOTA\_PRIVATE\_KEY\_PREFIX](variables/IOTA_PRIVATE_KEY_PREFIX.md) -- [SIGNATURE\_SCHEME\_TO\_FLAG](variables/SIGNATURE_SCHEME_TO_FLAG.md) -- [SIGNATURE\_SCHEME\_TO\_SIZE](variables/SIGNATURE_SCHEME_TO_SIZE.md) -- [SIGNATURE\_FLAG\_TO\_SCHEME](variables/SIGNATURE_FLAG_TO_SCHEME.md) - -### Functions - -- [messageWithIntent](functions/messageWithIntent.md) -- [decodeIotaPrivateKey](functions/decodeIotaPrivateKey.md) -- [encodeIotaPrivateKey](functions/encodeIotaPrivateKey.md) -- [isValidHardenedPath](functions/isValidHardenedPath.md) -- [isValidBIP32Path](functions/isValidBIP32Path.md) -- [mnemonicToSeed](functions/mnemonicToSeed.md) -- [mnemonicToSeedHex](functions/mnemonicToSeedHex.md) -- [toSerializedSignature](functions/toSerializedSignature.md) -- [parseSerializedSignature](functions/parseSerializedSignature.md) diff --git a/docs/content/ts-sdk/api/cryptography/interfaces/SignatureWithBytes.md b/docs/content/ts-sdk/api/cryptography/interfaces/SignatureWithBytes.md deleted file mode 100644 index ba584635d90..00000000000 --- a/docs/content/ts-sdk/api/cryptography/interfaces/SignatureWithBytes.md +++ /dev/null @@ -1,13 +0,0 @@ -# Interface: SignatureWithBytes - -## Properties - -### bytes - -> **bytes**: `string` - ---- - -### signature - -> **signature**: `string` diff --git a/docs/content/ts-sdk/api/cryptography/type-aliases/IntentScope.md b/docs/content/ts-sdk/api/cryptography/type-aliases/IntentScope.md deleted file mode 100644 index 6cba4a432ad..00000000000 --- a/docs/content/ts-sdk/api/cryptography/type-aliases/IntentScope.md +++ /dev/null @@ -1,3 +0,0 @@ -# Type Alias: IntentScope - -> **IntentScope**: `Exclude`\ diff --git a/docs/content/ts-sdk/api/cryptography/type-aliases/ParsedKeypair.md b/docs/content/ts-sdk/api/cryptography/type-aliases/ParsedKeypair.md deleted file mode 100644 index d35bea74c82..00000000000 --- a/docs/content/ts-sdk/api/cryptography/type-aliases/ParsedKeypair.md +++ /dev/null @@ -1,13 +0,0 @@ -# Type Alias: ParsedKeypair - -> **ParsedKeypair**: `object` - -## Type declaration - -### schema - -> **schema**: [`SignatureScheme`](SignatureScheme.md) - -### secretKey - -> **secretKey**: `Uint8Array` diff --git a/docs/content/ts-sdk/api/cryptography/type-aliases/SerializeSignatureInput.md b/docs/content/ts-sdk/api/cryptography/type-aliases/SerializeSignatureInput.md deleted file mode 100644 index aacf1be5579..00000000000 --- a/docs/content/ts-sdk/api/cryptography/type-aliases/SerializeSignatureInput.md +++ /dev/null @@ -1,23 +0,0 @@ -# Type Alias: SerializeSignatureInput - -> **SerializeSignatureInput**: `object` - -Pair of signature and corresponding public key - -## Type declaration - -### signatureScheme - -> **signatureScheme**: [`SignatureScheme`](SignatureScheme.md) - -### signature - -> **signature**: `Uint8Array` - -Base64-encoded signature - -### publicKey? - -> `optional` **publicKey**: [`PublicKey`](../classes/PublicKey.md) - -Base64-encoded public key diff --git a/docs/content/ts-sdk/api/cryptography/type-aliases/SignatureFlag.md b/docs/content/ts-sdk/api/cryptography/type-aliases/SignatureFlag.md deleted file mode 100644 index 06bdc308af2..00000000000 --- a/docs/content/ts-sdk/api/cryptography/type-aliases/SignatureFlag.md +++ /dev/null @@ -1,3 +0,0 @@ -# Type Alias: SignatureFlag - -> **SignatureFlag**: keyof _typeof_ [`SIGNATURE_FLAG_TO_SCHEME`](../variables/SIGNATURE_FLAG_TO_SCHEME.md) diff --git a/docs/content/ts-sdk/api/cryptography/type-aliases/SignatureScheme.md b/docs/content/ts-sdk/api/cryptography/type-aliases/SignatureScheme.md deleted file mode 100644 index 10bacc122d5..00000000000 --- a/docs/content/ts-sdk/api/cryptography/type-aliases/SignatureScheme.md +++ /dev/null @@ -1,3 +0,0 @@ -# Type Alias: SignatureScheme - -> **SignatureScheme**: `"ED25519"` \| `"Secp256k1"` \| `"Secp256r1"` \| `"MultiSig"` diff --git a/docs/content/ts-sdk/api/cryptography/variables/IOTA_PRIVATE_KEY_PREFIX.md b/docs/content/ts-sdk/api/cryptography/variables/IOTA_PRIVATE_KEY_PREFIX.md deleted file mode 100644 index f15475f4a0b..00000000000 --- a/docs/content/ts-sdk/api/cryptography/variables/IOTA_PRIVATE_KEY_PREFIX.md +++ /dev/null @@ -1,3 +0,0 @@ -# Variable: IOTA\_PRIVATE\_KEY\_PREFIX - -> `const` **IOTA\_PRIVATE\_KEY\_PREFIX**: `"iotaprivkey"` = `'iotaprivkey'` diff --git a/docs/content/ts-sdk/api/cryptography/variables/LEGACY_PRIVATE_KEY_SIZE.md b/docs/content/ts-sdk/api/cryptography/variables/LEGACY_PRIVATE_KEY_SIZE.md deleted file mode 100644 index d35b901d802..00000000000 --- a/docs/content/ts-sdk/api/cryptography/variables/LEGACY_PRIVATE_KEY_SIZE.md +++ /dev/null @@ -1,3 +0,0 @@ -# Variable: LEGACY\_PRIVATE\_KEY\_SIZE - -> `const` **LEGACY\_PRIVATE\_KEY\_SIZE**: `64` = `64` diff --git a/docs/content/ts-sdk/api/cryptography/variables/PRIVATE_KEY_SIZE.md b/docs/content/ts-sdk/api/cryptography/variables/PRIVATE_KEY_SIZE.md deleted file mode 100644 index a02f817c1d7..00000000000 --- a/docs/content/ts-sdk/api/cryptography/variables/PRIVATE_KEY_SIZE.md +++ /dev/null @@ -1,3 +0,0 @@ -# Variable: PRIVATE\_KEY\_SIZE - -> `const` **PRIVATE\_KEY\_SIZE**: `32` = `32` diff --git a/docs/content/ts-sdk/api/cryptography/variables/SIGNATURE_FLAG_TO_SCHEME.md b/docs/content/ts-sdk/api/cryptography/variables/SIGNATURE_FLAG_TO_SCHEME.md deleted file mode 100644 index 3b38748eec5..00000000000 --- a/docs/content/ts-sdk/api/cryptography/variables/SIGNATURE_FLAG_TO_SCHEME.md +++ /dev/null @@ -1,21 +0,0 @@ -# Variable: SIGNATURE\_FLAG\_TO\_SCHEME - -> `const` **SIGNATURE\_FLAG\_TO\_SCHEME**: `object` - -## Type declaration - -### 0 - -> `readonly` **0**: `"ED25519"` = `'ED25519'` - -### 1 - -> `readonly` **1**: `"Secp256k1"` = `'Secp256k1'` - -### 2 - -> `readonly` **2**: `"Secp256r1"` = `'Secp256r1'` - -### 3 - -> `readonly` **3**: `"MultiSig"` = `'MultiSig'` diff --git a/docs/content/ts-sdk/api/cryptography/variables/SIGNATURE_SCHEME_TO_FLAG.md b/docs/content/ts-sdk/api/cryptography/variables/SIGNATURE_SCHEME_TO_FLAG.md deleted file mode 100644 index 2828146641d..00000000000 --- a/docs/content/ts-sdk/api/cryptography/variables/SIGNATURE_SCHEME_TO_FLAG.md +++ /dev/null @@ -1,21 +0,0 @@ -# Variable: SIGNATURE\_SCHEME\_TO\_FLAG - -> `const` **SIGNATURE\_SCHEME\_TO\_FLAG**: `object` - -## Type declaration - -### ED25519 - -> `readonly` **ED25519**: `0` = `0x00` - -### Secp256k1 - -> `readonly` **Secp256k1**: `1` = `0x01` - -### Secp256r1 - -> `readonly` **Secp256r1**: `2` = `0x02` - -### MultiSig - -> `readonly` **MultiSig**: `3` = `0x03` diff --git a/docs/content/ts-sdk/api/cryptography/variables/SIGNATURE_SCHEME_TO_SIZE.md b/docs/content/ts-sdk/api/cryptography/variables/SIGNATURE_SCHEME_TO_SIZE.md deleted file mode 100644 index 59364899c46..00000000000 --- a/docs/content/ts-sdk/api/cryptography/variables/SIGNATURE_SCHEME_TO_SIZE.md +++ /dev/null @@ -1,17 +0,0 @@ -# Variable: SIGNATURE\_SCHEME\_TO\_SIZE - -> `const` **SIGNATURE\_SCHEME\_TO\_SIZE**: `object` - -## Type declaration - -### ED25519 - -> **ED25519**: `number` = `32` - -### Secp256k1 - -> **Secp256k1**: `number` = `33` - -### Secp256r1 - -> **Secp256r1**: `number` = `33` diff --git a/docs/content/ts-sdk/api/faucet/classes/FaucetRateLimitError.md b/docs/content/ts-sdk/api/faucet/classes/FaucetRateLimitError.md deleted file mode 100644 index c083e2ff12c..00000000000 --- a/docs/content/ts-sdk/api/faucet/classes/FaucetRateLimitError.md +++ /dev/null @@ -1,139 +0,0 @@ -# Class: FaucetRateLimitError - -## Extends - -- `Error` - -## Constructors - -### new FaucetRateLimitError() - -> **new FaucetRateLimitError**(`message`?): [`FaucetRateLimitError`](FaucetRateLimitError.md) - -#### Parameters - -• **message?**: `string` - -#### Returns - -[`FaucetRateLimitError`](FaucetRateLimitError.md) - -#### Inherited from - -`Error.constructor` - -### new FaucetRateLimitError() - -> **new FaucetRateLimitError**(`message`?, `options`?): [`FaucetRateLimitError`](FaucetRateLimitError.md) - -#### Parameters - -• **message?**: `string` - -• **options?**: `ErrorOptions` - -#### Returns - -[`FaucetRateLimitError`](FaucetRateLimitError.md) - -#### Inherited from - -`Error.constructor` - -## Properties - -### prepareStackTrace()? - -> `static` `optional` **prepareStackTrace**: (`err`, `stackTraces`) => `any` - -Optional override for formatting stack traces - -#### Parameters - -• **err**: `Error` - -• **stackTraces**: `CallSite`[] - -#### Returns - -`any` - -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - -#### Inherited from - -`Error.prepareStackTrace` - ---- - -### stackTraceLimit - -> `static` **stackTraceLimit**: `number` - -#### Inherited from - -`Error.stackTraceLimit` - ---- - -### cause? - -> `optional` **cause**: `unknown` - -#### Inherited from - -`Error.cause` - ---- - -### name - -> **name**: `string` - -#### Inherited from - -`Error.name` - ---- - -### message - -> **message**: `string` - -#### Inherited from - -`Error.message` - ---- - -### stack? - -> `optional` **stack**: `string` - -#### Inherited from - -`Error.stack` - -## Methods - -### captureStackTrace() - -> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` - -Create .stack property on a target object - -#### Parameters - -• **targetObject**: `object` - -• **constructorOpt?**: `Function` - -#### Returns - -`void` - -#### Inherited from - -`Error.captureStackTrace` diff --git a/docs/content/ts-sdk/api/faucet/functions/getFaucetHost.md b/docs/content/ts-sdk/api/faucet/functions/getFaucetHost.md deleted file mode 100644 index 3baaf30b700..00000000000 --- a/docs/content/ts-sdk/api/faucet/functions/getFaucetHost.md +++ /dev/null @@ -1,11 +0,0 @@ -# Function: getFaucetHost() - -> **getFaucetHost**(`network`): `string` - -## Parameters - -• **network**: `string` - -## Returns - -`string` diff --git a/docs/content/ts-sdk/api/faucet/functions/getFaucetRequestStatus.md b/docs/content/ts-sdk/api/faucet/functions/getFaucetRequestStatus.md deleted file mode 100644 index 1e8b8ff4b0c..00000000000 --- a/docs/content/ts-sdk/api/faucet/functions/getFaucetRequestStatus.md +++ /dev/null @@ -1,17 +0,0 @@ -# Function: getFaucetRequestStatus() - -> **getFaucetRequestStatus**(`input`): `Promise`\<`BatchStatusFaucetResponse`\> - -## Parameters - -• **input** - -• **input.host**: `string` - -• **input.taskId**: `string` - -• **input.headers?**: `HeadersInit` - -## Returns - -`Promise`\<`BatchStatusFaucetResponse`\> diff --git a/docs/content/ts-sdk/api/faucet/functions/requestIotaFromFaucetV0.md b/docs/content/ts-sdk/api/faucet/functions/requestIotaFromFaucetV0.md deleted file mode 100644 index 5fdaf5b048f..00000000000 --- a/docs/content/ts-sdk/api/faucet/functions/requestIotaFromFaucetV0.md +++ /dev/null @@ -1,17 +0,0 @@ -# Function: requestIotaFromFaucetV0() - -> **requestIotaFromFaucetV0**(`input`): `Promise`\<`FaucetResponse`\> - -## Parameters - -• **input** - -• **input.host**: `string` - -• **input.recipient**: `string` - -• **input.headers?**: `HeadersInit` - -## Returns - -`Promise`\<`FaucetResponse`\> diff --git a/docs/content/ts-sdk/api/faucet/functions/requestIotaFromFaucetV1.md b/docs/content/ts-sdk/api/faucet/functions/requestIotaFromFaucetV1.md deleted file mode 100644 index 91052957506..00000000000 --- a/docs/content/ts-sdk/api/faucet/functions/requestIotaFromFaucetV1.md +++ /dev/null @@ -1,17 +0,0 @@ -# Function: requestIotaFromFaucetV1() - -> **requestIotaFromFaucetV1**(`input`): `Promise`\<`BatchFaucetResponse`\> - -## Parameters - -• **input** - -• **input.host**: `string` - -• **input.recipient**: `string` - -• **input.headers?**: `HeadersInit` - -## Returns - -`Promise`\<`BatchFaucetResponse`\> diff --git a/docs/content/ts-sdk/api/faucet/index.md b/docs/content/ts-sdk/api/faucet/index.md deleted file mode 100644 index 6542dbbb933..00000000000 --- a/docs/content/ts-sdk/api/faucet/index.md +++ /dev/null @@ -1,14 +0,0 @@ -# faucet - -## Index - -### Classes - -- [FaucetRateLimitError](classes/FaucetRateLimitError.md) - -### Functions - -- [requestIotaFromFaucetV0](functions/requestIotaFromFaucetV0.md) -- [requestIotaFromFaucetV1](functions/requestIotaFromFaucetV1.md) -- [getFaucetRequestStatus](functions/getFaucetRequestStatus.md) -- [getFaucetHost](functions/getFaucetHost.md) diff --git a/docs/content/ts-sdk/api/graphql/classes/IotaGraphQLClient.md b/docs/content/ts-sdk/api/graphql/classes/IotaGraphQLClient.md deleted file mode 100644 index 8f2abf52ff9..00000000000 --- a/docs/content/ts-sdk/api/graphql/classes/IotaGraphQLClient.md +++ /dev/null @@ -1,63 +0,0 @@ -# Class: IotaGraphQLClient\ - -## Type Parameters - -• **Queries** _extends_ `Record`\<`string`, [`GraphQLDocument`](../type-aliases/GraphQLDocument.md)\> = `object` - -## Constructors - -### new IotaGraphQLClient() - -> **new IotaGraphQLClient**\<`Queries`\>(`__namedParameters`): [`IotaGraphQLClient`](IotaGraphQLClient.md)\<`Queries`\> - -#### Parameters - -• **\_\_namedParameters**: [`IotaGraphQLClientOptions`](../interfaces/IotaGraphQLClientOptions.md)\<`Queries`\> - -#### Returns - -[`IotaGraphQLClient`](IotaGraphQLClient.md)\<`Queries`\> - -## Methods - -### query() - -> **query**\<`Result`, `Variables`\>(`options`): `Promise`\<[`GraphQLQueryResult`](../type-aliases/GraphQLQueryResult.md)\<`Result`\>\> - -#### Type Parameters - -• **Result** = `Record`\<`string`, `unknown`\> - -• **Variables** = `Record`\<`string`, `unknown`\> - -#### Parameters - -• **options**: [`GraphQLQueryOptions`](../type-aliases/GraphQLQueryOptions.md)\<`Result`, `Variables`\> - -#### Returns - -`Promise`\<[`GraphQLQueryResult`](../type-aliases/GraphQLQueryResult.md)\<`Result`\>\> - ---- - -### execute() - -> **execute**\<`Query`, `Result`, `Variables`\>(`query`, `options`): `Promise`\<[`GraphQLQueryResult`](../type-aliases/GraphQLQueryResult.md)\<`Result`\>\> - -#### Type Parameters - -• **Query** _extends_ `string` - -• **Result** = `Queries`\[`Query`\] _extends_ [`GraphQLDocument`](../type-aliases/GraphQLDocument.md)\<`R`, `unknown`\> ? `R` : `Record`\<`string`, `unknown`\> - -• **Variables** = `Queries`\[`Query`\] _extends_ [`GraphQLDocument`](../type-aliases/GraphQLDocument.md)\<`unknown`, `V`\> ? `V` : `Record`\<`string`, `unknown`\> - -#### Parameters - -• **query**: `Query` - -• **options**: `Omit`\<[`GraphQLQueryOptions`](../type-aliases/GraphQLQueryOptions.md)\<`Result`, `Variables`\>, `"query"`\> - -#### Returns - -`Promise`\<[`GraphQLQueryResult`](../type-aliases/GraphQLQueryResult.md)\<`Result`\>\> diff --git a/docs/content/ts-sdk/api/graphql/classes/IotaGraphQLRequestError.md b/docs/content/ts-sdk/api/graphql/classes/IotaGraphQLRequestError.md deleted file mode 100644 index afb383fce34..00000000000 --- a/docs/content/ts-sdk/api/graphql/classes/IotaGraphQLRequestError.md +++ /dev/null @@ -1,139 +0,0 @@ -# Class: IotaGraphQLRequestError - -## Extends - -- `Error` - -## Constructors - -### new IotaGraphQLRequestError() - -> **new IotaGraphQLRequestError**(`message`?): [`IotaGraphQLRequestError`](IotaGraphQLRequestError.md) - -#### Parameters - -• **message?**: `string` - -#### Returns - -[`IotaGraphQLRequestError`](IotaGraphQLRequestError.md) - -#### Inherited from - -`Error.constructor` - -### new IotaGraphQLRequestError() - -> **new IotaGraphQLRequestError**(`message`?, `options`?): [`IotaGraphQLRequestError`](IotaGraphQLRequestError.md) - -#### Parameters - -• **message?**: `string` - -• **options?**: `ErrorOptions` - -#### Returns - -[`IotaGraphQLRequestError`](IotaGraphQLRequestError.md) - -#### Inherited from - -`Error.constructor` - -## Properties - -### prepareStackTrace()? - -> `static` `optional` **prepareStackTrace**: (`err`, `stackTraces`) => `any` - -Optional override for formatting stack traces - -#### Parameters - -• **err**: `Error` - -• **stackTraces**: `CallSite`[] - -#### Returns - -`any` - -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - -#### Inherited from - -`Error.prepareStackTrace` - ---- - -### stackTraceLimit - -> `static` **stackTraceLimit**: `number` - -#### Inherited from - -`Error.stackTraceLimit` - ---- - -### cause? - -> `optional` **cause**: `unknown` - -#### Inherited from - -`Error.cause` - ---- - -### name - -> **name**: `string` - -#### Inherited from - -`Error.name` - ---- - -### message - -> **message**: `string` - -#### Inherited from - -`Error.message` - ---- - -### stack? - -> `optional` **stack**: `string` - -#### Inherited from - -`Error.stack` - -## Methods - -### captureStackTrace() - -> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` - -Create .stack property on a target object - -#### Parameters - -• **targetObject**: `object` - -• **constructorOpt?**: `Function` - -#### Returns - -`void` - -#### Inherited from - -`Error.captureStackTrace` diff --git a/docs/content/ts-sdk/api/graphql/index.md b/docs/content/ts-sdk/api/graphql/index.md deleted file mode 100644 index c4718be8923..00000000000 --- a/docs/content/ts-sdk/api/graphql/index.md +++ /dev/null @@ -1,19 +0,0 @@ -# graphql - -## Index - -### Classes - -- [IotaGraphQLRequestError](classes/IotaGraphQLRequestError.md) -- [IotaGraphQLClient](classes/IotaGraphQLClient.md) - -### Interfaces - -- [IotaGraphQLClientOptions](interfaces/IotaGraphQLClientOptions.md) - -### Type Aliases - -- [GraphQLDocument](type-aliases/GraphQLDocument.md) -- [GraphQLQueryOptions](type-aliases/GraphQLQueryOptions.md) -- [GraphQLQueryResult](type-aliases/GraphQLQueryResult.md) -- [GraphQLResponseErrors](type-aliases/GraphQLResponseErrors.md) diff --git a/docs/content/ts-sdk/api/graphql/interfaces/IotaGraphQLClientOptions.md b/docs/content/ts-sdk/api/graphql/interfaces/IotaGraphQLClientOptions.md deleted file mode 100644 index 6d4cc827cf4..00000000000 --- a/docs/content/ts-sdk/api/graphql/interfaces/IotaGraphQLClientOptions.md +++ /dev/null @@ -1,51 +0,0 @@ -# Interface: IotaGraphQLClientOptions\ - -## Type Parameters - -• **Queries** _extends_ `Record`\<`string`, [`GraphQLDocument`](../type-aliases/GraphQLDocument.md)\> - -## Properties - -### url - -> **url**: `string` - ---- - -### fetch()? - -> `optional` **fetch**: (`input`, `init`?) => `Promise`\<`Response`\>(`input`, `init`?) => `Promise`\<`Response`\> - -[MDN Reference](https://developer.mozilla.org/docs/Web/API/fetch) - -#### Parameters - -• **input**: `URL` \| `RequestInfo` - -• **init?**: `RequestInit` - -#### Returns - -`Promise`\<`Response`\> - -#### Parameters - -• **input**: `string` \| `URL` \| `Request` - -• **init?**: `RequestInit` - -#### Returns - -`Promise`\<`Response`\> - ---- - -### headers? - -> `optional` **headers**: `Record`\<`string`, `string`\> - ---- - -### queries? - -> `optional` **queries**: `Queries` diff --git a/docs/content/ts-sdk/api/graphql/type-aliases/GraphQLDocument.md b/docs/content/ts-sdk/api/graphql/type-aliases/GraphQLDocument.md deleted file mode 100644 index 884c60bf206..00000000000 --- a/docs/content/ts-sdk/api/graphql/type-aliases/GraphQLDocument.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: GraphQLDocument\ - -> **GraphQLDocument**\<`Result`, `Variables`\>: `string` \| `DocumentNode` \| `TypedDocumentNode`\<`Result`, `Variables`\> \| `TadaDocumentNode`\<`Result`, `Variables`\> - -## Type Parameters - -• **Result** = `Record`\<`string`, `unknown`\> - -• **Variables** = `Record`\<`string`, `unknown`\> diff --git a/docs/content/ts-sdk/api/graphql/type-aliases/GraphQLQueryOptions.md b/docs/content/ts-sdk/api/graphql/type-aliases/GraphQLQueryOptions.md deleted file mode 100644 index 60ef82a0a74..00000000000 --- a/docs/content/ts-sdk/api/graphql/type-aliases/GraphQLQueryOptions.md +++ /dev/null @@ -1,23 +0,0 @@ -# Type Alias: GraphQLQueryOptions\ - -> **GraphQLQueryOptions**\<`Result`, `Variables`\>: `object` & `Variables` _extends_ `object` ? `object` : `object` - -## Type declaration - -### query - -> **query**: [`GraphQLDocument`](GraphQLDocument.md)\<`Result`, `Variables`\> - -### operationName? - -> `optional` **operationName**: `string` - -### extensions? - -> `optional` **extensions**: `Record`\<`string`, `unknown`\> - -## Type Parameters - -• **Result** = `Record`\<`string`, `unknown`\> - -• **Variables** = `Record`\<`string`, `unknown`\> diff --git a/docs/content/ts-sdk/api/graphql/type-aliases/GraphQLQueryResult.md b/docs/content/ts-sdk/api/graphql/type-aliases/GraphQLQueryResult.md deleted file mode 100644 index a515ef6abe6..00000000000 --- a/docs/content/ts-sdk/api/graphql/type-aliases/GraphQLQueryResult.md +++ /dev/null @@ -1,21 +0,0 @@ -# Type Alias: GraphQLQueryResult\ - -> **GraphQLQueryResult**\<`Result`\>: `object` - -## Type Parameters - -• **Result** = `Record`\<`string`, `unknown`\> - -## Type declaration - -### data? - -> `optional` **data**: `Result` - -### errors? - -> `optional` **errors**: [`GraphQLResponseErrors`](GraphQLResponseErrors.md) - -### extensions? - -> `optional` **extensions**: `Record`\<`string`, `unknown`\> diff --git a/docs/content/ts-sdk/api/graphql/type-aliases/GraphQLResponseErrors.md b/docs/content/ts-sdk/api/graphql/type-aliases/GraphQLResponseErrors.md deleted file mode 100644 index 1d285edae3f..00000000000 --- a/docs/content/ts-sdk/api/graphql/type-aliases/GraphQLResponseErrors.md +++ /dev/null @@ -1,3 +0,0 @@ -# Type Alias: GraphQLResponseErrors - -> **GraphQLResponseErrors**: `object`[] diff --git a/docs/content/ts-sdk/api/index.md b/docs/content/ts-sdk/api/index.md deleted file mode 100644 index 4ee3103cec3..00000000000 --- a/docs/content/ts-sdk/api/index.md +++ /dev/null @@ -1,16 +0,0 @@ -# @iota/iota-sdk - -## Modules - -- [bcs](bcs/index.md) -- [client](client/index.md) -- [cryptography](cryptography/index.md) -- [faucet](faucet/index.md) -- [graphql](graphql/index.md) -- [keypairs/ed25519](keypairs/ed25519/index.md) -- [keypairs/secp256k1](keypairs/secp256k1/index.md) -- [keypairs/secp256k1](keypairs/secp256k1/index.md) -- [multisig](multisig/index.md) -- [transactions](transactions/index.md) -- [utils](utils/index.md) -- [verify](verify/index.md) diff --git a/docs/content/ts-sdk/api/keypairs/ed25519/classes/Ed25519Keypair.md b/docs/content/ts-sdk/api/keypairs/ed25519/classes/Ed25519Keypair.md deleted file mode 100644 index eddf91bcedf..00000000000 --- a/docs/content/ts-sdk/api/keypairs/ed25519/classes/Ed25519Keypair.md +++ /dev/null @@ -1,266 +0,0 @@ -# Class: Ed25519Keypair - -An Ed25519 Keypair used for signing transactions. - -## Extends - -- [`Keypair`](../../../cryptography/classes/Keypair.md) - -## Constructors - -### new Ed25519Keypair() - -> **new Ed25519Keypair**(`keypair`?): [`Ed25519Keypair`](Ed25519Keypair.md) - -Create a new Ed25519 keypair instance. -Generate random keypair if no [Ed25519Keypair](Ed25519Keypair.md) is provided. - -#### Parameters - -• **keypair?**: [`Ed25519KeypairData`](../interfaces/Ed25519KeypairData.md) - -Ed25519 keypair - -#### Returns - -[`Ed25519Keypair`](Ed25519Keypair.md) - -#### Overrides - -[`Keypair`](../../../cryptography/classes/Keypair.md).[`constructor`](../../../cryptography/classes/Keypair.md#constructors) - -## Methods - -### signWithIntent() - -> **signWithIntent**(`bytes`, `intent`): `Promise`\<[`SignatureWithBytes`](../../../cryptography/interfaces/SignatureWithBytes.md)\> - -Sign messages with a specific intent. By combining the message bytes with the intent before hashing and signing, -it ensures that a signed message is tied to a specific purpose and domain separator is provided - -#### Parameters - -• **bytes**: `Uint8Array` - -• **intent**: [`IntentScope`](../../../cryptography/type-aliases/IntentScope.md) - -#### Returns - -`Promise`\<[`SignatureWithBytes`](../../../cryptography/interfaces/SignatureWithBytes.md)\> - -#### Inherited from - -[`Keypair`](../../../cryptography/classes/Keypair.md).[`signWithIntent`](../../../cryptography/classes/Keypair.md#signwithintent) - ---- - -### signTransaction() - -> **signTransaction**(`bytes`): `Promise`\<[`SignatureWithBytes`](../../../cryptography/interfaces/SignatureWithBytes.md)\> - -Signs provided transaction by calling `signWithIntent()` with a `TransactionData` provided as intent scope - -#### Parameters - -• **bytes**: `Uint8Array` - -#### Returns - -`Promise`\<[`SignatureWithBytes`](../../../cryptography/interfaces/SignatureWithBytes.md)\> - -#### Inherited from - -[`Keypair`](../../../cryptography/classes/Keypair.md).[`signTransaction`](../../../cryptography/classes/Keypair.md#signtransaction) - ---- - -### signPersonalMessage() - -> **signPersonalMessage**(`bytes`): `Promise`\<`object`\> - -Signs provided personal message by calling `signWithIntent()` with a `PersonalMessage` provided as intent scope - -#### Parameters - -• **bytes**: `Uint8Array` - -#### Returns - -`Promise`\<`object`\> - -##### bytes - -> **bytes**: `string` - -##### signature - -> **signature**: `string` - -#### Inherited from - -[`Keypair`](../../../cryptography/classes/Keypair.md).[`signPersonalMessage`](../../../cryptography/classes/Keypair.md#signpersonalmessage) - ---- - -### toIotaAddress() - -> **toIotaAddress**(): `string` - -#### Returns - -`string` - -#### Inherited from - -[`Keypair`](../../../cryptography/classes/Keypair.md).[`toIotaAddress`](../../../cryptography/classes/Keypair.md#toiotaaddress) - ---- - -### getKeyScheme() - -> **getKeyScheme**(): [`SignatureScheme`](../../../cryptography/type-aliases/SignatureScheme.md) - -Get the key scheme of the keypair ED25519 - -#### Returns - -[`SignatureScheme`](../../../cryptography/type-aliases/SignatureScheme.md) - -#### Overrides - -[`Keypair`](../../../cryptography/classes/Keypair.md).[`getKeyScheme`](../../../cryptography/classes/Keypair.md#getkeyscheme) - ---- - -### generate() - -> `static` **generate**(): [`Ed25519Keypair`](Ed25519Keypair.md) - -Generate a new random Ed25519 keypair - -#### Returns - -[`Ed25519Keypair`](Ed25519Keypair.md) - ---- - -### fromSecretKey() - -> `static` **fromSecretKey**(`secretKey`, `options`?): [`Ed25519Keypair`](Ed25519Keypair.md) - -Create a Ed25519 keypair from a raw secret key byte array, also known as seed. -This is NOT the private scalar which is result of hashing and bit clamping of -the raw secret key. - -#### Parameters - -• **secretKey**: `Uint8Array` - -secret key byte array - -• **options?** - -• **options.skipValidation?**: `boolean` - -#### Returns - -[`Ed25519Keypair`](Ed25519Keypair.md) - -#### Throws - -error if the provided secret key is invalid and validation is not skipped. - ---- - -### getPublicKey() - -> **getPublicKey**(): [`Ed25519PublicKey`](Ed25519PublicKey.md) - -The public key for this Ed25519 keypair - -#### Returns - -[`Ed25519PublicKey`](Ed25519PublicKey.md) - -#### Overrides - -[`Keypair`](../../../cryptography/classes/Keypair.md).[`getPublicKey`](../../../cryptography/classes/Keypair.md#getpublickey) - ---- - -### getSecretKey() - -> **getSecretKey**(): `string` - -The Bech32 secret key string for this Ed25519 keypair - -#### Returns - -`string` - -#### Overrides - -[`Keypair`](../../../cryptography/classes/Keypair.md).[`getSecretKey`](../../../cryptography/classes/Keypair.md#getsecretkey) - ---- - -### sign() - -> **sign**(`data`): `Promise`\<`Uint8Array`\> - -Return the signature for the provided data using Ed25519. - -#### Parameters - -• **data**: `Uint8Array` - -#### Returns - -`Promise`\<`Uint8Array`\> - -#### Overrides - -[`Keypair`](../../../cryptography/classes/Keypair.md).[`sign`](../../../cryptography/classes/Keypair.md#sign) - ---- - -### deriveKeypair() - -> `static` **deriveKeypair**(`mnemonics`, `path`?): [`Ed25519Keypair`](Ed25519Keypair.md) - -Derive Ed25519 keypair from mnemonics and path. The mnemonics must be normalized -and validated against the english wordlist. - -If path is none, it will default to m/44'/4218'/0'/0'/0', otherwise the path must -be compliant to SLIP-0010 in form m/44'/4218'/{account_index}'/{change_index}'/{address_index}'. - -#### Parameters - -• **mnemonics**: `string` - -• **path?**: `string` - -#### Returns - -[`Ed25519Keypair`](Ed25519Keypair.md) - ---- - -### deriveKeypairFromSeed() - -> `static` **deriveKeypairFromSeed**(`seedHex`, `path`?): [`Ed25519Keypair`](Ed25519Keypair.md) - -Derive Ed25519 keypair from mnemonicSeed and path. - -If path is none, it will default to m/44'/4218'/0'/0'/0', otherwise the path must -be compliant to SLIP-0010 in form m/44'/4218'/{account_index}'/{change_index}'/{address_index}'. - -#### Parameters - -• **seedHex**: `string` - -• **path?**: `string` - -#### Returns - -[`Ed25519Keypair`](Ed25519Keypair.md) diff --git a/docs/content/ts-sdk/api/keypairs/ed25519/classes/Ed25519PublicKey.md b/docs/content/ts-sdk/api/keypairs/ed25519/classes/Ed25519PublicKey.md deleted file mode 100644 index 01ad0dd18ab..00000000000 --- a/docs/content/ts-sdk/api/keypairs/ed25519/classes/Ed25519PublicKey.md +++ /dev/null @@ -1,274 +0,0 @@ -# Class: Ed25519PublicKey - -An Ed25519 public key - -## Extends - -- [`PublicKey`](../../../cryptography/classes/PublicKey.md) - -## Constructors - -### new Ed25519PublicKey() - -> **new Ed25519PublicKey**(`value`): [`Ed25519PublicKey`](Ed25519PublicKey.md) - -Create a new Ed25519PublicKey object - -#### Parameters - -• **value**: `PublicKeyInitData` - -ed25519 public key as buffer or base-64 encoded string - -#### Returns - -[`Ed25519PublicKey`](Ed25519PublicKey.md) - -#### Overrides - -[`PublicKey`](../../../cryptography/classes/PublicKey.md).[`constructor`](../../../cryptography/classes/PublicKey.md#constructors) - -## Properties - -### SIZE - -> `static` **SIZE**: `number` = `PUBLIC_KEY_SIZE` - -## Methods - -### toBase64() - -> **toBase64**(): `string` - -Return the base-64 representation of the public key - -#### Returns - -`string` - -#### Inherited from - -[`PublicKey`](../../../cryptography/classes/PublicKey.md).[`toBase64`](../../../cryptography/classes/PublicKey.md#tobase64) - ---- - -### toString() - -> **toString**(): `never` - -#### Returns - -`never` - -#### Inherited from - -[`PublicKey`](../../../cryptography/classes/PublicKey.md).[`toString`](../../../cryptography/classes/PublicKey.md#tostring) - ---- - -### toIotaPublicKey() - -> **toIotaPublicKey**(): `string` - -Return the IOTA representation of the public key encoded in -base-64. An IOTA public key is formed by the concatenation -of the scheme flag with the raw bytes of the public key - -#### Returns - -`string` - -#### Inherited from - -[`PublicKey`](../../../cryptography/classes/PublicKey.md).[`toIotaPublicKey`](../../../cryptography/classes/PublicKey.md#toiotapublickey) - ---- - -### verifyWithIntent() - -> **verifyWithIntent**(`bytes`, `signature`, `intent`): `Promise`\<`boolean`\> - -#### Parameters - -• **bytes**: `Uint8Array` - -• **signature**: `string` \| `Uint8Array` - -• **intent**: [`IntentScope`](../../../cryptography/type-aliases/IntentScope.md) - -#### Returns - -`Promise`\<`boolean`\> - -#### Inherited from - -[`PublicKey`](../../../cryptography/classes/PublicKey.md).[`verifyWithIntent`](../../../cryptography/classes/PublicKey.md#verifywithintent) - ---- - -### verifyPersonalMessage() - -> **verifyPersonalMessage**(`message`, `signature`): `Promise`\<`boolean`\> - -Verifies that the signature is valid for for the provided PersonalMessage - -#### Parameters - -• **message**: `Uint8Array` - -• **signature**: `string` \| `Uint8Array` - -#### Returns - -`Promise`\<`boolean`\> - -#### Inherited from - -[`PublicKey`](../../../cryptography/classes/PublicKey.md).[`verifyPersonalMessage`](../../../cryptography/classes/PublicKey.md#verifypersonalmessage) - ---- - -### verifyTransaction() - -> **verifyTransaction**(`transaction`, `signature`): `Promise`\<`boolean`\> - -Verifies that the signature is valid for for the provided Transaction - -#### Parameters - -• **transaction**: `Uint8Array` - -• **signature**: `string` \| `Uint8Array` - -#### Returns - -`Promise`\<`boolean`\> - -#### Inherited from - -[`PublicKey`](../../../cryptography/classes/PublicKey.md).[`verifyTransaction`](../../../cryptography/classes/PublicKey.md#verifytransaction) - ---- - -### toIotaBytes() - -> **toIotaBytes**(): `Uint8Array` - -Returns the bytes representation of the public key -prefixed with the signature scheme flag - -#### Returns - -`Uint8Array` - -#### Inherited from - -[`PublicKey`](../../../cryptography/classes/PublicKey.md).[`toIotaBytes`](../../../cryptography/classes/PublicKey.md#toiotabytes) - ---- - -### toIotaBytesForAddress() - -> **toIotaBytesForAddress**(): `Uint8Array` - -Returns the bytes representation of the public key -prefixed with the signature scheme flag. If the -signature scheme is ED25519, no prefix is set. - -#### Returns - -`Uint8Array` - -#### Inherited from - -[`PublicKey`](../../../cryptography/classes/PublicKey.md).[`toIotaBytesForAddress`](../../../cryptography/classes/PublicKey.md#toiotabytesforaddress) - ---- - -### toIotaAddress() - -> **toIotaAddress**(): `string` - -Return the IOTA address associated with this Ed25519 public key - -#### Returns - -`string` - -#### Inherited from - -[`PublicKey`](../../../cryptography/classes/PublicKey.md).[`toIotaAddress`](../../../cryptography/classes/PublicKey.md#toiotaaddress) - ---- - -### equals() - -> **equals**(`publicKey`): `boolean` - -Checks if two Ed25519 public keys are equal - -#### Parameters - -• **publicKey**: [`Ed25519PublicKey`](Ed25519PublicKey.md) - -#### Returns - -`boolean` - -#### Overrides - -[`PublicKey`](../../../cryptography/classes/PublicKey.md).[`equals`](../../../cryptography/classes/PublicKey.md#equals) - ---- - -### toRawBytes() - -> **toRawBytes**(): `Uint8Array` - -Return the byte array representation of the Ed25519 public key - -#### Returns - -`Uint8Array` - -#### Overrides - -[`PublicKey`](../../../cryptography/classes/PublicKey.md).[`toRawBytes`](../../../cryptography/classes/PublicKey.md#torawbytes) - ---- - -### flag() - -> **flag**(): `number` - -Return the IOTA address associated with this Ed25519 public key - -#### Returns - -`number` - -#### Overrides - -[`PublicKey`](../../../cryptography/classes/PublicKey.md).[`flag`](../../../cryptography/classes/PublicKey.md#flag) - ---- - -### verify() - -> **verify**(`message`, `signature`): `Promise`\<`boolean`\> - -Verifies that the signature is valid for for the provided message - -#### Parameters - -• **message**: `Uint8Array` - -• **signature**: `string` \| `Uint8Array` - -#### Returns - -`Promise`\<`boolean`\> - -#### Overrides - -[`PublicKey`](../../../cryptography/classes/PublicKey.md).[`verify`](../../../cryptography/classes/PublicKey.md#verify) diff --git a/docs/content/ts-sdk/api/keypairs/ed25519/index.md b/docs/content/ts-sdk/api/keypairs/ed25519/index.md deleted file mode 100644 index 0f255541112..00000000000 --- a/docs/content/ts-sdk/api/keypairs/ed25519/index.md +++ /dev/null @@ -1,16 +0,0 @@ -# keypairs/ed25519 - -## Index - -### Classes - -- [Ed25519Keypair](classes/Ed25519Keypair.md) -- [Ed25519PublicKey](classes/Ed25519PublicKey.md) - -### Interfaces - -- [Ed25519KeypairData](interfaces/Ed25519KeypairData.md) - -### Variables - -- [DEFAULT\_ED25519\_DERIVATION\_PATH](variables/DEFAULT_ED25519_DERIVATION_PATH.md) diff --git a/docs/content/ts-sdk/api/keypairs/ed25519/interfaces/Ed25519KeypairData.md b/docs/content/ts-sdk/api/keypairs/ed25519/interfaces/Ed25519KeypairData.md deleted file mode 100644 index 8a91d7a4c6a..00000000000 --- a/docs/content/ts-sdk/api/keypairs/ed25519/interfaces/Ed25519KeypairData.md +++ /dev/null @@ -1,17 +0,0 @@ -# Interface: Ed25519KeypairData - -Ed25519 Keypair data. The publickey is the 32-byte public key and -the secretkey is 64-byte, where the first 32 bytes is the secret -key and the last 32 bytes is the public key. - -## Properties - -### publicKey - -> **publicKey**: `Uint8Array` - ---- - -### secretKey - -> **secretKey**: `Uint8Array` diff --git a/docs/content/ts-sdk/api/keypairs/ed25519/variables/DEFAULT_ED25519_DERIVATION_PATH.md b/docs/content/ts-sdk/api/keypairs/ed25519/variables/DEFAULT_ED25519_DERIVATION_PATH.md deleted file mode 100644 index 73eccc6b64f..00000000000 --- a/docs/content/ts-sdk/api/keypairs/ed25519/variables/DEFAULT_ED25519_DERIVATION_PATH.md +++ /dev/null @@ -1,3 +0,0 @@ -# Variable: DEFAULT\_ED25519\_DERIVATION\_PATH - -> `const` **DEFAULT\_ED25519\_DERIVATION\_PATH**: `"m/44'/4218'/0'/0'/0'"` = `"m/44'/4218'/0'/0'/0'"` diff --git a/docs/content/ts-sdk/api/keypairs/secp256k1/classes/Secp256k1Keypair.md b/docs/content/ts-sdk/api/keypairs/secp256k1/classes/Secp256k1Keypair.md deleted file mode 100644 index ebf396ad00e..00000000000 --- a/docs/content/ts-sdk/api/keypairs/secp256k1/classes/Secp256k1Keypair.md +++ /dev/null @@ -1,265 +0,0 @@ -# Class: Secp256k1Keypair - -An Secp256k1 Keypair used for signing transactions. - -## Extends - -- [`Keypair`](../../../cryptography/classes/Keypair.md) - -## Constructors - -### new Secp256k1Keypair() - -> **new Secp256k1Keypair**(`keypair`?): [`Secp256k1Keypair`](Secp256k1Keypair.md) - -Create a new keypair instance. -Generate random keypair if no [Secp256k1Keypair](Secp256k1Keypair.md) is provided. - -#### Parameters - -• **keypair?**: [`Secp256k1KeypairData`](../interfaces/Secp256k1KeypairData.md) - -secp256k1 keypair - -#### Returns - -[`Secp256k1Keypair`](Secp256k1Keypair.md) - -#### Overrides - -[`Keypair`](../../../cryptography/classes/Keypair.md).[`constructor`](../../../cryptography/classes/Keypair.md#constructors) - -## Methods - -### signWithIntent() - -> **signWithIntent**(`bytes`, `intent`): `Promise`\<[`SignatureWithBytes`](../../../cryptography/interfaces/SignatureWithBytes.md)\> - -Sign messages with a specific intent. By combining the message bytes with the intent before hashing and signing, -it ensures that a signed message is tied to a specific purpose and domain separator is provided - -#### Parameters - -• **bytes**: `Uint8Array` - -• **intent**: [`IntentScope`](../../../cryptography/type-aliases/IntentScope.md) - -#### Returns - -`Promise`\<[`SignatureWithBytes`](../../../cryptography/interfaces/SignatureWithBytes.md)\> - -#### Inherited from - -[`Keypair`](../../../cryptography/classes/Keypair.md).[`signWithIntent`](../../../cryptography/classes/Keypair.md#signwithintent) - ---- - -### signTransaction() - -> **signTransaction**(`bytes`): `Promise`\<[`SignatureWithBytes`](../../../cryptography/interfaces/SignatureWithBytes.md)\> - -Signs provided transaction by calling `signWithIntent()` with a `TransactionData` provided as intent scope - -#### Parameters - -• **bytes**: `Uint8Array` - -#### Returns - -`Promise`\<[`SignatureWithBytes`](../../../cryptography/interfaces/SignatureWithBytes.md)\> - -#### Inherited from - -[`Keypair`](../../../cryptography/classes/Keypair.md).[`signTransaction`](../../../cryptography/classes/Keypair.md#signtransaction) - ---- - -### signPersonalMessage() - -> **signPersonalMessage**(`bytes`): `Promise`\<`object`\> - -Signs provided personal message by calling `signWithIntent()` with a `PersonalMessage` provided as intent scope - -#### Parameters - -• **bytes**: `Uint8Array` - -#### Returns - -`Promise`\<`object`\> - -##### bytes - -> **bytes**: `string` - -##### signature - -> **signature**: `string` - -#### Inherited from - -[`Keypair`](../../../cryptography/classes/Keypair.md).[`signPersonalMessage`](../../../cryptography/classes/Keypair.md#signpersonalmessage) - ---- - -### toIotaAddress() - -> **toIotaAddress**(): `string` - -#### Returns - -`string` - -#### Inherited from - -[`Keypair`](../../../cryptography/classes/Keypair.md).[`toIotaAddress`](../../../cryptography/classes/Keypair.md#toiotaaddress) - ---- - -### getKeyScheme() - -> **getKeyScheme**(): [`SignatureScheme`](../../../cryptography/type-aliases/SignatureScheme.md) - -Get the key scheme of the keypair Secp256k1 - -#### Returns - -[`SignatureScheme`](../../../cryptography/type-aliases/SignatureScheme.md) - -#### Overrides - -[`Keypair`](../../../cryptography/classes/Keypair.md).[`getKeyScheme`](../../../cryptography/classes/Keypair.md#getkeyscheme) - ---- - -### generate() - -> `static` **generate**(): [`Secp256k1Keypair`](Secp256k1Keypair.md) - -Generate a new random keypair - -#### Returns - -[`Secp256k1Keypair`](Secp256k1Keypair.md) - ---- - -### fromSecretKey() - -> `static` **fromSecretKey**(`secretKey`, `options`?): [`Secp256k1Keypair`](Secp256k1Keypair.md) - -Create a keypair from a raw secret key byte array. - -This method should only be used to recreate a keypair from a previously -generated secret key. Generating keypairs from a random seed should be done -with the Keypair.fromSeed method. - -#### Parameters - -• **secretKey**: `Uint8Array` - -secret key byte array - -• **options?** - -• **options.skipValidation?**: `boolean` - -#### Returns - -[`Secp256k1Keypair`](Secp256k1Keypair.md) - -#### Throws - -error if the provided secret key is invalid and validation is not skipped. - ---- - -### fromSeed() - -> `static` **fromSeed**(`seed`): [`Secp256k1Keypair`](Secp256k1Keypair.md) - -Generate a keypair from a 32 byte seed. - -#### Parameters - -• **seed**: `Uint8Array` - -seed byte array - -#### Returns - -[`Secp256k1Keypair`](Secp256k1Keypair.md) - ---- - -### getPublicKey() - -> **getPublicKey**(): [`PublicKey`](../../../cryptography/classes/PublicKey.md) - -The public key for this keypair - -#### Returns - -[`PublicKey`](../../../cryptography/classes/PublicKey.md) - -#### Overrides - -[`Keypair`](../../../cryptography/classes/Keypair.md).[`getPublicKey`](../../../cryptography/classes/Keypair.md#getpublickey) - ---- - -### getSecretKey() - -> **getSecretKey**(): `string` - -The Bech32 secret key string for this Secp256k1 keypair - -#### Returns - -`string` - -#### Overrides - -[`Keypair`](../../../cryptography/classes/Keypair.md).[`getSecretKey`](../../../cryptography/classes/Keypair.md#getsecretkey) - ---- - -### sign() - -> **sign**(`data`): `Promise`\<`Uint8Array`\> - -Return the signature for the provided data. - -#### Parameters - -• **data**: `Uint8Array` - -#### Returns - -`Promise`\<`Uint8Array`\> - -#### Overrides - -[`Keypair`](../../../cryptography/classes/Keypair.md).[`sign`](../../../cryptography/classes/Keypair.md#sign) - ---- - -### deriveKeypair() - -> `static` **deriveKeypair**(`mnemonics`, `path`?): [`Secp256k1Keypair`](Secp256k1Keypair.md) - -Derive Secp256k1 keypair from mnemonics and path. The mnemonics must be normalized -and validated against the english wordlist. - -If path is none, it will default to m/54'/4218'/0'/0/0, otherwise the path must -be compliant to BIP-32 in form m/54'/4218'/{account_index}'/{change_index}/{address_index}. - -#### Parameters - -• **mnemonics**: `string` - -• **path?**: `string` - -#### Returns - -[`Secp256k1Keypair`](Secp256k1Keypair.md) diff --git a/docs/content/ts-sdk/api/keypairs/secp256k1/classes/Secp256k1PublicKey.md b/docs/content/ts-sdk/api/keypairs/secp256k1/classes/Secp256k1PublicKey.md deleted file mode 100644 index 0d446b57fa8..00000000000 --- a/docs/content/ts-sdk/api/keypairs/secp256k1/classes/Secp256k1PublicKey.md +++ /dev/null @@ -1,274 +0,0 @@ -# Class: Secp256k1PublicKey - -A Secp256k1 public key - -## Extends - -- [`PublicKey`](../../../cryptography/classes/PublicKey.md) - -## Constructors - -### new Secp256k1PublicKey() - -> **new Secp256k1PublicKey**(`value`): [`Secp256k1PublicKey`](Secp256k1PublicKey.md) - -Create a new Secp256k1PublicKey object - -#### Parameters - -• **value**: `PublicKeyInitData` - -secp256k1 public key as buffer or base-64 encoded string - -#### Returns - -[`Secp256k1PublicKey`](Secp256k1PublicKey.md) - -#### Overrides - -[`PublicKey`](../../../cryptography/classes/PublicKey.md).[`constructor`](../../../cryptography/classes/PublicKey.md#constructors) - -## Properties - -### SIZE - -> `static` **SIZE**: `number` = `SECP256K1_PUBLIC_KEY_SIZE` - -## Methods - -### toBase64() - -> **toBase64**(): `string` - -Return the base-64 representation of the public key - -#### Returns - -`string` - -#### Inherited from - -[`PublicKey`](../../../cryptography/classes/PublicKey.md).[`toBase64`](../../../cryptography/classes/PublicKey.md#tobase64) - ---- - -### toString() - -> **toString**(): `never` - -#### Returns - -`never` - -#### Inherited from - -[`PublicKey`](../../../cryptography/classes/PublicKey.md).[`toString`](../../../cryptography/classes/PublicKey.md#tostring) - ---- - -### toIotaPublicKey() - -> **toIotaPublicKey**(): `string` - -Return the IOTA representation of the public key encoded in -base-64. An IOTA public key is formed by the concatenation -of the scheme flag with the raw bytes of the public key - -#### Returns - -`string` - -#### Inherited from - -[`PublicKey`](../../../cryptography/classes/PublicKey.md).[`toIotaPublicKey`](../../../cryptography/classes/PublicKey.md#toiotapublickey) - ---- - -### verifyWithIntent() - -> **verifyWithIntent**(`bytes`, `signature`, `intent`): `Promise`\<`boolean`\> - -#### Parameters - -• **bytes**: `Uint8Array` - -• **signature**: `string` \| `Uint8Array` - -• **intent**: [`IntentScope`](../../../cryptography/type-aliases/IntentScope.md) - -#### Returns - -`Promise`\<`boolean`\> - -#### Inherited from - -[`PublicKey`](../../../cryptography/classes/PublicKey.md).[`verifyWithIntent`](../../../cryptography/classes/PublicKey.md#verifywithintent) - ---- - -### verifyPersonalMessage() - -> **verifyPersonalMessage**(`message`, `signature`): `Promise`\<`boolean`\> - -Verifies that the signature is valid for for the provided PersonalMessage - -#### Parameters - -• **message**: `Uint8Array` - -• **signature**: `string` \| `Uint8Array` - -#### Returns - -`Promise`\<`boolean`\> - -#### Inherited from - -[`PublicKey`](../../../cryptography/classes/PublicKey.md).[`verifyPersonalMessage`](../../../cryptography/classes/PublicKey.md#verifypersonalmessage) - ---- - -### verifyTransaction() - -> **verifyTransaction**(`transaction`, `signature`): `Promise`\<`boolean`\> - -Verifies that the signature is valid for for the provided Transaction - -#### Parameters - -• **transaction**: `Uint8Array` - -• **signature**: `string` \| `Uint8Array` - -#### Returns - -`Promise`\<`boolean`\> - -#### Inherited from - -[`PublicKey`](../../../cryptography/classes/PublicKey.md).[`verifyTransaction`](../../../cryptography/classes/PublicKey.md#verifytransaction) - ---- - -### toIotaBytes() - -> **toIotaBytes**(): `Uint8Array` - -Returns the bytes representation of the public key -prefixed with the signature scheme flag - -#### Returns - -`Uint8Array` - -#### Inherited from - -[`PublicKey`](../../../cryptography/classes/PublicKey.md).[`toIotaBytes`](../../../cryptography/classes/PublicKey.md#toiotabytes) - ---- - -### toIotaBytesForAddress() - -> **toIotaBytesForAddress**(): `Uint8Array` - -Returns the bytes representation of the public key -prefixed with the signature scheme flag. If the -signature scheme is ED25519, no prefix is set. - -#### Returns - -`Uint8Array` - -#### Inherited from - -[`PublicKey`](../../../cryptography/classes/PublicKey.md).[`toIotaBytesForAddress`](../../../cryptography/classes/PublicKey.md#toiotabytesforaddress) - ---- - -### toIotaAddress() - -> **toIotaAddress**(): `string` - -Return the IOTA address associated with this Ed25519 public key - -#### Returns - -`string` - -#### Inherited from - -[`PublicKey`](../../../cryptography/classes/PublicKey.md).[`toIotaAddress`](../../../cryptography/classes/PublicKey.md#toiotaaddress) - ---- - -### equals() - -> **equals**(`publicKey`): `boolean` - -Checks if two Secp256k1 public keys are equal - -#### Parameters - -• **publicKey**: [`Secp256k1PublicKey`](Secp256k1PublicKey.md) - -#### Returns - -`boolean` - -#### Overrides - -[`PublicKey`](../../../cryptography/classes/PublicKey.md).[`equals`](../../../cryptography/classes/PublicKey.md#equals) - ---- - -### toRawBytes() - -> **toRawBytes**(): `Uint8Array` - -Return the byte array representation of the Secp256k1 public key - -#### Returns - -`Uint8Array` - -#### Overrides - -[`PublicKey`](../../../cryptography/classes/PublicKey.md).[`toRawBytes`](../../../cryptography/classes/PublicKey.md#torawbytes) - ---- - -### flag() - -> **flag**(): `number` - -Return the IOTA address associated with this Secp256k1 public key - -#### Returns - -`number` - -#### Overrides - -[`PublicKey`](../../../cryptography/classes/PublicKey.md).[`flag`](../../../cryptography/classes/PublicKey.md#flag) - ---- - -### verify() - -> **verify**(`message`, `signature`): `Promise`\<`boolean`\> - -Verifies that the signature is valid for for the provided message - -#### Parameters - -• **message**: `Uint8Array` - -• **signature**: `string` \| `Uint8Array` - -#### Returns - -`Promise`\<`boolean`\> - -#### Overrides - -[`PublicKey`](../../../cryptography/classes/PublicKey.md).[`verify`](../../../cryptography/classes/PublicKey.md#verify) diff --git a/docs/content/ts-sdk/api/keypairs/secp256k1/index.md b/docs/content/ts-sdk/api/keypairs/secp256k1/index.md deleted file mode 100644 index 128c2524bf9..00000000000 --- a/docs/content/ts-sdk/api/keypairs/secp256k1/index.md +++ /dev/null @@ -1,25 +0,0 @@ -# keypairs/secp256k1 - -## References - -### DEFAULT\_SECP256K1\_DERIVATION\_PATH - -Re-exports [DEFAULT_SECP256K1_DERIVATION_PATH](variables/DEFAULT_SECP256K1_DERIVATION_PATH.md) - ---- - -### Secp256k1Keypair - -Re-exports [Secp256k1Keypair](classes/Secp256k1Keypair.md) - ---- - -### Secp256k1KeypairData - -Re-exports [Secp256k1KeypairData](interfaces/Secp256k1KeypairData.md) - ---- - -### Secp256k1PublicKey - -Re-exports [Secp256k1PublicKey](classes/Secp256k1PublicKey.md) diff --git a/docs/content/ts-sdk/api/keypairs/secp256k1/interfaces/Secp256k1KeypairData.md b/docs/content/ts-sdk/api/keypairs/secp256k1/interfaces/Secp256k1KeypairData.md deleted file mode 100644 index 15128be2f2a..00000000000 --- a/docs/content/ts-sdk/api/keypairs/secp256k1/interfaces/Secp256k1KeypairData.md +++ /dev/null @@ -1,15 +0,0 @@ -# Interface: Secp256k1KeypairData - -Secp256k1 Keypair data - -## Properties - -### publicKey - -> **publicKey**: `Uint8Array` - ---- - -### secretKey - -> **secretKey**: `Uint8Array` diff --git a/docs/content/ts-sdk/api/keypairs/secp256k1/variables/DEFAULT_SECP256K1_DERIVATION_PATH.md b/docs/content/ts-sdk/api/keypairs/secp256k1/variables/DEFAULT_SECP256K1_DERIVATION_PATH.md deleted file mode 100644 index 27f35eea3ab..00000000000 --- a/docs/content/ts-sdk/api/keypairs/secp256k1/variables/DEFAULT_SECP256K1_DERIVATION_PATH.md +++ /dev/null @@ -1,3 +0,0 @@ -# Variable: DEFAULT\_SECP256K1\_DERIVATION\_PATH - -> `const` **DEFAULT\_SECP256K1\_DERIVATION\_PATH**: `"m/54'/4218'/0'/0/0"` = `"m/54'/4218'/0'/0/0"` diff --git a/docs/content/ts-sdk/api/multisig/classes/MultiSigPublicKey.md b/docs/content/ts-sdk/api/multisig/classes/MultiSigPublicKey.md deleted file mode 100644 index 0428fb1aa22..00000000000 --- a/docs/content/ts-sdk/api/multisig/classes/MultiSigPublicKey.md +++ /dev/null @@ -1,339 +0,0 @@ -# Class: MultiSigPublicKey - -A MultiSig public key - -## Extends - -- [`PublicKey`](../../cryptography/classes/PublicKey.md) - -## Constructors - -### new MultiSigPublicKey() - -> **new MultiSigPublicKey**(`value`): [`MultiSigPublicKey`](MultiSigPublicKey.md) - -Create a new MultiSigPublicKey object - -#### Parameters - -• **value**: `string` \| `Uint8Array` \| `MultiSigPublicKeyStruct` - -MultiSig public key as buffer or base-64 encoded string - -#### Returns - -[`MultiSigPublicKey`](MultiSigPublicKey.md) - -#### Overrides - -[`PublicKey`](../../cryptography/classes/PublicKey.md).[`constructor`](../../cryptography/classes/PublicKey.md#constructors) - -## Methods - -### toBase64() - -> **toBase64**(): `string` - -Return the base-64 representation of the public key - -#### Returns - -`string` - -#### Inherited from - -[`PublicKey`](../../cryptography/classes/PublicKey.md).[`toBase64`](../../cryptography/classes/PublicKey.md#tobase64) - ---- - -### toString() - -> **toString**(): `never` - -#### Returns - -`never` - -#### Inherited from - -[`PublicKey`](../../cryptography/classes/PublicKey.md).[`toString`](../../cryptography/classes/PublicKey.md#tostring) - ---- - -### toIotaPublicKey() - -> **toIotaPublicKey**(): `string` - -Return the IOTA representation of the public key encoded in -base-64. An IOTA public key is formed by the concatenation -of the scheme flag with the raw bytes of the public key - -#### Returns - -`string` - -#### Inherited from - -[`PublicKey`](../../cryptography/classes/PublicKey.md).[`toIotaPublicKey`](../../cryptography/classes/PublicKey.md#toiotapublickey) - ---- - -### verifyWithIntent() - -> **verifyWithIntent**(`bytes`, `signature`, `intent`): `Promise`\<`boolean`\> - -#### Parameters - -• **bytes**: `Uint8Array` - -• **signature**: `string` \| `Uint8Array` - -• **intent**: [`IntentScope`](../../cryptography/type-aliases/IntentScope.md) - -#### Returns - -`Promise`\<`boolean`\> - -#### Inherited from - -[`PublicKey`](../../cryptography/classes/PublicKey.md).[`verifyWithIntent`](../../cryptography/classes/PublicKey.md#verifywithintent) - ---- - -### verifyPersonalMessage() - -> **verifyPersonalMessage**(`message`, `signature`): `Promise`\<`boolean`\> - -Verifies that the signature is valid for for the provided PersonalMessage - -#### Parameters - -• **message**: `Uint8Array` - -• **signature**: `string` \| `Uint8Array` - -#### Returns - -`Promise`\<`boolean`\> - -#### Inherited from - -[`PublicKey`](../../cryptography/classes/PublicKey.md).[`verifyPersonalMessage`](../../cryptography/classes/PublicKey.md#verifypersonalmessage) - ---- - -### verifyTransaction() - -> **verifyTransaction**(`transaction`, `signature`): `Promise`\<`boolean`\> - -Verifies that the signature is valid for for the provided Transaction - -#### Parameters - -• **transaction**: `Uint8Array` - -• **signature**: `string` \| `Uint8Array` - -#### Returns - -`Promise`\<`boolean`\> - -#### Inherited from - -[`PublicKey`](../../cryptography/classes/PublicKey.md).[`verifyTransaction`](../../cryptography/classes/PublicKey.md#verifytransaction) - ---- - -### toIotaBytes() - -> **toIotaBytes**(): `Uint8Array` - -Returns the bytes representation of the public key -prefixed with the signature scheme flag - -#### Returns - -`Uint8Array` - -#### Inherited from - -[`PublicKey`](../../cryptography/classes/PublicKey.md).[`toIotaBytes`](../../cryptography/classes/PublicKey.md#toiotabytes) - ---- - -### toIotaBytesForAddress() - -> **toIotaBytesForAddress**(): `Uint8Array` - -Returns the bytes representation of the public key -prefixed with the signature scheme flag. If the -signature scheme is ED25519, no prefix is set. - -#### Returns - -`Uint8Array` - -#### Inherited from - -[`PublicKey`](../../cryptography/classes/PublicKey.md).[`toIotaBytesForAddress`](../../cryptography/classes/PublicKey.md#toiotabytesforaddress) - ---- - -### fromPublicKeys() - -> `static` **fromPublicKeys**(`__namedParameters`): [`MultiSigPublicKey`](MultiSigPublicKey.md) - -A static method to create a new MultiSig publickey instance from a set of public keys and their associated weights pairs and threshold. - -#### Parameters - -• **\_\_namedParameters** - -• **\_\_namedParameters.threshold**: `number` - -• **\_\_namedParameters.publicKeys**: `object`[] - -#### Returns - -[`MultiSigPublicKey`](MultiSigPublicKey.md) - ---- - -### equals() - -> **equals**(`publicKey`): `boolean` - -Checks if two MultiSig public keys are equal - -#### Parameters - -• **publicKey**: [`MultiSigPublicKey`](MultiSigPublicKey.md) - -#### Returns - -`boolean` - -#### Overrides - -[`PublicKey`](../../cryptography/classes/PublicKey.md).[`equals`](../../cryptography/classes/PublicKey.md#equals) - ---- - -### toRawBytes() - -> **toRawBytes**(): `Uint8Array` - -Return the byte array representation of the MultiSig public key - -#### Returns - -`Uint8Array` - -#### Overrides - -[`PublicKey`](../../cryptography/classes/PublicKey.md).[`toRawBytes`](../../cryptography/classes/PublicKey.md#torawbytes) - ---- - -### getPublicKeys() - -> **getPublicKeys**(): `object`[] - -#### Returns - -`object`[] - ---- - -### getThreshold() - -> **getThreshold**(): `number` - -#### Returns - -`number` - ---- - -### getSigner() - -> **getSigner**(...`signers`): [`MultiSigSigner`](MultiSigSigner.md) - -#### Parameters - -• ...**signers**: [[`Signer`](../../cryptography/classes/Signer.md)] - -#### Returns - -[`MultiSigSigner`](MultiSigSigner.md) - ---- - -### toIotaAddress() - -> **toIotaAddress**(): `string` - -Return the IOTA address associated with this MultiSig public key - -#### Returns - -`string` - -#### Overrides - -[`PublicKey`](../../cryptography/classes/PublicKey.md).[`toIotaAddress`](../../cryptography/classes/PublicKey.md#toiotaaddress) - ---- - -### flag() - -> **flag**(): `number` - -Return the IOTA address associated with this MultiSig public key - -#### Returns - -`number` - -#### Overrides - -[`PublicKey`](../../cryptography/classes/PublicKey.md).[`flag`](../../cryptography/classes/PublicKey.md#flag) - ---- - -### verify() - -> **verify**(`message`, `multisigSignature`): `Promise`\<`boolean`\> - -Verifies that the signature is valid for for the provided message - -#### Parameters - -• **message**: `Uint8Array` - -• **multisigSignature**: `string` - -#### Returns - -`Promise`\<`boolean`\> - -#### Overrides - -[`PublicKey`](../../cryptography/classes/PublicKey.md).[`verify`](../../cryptography/classes/PublicKey.md#verify) - ---- - -### combinePartialSignatures() - -> **combinePartialSignatures**(`signatures`): `string` - -Combines multiple partial signatures into a single multisig, ensuring that each public key signs only once -and that all the public keys involved are known and valid, and then serializes multisig into the standard format - -#### Parameters - -• **signatures**: `string`[] - -#### Returns - -`string` diff --git a/docs/content/ts-sdk/api/multisig/classes/MultiSigSigner.md b/docs/content/ts-sdk/api/multisig/classes/MultiSigSigner.md deleted file mode 100644 index fa42201acbd..00000000000 --- a/docs/content/ts-sdk/api/multisig/classes/MultiSigSigner.md +++ /dev/null @@ -1,184 +0,0 @@ -# Class: MultiSigSigner - -TODO: Document - -## Extends - -- [`Signer`](../../cryptography/classes/Signer.md) - -## Constructors - -### new MultiSigSigner() - -> **new MultiSigSigner**(`pubkey`, `signers`): [`MultiSigSigner`](MultiSigSigner.md) - -#### Parameters - -• **pubkey**: [`MultiSigPublicKey`](MultiSigPublicKey.md) - -• **signers**: [`Signer`](../../cryptography/classes/Signer.md)[] = `[]` - -#### Returns - -[`MultiSigSigner`](MultiSigSigner.md) - -#### Overrides - -[`Signer`](../../cryptography/classes/Signer.md).[`constructor`](../../cryptography/classes/Signer.md#constructors) - -## Methods - -### signWithIntent() - -> **signWithIntent**(`bytes`, `intent`): `Promise`\<[`SignatureWithBytes`](../../cryptography/interfaces/SignatureWithBytes.md)\> - -Sign messages with a specific intent. By combining the message bytes with the intent before hashing and signing, -it ensures that a signed message is tied to a specific purpose and domain separator is provided - -#### Parameters - -• **bytes**: `Uint8Array` - -• **intent**: [`IntentScope`](../../cryptography/type-aliases/IntentScope.md) - -#### Returns - -`Promise`\<[`SignatureWithBytes`](../../cryptography/interfaces/SignatureWithBytes.md)\> - -#### Inherited from - -[`Signer`](../../cryptography/classes/Signer.md).[`signWithIntent`](../../cryptography/classes/Signer.md#signwithintent) - ---- - -### toIotaAddress() - -> **toIotaAddress**(): `string` - -#### Returns - -`string` - -#### Inherited from - -[`Signer`](../../cryptography/classes/Signer.md).[`toIotaAddress`](../../cryptography/classes/Signer.md#toiotaaddress) - ---- - -### getKeyScheme() - -> **getKeyScheme**(): [`SignatureScheme`](../../cryptography/type-aliases/SignatureScheme.md) - -Get the key scheme of the keypair: Secp256k1 or ED25519 - -#### Returns - -[`SignatureScheme`](../../cryptography/type-aliases/SignatureScheme.md) - -#### Overrides - -[`Signer`](../../cryptography/classes/Signer.md).[`getKeyScheme`](../../cryptography/classes/Signer.md#getkeyscheme) - ---- - -### getPublicKey() - -> **getPublicKey**(): [`MultiSigPublicKey`](MultiSigPublicKey.md) - -The public key for this keypair - -#### Returns - -[`MultiSigPublicKey`](MultiSigPublicKey.md) - -#### Overrides - -[`Signer`](../../cryptography/classes/Signer.md).[`getPublicKey`](../../cryptography/classes/Signer.md#getpublickey) - ---- - -### sign() - -> **sign**(`_data`): `never` - -#### Parameters - -• **\_data**: `Uint8Array` - -#### Returns - -`never` - -#### Overrides - -[`Signer`](../../cryptography/classes/Signer.md).[`sign`](../../cryptography/classes/Signer.md#sign) - ---- - -### signData() - -> **signData**(`_data`): `never` - -#### Parameters - -• **\_data**: `Uint8Array` - -#### Returns - -`never` - ---- - -### signTransaction() - -> **signTransaction**(`bytes`): `Promise`\<`object`\> - -Signs provided transaction by calling `signWithIntent()` with a `TransactionData` provided as intent scope - -#### Parameters - -• **bytes**: `Uint8Array` - -#### Returns - -`Promise`\<`object`\> - -##### signature - -> **signature**: `string` - -##### bytes - -> **bytes**: `string` - -#### Overrides - -[`Signer`](../../cryptography/classes/Signer.md).[`signTransaction`](../../cryptography/classes/Signer.md#signtransaction) - ---- - -### signPersonalMessage() - -> **signPersonalMessage**(`bytes`): `Promise`\<`object`\> - -Signs provided personal message by calling `signWithIntent()` with a `PersonalMessage` provided as intent scope - -#### Parameters - -• **bytes**: `Uint8Array` - -#### Returns - -`Promise`\<`object`\> - -##### signature - -> **signature**: `string` - -##### bytes - -> **bytes**: `string` - -#### Overrides - -[`Signer`](../../cryptography/classes/Signer.md).[`signPersonalMessage`](../../cryptography/classes/Signer.md#signpersonalmessage) diff --git a/docs/content/ts-sdk/api/multisig/functions/parsePartialSignatures.md b/docs/content/ts-sdk/api/multisig/functions/parsePartialSignatures.md deleted file mode 100644 index c8da186fa70..00000000000 --- a/docs/content/ts-sdk/api/multisig/functions/parsePartialSignatures.md +++ /dev/null @@ -1,13 +0,0 @@ -# Function: parsePartialSignatures() - -> **parsePartialSignatures**(`multisig`): `ParsedPartialMultiSigSignature`[] - -Parse multisig structure into an array of individual signatures: signature scheme, the actual individual signature, public key and its weight. - -## Parameters - -• **multisig**: [`MultiSigStruct`](../type-aliases/MultiSigStruct.md) - -## Returns - -`ParsedPartialMultiSigSignature`[] diff --git a/docs/content/ts-sdk/api/multisig/index.md b/docs/content/ts-sdk/api/multisig/index.md deleted file mode 100644 index 2d1327238f1..00000000000 --- a/docs/content/ts-sdk/api/multisig/index.md +++ /dev/null @@ -1,16 +0,0 @@ -# multisig - -## Index - -### Classes - -- [MultiSigPublicKey](classes/MultiSigPublicKey.md) -- [MultiSigSigner](classes/MultiSigSigner.md) - -### Type Aliases - -- [MultiSigStruct](type-aliases/MultiSigStruct.md) - -### Functions - -- [parsePartialSignatures](functions/parsePartialSignatures.md) diff --git a/docs/content/ts-sdk/api/multisig/type-aliases/MultiSigStruct.md b/docs/content/ts-sdk/api/multisig/type-aliases/MultiSigStruct.md deleted file mode 100644 index 0f9e0237dd2..00000000000 --- a/docs/content/ts-sdk/api/multisig/type-aliases/MultiSigStruct.md +++ /dev/null @@ -1,17 +0,0 @@ -# Type Alias: MultiSigStruct - -> **MultiSigStruct**: `object` - -## Type declaration - -### sigs - -> **sigs**: `CompressedSignature`[] - -### bitmap - -> **bitmap**: `number` - -### multisig\_pk - -> **multisig\_pk**: `MultiSigPublicKeyStruct` diff --git a/docs/content/ts-sdk/api/transactions/classes/AsyncCache.md b/docs/content/ts-sdk/api/transactions/classes/AsyncCache.md deleted file mode 100644 index 36be0086784..00000000000 --- a/docs/content/ts-sdk/api/transactions/classes/AsyncCache.md +++ /dev/null @@ -1,297 +0,0 @@ -# Class: `abstract` AsyncCache - -## Constructors - -### new AsyncCache() - -> **new AsyncCache**(): [`AsyncCache`](AsyncCache.md) - -#### Returns - -[`AsyncCache`](AsyncCache.md) - -## Methods - -### get() - -> `abstract` `protected` **get**\<`T`\>(`type`, `key`): `Promise`\<`null` \| `CacheEntryTypes`\[`T`\]\> - -#### Type Parameters - -• **T** _extends_ keyof `CacheEntryTypes` - -#### Parameters - -• **type**: `T` - -• **key**: `string` - -#### Returns - -`Promise`\<`null` \| `CacheEntryTypes`\[`T`\]\> - ---- - -### set() - -> `abstract` `protected` **set**\<`T`\>(`type`, `key`, `value`): `Promise`\<`void`\> - -#### Type Parameters - -• **T** _extends_ keyof `CacheEntryTypes` - -#### Parameters - -• **type**: `T` - -• **key**: `string` - -• **value**: `CacheEntryTypes`\[`T`\] - -#### Returns - -`Promise`\<`void`\> - ---- - -### delete() - -> `abstract` `protected` **delete**\<`T`\>(`type`, `key`): `Promise`\<`void`\> - -#### Type Parameters - -• **T** _extends_ keyof `CacheEntryTypes` - -#### Parameters - -• **type**: `T` - -• **key**: `string` - -#### Returns - -`Promise`\<`void`\> - ---- - -### clear() - -> `abstract` **clear**\<`T`\>(`type`?): `Promise`\<`void`\> - -#### Type Parameters - -• **T** _extends_ keyof `CacheEntryTypes` - -#### Parameters - -• **type?**: `T` - -#### Returns - -`Promise`\<`void`\> - ---- - -### getObject() - -> **getObject**(`id`): `Promise`\<`null` \| `ObjectCacheEntry`\> - -#### Parameters - -• **id**: `string` - -#### Returns - -`Promise`\<`null` \| `ObjectCacheEntry`\> - ---- - -### getObjects() - -> **getObjects**(`ids`): `Promise`\<(`null` \| `ObjectCacheEntry`)[]\> - -#### Parameters - -• **ids**: `string`[] - -#### Returns - -`Promise`\<(`null` \| `ObjectCacheEntry`)[]\> - ---- - -### addObject() - -> **addObject**(`object`): `Promise`\<`ObjectCacheEntry`\> - -#### Parameters - -• **object**: `ObjectCacheEntry` - -#### Returns - -`Promise`\<`ObjectCacheEntry`\> - ---- - -### addObjects() - -> **addObjects**(`objects`): `Promise`\<`void`\> - -#### Parameters - -• **objects**: `ObjectCacheEntry`[] - -#### Returns - -`Promise`\<`void`\> - ---- - -### deleteObject() - -> **deleteObject**(`id`): `Promise`\<`void`\> - -#### Parameters - -• **id**: `string` - -#### Returns - -`Promise`\<`void`\> - ---- - -### deleteObjects() - -> **deleteObjects**(`ids`): `Promise`\<`void`\> - -#### Parameters - -• **ids**: `string`[] - -#### Returns - -`Promise`\<`void`\> - ---- - -### getMoveFunctionDefinition() - -> **getMoveFunctionDefinition**(`ref`): `Promise`\<`null` \| `MoveFunctionCacheEntry`\> - -#### Parameters - -• **ref** - -• **ref.package**: `string` - -• **ref.module**: `string` - -• **ref.function**: `string` - -#### Returns - -`Promise`\<`null` \| `MoveFunctionCacheEntry`\> - ---- - -### addMoveFunctionDefinition() - -> **addMoveFunctionDefinition**(`functionEntry`): `Promise`\<`object`\> - -#### Parameters - -• **functionEntry**: `MoveFunctionCacheEntry` - -#### Returns - -`Promise`\<`object`\> - -##### module - -> **module**: `string` - -##### function - -> **function**: `string` - -##### parameters - -> **parameters**: `object`[] - -##### package - -> **package**: `string` = `pkg` - ---- - -### deleteMoveFunctionDefinition() - -> **deleteMoveFunctionDefinition**(`ref`): `Promise`\<`void`\> - -#### Parameters - -• **ref** - -• **ref.package**: `string` - -• **ref.module**: `string` - -• **ref.function**: `string` - -#### Returns - -`Promise`\<`void`\> - ---- - -### getCustom() - -> **getCustom**\<`T`\>(`key`): `Promise`\<`null` \| `T`\> - -#### Type Parameters - -• **T** - -#### Parameters - -• **key**: `string` - -#### Returns - -`Promise`\<`null` \| `T`\> - ---- - -### setCustom() - -> **setCustom**\<`T`\>(`key`, `value`): `Promise`\<`void`\> - -#### Type Parameters - -• **T** - -#### Parameters - -• **key**: `string` - -• **value**: `T` - -#### Returns - -`Promise`\<`void`\> - ---- - -### deleteCustom() - -> **deleteCustom**(`key`): `Promise`\<`void`\> - -#### Parameters - -• **key**: `string` - -#### Returns - -`Promise`\<`void`\> diff --git a/docs/content/ts-sdk/api/transactions/classes/ObjectCache.md b/docs/content/ts-sdk/api/transactions/classes/ObjectCache.md deleted file mode 100644 index 9cad0a8a823..00000000000 --- a/docs/content/ts-sdk/api/transactions/classes/ObjectCache.md +++ /dev/null @@ -1,205 +0,0 @@ -# Class: ObjectCache - -## Constructors - -### new ObjectCache() - -> **new ObjectCache**(`__namedParameters`): [`ObjectCache`](ObjectCache.md) - -#### Parameters - -• **\_\_namedParameters**: `ObjectCacheOptions` - -#### Returns - -[`ObjectCache`](ObjectCache.md) - -## Methods - -### asPlugin() - -> **asPlugin**(): [`TransactionPlugin`](../type-aliases/TransactionPlugin.md) - -#### Returns - -[`TransactionPlugin`](../type-aliases/TransactionPlugin.md) - ---- - -### clear() - -> **clear**(): `Promise`\<`void`\> - -#### Returns - -`Promise`\<`void`\> - ---- - -### getMoveFunctionDefinition() - -> **getMoveFunctionDefinition**(`ref`): `Promise`\<`null` \| `MoveFunctionCacheEntry`\> - -#### Parameters - -• **ref** - -• **ref.package**: `string` - -• **ref.module**: `string` - -• **ref.function**: `string` - -#### Returns - -`Promise`\<`null` \| `MoveFunctionCacheEntry`\> - ---- - -### getObjects() - -> **getObjects**(`ids`): `Promise`\<(`null` \| `ObjectCacheEntry`)[]\> - -#### Parameters - -• **ids**: `string`[] - -#### Returns - -`Promise`\<(`null` \| `ObjectCacheEntry`)[]\> - ---- - -### deleteObjects() - -> **deleteObjects**(`ids`): `Promise`\<`void`\> - -#### Parameters - -• **ids**: `string`[] - -#### Returns - -`Promise`\<`void`\> - ---- - -### clearOwnedObjects() - -> **clearOwnedObjects**(): `Promise`\<`void`\> - -#### Returns - -`Promise`\<`void`\> - ---- - -### clearCustom() - -> **clearCustom**(): `Promise`\<`void`\> - -#### Returns - -`Promise`\<`void`\> - ---- - -### getCustom() - -> **getCustom**\<`T`\>(`key`): `Promise`\<`null` \| `T`\> - -#### Type Parameters - -• **T** - -#### Parameters - -• **key**: `string` - -#### Returns - -`Promise`\<`null` \| `T`\> - ---- - -### setCustom() - -> **setCustom**\<`T`\>(`key`, `value`): `Promise`\<`void`\> - -#### Type Parameters - -• **T** - -#### Parameters - -• **key**: `string` - -• **value**: `T` - -#### Returns - -`Promise`\<`void`\> - ---- - -### deleteCustom() - -> **deleteCustom**(`key`): `Promise`\<`void`\> - -#### Parameters - -• **key**: `string` - -#### Returns - -`Promise`\<`void`\> - ---- - -### applyEffects() - -> **applyEffects**(`effects`): `Promise`\<`void`\> - -#### Parameters - -• **effects** - -• **effects.$kind**: `"V1"` - -• **effects.V1** = `TransactionEffectsV1` - -• **effects.V1.status**: `EnumOutputShapeWithKeys`\<`object`, `"Success"` \| `"Failed"`\> = `ExecutionStatus` - -• **effects.V1.executedEpoch**: `string` = `...` - -• **effects.V1.gasUsed** = `GasCostSummary` - -• **effects.V1.gasUsed.computationCost**: `string` = `...` - -• **effects.V1.gasUsed.computationCostBurned**: `string` = `...` - -• **effects.V1.gasUsed.storageCost**: `string` = `...` - -• **effects.V1.gasUsed.storageRebate**: `string` = `...` - -• **effects.V1.gasUsed.nonRefundableStorageFee**: `string` = `...` - -• **effects.V1.transactionDigest**: `string` = `ObjectDigest` - -• **effects.V1.gasObjectIndex**: `null` \| `number` = `...` - -• **effects.V1.eventsDigest**: `null` \| `string` = `...` - -• **effects.V1.dependencies**: `string`[] = `...` - -• **effects.V1.lamportVersion**: `string` = `...` - -• **effects.V1.changedObjects**: [`string`, `object`][] = `...` - -• **effects.V1.unchangedSharedObjects**: [`string`, `EnumOutputShapeWithKeys`\<`object`, `"ReadOnlyRoot"` \| `"MutateDeleted"` \| `"ReadDeleted"` \| `"Cancelled"` \| `"PerEpochConfig"`\>][] = `...` - -• **effects.V1.auxDataDigest**: `null` \| `string` = `...` - -#### Returns - -`Promise`\<`void`\> diff --git a/docs/content/ts-sdk/api/transactions/classes/ParallelTransactionExecutor.md b/docs/content/ts-sdk/api/transactions/classes/ParallelTransactionExecutor.md deleted file mode 100644 index 40be6ca8364..00000000000 --- a/docs/content/ts-sdk/api/transactions/classes/ParallelTransactionExecutor.md +++ /dev/null @@ -1,59 +0,0 @@ -# Class: ParallelTransactionExecutor - -## Constructors - -### new ParallelTransactionExecutor() - -> **new ParallelTransactionExecutor**(`options`): [`ParallelTransactionExecutor`](ParallelTransactionExecutor.md) - -#### Parameters - -• **options**: [`ParallelTransactionExecutorOptions`](../interfaces/ParallelTransactionExecutorOptions.md) - -#### Returns - -[`ParallelTransactionExecutor`](ParallelTransactionExecutor.md) - -## Methods - -### resetCache() - -> **resetCache**(): `Promise`\<`void`\> - -#### Returns - -`Promise`\<`void`\> - ---- - -### waitForLastTransaction() - -> **waitForLastTransaction**(): `Promise`\<`void`\> - -#### Returns - -`Promise`\<`void`\> - ---- - -### executeTransaction() - -> **executeTransaction**(`transaction`, `options`?): `Promise`\<`object`\> - -#### Parameters - -• **transaction**: [`Transaction`](Transaction.md) - -• **options?**: [`IotaTransactionBlockResponseOptions`](../../client/interfaces/IotaTransactionBlockResponseOptions.md) - -#### Returns - -`Promise`\<`object`\> - -##### digest - -> **digest**: `string` - -##### effects - -> **effects**: `string` diff --git a/docs/content/ts-sdk/api/transactions/classes/SerialTransactionExecutor.md b/docs/content/ts-sdk/api/transactions/classes/SerialTransactionExecutor.md deleted file mode 100644 index c1c7bff91c5..00000000000 --- a/docs/content/ts-sdk/api/transactions/classes/SerialTransactionExecutor.md +++ /dev/null @@ -1,123 +0,0 @@ -# Class: SerialTransactionExecutor - -## Constructors - -### new SerialTransactionExecutor() - -> **new SerialTransactionExecutor**(`__namedParameters`): [`SerialTransactionExecutor`](SerialTransactionExecutor.md) - -#### Parameters - -• **\_\_namedParameters**: `Omit`\<`ObjectCacheOptions`, `"address"`\> & `object` - -#### Returns - -[`SerialTransactionExecutor`](SerialTransactionExecutor.md) - -## Methods - -### applyEffects() - -> **applyEffects**(`effects`): `Promise`\<[`void`, `void`]\> - -#### Parameters - -• **effects** - -• **effects.$kind**: `"V1"` - -• **effects.V1** = `TransactionEffectsV1` - -• **effects.V1.status**: `EnumOutputShapeWithKeys`\<`object`, `"Success"` \| `"Failed"`\> = `ExecutionStatus` - -• **effects.V1.executedEpoch**: `string` = `...` - -• **effects.V1.gasUsed** = `GasCostSummary` - -• **effects.V1.gasUsed.computationCost**: `string` = `...` - -• **effects.V1.gasUsed.computationCostBurned**: `string` = `...` - -• **effects.V1.gasUsed.storageCost**: `string` = `...` - -• **effects.V1.gasUsed.storageRebate**: `string` = `...` - -• **effects.V1.gasUsed.nonRefundableStorageFee**: `string` = `...` - -• **effects.V1.transactionDigest**: `string` = `ObjectDigest` - -• **effects.V1.gasObjectIndex**: `null` \| `number` = `...` - -• **effects.V1.eventsDigest**: `null` \| `string` = `...` - -• **effects.V1.dependencies**: `string`[] = `...` - -• **effects.V1.lamportVersion**: `string` = `...` - -• **effects.V1.changedObjects**: [`string`, `object`][] = `...` - -• **effects.V1.unchangedSharedObjects**: [`string`, `EnumOutputShapeWithKeys`\<`object`, `"ReadOnlyRoot"` \| `"MutateDeleted"` \| `"ReadDeleted"` \| `"Cancelled"` \| `"PerEpochConfig"`\>][] = `...` - -• **effects.V1.auxDataDigest**: `null` \| `string` = `...` - -#### Returns - -`Promise`\<[`void`, `void`]\> - ---- - -### buildTransaction() - -> **buildTransaction**(`transaction`): `Promise`\<`Uint8Array`\> - -#### Parameters - -• **transaction**: [`Transaction`](Transaction.md) - -#### Returns - -`Promise`\<`Uint8Array`\> - ---- - -### resetCache() - -> **resetCache**(): `Promise`\<`void`\> - -#### Returns - -`Promise`\<`void`\> - ---- - -### waitForLastTransaction() - -> **waitForLastTransaction**(): `Promise`\<`void`\> - -#### Returns - -`Promise`\<`void`\> - ---- - -### executeTransaction() - -> **executeTransaction**(`transaction`, `options`?): `Promise`\<`object`\> - -#### Parameters - -• **transaction**: `Uint8Array` \| [`Transaction`](Transaction.md) - -• **options?**: [`IotaTransactionBlockResponseOptions`](../../client/interfaces/IotaTransactionBlockResponseOptions.md) - -#### Returns - -`Promise`\<`object`\> - -##### digest - -> **digest**: `string` = `results.digest` - -##### effects - -> **effects**: `string` diff --git a/docs/content/ts-sdk/api/transactions/classes/Transaction.md b/docs/content/ts-sdk/api/transactions/classes/Transaction.md deleted file mode 100644 index 6ab53963495..00000000000 --- a/docs/content/ts-sdk/api/transactions/classes/Transaction.md +++ /dev/null @@ -1,958 +0,0 @@ -# Class: Transaction - -Transaction Builder - -## Constructors - -### new Transaction() - -> **new Transaction**(): [`Transaction`](Transaction.md) - -#### Returns - -[`Transaction`](Transaction.md) - -## Properties - -### object() - -> **object**: (`value`) => `object` - -Add a new object input to the transaction. - -#### Parameters - -• **value**: [`TransactionObjectInput`](../type-aliases/TransactionObjectInput.md) - -#### Returns - -`object` - -##### $kind - -> **$kind**: `"Input"` - -##### Input - -> **Input**: `number` - -##### type? - -> `optional` **type**: `"object"` - -#### system() - -##### Returns - -`object` - -###### $kind - -> **$kind**: `"Input"` - -###### Input - -> **Input**: `number` - -###### type? - -> `optional` **type**: `"object"` - -#### clock() - -##### Returns - -`object` - -###### $kind - -> **$kind**: `"Input"` - -###### Input - -> **Input**: `number` - -###### type? - -> `optional` **type**: `"object"` - -#### random() - -##### Returns - -`object` - -###### $kind - -> **$kind**: `"Input"` - -###### Input - -> **Input**: `number` - -###### type? - -> `optional` **type**: `"object"` - -#### denyList() - -##### Returns - -`object` - -###### $kind - -> **$kind**: `"Input"` - -###### Input - -> **Input**: `number` - -###### type? - -> `optional` **type**: `"object"` - -## Accessors - -### blockData - -#### Get Signature - -> **get** **blockData**(): `object` - -##### Deprecated - -Use `getData()` instead. - -##### Returns - -`object` - -###### ~~version~~ - -> **version**: `1` - -###### ~~sender?~~ - -> `optional` **sender**: `string` - -###### ~~expiration?~~ - -> `optional` **expiration**: `null` \| `object` \| `object` - -###### ~~gasConfig~~ - -> **gasConfig**: `object` = `GasConfig` - -###### gasConfig.budget? - -> `optional` **budget**: `string` \| `number` \| `bigint` - -###### gasConfig.price? - -> `optional` **price**: `string` \| `number` \| `bigint` - -###### gasConfig.payment? - -> `optional` **payment**: `object`[] - -###### gasConfig.owner? - -> `optional` **owner**: `string` - -###### ~~inputs~~ - -> **inputs**: (`object` \| `object`)[] - -###### ~~transactions~~ - -> **transactions**: (`object` \| `object` \| `object` \| `object` \| `object` \| `object` \| `object`)[] - ---- - -### pure - -#### Get Signature - -> **get** **pure**(): \<`T`\>(`type`, `value`) => `T`(`value`) => `T` - -##### Returns - -`Function` - -###### Type Parameters - -• **T** _extends_ `PureTypeName` - -###### Parameters - -• **type**: `T` _extends_ `PureTypeName` ? `ValidPureTypeName`\<`T`\<`T`\>\> : `T` - -• **value**: `ShapeFromPureTypeName`\<`T`\> - -###### Returns - -`T` - -###### Parameters - -• **value**: `Uint8Array` \| `SerializedBcs`\<`any`, `any`\> - -The pure value, serialized to BCS. If this is a Uint8Array, then the value -is assumed to be raw bytes, and will be used directly. - -###### Returns - -`T` - -###### u8() - -###### Parameters - -• **value**: `number` - -###### Returns - -`object` \| `object` \| `object` \| `object` \| `object` - -###### u16() - -###### Parameters - -• **value**: `number` - -###### Returns - -`object` \| `object` \| `object` \| `object` \| `object` - -###### u32() - -###### Parameters - -• **value**: `number` - -###### Returns - -`object` \| `object` \| `object` \| `object` \| `object` - -###### u64() - -###### Parameters - -• **value**: `string` \| `number` \| `bigint` - -###### Returns - -`object` \| `object` \| `object` \| `object` \| `object` - -###### u128() - -###### Parameters - -• **value**: `string` \| `number` \| `bigint` - -###### Returns - -`object` \| `object` \| `object` \| `object` \| `object` - -###### u256() - -###### Parameters - -• **value**: `string` \| `number` \| `bigint` - -###### Returns - -`object` \| `object` \| `object` \| `object` \| `object` - -###### bool() - -###### Parameters - -• **value**: `boolean` - -###### Returns - -`object` \| `object` \| `object` \| `object` \| `object` - -###### string() - -###### Parameters - -• **value**: `string` - -###### Returns - -`object` \| `object` \| `object` \| `object` \| `object` - -###### address() - -###### Parameters - -• **value**: `string` - -###### Returns - -`object` \| `object` \| `object` \| `object` \| `object` - -###### id() - -> **id**: (`value`) => `object` \| `object` \| `object` \| `object` \| `object` - -###### Parameters - -• **value**: `string` - -###### Returns - -`object` \| `object` \| `object` \| `object` \| `object` - -###### vector() - -###### Type Parameters - -• **Type** _extends_ `PureTypeName` - -###### Parameters - -• **type**: `Type` - -• **value**: `Iterable`\<`ShapeFromPureTypeName`\<`Type`\>, `any`, `any`\> & `object` - -###### Returns - -`object` \| `object` \| `object` \| `object` \| `object` - -###### option() - -###### Type Parameters - -• **Type** _extends_ `PureTypeName` - -###### Parameters - -• **type**: `Type` - -• **value**: `undefined` \| `null` \| `ShapeFromPureTypeName`\<`Type`\> - -###### Returns - -`object` \| `object` \| `object` \| `object` \| `object` - ---- - -### gas - -#### Get Signature - -> **get** **gas**(): `object` - -Returns an argument for the gas coin, to be used in a transaction. - -##### Returns - -`object` - -###### $kind - -> **$kind**: `"GasCoin"` - -###### GasCoin - -> **GasCoin**: `true` - -## Methods - -### fromKind() - -> `static` **fromKind**(`serialized`): [`Transaction`](Transaction.md) - -Converts from a serialize transaction kind (built with `build({ onlyTransactionKind: true })`) to a `Transaction` class. -Supports either a byte array, or base64-encoded bytes. - -#### Parameters - -• **serialized**: `string` \| `Uint8Array` - -#### Returns - -[`Transaction`](Transaction.md) - ---- - -### from() - -> `static` **from**(`transaction`): [`Transaction`](Transaction.md) - -Converts from a serialized transaction format to a `Transaction` class. -There are two supported serialized formats: - -- A string returned from `Transaction#serialize`. The serialized format must be compatible, or it will throw an error. -- A byte array (or base64-encoded bytes) containing BCS transaction data. - -#### Parameters - -• **transaction**: `string` \| `Uint8Array` \| [`Transaction`](Transaction.md) - -#### Returns - -[`Transaction`](Transaction.md) - ---- - -### registerGlobalSerializationPlugin() - -> `static` **registerGlobalSerializationPlugin**(`step`): `void` - -#### Parameters - -• **step**: [`TransactionPlugin`](../type-aliases/TransactionPlugin.md) - -#### Returns - -`void` - ---- - -### registerGlobalBuildPlugin() - -> `static` **registerGlobalBuildPlugin**(`step`): `void` - -#### Parameters - -• **step**: [`TransactionPlugin`](../type-aliases/TransactionPlugin.md) - -#### Returns - -`void` - ---- - -### addSerializationPlugin() - -> **addSerializationPlugin**(`step`): `void` - -#### Parameters - -• **step**: [`TransactionPlugin`](../type-aliases/TransactionPlugin.md) - -#### Returns - -`void` - ---- - -### addBuildPlugin() - -> **addBuildPlugin**(`step`): `void` - -#### Parameters - -• **step**: [`TransactionPlugin`](../type-aliases/TransactionPlugin.md) - -#### Returns - -`void` - ---- - -### addIntentResolver() - -> **addIntentResolver**(`intent`, `resolver`): `void` - -#### Parameters - -• **intent**: `string` - -• **resolver**: [`TransactionPlugin`](../type-aliases/TransactionPlugin.md) - -#### Returns - -`void` - ---- - -### setSender() - -> **setSender**(`sender`): `void` - -#### Parameters - -• **sender**: `string` - -#### Returns - -`void` - ---- - -### setSenderIfNotSet() - -> **setSenderIfNotSet**(`sender`): `void` - -Sets the sender only if it has not already been set. -This is useful for sponsored transaction flows where the sender may not be the same as the signer address. - -#### Parameters - -• **sender**: `string` - -#### Returns - -`void` - ---- - -### setExpiration() - -> **setExpiration**(`expiration`?): `void` - -#### Parameters - -• **expiration?**: `null` \| `EnumInputShape`\<`object`\> - -#### Returns - -`void` - ---- - -### setGasPrice() - -> **setGasPrice**(`price`): `void` - -#### Parameters - -• **price**: `number` \| `bigint` - -#### Returns - -`void` - ---- - -### setGasBudget() - -> **setGasBudget**(`budget`): `void` - -#### Parameters - -• **budget**: `number` \| `bigint` - -#### Returns - -`void` - ---- - -### setGasBudgetIfNotSet() - -> **setGasBudgetIfNotSet**(`budget`): `void` - -#### Parameters - -• **budget**: `number` \| `bigint` - -#### Returns - -`void` - ---- - -### setGasOwner() - -> **setGasOwner**(`owner`): `void` - -#### Parameters - -• **owner**: `string` - -#### Returns - -`void` - ---- - -### setGasPayment() - -> **setGasPayment**(`payments`): `void` - -#### Parameters - -• **payments**: `object`[] - -#### Returns - -`void` - ---- - -### getData() - -> **getData**(): `object` - -Get a snapshot of the transaction data, in JSON form: - -#### Returns - -`object` - -##### version - -> **version**: `2` - -##### sender? - -> `optional` **sender**: `null` \| `string` - -##### expiration? - -> `optional` **expiration**: `null` \| `EnumOutputShapeWithKeys`\<`object`, `"None"` \| `"Epoch"`\> - -##### gasData - -> **gasData**: `object` = `GasData` - -##### gasData.budget - -> **budget**: `null` \| `string` \| `number` - -##### gasData.price - -> **price**: `null` \| `string` \| `number` - -##### gasData.owner - -> **owner**: `null` \| `string` - -##### gasData.payment - -> **payment**: `null` \| `object`[] - -##### inputs - -> **inputs**: `EnumOutputShapeWithKeys`\<`object`, `"Pure"` \| `"Object"` \| `"UnresolvedPure"` \| `"UnresolvedObject"`\>[] - -##### commands - -> **commands**: `EnumOutputShapeWithKeys`\<`object`, `"MoveCall"` \| `"TransferObjects"` \| `"SplitCoins"` \| `"MergeCoins"` \| `"Publish"` \| `"MakeMoveVec"` \| `"Upgrade"` \| `"$Intent"`\>[] - ---- - -### objectRef() - -> **objectRef**(...`args`): `object` - -Add a new object input to the transaction using the fully-resolved object reference. -If you only have an object ID, use `builder.object(id)` instead. - -#### Parameters - -• ...**args**: [`object`] - -#### Returns - -`object` - -##### $kind - -> **$kind**: `"Input"` - -##### Input - -> **Input**: `number` - -##### type? - -> `optional` **type**: `"object"` - ---- - -### receivingRef() - -> **receivingRef**(...`args`): `object` - -Add a new receiving input to the transaction using the fully-resolved object reference. -If you only have an object ID, use `builder.object(id)` instead. - -#### Parameters - -• ...**args**: [`object`] - -#### Returns - -`object` - -##### $kind - -> **$kind**: `"Input"` - -##### Input - -> **Input**: `number` - -##### type? - -> `optional` **type**: `"object"` - ---- - -### sharedObjectRef() - -> **sharedObjectRef**(...`args`): `object` - -Add a new shared object input to the transaction using the fully-resolved shared object reference. -If you only have an object ID, use `builder.object(id)` instead. - -#### Parameters - -• ...**args**: [`object`] - -#### Returns - -`object` - -##### $kind - -> **$kind**: `"Input"` - -##### Input - -> **Input**: `number` - -##### type? - -> `optional` **type**: `"object"` - ---- - -### add() - -> **add**\<`T`\>(`command`): `T` - -Add a transaction to the transaction - -#### Type Parameters - -• **T** = [`TransactionResult`](../type-aliases/TransactionResult.md) - -#### Parameters - -• **command**: [`Command`](../type-aliases/Command.md) \| (`tx`) => `T` - -#### Returns - -`T` - ---- - -### splitCoins() - -> **splitCoins**(`coin`, `amounts`): [`TransactionResult`](../type-aliases/TransactionResult.md) - -#### Parameters - -• **coin**: `string` \| [`TransactionObjectArgument`](../type-aliases/TransactionObjectArgument.md) - -• **amounts**: (`string` \| `number` \| `bigint` \| `SerializedBcs`\<`any`, `any`\> \| [`TransactionArgument`](../type-aliases/TransactionArgument.md))[] - -#### Returns - -[`TransactionResult`](../type-aliases/TransactionResult.md) - ---- - -### mergeCoins() - -> **mergeCoins**(`destination`, `sources`): [`TransactionResult`](../type-aliases/TransactionResult.md) - -#### Parameters - -• **destination**: `string` \| [`TransactionObjectArgument`](../type-aliases/TransactionObjectArgument.md) - -• **sources**: (`string` \| [`TransactionObjectArgument`](../type-aliases/TransactionObjectArgument.md))[] - -#### Returns - -[`TransactionResult`](../type-aliases/TransactionResult.md) - ---- - -### publish() - -> **publish**(`__namedParameters`): [`TransactionResult`](../type-aliases/TransactionResult.md) - -#### Parameters - -• **\_\_namedParameters** - -• **\_\_namedParameters.modules**: `string`[] \| `number`[][] - -• **\_\_namedParameters.dependencies**: `string`[] - -#### Returns - -[`TransactionResult`](../type-aliases/TransactionResult.md) - ---- - -### upgrade() - -> **upgrade**(`__namedParameters`): [`TransactionResult`](../type-aliases/TransactionResult.md) - -#### Parameters - -• **\_\_namedParameters** - -• **\_\_namedParameters.modules**: `string`[] \| `number`[][] - -• **\_\_namedParameters.dependencies**: `string`[] - -• **\_\_namedParameters.package**: `string` - -• **\_\_namedParameters.ticket**: `string` \| [`TransactionObjectArgument`](../type-aliases/TransactionObjectArgument.md) - -#### Returns - -[`TransactionResult`](../type-aliases/TransactionResult.md) - ---- - -### moveCall() - -> **moveCall**(`__namedParameters`): [`TransactionResult`](../type-aliases/TransactionResult.md) - -#### Parameters - -• **\_\_namedParameters**: `object` \| `object` - -#### Returns - -[`TransactionResult`](../type-aliases/TransactionResult.md) - ---- - -### transferObjects() - -> **transferObjects**(`objects`, `address`): [`TransactionResult`](../type-aliases/TransactionResult.md) - -#### Parameters - -• **objects**: (`string` \| [`TransactionObjectArgument`](../type-aliases/TransactionObjectArgument.md))[] - -• **address**: `string` \| `SerializedBcs`\<`any`, `any`\> \| [`TransactionArgument`](../type-aliases/TransactionArgument.md) - -#### Returns - -[`TransactionResult`](../type-aliases/TransactionResult.md) - ---- - -### makeMoveVec() - -> **makeMoveVec**(`__namedParameters`): [`TransactionResult`](../type-aliases/TransactionResult.md) - -#### Parameters - -• **\_\_namedParameters** - -• **\_\_namedParameters.elements**: (`string` \| [`TransactionObjectArgument`](../type-aliases/TransactionObjectArgument.md))[] - -• **\_\_namedParameters.type?**: `string` - -#### Returns - -[`TransactionResult`](../type-aliases/TransactionResult.md) - ---- - -### ~~serialize()~~ - -> **serialize**(): `string` - -#### Returns - -`string` - -#### Deprecated - -Use toJSON instead. -For synchronous serialization, you can use `getData()` - ---- - -### toJSON() - -> **toJSON**(`options`): `Promise`\<`string`\> - -#### Parameters - -• **options**: [`SerializeTransactionOptions`](../interfaces/SerializeTransactionOptions.md) = `{}` - -#### Returns - -`Promise`\<`string`\> - ---- - -### sign() - -> **sign**(`options`): `Promise`\<[`SignatureWithBytes`](../../cryptography/interfaces/SignatureWithBytes.md)\> - -Build the transaction to BCS bytes, and sign it with the provided keypair. - -#### Parameters - -• **options**: `SignOptions` - -#### Returns - -`Promise`\<[`SignatureWithBytes`](../../cryptography/interfaces/SignatureWithBytes.md)\> - ---- - -### build() - -> **build**(`options`): `Promise`\<`Uint8Array`\> - -Build the transaction to BCS bytes. - -#### Parameters - -• **options**: [`BuildTransactionOptions`](../interfaces/BuildTransactionOptions.md) = `{}` - -#### Returns - -`Promise`\<`Uint8Array`\> - ---- - -### getDigest() - -> **getDigest**(`options`): `Promise`\<`string`\> - -Derive transaction digest - -#### Parameters - -• **options** = `{}` - -• **options.client?**: [`IotaClient`](../../client/classes/IotaClient.md) - -#### Returns - -`Promise`\<`string`\> - ---- - -### prepareForSerialization() - -> **prepareForSerialization**(`options`): `Promise`\<`void`\> - -#### Parameters - -• **options**: [`SerializeTransactionOptions`](../interfaces/SerializeTransactionOptions.md) - -#### Returns - -`Promise`\<`void`\> diff --git a/docs/content/ts-sdk/api/transactions/classes/TransactionDataBuilder.md b/docs/content/ts-sdk/api/transactions/classes/TransactionDataBuilder.md deleted file mode 100644 index 69f97d0aa15..00000000000 --- a/docs/content/ts-sdk/api/transactions/classes/TransactionDataBuilder.md +++ /dev/null @@ -1,391 +0,0 @@ -# Class: TransactionDataBuilder - -## Implements - -- [`TransactionData`](../type-aliases/TransactionData.md) - -## Constructors - -### new TransactionDataBuilder() - -> **new TransactionDataBuilder**(`clone`?): [`TransactionDataBuilder`](TransactionDataBuilder.md) - -#### Parameters - -• **clone?** - -• **clone.version?**: `2` = `...` - -• **clone.sender?**: `null` \| `string` = `...` - -• **clone.expiration?**: `null` \| `EnumOutputShapeWithKeys`\<`object`, `"None"` \| `"Epoch"`\> = `...` - -• **clone.gasData?** = `GasData` - -• **clone.gasData.budget?**: `null` \| `string` \| `number` = `...` - -• **clone.gasData.price?**: `null` \| `string` \| `number` = `...` - -• **clone.gasData.owner?**: `null` \| `string` = `...` - -• **clone.gasData.payment?**: `null` \| `object`[] = `...` - -• **clone.inputs?**: `EnumOutputShapeWithKeys`\<`object`, `"Pure"` \| `"Object"` \| `"UnresolvedPure"` \| `"UnresolvedObject"`\>[] = `...` - -• **clone.commands?**: `EnumOutputShapeWithKeys`\<`object`, `"MoveCall"` \| `"TransferObjects"` \| `"SplitCoins"` \| `"MergeCoins"` \| `"Publish"` \| `"MakeMoveVec"` \| `"Upgrade"` \| `"$Intent"`\>[] = `...` - -#### Returns - -[`TransactionDataBuilder`](TransactionDataBuilder.md) - -## Properties - -### version - -> **version**: `2` - -#### Implementation of - -`TransactionData.version` - ---- - -### sender - -> **sender**: `null` \| `string` - -#### Implementation of - -`TransactionData.sender` - ---- - -### expiration - -> **expiration**: `null` \| `EnumOutputShapeWithKeys`\<`object`, `"None"` \| `"Epoch"`\> - -#### Implementation of - -`TransactionData.expiration` - ---- - -### gasData - -> **gasData**: `object` - -#### budget - -> **budget**: `null` \| `string` \| `number` - -#### price - -> **price**: `null` \| `string` \| `number` - -#### owner - -> **owner**: `null` \| `string` - -#### payment - -> **payment**: `null` \| `object`[] - -#### Implementation of - -`TransactionData.gasData` - ---- - -### inputs - -> **inputs**: `EnumOutputShapeWithKeys`\<`object`, `"Pure"` \| `"Object"` \| `"UnresolvedPure"` \| `"UnresolvedObject"`\>[] - -#### Implementation of - -`TransactionData.inputs` - ---- - -### commands - -> **commands**: [`Command`](../type-aliases/Command.md)[] - -#### Implementation of - -`TransactionData.commands` - -## Accessors - -### gasConfig - -#### Get Signature - -> **get** **gasConfig**(): `object` - -##### Returns - -`object` - -###### budget - -> **budget**: `null` \| `string` \| `number` - -###### price - -> **price**: `null` \| `string` \| `number` - -###### owner - -> **owner**: `null` \| `string` - -###### payment - -> **payment**: `null` \| `object`[] - -#### Set Signature - -> **set** **gasConfig**(`value`): `void` - -##### Parameters - -• **value** - -• **value.budget**: `null` \| `string` \| `number` = `...` - -• **value.price**: `null` \| `string` \| `number` = `...` - -• **value.owner**: `null` \| `string` = `...` - -• **value.payment**: `null` \| `object`[] = `...` - -##### Returns - -`void` - -## Methods - -### fromKindBytes() - -> `static` **fromKindBytes**(`bytes`): [`TransactionDataBuilder`](TransactionDataBuilder.md) - -#### Parameters - -• **bytes**: `Uint8Array` - -#### Returns - -[`TransactionDataBuilder`](TransactionDataBuilder.md) - ---- - -### fromBytes() - -> `static` **fromBytes**(`bytes`): [`TransactionDataBuilder`](TransactionDataBuilder.md) - -#### Parameters - -• **bytes**: `Uint8Array` - -#### Returns - -[`TransactionDataBuilder`](TransactionDataBuilder.md) - ---- - -### restore() - -> `static` **restore**(`data`): [`TransactionDataBuilder`](TransactionDataBuilder.md) - -#### Parameters - -• **data**: `object` \| `object` - -#### Returns - -[`TransactionDataBuilder`](TransactionDataBuilder.md) - ---- - -### getDigestFromBytes() - -> `static` **getDigestFromBytes**(`bytes`): `string` - -Generate transaction digest. - -#### Parameters - -• **bytes**: `Uint8Array` - -BCS serialized transaction data - -#### Returns - -`string` - -transaction digest. - ---- - -### build() - -> **build**(`__namedParameters`): `Uint8Array` - -#### Parameters - -• **\_\_namedParameters** = `{}` - -• **\_\_namedParameters.maxSizeBytes?**: `number` = `Infinity` - -• **\_\_namedParameters.overrides?** - -• **\_\_namedParameters.overrides.expiration?**: `EnumOutputShapeWithKeys`\<`object`, `"None"` \| `"Epoch"`\> - -• **\_\_namedParameters.overrides.sender?**: `string` - -• **\_\_namedParameters.overrides.gasConfig?**: `Partial`\<`object`\> - -• **\_\_namedParameters.overrides.gasData?**: `Partial`\<`object`\> - -• **\_\_namedParameters.onlyTransactionKind?**: `boolean` - -#### Returns - -`Uint8Array` - ---- - -### addInput() - -> **addInput**\<`T`\>(`type`, `arg`): `object` - -#### Type Parameters - -• **T** _extends_ `"object"` \| `"pure"` - -#### Parameters - -• **type**: `T` - -• **arg**: `EnumOutputShapeWithKeys`\<`object`, `"Pure"` \| `"Object"` \| `"UnresolvedPure"` \| `"UnresolvedObject"`\> - -#### Returns - -`object` - -##### Input - -> **Input**: `number` = `index` - -##### type - -> **type**: `T` - -##### $kind - -> **$kind**: `"Input"` - ---- - -### getInputUses() - -> **getInputUses**(`index`, `fn`): `void` - -#### Parameters - -• **index**: `number` - -• **fn** - -#### Returns - -`void` - ---- - -### mapArguments() - -> **mapArguments**(`fn`): `void` - -#### Parameters - -• **fn** - -#### Returns - -`void` - ---- - -### replaceCommand() - -> **replaceCommand**(`index`, `replacement`): `void` - -#### Parameters - -• **index**: `number` - -• **replacement**: [`Command`](../type-aliases/Command.md) \| [`Command`](../type-aliases/Command.md)[] - -#### Returns - -`void` - ---- - -### getDigest() - -> **getDigest**(): `string` - -#### Returns - -`string` - ---- - -### snapshot() - -> **snapshot**(): `object` - -#### Returns - -`object` - -##### version - -> **version**: `2` - -##### sender? - -> `optional` **sender**: `null` \| `string` - -##### expiration? - -> `optional` **expiration**: `null` \| `EnumOutputShapeWithKeys`\<`object`, `"None"` \| `"Epoch"`\> - -##### gasData - -> **gasData**: `object` = `GasData` - -##### gasData.budget - -> **budget**: `null` \| `string` \| `number` - -##### gasData.price - -> **price**: `null` \| `string` \| `number` - -##### gasData.owner - -> **owner**: `null` \| `string` - -##### gasData.payment - -> **payment**: `null` \| `object`[] - -##### inputs - -> **inputs**: `EnumOutputShapeWithKeys`\<`object`, `"Pure"` \| `"Object"` \| `"UnresolvedPure"` \| `"UnresolvedObject"`\>[] - -##### commands - -> **commands**: `EnumOutputShapeWithKeys`\<`object`, `"MoveCall"` \| `"TransferObjects"` \| `"SplitCoins"` \| `"MergeCoins"` \| `"Publish"` \| `"MakeMoveVec"` \| `"Upgrade"` \| `"$Intent"`\>[] diff --git a/docs/content/ts-sdk/api/transactions/enumerations/UpgradePolicy.md b/docs/content/ts-sdk/api/transactions/enumerations/UpgradePolicy.md deleted file mode 100644 index 0c256285a35..00000000000 --- a/docs/content/ts-sdk/api/transactions/enumerations/UpgradePolicy.md +++ /dev/null @@ -1,19 +0,0 @@ -# Enumeration: UpgradePolicy - -## Enumeration Members - -### COMPATIBLE - -> **COMPATIBLE**: `0` - ---- - -### ADDITIVE - -> **ADDITIVE**: `128` - ---- - -### DEP\_ONLY - -> **DEP\_ONLY**: `192` diff --git a/docs/content/ts-sdk/api/transactions/functions/coinWithBalance.md b/docs/content/ts-sdk/api/transactions/functions/coinWithBalance.md deleted file mode 100644 index 432850432b2..00000000000 --- a/docs/content/ts-sdk/api/transactions/functions/coinWithBalance.md +++ /dev/null @@ -1,25 +0,0 @@ -# Function: coinWithBalance() - -> **coinWithBalance**(`__namedParameters`): (`tx`) => [`TransactionResult`](../type-aliases/TransactionResult.md) - -## Parameters - -• **\_\_namedParameters** - -• **\_\_namedParameters.balance**: `number` \| `bigint` - -• **\_\_namedParameters.type?**: `string` = `IOTA_TYPE` - -• **\_\_namedParameters.useGasCoin?**: `boolean` = `true` - -## Returns - -`Function` - -### Parameters - -• **tx**: [`Transaction`](../classes/Transaction.md) - -### Returns - -[`TransactionResult`](../type-aliases/TransactionResult.md) diff --git a/docs/content/ts-sdk/api/transactions/functions/getPureBcsSchema.md b/docs/content/ts-sdk/api/transactions/functions/getPureBcsSchema.md deleted file mode 100644 index 765629b98b5..00000000000 --- a/docs/content/ts-sdk/api/transactions/functions/getPureBcsSchema.md +++ /dev/null @@ -1,11 +0,0 @@ -# Function: getPureBcsSchema() - -> **getPureBcsSchema**(`typeSignature`): [`BcsType`](../../bcs/classes/BcsType.md)\<`any`\> \| `null` - -## Parameters - -• **typeSignature**: [`OpenMoveTypeSignatureBody`](../type-aliases/OpenMoveTypeSignatureBody.md) - -## Returns - -[`BcsType`](../../bcs/classes/BcsType.md)\<`any`\> \| `null` diff --git a/docs/content/ts-sdk/api/transactions/functions/isTransaction.md b/docs/content/ts-sdk/api/transactions/functions/isTransaction.md deleted file mode 100644 index 18208ac88c9..00000000000 --- a/docs/content/ts-sdk/api/transactions/functions/isTransaction.md +++ /dev/null @@ -1,11 +0,0 @@ -# Function: isTransaction() - -> **isTransaction**(`obj`): `obj is Transaction` - -## Parameters - -• **obj**: `unknown` - -## Returns - -`obj is Transaction` diff --git a/docs/content/ts-sdk/api/transactions/functions/normalizedTypeToMoveTypeSignature.md b/docs/content/ts-sdk/api/transactions/functions/normalizedTypeToMoveTypeSignature.md deleted file mode 100644 index bafdc45d357..00000000000 --- a/docs/content/ts-sdk/api/transactions/functions/normalizedTypeToMoveTypeSignature.md +++ /dev/null @@ -1,11 +0,0 @@ -# Function: normalizedTypeToMoveTypeSignature() - -> **normalizedTypeToMoveTypeSignature**(`type`): [`OpenMoveTypeSignature`](../type-aliases/OpenMoveTypeSignature.md) - -## Parameters - -• **type**: [`IotaMoveNormalizedType`](../../client/type-aliases/IotaMoveNormalizedType.md) - -## Returns - -[`OpenMoveTypeSignature`](../type-aliases/OpenMoveTypeSignature.md) diff --git a/docs/content/ts-sdk/api/transactions/index.md b/docs/content/ts-sdk/api/transactions/index.md deleted file mode 100644 index c2e79210d77..00000000000 --- a/docs/content/ts-sdk/api/transactions/index.md +++ /dev/null @@ -1,63 +0,0 @@ -# transactions - -## Index - -### Enumerations - -- [UpgradePolicy](enumerations/UpgradePolicy.md) - -### Classes - -- [AsyncCache](classes/AsyncCache.md) -- [ObjectCache](classes/ObjectCache.md) -- [Transaction](classes/Transaction.md) -- [TransactionDataBuilder](classes/TransactionDataBuilder.md) -- [ParallelTransactionExecutor](classes/ParallelTransactionExecutor.md) -- [SerialTransactionExecutor](classes/SerialTransactionExecutor.md) - -### Interfaces - -- [ParallelTransactionExecutorOptions](interfaces/ParallelTransactionExecutorOptions.md) -- [BuildTransactionOptions](interfaces/BuildTransactionOptions.md) -- [SerializeTransactionOptions](interfaces/SerializeTransactionOptions.md) - -### Type Aliases - -- [TransactionArgument](type-aliases/TransactionArgument.md) -- [TransactionInput](type-aliases/TransactionInput.md) -- [TransactionObjectArgument](type-aliases/TransactionObjectArgument.md) -- [TransactionResult](type-aliases/TransactionResult.md) -- [TransactionObjectInput](type-aliases/TransactionObjectInput.md) -- [ObjectRef](type-aliases/ObjectRef.md) -- [Argument](type-aliases/Argument.md) -- [GasData](type-aliases/GasData.md) -- [OpenMoveTypeSignatureBody](type-aliases/OpenMoveTypeSignatureBody.md) -- [OpenMoveTypeSignature](type-aliases/OpenMoveTypeSignature.md) -- [Command](type-aliases/Command.md) -- [CallArg](type-aliases/CallArg.md) -- [TransactionData](type-aliases/TransactionData.md) -- [SerializedTransactionDataV1](type-aliases/SerializedTransactionDataV1.md) -- [SerializedTransactionDataV2](type-aliases/SerializedTransactionDataV2.md) -- [TransactionPlugin](type-aliases/TransactionPlugin.md) - -### Variables - -- [Arguments](variables/Arguments.md) -- [Commands](variables/Commands.md) -- [Inputs](variables/Inputs.md) -- [ObjectRef](variables/ObjectRef.md) -- [Argument](variables/Argument.md) -- [GasData](variables/GasData.md) -- [OpenMoveTypeSignatureBody](variables/OpenMoveTypeSignatureBody.md) -- [OpenMoveTypeSignature](variables/OpenMoveTypeSignature.md) -- [Command](variables/Command.md) -- [TransactionData](variables/TransactionData.md) -- [SerializedTransactionDataV1](variables/SerializedTransactionDataV1.md) -- [SerializedTransactionDataV2](variables/SerializedTransactionDataV2.md) - -### Functions - -- [isTransaction](functions/isTransaction.md) -- [coinWithBalance](functions/coinWithBalance.md) -- [getPureBcsSchema](functions/getPureBcsSchema.md) -- [normalizedTypeToMoveTypeSignature](functions/normalizedTypeToMoveTypeSignature.md) diff --git a/docs/content/ts-sdk/api/transactions/interfaces/BuildTransactionOptions.md b/docs/content/ts-sdk/api/transactions/interfaces/BuildTransactionOptions.md deleted file mode 100644 index b3595d8c682..00000000000 --- a/docs/content/ts-sdk/api/transactions/interfaces/BuildTransactionOptions.md +++ /dev/null @@ -1,17 +0,0 @@ -# Interface: BuildTransactionOptions - -## Extended by - -- [`SerializeTransactionOptions`](SerializeTransactionOptions.md) - -## Properties - -### client? - -> `optional` **client**: [`IotaClient`](../../client/classes/IotaClient.md) - ---- - -### onlyTransactionKind? - -> `optional` **onlyTransactionKind**: `boolean` diff --git a/docs/content/ts-sdk/api/transactions/interfaces/ParallelTransactionExecutorOptions.md b/docs/content/ts-sdk/api/transactions/interfaces/ParallelTransactionExecutorOptions.md deleted file mode 100644 index a2a896fcdf1..00000000000 --- a/docs/content/ts-sdk/api/transactions/interfaces/ParallelTransactionExecutorOptions.md +++ /dev/null @@ -1,85 +0,0 @@ -# Interface: ParallelTransactionExecutorOptions - -## Extends - -- `Omit`\<`ObjectCacheOptions`, `"address"`\> - -## Properties - -### cache? - -> `optional` **cache**: [`AsyncCache`](../classes/AsyncCache.md) - -#### Inherited from - -`Omit.cache` - ---- - -### client - -> **client**: [`IotaClient`](../../client/classes/IotaClient.md) - ---- - -### signer - -> **signer**: [`Signer`](../../cryptography/classes/Signer.md) - ---- - -### coinBatchSize? - -> `optional` **coinBatchSize**: `number` - -The number of coins to create in a batch when refilling the gas pool - ---- - -### initialCoinBalance? - -> `optional` **initialCoinBalance**: `bigint` - -The initial balance of each coin created for the gas pool - ---- - -### minimumCoinBalance? - -> `optional` **minimumCoinBalance**: `bigint` - -The minimum balance of a coin that can be reused for future transactions. If the gasCoin is below this value, it will be used when refilling the gasPool - ---- - -### defaultGasBudget? - -> `optional` **defaultGasBudget**: `bigint` - -The gasBudget to use if the transaction has not defined it's own gasBudget, defaults to `minimumCoinBalance` - ---- - -### epochBoundaryWindow? - -> `optional` **epochBoundaryWindow**: `number` - -Time to wait before/after the expected epoch boundary before re-fetching the gas pool (in milliseconds). -Building transactions will be paused for up to 2x this duration around each epoch boundary to ensure the -gas price is up-to-date for the next epoch. - ---- - -### maxPoolSize? - -> `optional` **maxPoolSize**: `number` - -The maximum number of transactions that can be execute in parallel, this also determines the maximum number of gas coins that will be created - ---- - -### sourceCoins? - -> `optional` **sourceCoins**: `string`[] - -An initial list of coins used to fund the gas pool, uses all owned IOTA coins by default diff --git a/docs/content/ts-sdk/api/transactions/interfaces/SerializeTransactionOptions.md b/docs/content/ts-sdk/api/transactions/interfaces/SerializeTransactionOptions.md deleted file mode 100644 index f49846b7d96..00000000000 --- a/docs/content/ts-sdk/api/transactions/interfaces/SerializeTransactionOptions.md +++ /dev/null @@ -1,31 +0,0 @@ -# Interface: SerializeTransactionOptions - -## Extends - -- [`BuildTransactionOptions`](BuildTransactionOptions.md) - -## Properties - -### client? - -> `optional` **client**: [`IotaClient`](../../client/classes/IotaClient.md) - -#### Inherited from - -[`BuildTransactionOptions`](BuildTransactionOptions.md).[`client`](BuildTransactionOptions.md#client) - ---- - -### onlyTransactionKind? - -> `optional` **onlyTransactionKind**: `boolean` - -#### Inherited from - -[`BuildTransactionOptions`](BuildTransactionOptions.md).[`onlyTransactionKind`](BuildTransactionOptions.md#onlytransactionkind) - ---- - -### supportedIntents? - -> `optional` **supportedIntents**: `string`[] diff --git a/docs/content/ts-sdk/api/transactions/type-aliases/Argument.md b/docs/content/ts-sdk/api/transactions/type-aliases/Argument.md deleted file mode 100644 index c85eb152efd..00000000000 --- a/docs/content/ts-sdk/api/transactions/type-aliases/Argument.md +++ /dev/null @@ -1,3 +0,0 @@ -# Type Alias: Argument - -> **Argument**: `InferOutput`\<_typeof_ [`Argument`](../variables/Argument.md)\> diff --git a/docs/content/ts-sdk/api/transactions/type-aliases/CallArg.md b/docs/content/ts-sdk/api/transactions/type-aliases/CallArg.md deleted file mode 100644 index 4465aae5475..00000000000 --- a/docs/content/ts-sdk/api/transactions/type-aliases/CallArg.md +++ /dev/null @@ -1,3 +0,0 @@ -# Type Alias: CallArg - -> **CallArg**: `InferOutput`\<_typeof_ `CallArg`\> diff --git a/docs/content/ts-sdk/api/transactions/type-aliases/Command.md b/docs/content/ts-sdk/api/transactions/type-aliases/Command.md deleted file mode 100644 index 852dc1f4d1c..00000000000 --- a/docs/content/ts-sdk/api/transactions/type-aliases/Command.md +++ /dev/null @@ -1,133 +0,0 @@ -# Type Alias: Command\ - -> **Command**\<`Arg`\>: `EnumOutputShape`\<`object`\> - -## Type declaration - -### MoveCall - -> **MoveCall**: `object` - -### MoveCall.package - -> **package**: `string` - -### MoveCall.module - -> **module**: `string` - -### MoveCall.function - -> **function**: `string` - -### MoveCall.typeArguments - -> **typeArguments**: `string`[] - -### MoveCall.arguments - -> **arguments**: `Arg`[] - -### MoveCall.\_argumentTypes? - -> `optional` **\_argumentTypes**: [`OpenMoveTypeSignature`](OpenMoveTypeSignature.md)[] \| `null` - -### TransferObjects - -> **TransferObjects**: `object` - -### TransferObjects.objects - -> **objects**: `Arg`[] - -### TransferObjects.address - -> **address**: `Arg` - -### SplitCoins - -> **SplitCoins**: `object` - -### SplitCoins.coin - -> **coin**: `Arg` - -### SplitCoins.amounts - -> **amounts**: `Arg`[] - -### MergeCoins - -> **MergeCoins**: `object` - -### MergeCoins.destination - -> **destination**: `Arg` - -### MergeCoins.sources - -> **sources**: `Arg`[] - -### Publish - -> **Publish**: `object` - -### Publish.modules - -> **modules**: `string`[] - -### Publish.dependencies - -> **dependencies**: `string`[] - -### MakeMoveVec - -> **MakeMoveVec**: `object` - -### MakeMoveVec.type - -> **type**: `string` \| `null` - -### MakeMoveVec.elements - -> **elements**: `Arg`[] - -### Upgrade - -> **Upgrade**: `object` - -### Upgrade.modules - -> **modules**: `string`[] - -### Upgrade.dependencies - -> **dependencies**: `string`[] - -### Upgrade.package - -> **package**: `string` - -### Upgrade.ticket - -> **ticket**: `Arg` - -### $Intent - -> **$Intent**: `object` - -### $Intent.name - -> **name**: `string` - -### $Intent.inputs - -> **inputs**: `Record`\<`string`, [`Argument`](Argument.md) \| [`Argument`](Argument.md)[]\> - -### $Intent.data - -> **data**: `Record`\<`string`, `unknown`\> - -## Type Parameters - -• **Arg** = [`Argument`](Argument.md) diff --git a/docs/content/ts-sdk/api/transactions/type-aliases/GasData.md b/docs/content/ts-sdk/api/transactions/type-aliases/GasData.md deleted file mode 100644 index b6305390618..00000000000 --- a/docs/content/ts-sdk/api/transactions/type-aliases/GasData.md +++ /dev/null @@ -1,3 +0,0 @@ -# Type Alias: GasData - -> **GasData**: `InferOutput`\<_typeof_ [`GasData`](../variables/GasData.md)\> diff --git a/docs/content/ts-sdk/api/transactions/type-aliases/ObjectRef.md b/docs/content/ts-sdk/api/transactions/type-aliases/ObjectRef.md deleted file mode 100644 index 8d46548255d..00000000000 --- a/docs/content/ts-sdk/api/transactions/type-aliases/ObjectRef.md +++ /dev/null @@ -1,3 +0,0 @@ -# Type Alias: ObjectRef - -> **ObjectRef**: `InferOutput`\<_typeof_ [`ObjectRef`](../variables/ObjectRef.md)\> diff --git a/docs/content/ts-sdk/api/transactions/type-aliases/OpenMoveTypeSignature.md b/docs/content/ts-sdk/api/transactions/type-aliases/OpenMoveTypeSignature.md deleted file mode 100644 index 3b7474bf7bc..00000000000 --- a/docs/content/ts-sdk/api/transactions/type-aliases/OpenMoveTypeSignature.md +++ /dev/null @@ -1,3 +0,0 @@ -# Type Alias: OpenMoveTypeSignature - -> **OpenMoveTypeSignature**: `InferOutput`\<_typeof_ [`OpenMoveTypeSignature`](../variables/OpenMoveTypeSignature.md)\> diff --git a/docs/content/ts-sdk/api/transactions/type-aliases/OpenMoveTypeSignatureBody.md b/docs/content/ts-sdk/api/transactions/type-aliases/OpenMoveTypeSignatureBody.md deleted file mode 100644 index 8f8ce94cace..00000000000 --- a/docs/content/ts-sdk/api/transactions/type-aliases/OpenMoveTypeSignatureBody.md +++ /dev/null @@ -1,3 +0,0 @@ -# Type Alias: OpenMoveTypeSignatureBody - -> **OpenMoveTypeSignatureBody**: `"address"` \| `"bool"` \| `"u8"` \| `"u16"` \| `"u32"` \| `"u64"` \| `"u128"` \| `"u256"` \| `object` \| `object` \| `object` diff --git a/docs/content/ts-sdk/api/transactions/type-aliases/SerializedTransactionDataV1.md b/docs/content/ts-sdk/api/transactions/type-aliases/SerializedTransactionDataV1.md deleted file mode 100644 index 19084da2839..00000000000 --- a/docs/content/ts-sdk/api/transactions/type-aliases/SerializedTransactionDataV1.md +++ /dev/null @@ -1,3 +0,0 @@ -# Type Alias: SerializedTransactionDataV1 - -> **SerializedTransactionDataV1**: `InferOutput`\<_typeof_ [`SerializedTransactionDataV1`](../variables/SerializedTransactionDataV1.md)\> diff --git a/docs/content/ts-sdk/api/transactions/type-aliases/SerializedTransactionDataV2.md b/docs/content/ts-sdk/api/transactions/type-aliases/SerializedTransactionDataV2.md deleted file mode 100644 index 38f7ed0e41e..00000000000 --- a/docs/content/ts-sdk/api/transactions/type-aliases/SerializedTransactionDataV2.md +++ /dev/null @@ -1,3 +0,0 @@ -# Type Alias: SerializedTransactionDataV2 - -> **SerializedTransactionDataV2**: `InferOutput`\<_typeof_ [`SerializedTransactionDataV2`](../variables/SerializedTransactionDataV2.md)\> diff --git a/docs/content/ts-sdk/api/transactions/type-aliases/TransactionArgument.md b/docs/content/ts-sdk/api/transactions/type-aliases/TransactionArgument.md deleted file mode 100644 index 836b8760ba0..00000000000 --- a/docs/content/ts-sdk/api/transactions/type-aliases/TransactionArgument.md +++ /dev/null @@ -1,3 +0,0 @@ -# Type Alias: TransactionArgument - -> **TransactionArgument**: `InferInput`\<_typeof_ [`Argument`](../variables/Argument.md)\> \| (`tx`) => `InferInput`\<_typeof_ [`Argument`](../variables/Argument.md)\> diff --git a/docs/content/ts-sdk/api/transactions/type-aliases/TransactionData.md b/docs/content/ts-sdk/api/transactions/type-aliases/TransactionData.md deleted file mode 100644 index fd3405985e4..00000000000 --- a/docs/content/ts-sdk/api/transactions/type-aliases/TransactionData.md +++ /dev/null @@ -1,3 +0,0 @@ -# Type Alias: TransactionData - -> **TransactionData**: `InferOutput`\<_typeof_ [`TransactionData`](../variables/TransactionData.md)\> diff --git a/docs/content/ts-sdk/api/transactions/type-aliases/TransactionInput.md b/docs/content/ts-sdk/api/transactions/type-aliases/TransactionInput.md deleted file mode 100644 index 229d8a89ec7..00000000000 --- a/docs/content/ts-sdk/api/transactions/type-aliases/TransactionInput.md +++ /dev/null @@ -1,3 +0,0 @@ -# Type Alias: TransactionInput - -> **TransactionInput**: [`CallArg`](CallArg.md) diff --git a/docs/content/ts-sdk/api/transactions/type-aliases/TransactionObjectArgument.md b/docs/content/ts-sdk/api/transactions/type-aliases/TransactionObjectArgument.md deleted file mode 100644 index de01e6e364e..00000000000 --- a/docs/content/ts-sdk/api/transactions/type-aliases/TransactionObjectArgument.md +++ /dev/null @@ -1,3 +0,0 @@ -# Type Alias: TransactionObjectArgument - -> **TransactionObjectArgument**: `Exclude`\<`InferInput`\<_typeof_ [`Argument`](../variables/Argument.md)\>, `object`\> \| (`tx`) => `Exclude`\<`InferInput`\<_typeof_ [`Argument`](../variables/Argument.md)\>, `object`\> diff --git a/docs/content/ts-sdk/api/transactions/type-aliases/TransactionObjectInput.md b/docs/content/ts-sdk/api/transactions/type-aliases/TransactionObjectInput.md deleted file mode 100644 index 52bf593828f..00000000000 --- a/docs/content/ts-sdk/api/transactions/type-aliases/TransactionObjectInput.md +++ /dev/null @@ -1,3 +0,0 @@ -# Type Alias: TransactionObjectInput - -> **TransactionObjectInput**: `string` \| [`CallArg`](CallArg.md) \| [`TransactionObjectArgument`](TransactionObjectArgument.md) diff --git a/docs/content/ts-sdk/api/transactions/type-aliases/TransactionPlugin.md b/docs/content/ts-sdk/api/transactions/type-aliases/TransactionPlugin.md deleted file mode 100644 index f1d2c692900..00000000000 --- a/docs/content/ts-sdk/api/transactions/type-aliases/TransactionPlugin.md +++ /dev/null @@ -1,15 +0,0 @@ -# Type Alias: TransactionPlugin() - -> **TransactionPlugin**: (`transactionData`, `options`, `next`) => `Promise`\<`void`\> - -## Parameters - -• **transactionData**: [`TransactionDataBuilder`](../classes/TransactionDataBuilder.md) - -• **options**: [`BuildTransactionOptions`](../interfaces/BuildTransactionOptions.md) - -• **next** - -## Returns - -`Promise`\<`void`\> diff --git a/docs/content/ts-sdk/api/transactions/type-aliases/TransactionResult.md b/docs/content/ts-sdk/api/transactions/type-aliases/TransactionResult.md deleted file mode 100644 index 15823fd9a1d..00000000000 --- a/docs/content/ts-sdk/api/transactions/type-aliases/TransactionResult.md +++ /dev/null @@ -1,3 +0,0 @@ -# Type Alias: TransactionResult - -> **TransactionResult**: `Extract`\<[`Argument`](Argument.md), `object`\> & `Extract`\<[`Argument`](Argument.md), `object`\>[] diff --git a/docs/content/ts-sdk/api/transactions/variables/Argument.md b/docs/content/ts-sdk/api/transactions/variables/Argument.md deleted file mode 100644 index 3a4f8696679..00000000000 --- a/docs/content/ts-sdk/api/transactions/variables/Argument.md +++ /dev/null @@ -1,3 +0,0 @@ -# Variable: Argument - -> `const` **Argument**: `GenericSchema`\<`object` \| `object` \| `object` \| `object`, `object` \| `object` \| `object` \| `object` \| `object`, `BaseIssue`\<`unknown`\>\> diff --git a/docs/content/ts-sdk/api/transactions/variables/Arguments.md b/docs/content/ts-sdk/api/transactions/variables/Arguments.md deleted file mode 100644 index b9757be7565..00000000000 --- a/docs/content/ts-sdk/api/transactions/variables/Arguments.md +++ /dev/null @@ -1,496 +0,0 @@ -# Variable: Arguments - -> `const` **Arguments**: `object` - -## Type declaration - -### pure() - -> **pure**: \<`T`\>(`type`, `value`) => `T`(`value`) => `T` - -#### Type Parameters - -• **T** _extends_ `PureTypeName` - -#### Parameters - -• **type**: `T` _extends_ `PureTypeName` ? `ValidPureTypeName`\<`T`\<`T`\>\> : `T` - -• **value**: `ShapeFromPureTypeName`\<`T`\> - -#### Returns - -`T` - -#### Parameters - -• **value**: `Uint8Array` \| `SerializedBcs`\<`any`, `any`\> - -The pure value, serialized to BCS. If this is a Uint8Array, then the value -is assumed to be raw bytes, and will be used directly. - -#### Returns - -`T` - -### pure.u8() - -#### Parameters - -• **value**: `number` - -#### Returns - -`Function` - -##### Parameters - -• **tx**: [`Transaction`](../classes/Transaction.md) - -##### Returns - -`object` \| `object` \| `object` \| `object` \| `object` - -### pure.u16() - -#### Parameters - -• **value**: `number` - -#### Returns - -`Function` - -##### Parameters - -• **tx**: [`Transaction`](../classes/Transaction.md) - -##### Returns - -`object` \| `object` \| `object` \| `object` \| `object` - -### pure.u32() - -#### Parameters - -• **value**: `number` - -#### Returns - -`Function` - -##### Parameters - -• **tx**: [`Transaction`](../classes/Transaction.md) - -##### Returns - -`object` \| `object` \| `object` \| `object` \| `object` - -### pure.u64() - -#### Parameters - -• **value**: `string` \| `number` \| `bigint` - -#### Returns - -`Function` - -##### Parameters - -• **tx**: [`Transaction`](../classes/Transaction.md) - -##### Returns - -`object` \| `object` \| `object` \| `object` \| `object` - -### pure.u128() - -#### Parameters - -• **value**: `string` \| `number` \| `bigint` - -#### Returns - -`Function` - -##### Parameters - -• **tx**: [`Transaction`](../classes/Transaction.md) - -##### Returns - -`object` \| `object` \| `object` \| `object` \| `object` - -### pure.u256() - -#### Parameters - -• **value**: `string` \| `number` \| `bigint` - -#### Returns - -`Function` - -##### Parameters - -• **tx**: [`Transaction`](../classes/Transaction.md) - -##### Returns - -`object` \| `object` \| `object` \| `object` \| `object` - -### pure.bool() - -#### Parameters - -• **value**: `boolean` - -#### Returns - -`Function` - -##### Parameters - -• **tx**: [`Transaction`](../classes/Transaction.md) - -##### Returns - -`object` \| `object` \| `object` \| `object` \| `object` - -### pure.string() - -#### Parameters - -• **value**: `string` - -#### Returns - -`Function` - -##### Parameters - -• **tx**: [`Transaction`](../classes/Transaction.md) - -##### Returns - -`object` \| `object` \| `object` \| `object` \| `object` - -### pure.address() - -#### Parameters - -• **value**: `string` - -#### Returns - -`Function` - -##### Parameters - -• **tx**: [`Transaction`](../classes/Transaction.md) - -##### Returns - -`object` \| `object` \| `object` \| `object` \| `object` - -### pure.id() - -> **id**: (`value`) => (`tx`) => `object` \| `object` \| `object` \| `object` \| `object` - -#### Parameters - -• **value**: `string` - -#### Returns - -`Function` - -##### Parameters - -• **tx**: [`Transaction`](../classes/Transaction.md) - -##### Returns - -`object` \| `object` \| `object` \| `object` \| `object` - -### pure.vector() - -#### Type Parameters - -• **Type** _extends_ `PureTypeName` - -#### Parameters - -• **type**: `Type` - -• **value**: `Iterable`\<`ShapeFromPureTypeName`\<`Type`\>, `any`, `any`\> & `object` - -#### Returns - -`Function` - -##### Parameters - -• **tx**: [`Transaction`](../classes/Transaction.md) - -##### Returns - -`object` \| `object` \| `object` \| `object` \| `object` - -### pure.option() - -#### Type Parameters - -• **Type** _extends_ `PureTypeName` - -#### Parameters - -• **type**: `Type` - -• **value**: `undefined` \| `null` \| `ShapeFromPureTypeName`\<`Type`\> - -#### Returns - -`Function` - -##### Parameters - -• **tx**: [`Transaction`](../classes/Transaction.md) - -##### Returns - -`object` \| `object` \| `object` \| `object` \| `object` - -### object() - -> **object**: (`value`) => (`tx`) => `object` - -#### Parameters - -• **value**: [`TransactionObjectInput`](../type-aliases/TransactionObjectInput.md) - -#### Returns - -`Function` - -##### Parameters - -• **tx**: [`Transaction`](../classes/Transaction.md) - -##### Returns - -`object` - -###### $kind - -> **$kind**: `"Input"` - -###### Input - -> **Input**: `number` - -###### type? - -> `optional` **type**: `"object"` - -### object.system() - -#### Returns - -`Function` - -##### Parameters - -• **tx**: [`Transaction`](../classes/Transaction.md) - -##### Returns - -`object` - -###### $kind - -> **$kind**: `"Input"` - -###### Input - -> **Input**: `number` - -###### type? - -> `optional` **type**: `"object"` - -### object.clock() - -#### Returns - -`Function` - -##### Parameters - -• **tx**: [`Transaction`](../classes/Transaction.md) - -##### Returns - -`object` - -###### $kind - -> **$kind**: `"Input"` - -###### Input - -> **Input**: `number` - -###### type? - -> `optional` **type**: `"object"` - -### object.random() - -#### Returns - -`Function` - -##### Parameters - -• **tx**: [`Transaction`](../classes/Transaction.md) - -##### Returns - -`object` - -###### $kind - -> **$kind**: `"Input"` - -###### Input - -> **Input**: `number` - -###### type? - -> `optional` **type**: `"object"` - -### object.denyList() - -#### Returns - -`Function` - -##### Parameters - -• **tx**: [`Transaction`](../classes/Transaction.md) - -##### Returns - -`object` - -###### $kind - -> **$kind**: `"Input"` - -###### Input - -> **Input**: `number` - -###### type? - -> `optional` **type**: `"object"` - -### sharedObjectRef() - -> **sharedObjectRef**: (...`args`) => (`tx`) => `object` - -#### Parameters - -• ...**args**: [`object`] - -#### Returns - -`Function` - -##### Parameters - -• **tx**: [`Transaction`](../classes/Transaction.md) - -##### Returns - -`object` - -###### $kind - -> **$kind**: `"Input"` - -###### Input - -> **Input**: `number` - -###### type? - -> `optional` **type**: `"object"` - -### objectRef() - -> **objectRef**: (...`args`) => (`tx`) => `object` - -#### Parameters - -• ...**args**: [`object`] - -#### Returns - -`Function` - -##### Parameters - -• **tx**: [`Transaction`](../classes/Transaction.md) - -##### Returns - -`object` - -###### $kind - -> **$kind**: `"Input"` - -###### Input - -> **Input**: `number` - -###### type? - -> `optional` **type**: `"object"` - -### receivingRef() - -> **receivingRef**: (...`args`) => (`tx`) => `object` - -#### Parameters - -• ...**args**: [`object`] - -#### Returns - -`Function` - -##### Parameters - -• **tx**: [`Transaction`](../classes/Transaction.md) - -##### Returns - -`object` - -###### $kind - -> **$kind**: `"Input"` - -###### Input - -> **Input**: `number` - -###### type? - -> `optional` **type**: `"object"` diff --git a/docs/content/ts-sdk/api/transactions/variables/Command.md b/docs/content/ts-sdk/api/transactions/variables/Command.md deleted file mode 100644 index ae625f52b55..00000000000 --- a/docs/content/ts-sdk/api/transactions/variables/Command.md +++ /dev/null @@ -1,145 +0,0 @@ -# Variable: Command - -> `const` **Command**: `EnumSchema`\<`object`\> - -## Type declaration - -### MoveCall - -> **MoveCall**: `ObjectSchema`\<`object`, `undefined`\> = `ProgrammableMoveCall` - -#### Type declaration - -##### package - -> `readonly` **package**: `SchemaWithPipe`\<[`StringSchema`\<`undefined`\>, `TransformAction`\<`string`, `string`\>, `CheckAction`\<`string`, `undefined`\>]\> = `ObjectID` - -##### module - -> `readonly` **module**: `StringSchema`\<`undefined`\> - -##### function - -> `readonly` **function**: `StringSchema`\<`undefined`\> - -##### typeArguments - -> `readonly` **typeArguments**: `ArraySchema`\<`StringSchema`\<`undefined`\>, `undefined`\> - -##### arguments - -> `readonly` **arguments**: `ArraySchema`\<`GenericSchema`\<`object` \| `object` \| `object` \| `object`, `object` \| `object` \| `object` \| `object` \| `object`, `BaseIssue`\<`unknown`\>\>, `undefined`\> - -##### \_argumentTypes - -> `readonly` **\_argumentTypes**: `OptionalSchema`\<`NullableSchema`\<`ArraySchema`\<`ObjectSchema`\<`object`, `undefined`\>, `undefined`\>, `never`\>, `never`\> - -### TransferObjects - -> **TransferObjects**: `ObjectSchema`\<`object`, `undefined`\> - -#### Type declaration - -##### objects - -> `readonly` **objects**: `ArraySchema`\<`GenericSchema`\<`object` \| `object` \| `object` \| `object`, `object` \| `object` \| `object` \| `object` \| `object`, `BaseIssue`\<`unknown`\>\>, `undefined`\> - -##### address - -> `readonly` **address**: `GenericSchema`\<`object` \| `object` \| `object` \| `object`, `object` \| `object` \| `object` \| `object` \| `object`, `BaseIssue`\<`unknown`\>\> = `Argument` - -### SplitCoins - -> **SplitCoins**: `ObjectSchema`\<`object`, `undefined`\> - -#### Type declaration - -##### coin - -> `readonly` **coin**: `GenericSchema`\<`object` \| `object` \| `object` \| `object`, `object` \| `object` \| `object` \| `object` \| `object`, `BaseIssue`\<`unknown`\>\> = `Argument` - -##### amounts - -> `readonly` **amounts**: `ArraySchema`\<`GenericSchema`\<`object` \| `object` \| `object` \| `object`, `object` \| `object` \| `object` \| `object` \| `object`, `BaseIssue`\<`unknown`\>\>, `undefined`\> - -### MergeCoins - -> **MergeCoins**: `ObjectSchema`\<`object`, `undefined`\> - -#### Type declaration - -##### destination - -> `readonly` **destination**: `GenericSchema`\<`object` \| `object` \| `object` \| `object`, `object` \| `object` \| `object` \| `object` \| `object`, `BaseIssue`\<`unknown`\>\> = `Argument` - -##### sources - -> `readonly` **sources**: `ArraySchema`\<`GenericSchema`\<`object` \| `object` \| `object` \| `object`, `object` \| `object` \| `object` \| `object` \| `object`, `BaseIssue`\<`unknown`\>\>, `undefined`\> - -### Publish - -> **Publish**: `ObjectSchema`\<`object`, `undefined`\> - -#### Type declaration - -##### modules - -> `readonly` **modules**: `ArraySchema`\<`StringSchema`\<`undefined`\>, `undefined`\> - -##### dependencies - -> `readonly` **dependencies**: `ArraySchema`\<`SchemaWithPipe`\<[`StringSchema`\<`undefined`\>, `TransformAction`\<`string`, `string`\>, `CheckAction`\<`string`, `undefined`\>]\>, `undefined`\> - -### MakeMoveVec - -> **MakeMoveVec**: `ObjectSchema`\<`object`, `undefined`\> - -#### Type declaration - -##### type - -> `readonly` **type**: `NullableSchema`\<`StringSchema`\<`undefined`\>, `never`\> - -##### elements - -> `readonly` **elements**: `ArraySchema`\<`GenericSchema`\<`object` \| `object` \| `object` \| `object`, `object` \| `object` \| `object` \| `object` \| `object`, `BaseIssue`\<`unknown`\>\>, `undefined`\> - -### Upgrade - -> **Upgrade**: `ObjectSchema`\<`object`, `undefined`\> - -#### Type declaration - -##### modules - -> `readonly` **modules**: `ArraySchema`\<`StringSchema`\<`undefined`\>, `undefined`\> - -##### dependencies - -> `readonly` **dependencies**: `ArraySchema`\<`SchemaWithPipe`\<[`StringSchema`\<`undefined`\>, `TransformAction`\<`string`, `string`\>, `CheckAction`\<`string`, `undefined`\>]\>, `undefined`\> - -##### package - -> `readonly` **package**: `SchemaWithPipe`\<[`StringSchema`\<`undefined`\>, `TransformAction`\<`string`, `string`\>, `CheckAction`\<`string`, `undefined`\>]\> = `ObjectID` - -##### ticket - -> `readonly` **ticket**: `GenericSchema`\<`object` \| `object` \| `object` \| `object`, `object` \| `object` \| `object` \| `object` \| `object`, `BaseIssue`\<`unknown`\>\> = `Argument` - -### $Intent - -> **$Intent**: `ObjectSchema`\<`object`, `undefined`\> - -#### Type declaration - -##### name - -> `readonly` **name**: `StringSchema`\<`undefined`\> - -##### inputs - -> `readonly` **inputs**: `RecordSchema`\<`StringSchema`\<`undefined`\>, `UnionSchema`\<[`GenericSchema`\<`object` \| `object` \| `object` \| `object`, `object` \| `object` \| `object` \| `object` \| `object`, `BaseIssue`\<`unknown`\>\>, `ArraySchema`\<`GenericSchema`\<`object` \| `object` \| `object` \| `object`, `object` \| `object` \| `object` \| `object` \| `object`, `BaseIssue`\<`unknown`\>\>, `undefined`\>], `undefined`\>, `undefined`\> - -##### data - -> `readonly` **data**: `RecordSchema`\<`StringSchema`\<`undefined`\>, `UnknownSchema`, `undefined`\> diff --git a/docs/content/ts-sdk/api/transactions/variables/Commands.md b/docs/content/ts-sdk/api/transactions/variables/Commands.md deleted file mode 100644 index 1e6564413ac..00000000000 --- a/docs/content/ts-sdk/api/transactions/variables/Commands.md +++ /dev/null @@ -1,115 +0,0 @@ -# Variable: Commands - -> `const` **Commands**: `object` - -Simple helpers used to construct transactions: - -## Type declaration - -### MoveCall() - -#### Parameters - -• **input**: `object` \| `object` - -#### Returns - -`TransactionShape`\<`"MoveCall"`\> - -### TransferObjects() - -#### Parameters - -• **objects**: (`object` \| `object` \| `object` \| `object`)[] - -• **address**: `object` \| `object` \| `object` \| `object` - -#### Returns - -`TransactionShape`\<`"TransferObjects"`\> - -### SplitCoins() - -#### Parameters - -• **coin**: `object` \| `object` \| `object` \| `object` - -• **amounts**: (`object` \| `object` \| `object` \| `object`)[] - -#### Returns - -`TransactionShape`\<`"SplitCoins"`\> - -### MergeCoins() - -#### Parameters - -• **destination**: `object` \| `object` \| `object` \| `object` - -• **sources**: (`object` \| `object` \| `object` \| `object`)[] - -#### Returns - -`TransactionShape`\<`"MergeCoins"`\> - -### Publish() - -#### Parameters - -• **\_\_namedParameters** - -• **\_\_namedParameters.modules**: `string`[] \| `number`[][] - -• **\_\_namedParameters.dependencies**: `string`[] - -#### Returns - -`TransactionShape`\<`"Publish"`\> - -### Upgrade() - -#### Parameters - -• **\_\_namedParameters** - -• **\_\_namedParameters.modules**: `string`[] \| `number`[][] - -• **\_\_namedParameters.dependencies**: `string`[] - -• **\_\_namedParameters.package**: `string` - -• **\_\_namedParameters.ticket**: `object` \| `object` \| `object` \| `object` - -#### Returns - -`TransactionShape`\<`"Upgrade"`\> - -### MakeMoveVec() - -#### Parameters - -• **\_\_namedParameters** - -• **\_\_namedParameters.type?**: `string` - -• **\_\_namedParameters.elements**: (`object` \| `object` \| `object` \| `object`)[] - -#### Returns - -`TransactionShape`\<`"MakeMoveVec"`\> - -### Intent() - -#### Parameters - -• **\_\_namedParameters** - -• **\_\_namedParameters.name**: `string` - -• **\_\_namedParameters.inputs?**: `Record`\<`string`, `object` \| `object` \| `object` \| `object` \| (`object` \| `object` \| `object` \| `object`)[]\> = `{}` - -• **\_\_namedParameters.data?**: `Record`\<`string`, `unknown`\> = `{}` - -#### Returns - -`TransactionShape`\<`"$Intent"`\> diff --git a/docs/content/ts-sdk/api/transactions/variables/GasData.md b/docs/content/ts-sdk/api/transactions/variables/GasData.md deleted file mode 100644 index da28ef91032..00000000000 --- a/docs/content/ts-sdk/api/transactions/variables/GasData.md +++ /dev/null @@ -1,21 +0,0 @@ -# Variable: GasData - -> `const` **GasData**: `ObjectSchema`\<`object`, `undefined`\> - -## Type declaration - -### budget - -> `readonly` **budget**: `NullableSchema`\<`SchemaWithPipe`\<[`UnionSchema`\<[`StringSchema`\<`undefined`\>, `SchemaWithPipe`\<[`NumberSchema`\<`undefined`\>, `IntegerAction`\<`number`, `undefined`\>]\>], `undefined`\>, `CheckAction`\<`string` \| `number`, `"Invalid u64"`\>]\>, `never`\> - -### price - -> `readonly` **price**: `NullableSchema`\<`SchemaWithPipe`\<[`UnionSchema`\<[`StringSchema`\<`undefined`\>, `SchemaWithPipe`\<[`NumberSchema`\<`undefined`\>, `IntegerAction`\<`number`, `undefined`\>]\>], `undefined`\>, `CheckAction`\<`string` \| `number`, `"Invalid u64"`\>]\>, `never`\> - -### owner - -> `readonly` **owner**: `NullableSchema`\<`SchemaWithPipe`\<[`StringSchema`\<`undefined`\>, `TransformAction`\<`string`, `string`\>, `CheckAction`\<`string`, `undefined`\>]\>, `never`\> - -### payment - -> `readonly` **payment**: `NullableSchema`\<`ArraySchema`\<`ObjectSchema`\<`object`, `undefined`\>, `undefined`\>, `never`\> diff --git a/docs/content/ts-sdk/api/transactions/variables/Inputs.md b/docs/content/ts-sdk/api/transactions/variables/Inputs.md deleted file mode 100644 index 57163e5994b..00000000000 --- a/docs/content/ts-sdk/api/transactions/variables/Inputs.md +++ /dev/null @@ -1,275 +0,0 @@ -# Variable: Inputs - -> `const` **Inputs**: `object` - -## Type declaration - -### Pure() - -> **Pure**: (`data`) => `Extract`\<[`CallArg`](../type-aliases/CallArg.md), `object`\> - -#### Parameters - -• **data**: `Uint8Array` \| `SerializedBcs`\<`any`, `any`\> - -#### Returns - -`Extract`\<[`CallArg`](../type-aliases/CallArg.md), `object`\> - -### ObjectRef() - -#### Parameters - -• **\_\_namedParameters** - -• **\_\_namedParameters.objectId**: `string` - -• **\_\_namedParameters.version**: `string` \| `number` - -• **\_\_namedParameters.digest**: `string` - -#### Returns - -`object` - -##### Pure - -> **Pure**: `undefined` - -##### UnresolvedPure - -> **UnresolvedPure**: `undefined` - -##### UnresolvedObject - -> **UnresolvedObject**: `undefined` - -##### $kind - -> **$kind**: `"Object"` - -##### Object - -> **Object**: `EnumOutputShapeWithKeys`\<`object`, `"ImmOrOwnedObject"` \| `"SharedObject"` \| `"Receiving"`\> = `ObjectArg` - -###### Type declaration - -###### ImmOrOwnedObject - -> **ImmOrOwnedObject**: `object` = `ObjectRef` - -###### ImmOrOwnedObject.objectId - -> **objectId**: `string` = `IotaAddress` - -###### ImmOrOwnedObject.version - -> **version**: `string` \| `number` = `JsonU64` - -###### ImmOrOwnedObject.digest - -> **digest**: `string` - -###### SharedObject - -> **SharedObject**: `object` - -###### SharedObject.objectId - -> **objectId**: `string` = `ObjectID` - -###### SharedObject.initialSharedVersion - -> **initialSharedVersion**: `string` \| `number` = `JsonU64` - -###### SharedObject.mutable - -> **mutable**: `boolean` - -###### Receiving - -> **Receiving**: `object` = `ObjectRef` - -###### Receiving.objectId - -> **objectId**: `string` = `IotaAddress` - -###### Receiving.version - -> **version**: `string` \| `number` = `JsonU64` - -###### Receiving.digest - -> **digest**: `string` - -### SharedObjectRef() - -#### Parameters - -• **\_\_namedParameters** - -• **\_\_namedParameters.objectId**: `string` - -• **\_\_namedParameters.mutable**: `boolean` - -• **\_\_namedParameters.initialSharedVersion**: `string` \| `number` - -#### Returns - -`object` - -##### Pure - -> **Pure**: `undefined` - -##### UnresolvedPure - -> **UnresolvedPure**: `undefined` - -##### UnresolvedObject - -> **UnresolvedObject**: `undefined` - -##### $kind - -> **$kind**: `"Object"` - -##### Object - -> **Object**: `EnumOutputShapeWithKeys`\<`object`, `"ImmOrOwnedObject"` \| `"SharedObject"` \| `"Receiving"`\> = `ObjectArg` - -###### Type declaration - -###### ImmOrOwnedObject - -> **ImmOrOwnedObject**: `object` = `ObjectRef` - -###### ImmOrOwnedObject.objectId - -> **objectId**: `string` = `IotaAddress` - -###### ImmOrOwnedObject.version - -> **version**: `string` \| `number` = `JsonU64` - -###### ImmOrOwnedObject.digest - -> **digest**: `string` - -###### SharedObject - -> **SharedObject**: `object` - -###### SharedObject.objectId - -> **objectId**: `string` = `ObjectID` - -###### SharedObject.initialSharedVersion - -> **initialSharedVersion**: `string` \| `number` = `JsonU64` - -###### SharedObject.mutable - -> **mutable**: `boolean` - -###### Receiving - -> **Receiving**: `object` = `ObjectRef` - -###### Receiving.objectId - -> **objectId**: `string` = `IotaAddress` - -###### Receiving.version - -> **version**: `string` \| `number` = `JsonU64` - -###### Receiving.digest - -> **digest**: `string` - -### ReceivingRef() - -#### Parameters - -• **\_\_namedParameters** - -• **\_\_namedParameters.objectId**: `string` - -• **\_\_namedParameters.version**: `string` \| `number` - -• **\_\_namedParameters.digest**: `string` - -#### Returns - -`object` - -##### Pure - -> **Pure**: `undefined` - -##### UnresolvedPure - -> **UnresolvedPure**: `undefined` - -##### UnresolvedObject - -> **UnresolvedObject**: `undefined` - -##### $kind - -> **$kind**: `"Object"` - -##### Object - -> **Object**: `EnumOutputShapeWithKeys`\<`object`, `"ImmOrOwnedObject"` \| `"SharedObject"` \| `"Receiving"`\> = `ObjectArg` - -###### Type declaration - -###### ImmOrOwnedObject - -> **ImmOrOwnedObject**: `object` = `ObjectRef` - -###### ImmOrOwnedObject.objectId - -> **objectId**: `string` = `IotaAddress` - -###### ImmOrOwnedObject.version - -> **version**: `string` \| `number` = `JsonU64` - -###### ImmOrOwnedObject.digest - -> **digest**: `string` - -###### SharedObject - -> **SharedObject**: `object` - -###### SharedObject.objectId - -> **objectId**: `string` = `ObjectID` - -###### SharedObject.initialSharedVersion - -> **initialSharedVersion**: `string` \| `number` = `JsonU64` - -###### SharedObject.mutable - -> **mutable**: `boolean` - -###### Receiving - -> **Receiving**: `object` = `ObjectRef` - -###### Receiving.objectId - -> **objectId**: `string` = `IotaAddress` - -###### Receiving.version - -> **version**: `string` \| `number` = `JsonU64` - -###### Receiving.digest - -> **digest**: `string` diff --git a/docs/content/ts-sdk/api/transactions/variables/ObjectRef.md b/docs/content/ts-sdk/api/transactions/variables/ObjectRef.md deleted file mode 100644 index faaf4bcb02e..00000000000 --- a/docs/content/ts-sdk/api/transactions/variables/ObjectRef.md +++ /dev/null @@ -1,17 +0,0 @@ -# Variable: ObjectRef - -> `const` **ObjectRef**: `ObjectSchema`\<`object`, `undefined`\> - -## Type declaration - -### objectId - -> `readonly` **objectId**: `SchemaWithPipe`\<[`StringSchema`\<`undefined`\>, `TransformAction`\<`string`, `string`\>, `CheckAction`\<`string`, `undefined`\>]\> = `IotaAddress` - -### version - -> `readonly` **version**: `SchemaWithPipe`\<[`UnionSchema`\<[`StringSchema`\<`undefined`\>, `SchemaWithPipe`\<[`NumberSchema`\<`undefined`\>, `IntegerAction`\<`number`, `undefined`\>]\>], `undefined`\>, `CheckAction`\<`string` \| `number`, `"Invalid u64"`\>]\> = `JsonU64` - -### digest - -> `readonly` **digest**: `StringSchema`\<`undefined`\> diff --git a/docs/content/ts-sdk/api/transactions/variables/OpenMoveTypeSignature.md b/docs/content/ts-sdk/api/transactions/variables/OpenMoveTypeSignature.md deleted file mode 100644 index 4f23fe77bc8..00000000000 --- a/docs/content/ts-sdk/api/transactions/variables/OpenMoveTypeSignature.md +++ /dev/null @@ -1,13 +0,0 @@ -# Variable: OpenMoveTypeSignature - -> `const` **OpenMoveTypeSignature**: `ObjectSchema`\<`object`, `undefined`\> - -## Type declaration - -### ref - -> `readonly` **ref**: `NullableSchema`\<`UnionSchema`\<[`LiteralSchema`\<`"&"`, `undefined`\>, `LiteralSchema`\<`"&mut"`, `undefined`\>], `undefined`\>, `never`\> - -### body - -> `readonly` **body**: `GenericSchema`\<[`OpenMoveTypeSignatureBody`](../type-aliases/OpenMoveTypeSignatureBody.md), [`OpenMoveTypeSignatureBody`](../type-aliases/OpenMoveTypeSignatureBody.md), `BaseIssue`\<`unknown`\>\> = `OpenMoveTypeSignatureBody` diff --git a/docs/content/ts-sdk/api/transactions/variables/OpenMoveTypeSignatureBody.md b/docs/content/ts-sdk/api/transactions/variables/OpenMoveTypeSignatureBody.md deleted file mode 100644 index 1ddca2645fd..00000000000 --- a/docs/content/ts-sdk/api/transactions/variables/OpenMoveTypeSignatureBody.md +++ /dev/null @@ -1,3 +0,0 @@ -# Variable: OpenMoveTypeSignatureBody - -> **OpenMoveTypeSignatureBody**: `GenericSchema`\<[`OpenMoveTypeSignatureBody`](../type-aliases/OpenMoveTypeSignatureBody.md), [`OpenMoveTypeSignatureBody`](../type-aliases/OpenMoveTypeSignatureBody.md), `BaseIssue`\<`unknown`\>\> diff --git a/docs/content/ts-sdk/api/transactions/variables/SerializedTransactionDataV1.md b/docs/content/ts-sdk/api/transactions/variables/SerializedTransactionDataV1.md deleted file mode 100644 index 6a27477a35a..00000000000 --- a/docs/content/ts-sdk/api/transactions/variables/SerializedTransactionDataV1.md +++ /dev/null @@ -1,47 +0,0 @@ -# Variable: SerializedTransactionDataV1 - -> `const` **SerializedTransactionDataV1**: `ObjectSchema`\<`object`, `undefined`\> - -## Type declaration - -### version - -> `readonly` **version**: `LiteralSchema`\<`1`, `undefined`\> - -### sender - -> `readonly` **sender**: `OptionalSchema`\<`StringSchema`\<`undefined`\>, `never`\> - -### expiration - -> `readonly` **expiration**: `NullishSchema`\<`UnionSchema`\<[`ObjectSchema`\<`object`, `undefined`\>, `ObjectSchema`\<`object`, `undefined`\>], `undefined`\>, `never`\> - -### gasConfig - -> `readonly` **gasConfig**: `ObjectSchema`\<`object`, `undefined`\> = `GasConfig` - -#### Type declaration - -##### budget - -> `readonly` **budget**: `OptionalSchema`\<`SchemaWithPipe`\<[`UnionSchema`\<[`NumberSchema`\<`undefined`\>, `StringSchema`\<`undefined`\>, `BigintSchema`\<`undefined`\>], `undefined`\>, `CheckAction`\<`string` \| `number` \| `bigint`, `undefined`\>]\>, `never`\> - -##### price - -> `readonly` **price**: `OptionalSchema`\<`SchemaWithPipe`\<[`UnionSchema`\<[`NumberSchema`\<`undefined`\>, `StringSchema`\<`undefined`\>, `BigintSchema`\<`undefined`\>], `undefined`\>, `CheckAction`\<`string` \| `number` \| `bigint`, `undefined`\>]\>, `never`\> - -##### payment - -> `readonly` **payment**: `OptionalSchema`\<`ArraySchema`\<`ObjectSchema`\<`object`, `undefined`\>, `undefined`\>, `never`\> - -##### owner - -> `readonly` **owner**: `OptionalSchema`\<`StringSchema`\<`undefined`\>, `never`\> - -### inputs - -> `readonly` **inputs**: `ArraySchema`\<`UnionSchema`\<[`ObjectSchema`\<`object`, `undefined`\>, `ObjectSchema`\<`object`, `undefined`\>], `undefined`\>, `undefined`\> - -### transactions - -> `readonly` **transactions**: `ArraySchema`\<`UnionSchema`\<[`ObjectSchema`\<`object`, `undefined`\>, `ObjectSchema`\<`object`, `undefined`\>, `ObjectSchema`\<`object`, `undefined`\>], `undefined`\>, `undefined`\> diff --git a/docs/content/ts-sdk/api/transactions/variables/SerializedTransactionDataV2.md b/docs/content/ts-sdk/api/transactions/variables/SerializedTransactionDataV2.md deleted file mode 100644 index a84362cbe02..00000000000 --- a/docs/content/ts-sdk/api/transactions/variables/SerializedTransactionDataV2.md +++ /dev/null @@ -1,47 +0,0 @@ -# Variable: SerializedTransactionDataV2 - -> `const` **SerializedTransactionDataV2**: `ObjectSchema`\<`object`, `undefined`\> - -## Type declaration - -### version - -> `readonly` **version**: `LiteralSchema`\<`2`, `undefined`\> - -### sender - -> `readonly` **sender**: `NullishSchema`\<`SchemaWithPipe`\<[`StringSchema`\<`undefined`\>, `TransformAction`\<`string`, `string`\>, `CheckAction`\<`string`, `undefined`\>]\>, `never`\> - -### expiration - -> `readonly` **expiration**: `NullishSchema`\<`GenericSchema`\<`EnumInputShape`\<`object`\>, `EnumInputShape`\<`object`\>, `BaseIssue`\<`unknown`\>\>, `never`\> - -### gasData - -> `readonly` **gasData**: `ObjectSchema`\<`object`, `undefined`\> = `GasData` - -#### Type declaration - -##### budget - -> `readonly` **budget**: `NullableSchema`\<`SchemaWithPipe`\<[`UnionSchema`\<[`StringSchema`\<`undefined`\>, `SchemaWithPipe`\<[..., ...]\>], `undefined`\>, `CheckAction`\<`string` \| `number`, `"Invalid u64"`\>]\>, `never`\> - -##### price - -> `readonly` **price**: `NullableSchema`\<`SchemaWithPipe`\<[`UnionSchema`\<[`StringSchema`\<`undefined`\>, `SchemaWithPipe`\<[..., ...]\>], `undefined`\>, `CheckAction`\<`string` \| `number`, `"Invalid u64"`\>]\>, `never`\> - -##### owner - -> `readonly` **owner**: `NullableSchema`\<`SchemaWithPipe`\<[`StringSchema`\<`undefined`\>, `TransformAction`\<`string`, `string`\>, `CheckAction`\<`string`, `undefined`\>]\>, `never`\> - -##### payment - -> `readonly` **payment**: `NullableSchema`\<`ArraySchema`\<`ObjectSchema`\<`object`, `undefined`\>, `undefined`\>, `never`\> - -### inputs - -> `readonly` **inputs**: `ArraySchema`\<`GenericSchema`\<`EnumInputShape`\<`object`\>, `EnumInputShape`\<`object`\>, `BaseIssue`\<`unknown`\>\>, `undefined`\> - -### commands - -> `readonly` **commands**: `ArraySchema`\<`GenericSchema`\<`EnumInputShape`\<`object`\>, `EnumInputShape`\<`object`\>, `BaseIssue`\<`unknown`\>\>, `undefined`\> diff --git a/docs/content/ts-sdk/api/transactions/variables/TransactionData.md b/docs/content/ts-sdk/api/transactions/variables/TransactionData.md deleted file mode 100644 index c200a513e2c..00000000000 --- a/docs/content/ts-sdk/api/transactions/variables/TransactionData.md +++ /dev/null @@ -1,47 +0,0 @@ -# Variable: TransactionData - -> `const` **TransactionData**: `ObjectSchema`\<`object`, `undefined`\> - -## Type declaration - -### version - -> `readonly` **version**: `LiteralSchema`\<`2`, `undefined`\> - -### sender - -> `readonly` **sender**: `NullishSchema`\<`SchemaWithPipe`\<[`StringSchema`\<`undefined`\>, `TransformAction`\<`string`, `string`\>, `CheckAction`\<`string`, `undefined`\>]\>, `never`\> - -### expiration - -> `readonly` **expiration**: `NullishSchema`\<`EnumSchema`\<`object`\>, `never`\> - -### gasData - -> `readonly` **gasData**: `ObjectSchema`\<`object`, `undefined`\> = `GasData` - -#### Type declaration - -##### budget - -> `readonly` **budget**: `NullableSchema`\<`SchemaWithPipe`\<[`UnionSchema`\<[`StringSchema`\<`undefined`\>, `SchemaWithPipe`\<[..., ...]\>], `undefined`\>, `CheckAction`\<`string` \| `number`, `"Invalid u64"`\>]\>, `never`\> - -##### price - -> `readonly` **price**: `NullableSchema`\<`SchemaWithPipe`\<[`UnionSchema`\<[`StringSchema`\<`undefined`\>, `SchemaWithPipe`\<[..., ...]\>], `undefined`\>, `CheckAction`\<`string` \| `number`, `"Invalid u64"`\>]\>, `never`\> - -##### owner - -> `readonly` **owner**: `NullableSchema`\<`SchemaWithPipe`\<[`StringSchema`\<`undefined`\>, `TransformAction`\<`string`, `string`\>, `CheckAction`\<`string`, `undefined`\>]\>, `never`\> - -##### payment - -> `readonly` **payment**: `NullableSchema`\<`ArraySchema`\<`ObjectSchema`\<`object`, `undefined`\>, `undefined`\>, `never`\> - -### inputs - -> `readonly` **inputs**: `ArraySchema`\<`EnumSchema`\<`object`\>, `undefined`\> - -### commands - -> `readonly` **commands**: `ArraySchema`\<`EnumSchema`\<`object`\>, `undefined`\> diff --git a/docs/content/ts-sdk/api/typedoc-sidebar.cjs b/docs/content/ts-sdk/api/typedoc-sidebar.cjs deleted file mode 100644 index d25f7121036..00000000000 --- a/docs/content/ts-sdk/api/typedoc-sidebar.cjs +++ /dev/null @@ -1,4 +0,0 @@ -// @ts-check -/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ -const typedocSidebar = { items: [{"type":"category","label":"bcs","items":[{"type":"category","label":"Classes","items":[{"type":"doc","id":"references/ts-sdk/api/bcs/classes/BcsType","label":"BcsType"},{"type":"doc","id":"references/ts-sdk/api/bcs/classes/TypeTagSerializer","label":"TypeTagSerializer"}]},{"type":"category","label":"Interfaces","items":[{"type":"doc","id":"references/ts-sdk/api/bcs/interfaces/BcsTypeOptions","label":"BcsTypeOptions"}]},{"type":"category","label":"Type Aliases","items":[{"type":"doc","id":"references/ts-sdk/api/bcs/type-aliases/TypeTag","label":"TypeTag"}]},{"type":"category","label":"Variables","items":[{"type":"doc","id":"references/ts-sdk/api/bcs/variables/bcs","label":"bcs"}]}],"link":{"type":"doc","id":"references/ts-sdk/api/bcs/index"}},{"type":"category","label":"client","items":[{"type":"category","label":"Enumerations","items":[{"type":"doc","id":"references/ts-sdk/api/client/enumerations/Network","label":"Network"}]},{"type":"category","label":"Classes","items":[{"type":"doc","id":"references/ts-sdk/api/client/classes/IotaClient","label":"IotaClient"},{"type":"doc","id":"references/ts-sdk/api/client/classes/IotaHTTPTransportError","label":"IotaHTTPTransportError"},{"type":"doc","id":"references/ts-sdk/api/client/classes/JsonRpcError","label":"JsonRpcError"},{"type":"doc","id":"references/ts-sdk/api/client/classes/IotaHTTPStatusError","label":"IotaHTTPStatusError"},{"type":"doc","id":"references/ts-sdk/api/client/classes/IotaHTTPTransport","label":"IotaHTTPTransport"}]},{"type":"category","label":"Interfaces","items":[{"type":"doc","id":"references/ts-sdk/api/client/interfaces/PaginationArguments","label":"PaginationArguments"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/OrderArguments","label":"OrderArguments"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/IotaHTTPTransportOptions","label":"IotaHTTPTransportOptions"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/IotaTransportRequestOptions","label":"IotaTransportRequestOptions"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/IotaTransportSubscribeOptions","label":"IotaTransportSubscribeOptions"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/IotaTransport","label":"IotaTransport"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/NetworkConfiguration","label":"NetworkConfiguration"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/KioskConfiguration","label":"KioskConfiguration"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/AddressMetrics","label":"AddressMetrics"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/Balance","label":"Balance"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/BalanceChange","label":"BalanceChange"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/Checkpoint","label":"Checkpoint"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/Claim","label":"Claim"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/CoinStruct","label":"CoinStruct"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/CommitteeInfo","label":"CommitteeInfo"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/DelegatedStake","label":"DelegatedStake"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/DelegatedTimelockedStake","label":"DelegatedTimelockedStake"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/DevInspectArgs","label":"DevInspectArgs"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/DevInspectResults","label":"DevInspectResults"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/DisplayFieldsResponse","label":"DisplayFieldsResponse"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/DryRunTransactionBlockResponse","label":"DryRunTransactionBlockResponse"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/DynamicFieldInfo","label":"DynamicFieldInfo"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/DynamicFieldName","label":"DynamicFieldName"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/ECMHLiveObjectSetDigest","label":"ECMHLiveObjectSetDigest"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/EndOfEpochData","label":"EndOfEpochData"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/EndOfEpochInfo","label":"EndOfEpochInfo"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/EpochInfo","label":"EpochInfo"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/EpochMetrics","label":"EpochMetrics"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/IotaEvent","label":"IotaEvent"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/EventId","label":"EventId"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/GasCostSummary","label":"GasCostSummary"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/IotaGasData","label":"IotaGasData"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/GetPastObjectRequest","label":"GetPastObjectRequest"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/IotaActiveJwk","label":"IotaActiveJwk"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/IotaAuthenticatorStateExpire","label":"IotaAuthenticatorStateExpire"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/IotaChangeEpoch","label":"IotaChangeEpoch"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/CoinMetadata","label":"CoinMetadata"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/IotaExecutionResult","label":"IotaExecutionResult"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/IotaJWK","label":"IotaJWK"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/IotaJwkId","label":"IotaJwkId"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/IotaMoveAbilitySet","label":"IotaMoveAbilitySet"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/IotaMoveModuleId","label":"IotaMoveModuleId"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/IotaMoveNormalizedField","label":"IotaMoveNormalizedField"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/IotaMoveNormalizedFunction","label":"IotaMoveNormalizedFunction"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/IotaMoveNormalizedModule","label":"IotaMoveNormalizedModule"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/IotaMoveNormalizedStruct","label":"IotaMoveNormalizedStruct"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/IotaMoveStructTypeParameter","label":"IotaMoveStructTypeParameter"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/IotaObjectResponse","label":"IotaObjectResponse"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/MoveCallIotaTransaction","label":"MoveCallIotaTransaction"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/IotaSystemStateSummary","label":"IotaSystemStateSummary"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/IotaValidatorSummary","label":"IotaValidatorSummary"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/MoveCallMetrics","label":"MoveCallMetrics"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/MoveCallParams","label":"MoveCallParams"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/MoveFunctionName","label":"MoveFunctionName"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/MoveVariant","label":"MoveVariant"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/MultiSig","label":"MultiSig"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/MultiSigPublicKey","label":"MultiSigPublicKey"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/NetworkMetrics","label":"NetworkMetrics"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/IotaObjectData","label":"IotaObjectData"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/IotaObjectDataOptions","label":"IotaObjectDataOptions"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/IotaObjectRef","label":"IotaObjectRef"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/IotaObjectResponseQuery","label":"IotaObjectResponseQuery"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/OwnedObjectRef","label":"OwnedObjectRef"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/PaginatedCheckpoints","label":"PaginatedCheckpoints"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/PaginatedCoins","label":"PaginatedCoins"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/PaginatedDynamicFieldInfos","label":"PaginatedDynamicFieldInfos"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/PaginatedEpochInfos","label":"PaginatedEpochInfos"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/PaginatedEpochMetricss","label":"PaginatedEpochMetricss"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/PaginatedEvents","label":"PaginatedEvents"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/PaginatedObjectsResponse","label":"PaginatedObjectsResponse"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/PaginatedTransactionResponse","label":"PaginatedTransactionResponse"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/PasskeyAuthenticator","label":"PasskeyAuthenticator"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/ProtocolConfig","label":"ProtocolConfig"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/CoinSupply","label":"CoinSupply"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/IotaTransactionBlock","label":"IotaTransactionBlock"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/TransactionBlockBytes","label":"TransactionBlockBytes"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/TransactionBlockEffectsModifiedAtVersions","label":"TransactionBlockEffectsModifiedAtVersions"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/IotaTransactionBlockResponse","label":"IotaTransactionBlockResponse"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/IotaTransactionBlockResponseOptions","label":"IotaTransactionBlockResponseOptions"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/IotaTransactionBlockResponseQuery","label":"IotaTransactionBlockResponseQuery"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/TransferObjectParams","label":"TransferObjectParams"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/TypeOrigin","label":"TypeOrigin"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/UpgradeInfo","label":"UpgradeInfo"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/ValidatorApy","label":"ValidatorApy"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/ValidatorsApy","label":"ValidatorsApy"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/ZkLoginAuthenticator","label":"ZkLoginAuthenticator"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/ZkLoginInputs","label":"ZkLoginInputs"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/ZkLoginProof","label":"ZkLoginProof"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/DevInspectTransactionBlockParams","label":"DevInspectTransactionBlockParams"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/DryRunTransactionBlockParams","label":"DryRunTransactionBlockParams"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/ExecuteTransactionBlockParams","label":"ExecuteTransactionBlockParams"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/GetChainIdentifierParams","label":"GetChainIdentifierParams"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/GetCheckpointParams","label":"GetCheckpointParams"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/GetCheckpointsParams","label":"GetCheckpointsParams"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/GetEventsParams","label":"GetEventsParams"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/GetLatestCheckpointSequenceNumberParams","label":"GetLatestCheckpointSequenceNumberParams"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/GetMoveFunctionArgTypesParams","label":"GetMoveFunctionArgTypesParams"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/GetNormalizedMoveFunctionParams","label":"GetNormalizedMoveFunctionParams"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/GetNormalizedMoveModuleParams","label":"GetNormalizedMoveModuleParams"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/GetNormalizedMoveModulesByPackageParams","label":"GetNormalizedMoveModulesByPackageParams"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/GetNormalizedMoveStructParams","label":"GetNormalizedMoveStructParams"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/GetObjectParams","label":"GetObjectParams"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/GetProtocolConfigParams","label":"GetProtocolConfigParams"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/GetTotalTransactionBlocksParams","label":"GetTotalTransactionBlocksParams"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/GetTransactionBlockParams","label":"GetTransactionBlockParams"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/MultiGetObjectsParams","label":"MultiGetObjectsParams"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/MultiGetTransactionBlocksParams","label":"MultiGetTransactionBlocksParams"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/TryGetPastObjectParams","label":"TryGetPastObjectParams"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/TryMultiGetPastObjectsParams","label":"TryMultiGetPastObjectsParams"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/GetAllBalancesParams","label":"GetAllBalancesParams"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/GetAllCoinsParams","label":"GetAllCoinsParams"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/GetAllEpochAddressMetricsParams","label":"GetAllEpochAddressMetricsParams"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/GetBalanceParams","label":"GetBalanceParams"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/GetCheckpointAddressMetricsParams","label":"GetCheckpointAddressMetricsParams"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/GetCoinMetadataParams","label":"GetCoinMetadataParams"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/GetCoinsParams","label":"GetCoinsParams"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/GetCommitteeInfoParams","label":"GetCommitteeInfoParams"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/GetCurrentEpochParams","label":"GetCurrentEpochParams"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/GetDynamicFieldObjectParams","label":"GetDynamicFieldObjectParams"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/GetDynamicFieldsParams","label":"GetDynamicFieldsParams"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/GetEpochMetricsParams","label":"GetEpochMetricsParams"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/GetEpochsParams","label":"GetEpochsParams"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/GetLatestAddressMetricsParams","label":"GetLatestAddressMetricsParams"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/GetLatestIotaSystemStateParams","label":"GetLatestIotaSystemStateParams"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/GetMoveCallMetricsParams","label":"GetMoveCallMetricsParams"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/GetNetworkMetricsParams","label":"GetNetworkMetricsParams"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/GetReferenceGasPriceParams","label":"GetReferenceGasPriceParams"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/GetStakesParams","label":"GetStakesParams"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/GetStakesByIdsParams","label":"GetStakesByIdsParams"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/GetTimelockedStakesParams","label":"GetTimelockedStakesParams"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/GetTimelockedStakesByIdsParams","label":"GetTimelockedStakesByIdsParams"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/GetTotalSupplyParams","label":"GetTotalSupplyParams"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/GetTotalTransactionsParams","label":"GetTotalTransactionsParams"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/GetValidatorsApyParams","label":"GetValidatorsApyParams"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/QueryEventsParams","label":"QueryEventsParams"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/SubscribeEventParams","label":"SubscribeEventParams"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/SubscribeTransactionParams","label":"SubscribeTransactionParams"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/UnsafeBatchTransactionParams","label":"UnsafeBatchTransactionParams"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/UnsafeMergeCoinsParams","label":"UnsafeMergeCoinsParams"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/UnsafeMoveCallParams","label":"UnsafeMoveCallParams"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/UnsafePayParams","label":"UnsafePayParams"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/UnsafePayAllIotaParams","label":"UnsafePayAllIotaParams"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/UnsafePayIotaParams","label":"UnsafePayIotaParams"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/UnsafePublishParams","label":"UnsafePublishParams"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/UnsafeRequestAddStakeParams","label":"UnsafeRequestAddStakeParams"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/UnsafeRequestAddTimelockedStakeParams","label":"UnsafeRequestAddTimelockedStakeParams"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/UnsafeRequestWithdrawStakeParams","label":"UnsafeRequestWithdrawStakeParams"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/UnsafeRequestWithdrawTimelockedStakeParams","label":"UnsafeRequestWithdrawTimelockedStakeParams"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/UnsafeSplitCoinParams","label":"UnsafeSplitCoinParams"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/UnsafeSplitCoinEqualParams","label":"UnsafeSplitCoinEqualParams"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/UnsafeTransferIotaParams","label":"UnsafeTransferIotaParams"},{"type":"doc","id":"references/ts-sdk/api/client/interfaces/UnsafeTransferObjectParams","label":"UnsafeTransferObjectParams"}]},{"type":"category","label":"Type Aliases","items":[{"type":"doc","id":"references/ts-sdk/api/client/type-aliases/IotaClientOptions","label":"IotaClientOptions"},{"type":"doc","id":"references/ts-sdk/api/client/type-aliases/HttpHeaders","label":"HttpHeaders"},{"type":"doc","id":"references/ts-sdk/api/client/type-aliases/NetworkId","label":"NetworkId"},{"type":"doc","id":"references/ts-sdk/api/client/type-aliases/ChainType","label":"ChainType"},{"type":"doc","id":"references/ts-sdk/api/client/type-aliases/EpochPage","label":"EpochPage"},{"type":"doc","id":"references/ts-sdk/api/client/type-aliases/EpochMetricsPage","label":"EpochMetricsPage"},{"type":"doc","id":"references/ts-sdk/api/client/type-aliases/CheckpointPage","label":"CheckpointPage"},{"type":"doc","id":"references/ts-sdk/api/client/type-aliases/AllEpochsAddressMetrics","label":"AllEpochsAddressMetrics"},{"type":"doc","id":"references/ts-sdk/api/client/type-aliases/MoveCallMetric","label":"MoveCallMetric"},{"type":"doc","id":"references/ts-sdk/api/client/type-aliases/DynamicFieldPage","label":"DynamicFieldPage"},{"type":"doc","id":"references/ts-sdk/api/client/type-aliases/IotaMoveNormalizedModules","label":"IotaMoveNormalizedModules"},{"type":"doc","id":"references/ts-sdk/api/client/type-aliases/IotaMoveObject","label":"IotaMoveObject"},{"type":"doc","id":"references/ts-sdk/api/client/type-aliases/IotaMovePackage","label":"IotaMovePackage"},{"type":"doc","id":"references/ts-sdk/api/client/type-aliases/ProgrammableTransaction","label":"ProgrammableTransaction"},{"type":"doc","id":"references/ts-sdk/api/client/type-aliases/IotaObjectChangePublished","label":"IotaObjectChangePublished"},{"type":"doc","id":"references/ts-sdk/api/client/type-aliases/IotaObjectChangeTransferred","label":"IotaObjectChangeTransferred"},{"type":"doc","id":"references/ts-sdk/api/client/type-aliases/IotaObjectChangeMutated","label":"IotaObjectChangeMutated"},{"type":"doc","id":"references/ts-sdk/api/client/type-aliases/IotaObjectChangeDeleted","label":"IotaObjectChangeDeleted"},{"type":"doc","id":"references/ts-sdk/api/client/type-aliases/IotaObjectChangeWrapped","label":"IotaObjectChangeWrapped"},{"type":"doc","id":"references/ts-sdk/api/client/type-aliases/IotaObjectChangeCreated","label":"IotaObjectChangeCreated"},{"type":"doc","id":"references/ts-sdk/api/client/type-aliases/CoinBalance","label":"CoinBalance"},{"type":"doc","id":"references/ts-sdk/api/client/type-aliases/Order","label":"Order"},{"type":"doc","id":"references/ts-sdk/api/client/type-aliases/Unsubscribe","label":"Unsubscribe"},{"type":"doc","id":"references/ts-sdk/api/client/type-aliases/CheckpointCommitment","label":"CheckpointCommitment"},{"type":"doc","id":"references/ts-sdk/api/client/type-aliases/CheckpointId","label":"CheckpointId"},{"type":"doc","id":"references/ts-sdk/api/client/type-aliases/CompressedSignature","label":"CompressedSignature"},{"type":"doc","id":"references/ts-sdk/api/client/type-aliases/ConsensusDeterminedVersionAssignments","label":"ConsensusDeterminedVersionAssignments"},{"type":"doc","id":"references/ts-sdk/api/client/type-aliases/IotaParsedData","label":"IotaParsedData"},{"type":"doc","id":"references/ts-sdk/api/client/type-aliases/DynamicFieldType","label":"DynamicFieldType"},{"type":"doc","id":"references/ts-sdk/api/client/type-aliases/IotaEventFilter","label":"IotaEventFilter"},{"type":"doc","id":"references/ts-sdk/api/client/type-aliases/ExecuteTransactionRequestType","label":"ExecuteTransactionRequestType"},{"type":"doc","id":"references/ts-sdk/api/client/type-aliases/ExecutionStatus","label":"ExecutionStatus"},{"type":"doc","id":"references/ts-sdk/api/client/type-aliases/InputObjectKind","label":"InputObjectKind"},{"type":"doc","id":"references/ts-sdk/api/client/type-aliases/IotaArgument","label":"IotaArgument"},{"type":"doc","id":"references/ts-sdk/api/client/type-aliases/IotaCallArg","label":"IotaCallArg"},{"type":"doc","id":"references/ts-sdk/api/client/type-aliases/IotaEndOfEpochTransactionKind","label":"IotaEndOfEpochTransactionKind"},{"type":"doc","id":"references/ts-sdk/api/client/type-aliases/IotaMoveAbility","label":"IotaMoveAbility"},{"type":"doc","id":"references/ts-sdk/api/client/type-aliases/IotaMoveNormalizedType","label":"IotaMoveNormalizedType"},{"type":"doc","id":"references/ts-sdk/api/client/type-aliases/IotaMoveVisibility","label":"IotaMoveVisibility"},{"type":"doc","id":"references/ts-sdk/api/client/type-aliases/IotaObjectDataFilter","label":"IotaObjectDataFilter"},{"type":"doc","id":"references/ts-sdk/api/client/type-aliases/IotaTransaction","label":"IotaTransaction"},{"type":"doc","id":"references/ts-sdk/api/client/type-aliases/IotaTransactionBlockBuilderMode","label":"IotaTransactionBlockBuilderMode"},{"type":"doc","id":"references/ts-sdk/api/client/type-aliases/IotaMoveFunctionArgType","label":"IotaMoveFunctionArgType"},{"type":"doc","id":"references/ts-sdk/api/client/type-aliases/MoveStruct","label":"MoveStruct"},{"type":"doc","id":"references/ts-sdk/api/client/type-aliases/MoveValue","label":"MoveValue"},{"type":"doc","id":"references/ts-sdk/api/client/type-aliases/IotaObjectChange","label":"IotaObjectChange"},{"type":"doc","id":"references/ts-sdk/api/client/type-aliases/ObjectRead","label":"ObjectRead"},{"type":"doc","id":"references/ts-sdk/api/client/type-aliases/ObjectResponseError","label":"ObjectResponseError"},{"type":"doc","id":"references/ts-sdk/api/client/type-aliases/ObjectValueKind","label":"ObjectValueKind"},{"type":"doc","id":"references/ts-sdk/api/client/type-aliases/ObjectOwner","label":"ObjectOwner"},{"type":"doc","id":"references/ts-sdk/api/client/type-aliases/ProtocolConfigValue","label":"ProtocolConfigValue"},{"type":"doc","id":"references/ts-sdk/api/client/type-aliases/PublicKey","label":"PublicKey"},{"type":"doc","id":"references/ts-sdk/api/client/type-aliases/RPCTransactionRequestParams","label":"RPCTransactionRequestParams"},{"type":"doc","id":"references/ts-sdk/api/client/type-aliases/RawData","label":"RawData"},{"type":"doc","id":"references/ts-sdk/api/client/type-aliases/Signature","label":"Signature"},{"type":"doc","id":"references/ts-sdk/api/client/type-aliases/StakeObject","label":"StakeObject"},{"type":"doc","id":"references/ts-sdk/api/client/type-aliases/TimelockedStake","label":"TimelockedStake"},{"type":"doc","id":"references/ts-sdk/api/client/type-aliases/TransactionBlockData","label":"TransactionBlockData"},{"type":"doc","id":"references/ts-sdk/api/client/type-aliases/TransactionEffects","label":"TransactionEffects"},{"type":"doc","id":"references/ts-sdk/api/client/type-aliases/IotaTransactionBlockKind","label":"IotaTransactionBlockKind"},{"type":"doc","id":"references/ts-sdk/api/client/type-aliases/TransactionFilter","label":"TransactionFilter"},{"type":"doc","id":"references/ts-sdk/api/client/type-aliases/GetOwnedObjectsParams","label":"GetOwnedObjectsParams"},{"type":"doc","id":"references/ts-sdk/api/client/type-aliases/QueryTransactionBlocksParams","label":"QueryTransactionBlocksParams"}]},{"type":"category","label":"Functions","items":[{"type":"doc","id":"references/ts-sdk/api/client/functions/getAppsBackend","label":"getAppsBackend"},{"type":"doc","id":"references/ts-sdk/api/client/functions/isIotaClient","label":"isIotaClient"},{"type":"doc","id":"references/ts-sdk/api/client/functions/getAllNetworks","label":"getAllNetworks"},{"type":"doc","id":"references/ts-sdk/api/client/functions/getNetwork","label":"getNetwork"},{"type":"doc","id":"references/ts-sdk/api/client/functions/getDefaultNetwork","label":"getDefaultNetwork"},{"type":"doc","id":"references/ts-sdk/api/client/functions/getFullnodeUrl","label":"getFullnodeUrl"}]}],"link":{"type":"doc","id":"references/ts-sdk/api/client/index"}},{"type":"category","label":"cryptography","items":[{"type":"category","label":"Classes","items":[{"type":"doc","id":"references/ts-sdk/api/cryptography/classes/Signer","label":"Signer"},{"type":"doc","id":"references/ts-sdk/api/cryptography/classes/Keypair","label":"Keypair"},{"type":"doc","id":"references/ts-sdk/api/cryptography/classes/PublicKey","label":"PublicKey"}]},{"type":"category","label":"Interfaces","items":[{"type":"doc","id":"references/ts-sdk/api/cryptography/interfaces/SignatureWithBytes","label":"SignatureWithBytes"}]},{"type":"category","label":"Type Aliases","items":[{"type":"doc","id":"references/ts-sdk/api/cryptography/type-aliases/IntentScope","label":"IntentScope"},{"type":"doc","id":"references/ts-sdk/api/cryptography/type-aliases/ParsedKeypair","label":"ParsedKeypair"},{"type":"doc","id":"references/ts-sdk/api/cryptography/type-aliases/SignatureScheme","label":"SignatureScheme"},{"type":"doc","id":"references/ts-sdk/api/cryptography/type-aliases/SignatureFlag","label":"SignatureFlag"},{"type":"doc","id":"references/ts-sdk/api/cryptography/type-aliases/SerializeSignatureInput","label":"SerializeSignatureInput"}]},{"type":"category","label":"Variables","items":[{"type":"doc","id":"references/ts-sdk/api/cryptography/variables/PRIVATE_KEY_SIZE","label":"PRIVATE_KEY_SIZE"},{"type":"doc","id":"references/ts-sdk/api/cryptography/variables/LEGACY_PRIVATE_KEY_SIZE","label":"LEGACY_PRIVATE_KEY_SIZE"},{"type":"doc","id":"references/ts-sdk/api/cryptography/variables/IOTA_PRIVATE_KEY_PREFIX","label":"IOTA_PRIVATE_KEY_PREFIX"},{"type":"doc","id":"references/ts-sdk/api/cryptography/variables/SIGNATURE_SCHEME_TO_FLAG","label":"SIGNATURE_SCHEME_TO_FLAG"},{"type":"doc","id":"references/ts-sdk/api/cryptography/variables/SIGNATURE_SCHEME_TO_SIZE","label":"SIGNATURE_SCHEME_TO_SIZE"},{"type":"doc","id":"references/ts-sdk/api/cryptography/variables/SIGNATURE_FLAG_TO_SCHEME","label":"SIGNATURE_FLAG_TO_SCHEME"}]},{"type":"category","label":"Functions","items":[{"type":"doc","id":"references/ts-sdk/api/cryptography/functions/messageWithIntent","label":"messageWithIntent"},{"type":"doc","id":"references/ts-sdk/api/cryptography/functions/decodeIotaPrivateKey","label":"decodeIotaPrivateKey"},{"type":"doc","id":"references/ts-sdk/api/cryptography/functions/encodeIotaPrivateKey","label":"encodeIotaPrivateKey"},{"type":"doc","id":"references/ts-sdk/api/cryptography/functions/isValidHardenedPath","label":"isValidHardenedPath"},{"type":"doc","id":"references/ts-sdk/api/cryptography/functions/isValidBIP32Path","label":"isValidBIP32Path"},{"type":"doc","id":"references/ts-sdk/api/cryptography/functions/mnemonicToSeed","label":"mnemonicToSeed"},{"type":"doc","id":"references/ts-sdk/api/cryptography/functions/mnemonicToSeedHex","label":"mnemonicToSeedHex"},{"type":"doc","id":"references/ts-sdk/api/cryptography/functions/toSerializedSignature","label":"toSerializedSignature"},{"type":"doc","id":"references/ts-sdk/api/cryptography/functions/parseSerializedSignature","label":"parseSerializedSignature"}]}],"link":{"type":"doc","id":"references/ts-sdk/api/cryptography/index"}},{"type":"category","label":"faucet","items":[{"type":"category","label":"Classes","items":[{"type":"doc","id":"references/ts-sdk/api/faucet/classes/FaucetRateLimitError","label":"FaucetRateLimitError"}]},{"type":"category","label":"Functions","items":[{"type":"doc","id":"references/ts-sdk/api/faucet/functions/requestIotaFromFaucetV0","label":"requestIotaFromFaucetV0"},{"type":"doc","id":"references/ts-sdk/api/faucet/functions/requestIotaFromFaucetV1","label":"requestIotaFromFaucetV1"},{"type":"doc","id":"references/ts-sdk/api/faucet/functions/getFaucetRequestStatus","label":"getFaucetRequestStatus"},{"type":"doc","id":"references/ts-sdk/api/faucet/functions/getFaucetHost","label":"getFaucetHost"}]}],"link":{"type":"doc","id":"references/ts-sdk/api/faucet/index"}},{"type":"category","label":"graphql","items":[{"type":"category","label":"Classes","items":[{"type":"doc","id":"references/ts-sdk/api/graphql/classes/IotaGraphQLRequestError","label":"IotaGraphQLRequestError"},{"type":"doc","id":"references/ts-sdk/api/graphql/classes/IotaGraphQLClient","label":"IotaGraphQLClient"}]},{"type":"category","label":"Interfaces","items":[{"type":"doc","id":"references/ts-sdk/api/graphql/interfaces/IotaGraphQLClientOptions","label":"IotaGraphQLClientOptions"}]},{"type":"category","label":"Type Aliases","items":[{"type":"doc","id":"references/ts-sdk/api/graphql/type-aliases/GraphQLDocument","label":"GraphQLDocument"},{"type":"doc","id":"references/ts-sdk/api/graphql/type-aliases/GraphQLQueryOptions","label":"GraphQLQueryOptions"},{"type":"doc","id":"references/ts-sdk/api/graphql/type-aliases/GraphQLQueryResult","label":"GraphQLQueryResult"},{"type":"doc","id":"references/ts-sdk/api/graphql/type-aliases/GraphQLResponseErrors","label":"GraphQLResponseErrors"}]}],"link":{"type":"doc","id":"references/ts-sdk/api/graphql/index"}},{"type":"category","label":"keypairs","items":[{"type":"category","label":"ed25519","items":[{"type":"category","label":"Classes","items":[{"type":"doc","id":"references/ts-sdk/api/keypairs/ed25519/classes/Ed25519Keypair","label":"Ed25519Keypair"},{"type":"doc","id":"references/ts-sdk/api/keypairs/ed25519/classes/Ed25519PublicKey","label":"Ed25519PublicKey"}]},{"type":"category","label":"Interfaces","items":[{"type":"doc","id":"references/ts-sdk/api/keypairs/ed25519/interfaces/Ed25519KeypairData","label":"Ed25519KeypairData"}]},{"type":"category","label":"Variables","items":[{"type":"doc","id":"references/ts-sdk/api/keypairs/ed25519/variables/DEFAULT_ED25519_DERIVATION_PATH","label":"DEFAULT_ED25519_DERIVATION_PATH"}]}],"link":{"type":"doc","id":"references/ts-sdk/api/keypairs/ed25519/index"}},{"type":"category","label":"secp256k1","items":[{"type":"category","label":"Classes","items":[{"type":"doc","id":"references/ts-sdk/api/keypairs/secp256k1/classes/Secp256k1Keypair","label":"Secp256k1Keypair"},{"type":"doc","id":"references/ts-sdk/api/keypairs/secp256k1/classes/Secp256k1PublicKey","label":"Secp256k1PublicKey"}]},{"type":"category","label":"Interfaces","items":[{"type":"doc","id":"references/ts-sdk/api/keypairs/secp256k1/interfaces/Secp256k1KeypairData","label":"Secp256k1KeypairData"}]},{"type":"category","label":"Variables","items":[{"type":"doc","id":"references/ts-sdk/api/keypairs/secp256k1/variables/DEFAULT_SECP256K1_DERIVATION_PATH","label":"DEFAULT_SECP256K1_DERIVATION_PATH"}]}],"link":{"type":"doc","id":"references/ts-sdk/api/keypairs/secp256k1/index"}},{"type":"doc","id":"references/ts-sdk/api/keypairs/secp256k1/index","label":"secp256k1"}]},{"type":"category","label":"multisig","items":[{"type":"category","label":"Classes","items":[{"type":"doc","id":"references/ts-sdk/api/multisig/classes/MultiSigPublicKey","label":"MultiSigPublicKey"},{"type":"doc","id":"references/ts-sdk/api/multisig/classes/MultiSigSigner","label":"MultiSigSigner"}]},{"type":"category","label":"Type Aliases","items":[{"type":"doc","id":"references/ts-sdk/api/multisig/type-aliases/MultiSigStruct","label":"MultiSigStruct"}]},{"type":"category","label":"Functions","items":[{"type":"doc","id":"references/ts-sdk/api/multisig/functions/parsePartialSignatures","label":"parsePartialSignatures"}]}],"link":{"type":"doc","id":"references/ts-sdk/api/multisig/index"}},{"type":"category","label":"transactions","items":[{"type":"category","label":"Enumerations","items":[{"type":"doc","id":"references/ts-sdk/api/transactions/enumerations/UpgradePolicy","label":"UpgradePolicy"}]},{"type":"category","label":"Classes","items":[{"type":"doc","id":"references/ts-sdk/api/transactions/classes/AsyncCache","label":"AsyncCache"},{"type":"doc","id":"references/ts-sdk/api/transactions/classes/ObjectCache","label":"ObjectCache"},{"type":"doc","id":"references/ts-sdk/api/transactions/classes/Transaction","label":"Transaction"},{"type":"doc","id":"references/ts-sdk/api/transactions/classes/TransactionDataBuilder","label":"TransactionDataBuilder"},{"type":"doc","id":"references/ts-sdk/api/transactions/classes/ParallelTransactionExecutor","label":"ParallelTransactionExecutor"},{"type":"doc","id":"references/ts-sdk/api/transactions/classes/SerialTransactionExecutor","label":"SerialTransactionExecutor"}]},{"type":"category","label":"Interfaces","items":[{"type":"doc","id":"references/ts-sdk/api/transactions/interfaces/ParallelTransactionExecutorOptions","label":"ParallelTransactionExecutorOptions"},{"type":"doc","id":"references/ts-sdk/api/transactions/interfaces/BuildTransactionOptions","label":"BuildTransactionOptions"},{"type":"doc","id":"references/ts-sdk/api/transactions/interfaces/SerializeTransactionOptions","label":"SerializeTransactionOptions"}]},{"type":"category","label":"Type Aliases","items":[{"type":"doc","id":"references/ts-sdk/api/transactions/type-aliases/TransactionArgument","label":"TransactionArgument"},{"type":"doc","id":"references/ts-sdk/api/transactions/type-aliases/TransactionInput","label":"TransactionInput"},{"type":"doc","id":"references/ts-sdk/api/transactions/type-aliases/TransactionObjectArgument","label":"TransactionObjectArgument"},{"type":"doc","id":"references/ts-sdk/api/transactions/type-aliases/TransactionResult","label":"TransactionResult"},{"type":"doc","id":"references/ts-sdk/api/transactions/type-aliases/TransactionObjectInput","label":"TransactionObjectInput"},{"type":"doc","id":"references/ts-sdk/api/transactions/type-aliases/ObjectRef","label":"ObjectRef"},{"type":"doc","id":"references/ts-sdk/api/transactions/type-aliases/Argument","label":"Argument"},{"type":"doc","id":"references/ts-sdk/api/transactions/type-aliases/GasData","label":"GasData"},{"type":"doc","id":"references/ts-sdk/api/transactions/type-aliases/OpenMoveTypeSignatureBody","label":"OpenMoveTypeSignatureBody"},{"type":"doc","id":"references/ts-sdk/api/transactions/type-aliases/OpenMoveTypeSignature","label":"OpenMoveTypeSignature"},{"type":"doc","id":"references/ts-sdk/api/transactions/type-aliases/Command","label":"Command"},{"type":"doc","id":"references/ts-sdk/api/transactions/type-aliases/CallArg","label":"CallArg"},{"type":"doc","id":"references/ts-sdk/api/transactions/type-aliases/TransactionData","label":"TransactionData"},{"type":"doc","id":"references/ts-sdk/api/transactions/type-aliases/SerializedTransactionDataV1","label":"SerializedTransactionDataV1"},{"type":"doc","id":"references/ts-sdk/api/transactions/type-aliases/SerializedTransactionDataV2","label":"SerializedTransactionDataV2"},{"type":"doc","id":"references/ts-sdk/api/transactions/type-aliases/TransactionPlugin","label":"TransactionPlugin"}]},{"type":"category","label":"Variables","items":[{"type":"doc","id":"references/ts-sdk/api/transactions/variables/Arguments","label":"Arguments"},{"type":"doc","id":"references/ts-sdk/api/transactions/variables/Commands","label":"Commands"},{"type":"doc","id":"references/ts-sdk/api/transactions/variables/Inputs","label":"Inputs"},{"type":"doc","id":"references/ts-sdk/api/transactions/variables/ObjectRef","label":"ObjectRef"},{"type":"doc","id":"references/ts-sdk/api/transactions/variables/Argument","label":"Argument"},{"type":"doc","id":"references/ts-sdk/api/transactions/variables/GasData","label":"GasData"},{"type":"doc","id":"references/ts-sdk/api/transactions/variables/OpenMoveTypeSignatureBody","label":"OpenMoveTypeSignatureBody"},{"type":"doc","id":"references/ts-sdk/api/transactions/variables/OpenMoveTypeSignature","label":"OpenMoveTypeSignature"},{"type":"doc","id":"references/ts-sdk/api/transactions/variables/Command","label":"Command"},{"type":"doc","id":"references/ts-sdk/api/transactions/variables/TransactionData","label":"TransactionData"},{"type":"doc","id":"references/ts-sdk/api/transactions/variables/SerializedTransactionDataV1","label":"SerializedTransactionDataV1"},{"type":"doc","id":"references/ts-sdk/api/transactions/variables/SerializedTransactionDataV2","label":"SerializedTransactionDataV2"}]},{"type":"category","label":"Functions","items":[{"type":"doc","id":"references/ts-sdk/api/transactions/functions/isTransaction","label":"isTransaction"},{"type":"doc","id":"references/ts-sdk/api/transactions/functions/coinWithBalance","label":"coinWithBalance"},{"type":"doc","id":"references/ts-sdk/api/transactions/functions/getPureBcsSchema","label":"getPureBcsSchema"},{"type":"doc","id":"references/ts-sdk/api/transactions/functions/normalizedTypeToMoveTypeSignature","label":"normalizedTypeToMoveTypeSignature"}]}],"link":{"type":"doc","id":"references/ts-sdk/api/transactions/index"}},{"type":"category","label":"utils","items":[{"type":"category","label":"Variables","items":[{"type":"doc","id":"references/ts-sdk/api/utils/variables/IOTA_DECIMALS","label":"IOTA_DECIMALS"},{"type":"doc","id":"references/ts-sdk/api/utils/variables/NANOS_PER_IOTA","label":"NANOS_PER_IOTA"},{"type":"doc","id":"references/ts-sdk/api/utils/variables/MOVE_STDLIB_ADDRESS","label":"MOVE_STDLIB_ADDRESS"},{"type":"doc","id":"references/ts-sdk/api/utils/variables/IOTA_FRAMEWORK_ADDRESS","label":"IOTA_FRAMEWORK_ADDRESS"},{"type":"doc","id":"references/ts-sdk/api/utils/variables/IOTA_SYSTEM_ADDRESS","label":"IOTA_SYSTEM_ADDRESS"},{"type":"doc","id":"references/ts-sdk/api/utils/variables/IOTA_CLOCK_OBJECT_ID","label":"IOTA_CLOCK_OBJECT_ID"},{"type":"doc","id":"references/ts-sdk/api/utils/variables/IOTA_SYSTEM_MODULE_NAME","label":"IOTA_SYSTEM_MODULE_NAME"},{"type":"doc","id":"references/ts-sdk/api/utils/variables/IOTA_TYPE_ARG","label":"IOTA_TYPE_ARG"},{"type":"doc","id":"references/ts-sdk/api/utils/variables/IOTA_SYSTEM_STATE_OBJECT_ID","label":"IOTA_SYSTEM_STATE_OBJECT_ID"},{"type":"doc","id":"references/ts-sdk/api/utils/variables/IOTA_ADDRESS_LENGTH","label":"IOTA_ADDRESS_LENGTH"}]},{"type":"category","label":"Functions","items":[{"type":"doc","id":"references/ts-sdk/api/utils/functions/fromB64","label":"fromB64"},{"type":"doc","id":"references/ts-sdk/api/utils/functions/toB64","label":"toB64"},{"type":"doc","id":"references/ts-sdk/api/utils/functions/fromHEX","label":"fromHEX"},{"type":"doc","id":"references/ts-sdk/api/utils/functions/toHEX","label":"toHEX"},{"type":"doc","id":"references/ts-sdk/api/utils/functions/formatAddress","label":"formatAddress"},{"type":"doc","id":"references/ts-sdk/api/utils/functions/formatDigest","label":"formatDigest"},{"type":"doc","id":"references/ts-sdk/api/utils/functions/formatType","label":"formatType"},{"type":"doc","id":"references/ts-sdk/api/utils/functions/isValidTransactionDigest","label":"isValidTransactionDigest"},{"type":"doc","id":"references/ts-sdk/api/utils/functions/isValidIotaAddress","label":"isValidIotaAddress"},{"type":"doc","id":"references/ts-sdk/api/utils/functions/isValidIotaObjectId","label":"isValidIotaObjectId"},{"type":"doc","id":"references/ts-sdk/api/utils/functions/parseStructTag","label":"parseStructTag"},{"type":"doc","id":"references/ts-sdk/api/utils/functions/normalizeStructTag","label":"normalizeStructTag"},{"type":"doc","id":"references/ts-sdk/api/utils/functions/normalizeIotaAddress","label":"normalizeIotaAddress"},{"type":"doc","id":"references/ts-sdk/api/utils/functions/normalizeIotaObjectId","label":"normalizeIotaObjectId"}]}],"link":{"type":"doc","id":"references/ts-sdk/api/utils/index"}},{"type":"category","label":"verify","items":[{"type":"category","label":"Functions","items":[{"type":"doc","id":"references/ts-sdk/api/verify/functions/verifySignature","label":"verifySignature"},{"type":"doc","id":"references/ts-sdk/api/verify/functions/verifyPersonalMessageSignature","label":"verifyPersonalMessageSignature"},{"type":"doc","id":"references/ts-sdk/api/verify/functions/verifyTransactionSignature","label":"verifyTransactionSignature"},{"type":"doc","id":"references/ts-sdk/api/verify/functions/publicKeyFromRawBytes","label":"publicKeyFromRawBytes"},{"type":"doc","id":"references/ts-sdk/api/verify/functions/publicKeyFromIotaBytes","label":"publicKeyFromIotaBytes"}]}],"link":{"type":"doc","id":"references/ts-sdk/api/verify/index"}}]}; -module.exports = typedocSidebar.items; \ No newline at end of file diff --git a/docs/content/ts-sdk/api/utils/functions/formatAddress.md b/docs/content/ts-sdk/api/utils/functions/formatAddress.md deleted file mode 100644 index c3a167f0e9b..00000000000 --- a/docs/content/ts-sdk/api/utils/functions/formatAddress.md +++ /dev/null @@ -1,11 +0,0 @@ -# Function: formatAddress() - -> **formatAddress**(`address`): `string` - -## Parameters - -• **address**: `string` - -## Returns - -`string` diff --git a/docs/content/ts-sdk/api/utils/functions/formatDigest.md b/docs/content/ts-sdk/api/utils/functions/formatDigest.md deleted file mode 100644 index 41a3ba2dd1b..00000000000 --- a/docs/content/ts-sdk/api/utils/functions/formatDigest.md +++ /dev/null @@ -1,11 +0,0 @@ -# Function: formatDigest() - -> **formatDigest**(`digest`): `string` - -## Parameters - -• **digest**: `string` - -## Returns - -`string` diff --git a/docs/content/ts-sdk/api/utils/functions/formatType.md b/docs/content/ts-sdk/api/utils/functions/formatType.md deleted file mode 100644 index 7941bffb537..00000000000 --- a/docs/content/ts-sdk/api/utils/functions/formatType.md +++ /dev/null @@ -1,11 +0,0 @@ -# Function: formatType() - -> **formatType**(`type`): `string` - -## Parameters - -• **type**: `string` - -## Returns - -`string` diff --git a/docs/content/ts-sdk/api/utils/functions/fromB64.md b/docs/content/ts-sdk/api/utils/functions/fromB64.md deleted file mode 100644 index 9c32aca174a..00000000000 --- a/docs/content/ts-sdk/api/utils/functions/fromB64.md +++ /dev/null @@ -1,11 +0,0 @@ -# Function: fromB64() - -> **fromB64**(`base64String`): `Uint8Array` - -## Parameters - -• **base64String**: `string` - -## Returns - -`Uint8Array` diff --git a/docs/content/ts-sdk/api/utils/functions/fromHEX.md b/docs/content/ts-sdk/api/utils/functions/fromHEX.md deleted file mode 100644 index 2a2e84dd9c7..00000000000 --- a/docs/content/ts-sdk/api/utils/functions/fromHEX.md +++ /dev/null @@ -1,11 +0,0 @@ -# Function: fromHEX() - -> **fromHEX**(`hexStr`): `Uint8Array` - -## Parameters - -• **hexStr**: `string` - -## Returns - -`Uint8Array` diff --git a/docs/content/ts-sdk/api/utils/functions/isValidIotaAddress.md b/docs/content/ts-sdk/api/utils/functions/isValidIotaAddress.md deleted file mode 100644 index 4d59e4823c4..00000000000 --- a/docs/content/ts-sdk/api/utils/functions/isValidIotaAddress.md +++ /dev/null @@ -1,11 +0,0 @@ -# Function: isValidIotaAddress() - -> **isValidIotaAddress**(`value`): `value is string` - -## Parameters - -• **value**: `string` - -## Returns - -`value is string` diff --git a/docs/content/ts-sdk/api/utils/functions/isValidIotaObjectId.md b/docs/content/ts-sdk/api/utils/functions/isValidIotaObjectId.md deleted file mode 100644 index e6a979a5dd0..00000000000 --- a/docs/content/ts-sdk/api/utils/functions/isValidIotaObjectId.md +++ /dev/null @@ -1,11 +0,0 @@ -# Function: isValidIotaObjectId() - -> **isValidIotaObjectId**(`value`): `boolean` - -## Parameters - -• **value**: `string` - -## Returns - -`boolean` diff --git a/docs/content/ts-sdk/api/utils/functions/isValidTransactionDigest.md b/docs/content/ts-sdk/api/utils/functions/isValidTransactionDigest.md deleted file mode 100644 index c796a72169a..00000000000 --- a/docs/content/ts-sdk/api/utils/functions/isValidTransactionDigest.md +++ /dev/null @@ -1,13 +0,0 @@ -# Function: isValidTransactionDigest() - -> **isValidTransactionDigest**(`value`): `value is string` - -Returns whether the tx digest is valid based on the serialization format - -## Parameters - -• **value**: `string` - -## Returns - -`value is string` diff --git a/docs/content/ts-sdk/api/utils/functions/normalizeIotaAddress.md b/docs/content/ts-sdk/api/utils/functions/normalizeIotaAddress.md deleted file mode 100644 index 62b6dde0733..00000000000 --- a/docs/content/ts-sdk/api/utils/functions/normalizeIotaAddress.md +++ /dev/null @@ -1,23 +0,0 @@ -# Function: normalizeIotaAddress() - -> **normalizeIotaAddress**(`value`, `forceAdd0x`): `string` - -Perform the following operations: - -1. Make the address lower case -2. Prepend `0x` if the string does not start with `0x`. -3. Add more zeros if the length of the address(excluding `0x`) is less than `IOTA_ADDRESS_LENGTH` - -WARNING: if the address value itself starts with `0x`, e.g., `0x0x`, the default behavior -is to treat the first `0x` not as part of the address. The default behavior can be overridden by -setting `forceAdd0x` to true - -## Parameters - -• **value**: `string` - -• **forceAdd0x**: `boolean` = `false` - -## Returns - -`string` diff --git a/docs/content/ts-sdk/api/utils/functions/normalizeIotaObjectId.md b/docs/content/ts-sdk/api/utils/functions/normalizeIotaObjectId.md deleted file mode 100644 index 28534bd38e2..00000000000 --- a/docs/content/ts-sdk/api/utils/functions/normalizeIotaObjectId.md +++ /dev/null @@ -1,13 +0,0 @@ -# Function: normalizeIotaObjectId() - -> **normalizeIotaObjectId**(`value`, `forceAdd0x`): `string` - -## Parameters - -• **value**: `string` - -• **forceAdd0x**: `boolean` = `false` - -## Returns - -`string` diff --git a/docs/content/ts-sdk/api/utils/functions/normalizeStructTag.md b/docs/content/ts-sdk/api/utils/functions/normalizeStructTag.md deleted file mode 100644 index 4dedb10bc34..00000000000 --- a/docs/content/ts-sdk/api/utils/functions/normalizeStructTag.md +++ /dev/null @@ -1,11 +0,0 @@ -# Function: normalizeStructTag() - -> **normalizeStructTag**(`type`): `string` - -## Parameters - -• **type**: `string` \| `StructTag` - -## Returns - -`string` diff --git a/docs/content/ts-sdk/api/utils/functions/parseStructTag.md b/docs/content/ts-sdk/api/utils/functions/parseStructTag.md deleted file mode 100644 index 6cd9aa7e153..00000000000 --- a/docs/content/ts-sdk/api/utils/functions/parseStructTag.md +++ /dev/null @@ -1,11 +0,0 @@ -# Function: parseStructTag() - -> **parseStructTag**(`type`): `StructTag` - -## Parameters - -• **type**: `string` - -## Returns - -`StructTag` diff --git a/docs/content/ts-sdk/api/utils/functions/toB64.md b/docs/content/ts-sdk/api/utils/functions/toB64.md deleted file mode 100644 index b24565ffe87..00000000000 --- a/docs/content/ts-sdk/api/utils/functions/toB64.md +++ /dev/null @@ -1,11 +0,0 @@ -# Function: toB64() - -> **toB64**(`bytes`): `string` - -## Parameters - -• **bytes**: `Uint8Array` - -## Returns - -`string` diff --git a/docs/content/ts-sdk/api/utils/functions/toHEX.md b/docs/content/ts-sdk/api/utils/functions/toHEX.md deleted file mode 100644 index a9cd257eca6..00000000000 --- a/docs/content/ts-sdk/api/utils/functions/toHEX.md +++ /dev/null @@ -1,11 +0,0 @@ -# Function: toHEX() - -> **toHEX**(`bytes`): `string` - -## Parameters - -• **bytes**: `Uint8Array` - -## Returns - -`string` diff --git a/docs/content/ts-sdk/api/utils/index.md b/docs/content/ts-sdk/api/utils/index.md deleted file mode 100644 index 54098ba1a11..00000000000 --- a/docs/content/ts-sdk/api/utils/index.md +++ /dev/null @@ -1,33 +0,0 @@ -# utils - -## Index - -### Variables - -- [IOTA\_DECIMALS](variables/IOTA_DECIMALS.md) -- [NANOS\_PER\_IOTA](variables/NANOS_PER_IOTA.md) -- [MOVE\_STDLIB\_ADDRESS](variables/MOVE_STDLIB_ADDRESS.md) -- [IOTA\_FRAMEWORK\_ADDRESS](variables/IOTA_FRAMEWORK_ADDRESS.md) -- [IOTA\_SYSTEM\_ADDRESS](variables/IOTA_SYSTEM_ADDRESS.md) -- [IOTA\_CLOCK\_OBJECT\_ID](variables/IOTA_CLOCK_OBJECT_ID.md) -- [IOTA\_SYSTEM\_MODULE\_NAME](variables/IOTA_SYSTEM_MODULE_NAME.md) -- [IOTA\_TYPE\_ARG](variables/IOTA_TYPE_ARG.md) -- [IOTA\_SYSTEM\_STATE\_OBJECT\_ID](variables/IOTA_SYSTEM_STATE_OBJECT_ID.md) -- [IOTA\_ADDRESS\_LENGTH](variables/IOTA_ADDRESS_LENGTH.md) - -### Functions - -- [fromB64](functions/fromB64.md) -- [toB64](functions/toB64.md) -- [fromHEX](functions/fromHEX.md) -- [toHEX](functions/toHEX.md) -- [formatAddress](functions/formatAddress.md) -- [formatDigest](functions/formatDigest.md) -- [formatType](functions/formatType.md) -- [isValidTransactionDigest](functions/isValidTransactionDigest.md) -- [isValidIotaAddress](functions/isValidIotaAddress.md) -- [isValidIotaObjectId](functions/isValidIotaObjectId.md) -- [parseStructTag](functions/parseStructTag.md) -- [normalizeStructTag](functions/normalizeStructTag.md) -- [normalizeIotaAddress](functions/normalizeIotaAddress.md) -- [normalizeIotaObjectId](functions/normalizeIotaObjectId.md) diff --git a/docs/content/ts-sdk/api/utils/variables/IOTA_ADDRESS_LENGTH.md b/docs/content/ts-sdk/api/utils/variables/IOTA_ADDRESS_LENGTH.md deleted file mode 100644 index 1fb9e5b63a4..00000000000 --- a/docs/content/ts-sdk/api/utils/variables/IOTA_ADDRESS_LENGTH.md +++ /dev/null @@ -1,3 +0,0 @@ -# Variable: IOTA\_ADDRESS\_LENGTH - -> `const` **IOTA\_ADDRESS\_LENGTH**: `32` = `32` diff --git a/docs/content/ts-sdk/api/utils/variables/IOTA_CLOCK_OBJECT_ID.md b/docs/content/ts-sdk/api/utils/variables/IOTA_CLOCK_OBJECT_ID.md deleted file mode 100644 index fd283f0e8e5..00000000000 --- a/docs/content/ts-sdk/api/utils/variables/IOTA_CLOCK_OBJECT_ID.md +++ /dev/null @@ -1,3 +0,0 @@ -# Variable: IOTA\_CLOCK\_OBJECT\_ID - -> `const` **IOTA\_CLOCK\_OBJECT\_ID**: `string` diff --git a/docs/content/ts-sdk/api/utils/variables/IOTA_DECIMALS.md b/docs/content/ts-sdk/api/utils/variables/IOTA_DECIMALS.md deleted file mode 100644 index f1df665dedc..00000000000 --- a/docs/content/ts-sdk/api/utils/variables/IOTA_DECIMALS.md +++ /dev/null @@ -1,3 +0,0 @@ -# Variable: IOTA\_DECIMALS - -> `const` **IOTA\_DECIMALS**: `9` = `9` diff --git a/docs/content/ts-sdk/api/utils/variables/IOTA_FRAMEWORK_ADDRESS.md b/docs/content/ts-sdk/api/utils/variables/IOTA_FRAMEWORK_ADDRESS.md deleted file mode 100644 index b890559b3dc..00000000000 --- a/docs/content/ts-sdk/api/utils/variables/IOTA_FRAMEWORK_ADDRESS.md +++ /dev/null @@ -1,3 +0,0 @@ -# Variable: IOTA\_FRAMEWORK\_ADDRESS - -> `const` **IOTA\_FRAMEWORK\_ADDRESS**: `"0x2"` = `'0x2'` diff --git a/docs/content/ts-sdk/api/utils/variables/IOTA_SYSTEM_ADDRESS.md b/docs/content/ts-sdk/api/utils/variables/IOTA_SYSTEM_ADDRESS.md deleted file mode 100644 index 7e37bcfa041..00000000000 --- a/docs/content/ts-sdk/api/utils/variables/IOTA_SYSTEM_ADDRESS.md +++ /dev/null @@ -1,3 +0,0 @@ -# Variable: IOTA\_SYSTEM\_ADDRESS - -> `const` **IOTA\_SYSTEM\_ADDRESS**: `"0x3"` = `'0x3'` diff --git a/docs/content/ts-sdk/api/utils/variables/IOTA_SYSTEM_MODULE_NAME.md b/docs/content/ts-sdk/api/utils/variables/IOTA_SYSTEM_MODULE_NAME.md deleted file mode 100644 index ca2c521163a..00000000000 --- a/docs/content/ts-sdk/api/utils/variables/IOTA_SYSTEM_MODULE_NAME.md +++ /dev/null @@ -1,3 +0,0 @@ -# Variable: IOTA\_SYSTEM\_MODULE\_NAME - -> `const` **IOTA\_SYSTEM\_MODULE\_NAME**: `"iota_system"` = `'iota_system'` diff --git a/docs/content/ts-sdk/api/utils/variables/IOTA_SYSTEM_STATE_OBJECT_ID.md b/docs/content/ts-sdk/api/utils/variables/IOTA_SYSTEM_STATE_OBJECT_ID.md deleted file mode 100644 index d76f5c32308..00000000000 --- a/docs/content/ts-sdk/api/utils/variables/IOTA_SYSTEM_STATE_OBJECT_ID.md +++ /dev/null @@ -1,3 +0,0 @@ -# Variable: IOTA\_SYSTEM\_STATE\_OBJECT\_ID - -> `const` **IOTA\_SYSTEM\_STATE\_OBJECT\_ID**: `string` diff --git a/docs/content/ts-sdk/api/utils/variables/IOTA_TYPE_ARG.md b/docs/content/ts-sdk/api/utils/variables/IOTA_TYPE_ARG.md deleted file mode 100644 index 90c769bb7a7..00000000000 --- a/docs/content/ts-sdk/api/utils/variables/IOTA_TYPE_ARG.md +++ /dev/null @@ -1,3 +0,0 @@ -# Variable: IOTA\_TYPE\_ARG - -> `const` **IOTA\_TYPE\_ARG**: `"0x2::iota::IOTA"` diff --git a/docs/content/ts-sdk/api/utils/variables/MOVE_STDLIB_ADDRESS.md b/docs/content/ts-sdk/api/utils/variables/MOVE_STDLIB_ADDRESS.md deleted file mode 100644 index ae4d58a71c1..00000000000 --- a/docs/content/ts-sdk/api/utils/variables/MOVE_STDLIB_ADDRESS.md +++ /dev/null @@ -1,3 +0,0 @@ -# Variable: MOVE\_STDLIB\_ADDRESS - -> `const` **MOVE\_STDLIB\_ADDRESS**: `"0x1"` = `'0x1'` diff --git a/docs/content/ts-sdk/api/utils/variables/NANOS_PER_IOTA.md b/docs/content/ts-sdk/api/utils/variables/NANOS_PER_IOTA.md deleted file mode 100644 index 19cedc83a26..00000000000 --- a/docs/content/ts-sdk/api/utils/variables/NANOS_PER_IOTA.md +++ /dev/null @@ -1,3 +0,0 @@ -# Variable: NANOS\_PER\_IOTA - -> `const` **NANOS\_PER\_IOTA**: `bigint` diff --git a/docs/content/ts-sdk/api/verify/functions/publicKeyFromIotaBytes.md b/docs/content/ts-sdk/api/verify/functions/publicKeyFromIotaBytes.md deleted file mode 100644 index 03bd0e8353c..00000000000 --- a/docs/content/ts-sdk/api/verify/functions/publicKeyFromIotaBytes.md +++ /dev/null @@ -1,11 +0,0 @@ -# Function: publicKeyFromIotaBytes() - -> **publicKeyFromIotaBytes**(`publicKey`): [`PublicKey`](../../cryptography/classes/PublicKey.md) - -## Parameters - -• **publicKey**: `string` \| `Uint8Array` - -## Returns - -[`PublicKey`](../../cryptography/classes/PublicKey.md) diff --git a/docs/content/ts-sdk/api/verify/functions/publicKeyFromRawBytes.md b/docs/content/ts-sdk/api/verify/functions/publicKeyFromRawBytes.md deleted file mode 100644 index 1653d84f622..00000000000 --- a/docs/content/ts-sdk/api/verify/functions/publicKeyFromRawBytes.md +++ /dev/null @@ -1,13 +0,0 @@ -# Function: publicKeyFromRawBytes() - -> **publicKeyFromRawBytes**(`signatureScheme`, `bytes`): [`PublicKey`](../../cryptography/classes/PublicKey.md) - -## Parameters - -• **signatureScheme**: [`SignatureScheme`](../../cryptography/type-aliases/SignatureScheme.md) - -• **bytes**: `Uint8Array` - -## Returns - -[`PublicKey`](../../cryptography/classes/PublicKey.md) diff --git a/docs/content/ts-sdk/api/verify/functions/verifyPersonalMessageSignature.md b/docs/content/ts-sdk/api/verify/functions/verifyPersonalMessageSignature.md deleted file mode 100644 index f5ffbb44e69..00000000000 --- a/docs/content/ts-sdk/api/verify/functions/verifyPersonalMessageSignature.md +++ /dev/null @@ -1,13 +0,0 @@ -# Function: verifyPersonalMessageSignature() - -> **verifyPersonalMessageSignature**(`message`, `signature`): `Promise`\<[`PublicKey`](../../cryptography/classes/PublicKey.md)\> - -## Parameters - -• **message**: `Uint8Array` - -• **signature**: `string` - -## Returns - -`Promise`\<[`PublicKey`](../../cryptography/classes/PublicKey.md)\> diff --git a/docs/content/ts-sdk/api/verify/functions/verifySignature.md b/docs/content/ts-sdk/api/verify/functions/verifySignature.md deleted file mode 100644 index 6b15319df4d..00000000000 --- a/docs/content/ts-sdk/api/verify/functions/verifySignature.md +++ /dev/null @@ -1,13 +0,0 @@ -# Function: verifySignature() - -> **verifySignature**(`bytes`, `signature`): `Promise`\<[`PublicKey`](../../cryptography/classes/PublicKey.md)\> - -## Parameters - -• **bytes**: `Uint8Array` - -• **signature**: `string` - -## Returns - -`Promise`\<[`PublicKey`](../../cryptography/classes/PublicKey.md)\> diff --git a/docs/content/ts-sdk/api/verify/functions/verifyTransactionSignature.md b/docs/content/ts-sdk/api/verify/functions/verifyTransactionSignature.md deleted file mode 100644 index 2f4ce54b83c..00000000000 --- a/docs/content/ts-sdk/api/verify/functions/verifyTransactionSignature.md +++ /dev/null @@ -1,13 +0,0 @@ -# Function: verifyTransactionSignature() - -> **verifyTransactionSignature**(`transaction`, `signature`): `Promise`\<[`PublicKey`](../../cryptography/classes/PublicKey.md)\> - -## Parameters - -• **transaction**: `Uint8Array` - -• **signature**: `string` - -## Returns - -`Promise`\<[`PublicKey`](../../cryptography/classes/PublicKey.md)\> diff --git a/docs/content/ts-sdk/api/verify/index.md b/docs/content/ts-sdk/api/verify/index.md deleted file mode 100644 index b1b20ba8ef8..00000000000 --- a/docs/content/ts-sdk/api/verify/index.md +++ /dev/null @@ -1,11 +0,0 @@ -# verify - -## Index - -### Functions - -- [verifySignature](functions/verifySignature.md) -- [verifyPersonalMessageSignature](functions/verifyPersonalMessageSignature.md) -- [verifyTransactionSignature](functions/verifyTransactionSignature.md) -- [publicKeyFromRawBytes](functions/publicKeyFromRawBytes.md) -- [publicKeyFromIotaBytes](functions/publicKeyFromIotaBytes.md) diff --git a/docs/site/docusaurus.config.js b/docs/site/docusaurus.config.js index 580b3e7fad7..7d6e9dc4d7e 100644 --- a/docs/site/docusaurus.config.js +++ b/docs/site/docusaurus.config.js @@ -60,7 +60,7 @@ const config = { schema: "../../crates/iota-graphql-rpc/schema.graphql", rootPath: "../content", // docs will be generated under rootPath/baseURL - baseURL: "references/iota-api/iota-graphql/reference", + baseURL: "../../generated-docs/graphql", loaders: { GraphQLFileLoader: "@graphql-tools/graphql-file-loader", }, @@ -91,14 +91,14 @@ const config = { "../../sdk/typescript/src/graphql", "../../sdk/typescript/src/keypairs/ed25519", "../../sdk/typescript/src/keypairs/secp256k1", - "../../sdk/typescript/src/keypairs/secp256k1", + "../../sdk/typescript/src/keypairs/secp256r1", "../../sdk/typescript/src/multisig", "../../sdk/typescript/src/transactions", "../../sdk/typescript/src/utils", "../../sdk/typescript/src/verify" ], plugin: ["typedoc-plugin-markdown"], - out: "../../docs/content/references/ts-sdk/api/", + out: "../../docs/content/ts-sdk/api/", githubPages: false, readme: "none", hideGenerator: true, diff --git a/docs/site/package.json b/docs/site/package.json index 19d5568dd89..445318feb87 100644 --- a/docs/site/package.json +++ b/docs/site/package.json @@ -4,9 +4,12 @@ "private": true, "scripts": { "docusaurus": "docusaurus", - "dev": "UPDATE=1 cargo test --manifest-path ../../crates/iota-framework/Cargo.toml; docusaurus graphql-to-doc; rm '../content/references/iota-api/iota-graphql/reference/generated.md'; docusaurus start", - "build": "UPDATE=1 cargo test --manifest-path ../../crates/iota-framework/Cargo.toml; docusaurus graphql-to-doc; rm '../content/references/iota-api/iota-graphql/reference/generated.md'; docusaurus build", - "download-references": "git clean -Xdf ../content/references/iota-evm/; ./scripts/get-iota-evm-references.sh; git clean -Xdf ../content/references/iota-identity/; ./scripts/get-iota-identity-references.sh", + "dev": "pnpm download-iota-references; docusaurus start", + "build": "pnpm download-iota-references; docusaurus build", + "generate-ts-docs": "docusaurus generate-typedoc; rm -rf ../../generated-docs/ts; mkdir ../../generated-docs/ts; cp -Rv ../content/ts-sdk/api/* ../../generated-docs/ts/;", + "generate-graphql-docs" : "docusaurus graphql-to-doc; rm '../../generated-docs/graphql/generated.md';", + "download-iota-references": "git clean -Xdf ../content/references/; ./scripts/get-iota-references.sh;", + "download-external-references": "git clean -Xdf ../content/references/iota-evm/; ./scripts/get-iota-evm-references.sh; git clean -Xdf ../content/references/iota-identity/; ./scripts/get-iota-identity-references.sh", "swizzle": "docusaurus swizzle", "deploy": "docusaurus deploy", "clear": "docusaurus clear", diff --git a/docs/site/scripts/get-iota-references.sh b/docs/site/scripts/get-iota-references.sh new file mode 100755 index 00000000000..03ed21c4624 --- /dev/null +++ b/docs/site/scripts/get-iota-references.sh @@ -0,0 +1,15 @@ +#!/bin/sh + +# Create temporary directory to work in +mkdir tmp +cd tmp + +# Download and copy docs +curl -sL https://s3.eu-central-1.amazonaws.com/files.iota.org/iota-wiki/iota/testnet.tar.gz | tar xzv +cp -Rv generated-docs/ts/* ../../content/ts-sdk/api +cp -Rv generated-docs/graphql/* ../../content/references/iota-api/iota-graphql +cp -Rv generated-docs/framework/* ../../content/references/framework + +# Return to root and cleanup +cd - +rm -rf tmp