Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,4 @@ jobs:
- name: Lint
run: npm run lint
- name: Build
run: npm run build:mesh && npm run build:docs && npm run build:apps && npm run build:scripts
run: npm run build:mesh && npm run build:docs && npm run build:docs:markdown && npm run build:apps && npm run build:scripts
9 changes: 9 additions & 0 deletions docs/markdown/mesh-common/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
**@meshsdk/common**

***

# mesh-common

Contains constants, types and interfaces used across the SDK and different serialization libraries

[meshjs.dev](https://meshjs.dev/)
123 changes: 123 additions & 0 deletions docs/markdown/mesh-common/classes/AssetFingerprint.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
[**@meshsdk/common**](../README.md)

***

[@meshsdk/common](../globals.md) / AssetFingerprint

# Class: AssetFingerprint

Defined in: utils/asset-fingerprint.ts:15

## Properties

### hashBuf

> `readonly` **hashBuf**: `Uint8Array`

Defined in: utils/asset-fingerprint.ts:16

## Methods

### checksum()

> **checksum**(): `string`

Defined in: utils/asset-fingerprint.ts:62

#### Returns

`string`

***

### fingerprint()

> **fingerprint**(): `string`

Defined in: utils/asset-fingerprint.ts:48

#### Returns

`string`

***

### hash()

> **hash**(): `string`

Defined in: utils/asset-fingerprint.ts:53

#### Returns

`string`

***

### prefix()

> **prefix**(): `string`

Defined in: utils/asset-fingerprint.ts:57

#### Returns

`string`

***

### fromBech32()

> `static` **fromBech32**(`fingerprint`): `AssetFingerprint`

Defined in: utils/asset-fingerprint.ts:38

#### Parameters

##### fingerprint

`string`

#### Returns

`AssetFingerprint`

***

### fromHash()

> `static` **fromHash**(`hash`): `AssetFingerprint`

Defined in: utils/asset-fingerprint.ts:22

#### Parameters

##### hash

`Uint8Array`

#### Returns

`AssetFingerprint`

***

### fromParts()

> `static` **fromParts**(`policyId`, `assetName`): `AssetFingerprint`

Defined in: utils/asset-fingerprint.ts:26

#### Parameters

##### policyId

`Uint8Array`

##### assetName

`Uint8Array`

#### Returns

`AssetFingerprint`
191 changes: 191 additions & 0 deletions docs/markdown/mesh-common/classes/BigNum.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,191 @@
[**@meshsdk/common**](../README.md)

***

[@meshsdk/common](../globals.md) / BigNum

# Class: BigNum

Defined in: utils/big-num.ts:1

## Constructors

### Constructor

> **new BigNum**(`value?`): `BigNum`

Defined in: utils/big-num.ts:4

#### Parameters

##### value?

`string` | `number` | `bigint`

#### Returns

`BigNum`

## Properties

### value

> **value**: `bigint`

Defined in: utils/big-num.ts:2

## Methods

### checkedAdd()

> **checkedAdd**(`other`): `BigNum`

Defined in: utils/big-num.ts:31

#### Parameters

##### other

`BigNum`

#### Returns

`BigNum`

***

### checkedMul()

> **checkedMul**(`other`): `BigNum`

Defined in: utils/big-num.ts:26

#### Parameters

##### other

`BigNum`

#### Returns

`BigNum`

***

### checkedSub()

> **checkedSub**(`other`): `BigNum`

Defined in: utils/big-num.ts:36

#### Parameters

##### other

`BigNum`

#### Returns

`BigNum`

***

### clampedSub()

> **clampedSub**(`other`): `BigNum`

Defined in: utils/big-num.ts:41

#### Parameters

##### other

`BigNum`

#### Returns

`BigNum`

***

### compare()

> **compare**(`other`): `-1` \| `0` \| `1`

Defined in: utils/big-num.ts:53

#### Parameters

##### other

`BigNum`

#### Returns

`-1` \| `0` \| `1`

***

### divFloor()

> **divFloor**(`other`): `BigNum`

Defined in: utils/big-num.ts:21

#### Parameters

##### other

`BigNum`

#### Returns

`BigNum`

***

### lessThan()

> **lessThan**(`other`): `boolean`

Defined in: utils/big-num.ts:49

#### Parameters

##### other

`BigNum`

#### Returns

`boolean`

***

### toString()

> **toString**(): `string`

Defined in: utils/big-num.ts:65

#### Returns

`string`

***

### new()

> `static` **new**(`value`): `BigNum`

Defined in: utils/big-num.ts:12

#### Parameters

##### value

`undefined` | `string` | `number` | `bigint`

#### Returns

`BigNum`
Loading