docs: Update blockchain signers documentation (#249)

Cerebellum-Network · May 15, 2024 · e51b49a · e51b49a
1 parent 984ffb7
commit e51b49a
Show file tree

Hide file tree

Showing 21 changed files with 453 additions and 22 deletions.
diff --git a/packages/blockchain/docs/README.md b/packages/blockchain/docs/README.md
@@ -16,6 +16,8 @@
 ## Signers
 
 - [CereWalletSigner](classes/CereWalletSigner.md)
+- [JsonSigner](classes/JsonSigner.md)
+- [KeyringSigner](classes/KeyringSigner.md)
 - [Signer](classes/Signer.md)
 - [UriSigner](classes/UriSigner.md)
 - [Web3Signer](classes/Web3Signer.md)
diff --git a/packages/blockchain/docs/classes/CereWalletSigner.md b/packages/blockchain/docs/classes/CereWalletSigner.md
@@ -132,6 +132,28 @@ A promise that resolves to the signature.
 
 ___
 
+### unlock
+
+▸ **unlock**(`passphrase?`): `Promise`\<`void`\>
+
+Unlocks the signer with a passphrase.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `passphrase?` | `string` | The passphrase to unlock the signer. |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Inherited from
+
+[Web3Signer](Web3Signer.md).[unlock](Web3Signer.md#unlock)
+
+___
+
 ### isSigner
 
 ▸ **isSigner**(`signer`): signer is Signer

diff --git a/packages/blockchain/docs/classes/DDCClustersPallet.md b/packages/blockchain/docs/classes/DDCClustersPallet.md
@@ -90,7 +90,7 @@ Creates a new cluster.
 | `clusterId` | \`0x$\{string}\` | The ID of the cluster. |
 | `clusterManagerId` | `string` | The ID of the cluster manager. |
 | `clusterReserveId` | `string` | The ID of the cluster reserve. |
-| `clusterProps` | `ClusterProps` | The properties of the cluster. |
+| `clusterProps` | `Partial`\<`ClusterProps`\> | The properties of the cluster. |
 | `clusterGovernmentParams` | `ClusterGovernmentParams` | The government parameters of the cluster. |
 
 #### Returns
@@ -273,7 +273,7 @@ Sets the properties of a cluster.
 | Name | Type | Description |
 | :------ | :------ | :------ |
 | `clusterId` | \`0x$\{string}\` | The ID of the cluster. |
-| `clusterProps` | `ClusterProps` | The properties of the cluster. |
+| `clusterProps` | `Partial`\<`ClusterProps`\> | The properties of the cluster. |
 
 #### Returns
 

diff --git a/packages/blockchain/docs/classes/JsonSigner.md b/packages/blockchain/docs/classes/JsonSigner.md
@@ -0,0 +1,45 @@
+[@cere-ddc-sdk/blockchain](../README.md) / JsonSigner
+
+# Class: JsonSigner
+
+Signer that uses a JSON object to create a keypair.
+
+**`Example`**
+
+```typescript
+const accountDataJson = {}; // Exported from Cere Wallet or other wallets
+const jsonSigner = new JsonSigner(accountDataJson, { passphrase: '1234' });
+const signature = await jsonSigner.sign('data');
+
+console.log(signature);
+```
+
+## Hierarchy
+
+- [`KeyringSigner`](KeyringSigner.md)
+
+  ↳ **`JsonSigner`**
+
+## Methods
+
+### isSigner
+
+▸ **isSigner**(`signer`): signer is Signer
+
+Checks if an object is a signer.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `signer` | `unknown` | The object to check. |
+
+#### Returns
+
+signer is Signer
+
+A boolean indicating whether the object is a signer.
+
+#### Inherited from
+
+[KeyringSigner](KeyringSigner.md).[isSigner](KeyringSigner.md#issigner)
diff --git a/packages/blockchain/docs/classes/KeyringSigner.md b/packages/blockchain/docs/classes/KeyringSigner.md
@@ -0,0 +1,49 @@
+[@cere-ddc-sdk/blockchain](../README.md) / KeyringSigner
+
+# Class: KeyringSigner
+
+Signer that uses a keyring pair to sign data.
+
+**`Example`**
+
+```typescript
+const pair = new Keyring().addFromUri('//Alice');
+const keyringSigner = new KeyringSigner(pair);
+const signature = await keyringSigner.sign('data');
+
+console.log(signature);
+```
+
+## Hierarchy
+
+- [`Signer`](Signer.md)
+
+  ↳ **`KeyringSigner`**
+
+  ↳↳ [`UriSigner`](UriSigner.md)
+
+  ↳↳ [`JsonSigner`](JsonSigner.md)
+
+## Methods
+
+### isSigner
+
+▸ **isSigner**(`signer`): signer is Signer
+
+Checks if an object is a signer.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `signer` | `unknown` | The object to check. |
+
+#### Returns
+
+signer is Signer
+
+A boolean indicating whether the object is a signer.
+
+#### Inherited from
+
+[Signer](Signer.md).[isSigner](Signer.md#issigner)
diff --git a/packages/blockchain/docs/classes/Signer.md b/packages/blockchain/docs/classes/Signer.md
@@ -20,10 +20,10 @@ console.log(isReady);
 
 - **`Signer`**
 
-  ↳ [`UriSigner`](UriSigner.md)
-
   ↳ [`Web3Signer`](Web3Signer.md)
 
+  ↳ [`KeyringSigner`](KeyringSigner.md)
+
 ## Methods
 
 ### isReady
@@ -60,6 +60,24 @@ A promise that resolves to the signature.
 
 ___
 
+### unlock
+
+▸ **unlock**(`passphrase?`): `Promise`\<`void`\>
+
+Unlocks the signer with a passphrase.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `passphrase?` | `string` | The passphrase to unlock the signer. |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+___
+
 ### isSigner
 
 ▸ **isSigner**(`signer`): signer is Signer
@@ -88,6 +106,14 @@ The address of the signer.
 
 ___
 
+### isLocked
+
+• `Readonly` `Abstract` **isLocked**: `boolean`
+
+A boolean indicating whether the signer is locked.
+
+___
+
 ### publicKey
 
 • `Readonly` `Abstract` **publicKey**: `Uint8Array`

diff --git a/packages/blockchain/docs/classes/UriSigner.md b/packages/blockchain/docs/classes/UriSigner.md
@@ -15,7 +15,7 @@ console.log(signature);
 
 ## Hierarchy
 
-- [`Signer`](Signer.md)
+- [`KeyringSigner`](KeyringSigner.md)
 
   ↳ **`UriSigner`**
 
@@ -41,4 +41,4 @@ A boolean indicating whether the object is a signer.
 
 #### Inherited from
 
-[Signer](Signer.md).[isSigner](Signer.md#issigner)
+[KeyringSigner](KeyringSigner.md).[isSigner](KeyringSigner.md#issigner)
diff --git a/packages/blockchain/docs/classes/Web3Signer.md b/packages/blockchain/docs/classes/Web3Signer.md
@@ -153,6 +153,28 @@ A promise that resolves to the signature.
 
 ___
 
+### unlock
+
+▸ **unlock**(`passphrase?`): `Promise`\<`void`\>
+
+Unlocks the signer with a passphrase.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `passphrase?` | `string` | The passphrase to unlock the signer. |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Inherited from
+
+[Signer](Signer.md).[unlock](Signer.md#unlock)
+
+___
+
 ### isSigner
 
 ▸ **isSigner**(`signer`): signer is Signer

diff --git a/packages/ddc-client/docs/README.md b/packages/ddc-client/docs/README.md
@@ -27,5 +27,7 @@
 
 ## Signers
 
+- [JsonSigner](classes/JsonSigner.md)
+- [KeyringSigner](classes/KeyringSigner.md)
 - [Signer](classes/Signer.md)
 - [UriSigner](classes/UriSigner.md)
diff --git a/packages/ddc-client/docs/classes/DdcClient.md b/packages/ddc-client/docs/classes/DdcClient.md
@@ -263,7 +263,7 @@ ___
 
 ### resolveName
 
-▸ **resolveName**(`bucketId`, `cnsName`): `Promise`\<``null`` \| `string`\>
+▸ **resolveName**(`bucketId`, `cnsName`, `options?`): `Promise`\<`Cid`\>
 
 Resolves a CNS name to a specific CID.
 
@@ -273,10 +273,11 @@ Resolves a CNS name to a specific CID.
 | :------ | :------ | :------ |
 | `bucketId` | `bigint` | The ID of the bucket to resolve the CNS name in. |
 | `cnsName` | `string` | The CNS name to resolve. |
+| `options?` | `CnsRecordGetOptions` | - |
 
 #### Returns
 
-`Promise`\<``null`` \| `string`\>
+`Promise`\<`Cid`\>
 
 A promise that resolves to the CID of the CNS name.
 

diff --git a/packages/ddc-client/docs/classes/JsonSigner.md b/packages/ddc-client/docs/classes/JsonSigner.md
@@ -0,0 +1,45 @@
+[@cere-ddc-sdk/ddc-client](../README.md) / JsonSigner
+
+# Class: JsonSigner
+
+Signer that uses a JSON object to create a keypair.
+
+**`Example`**
+
+```typescript
+const accountDataJson = {}; // Exported from Cere Wallet or other wallets
+const jsonSigner = new JsonSigner(accountDataJson, { passphrase: '1234' });
+const signature = await jsonSigner.sign('data');
+
+console.log(signature);
+```
+
+## Hierarchy
+
+- [`KeyringSigner`](KeyringSigner.md)
+
+  ↳ **`JsonSigner`**
+
+## Methods
+
+### isSigner
+
+▸ **isSigner**(`signer`): signer is Signer
+
+Checks if an object is a signer.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `signer` | `unknown` | The object to check. |
+
+#### Returns
+
+signer is Signer
+
+A boolean indicating whether the object is a signer.
+
+#### Inherited from
+
+[KeyringSigner](KeyringSigner.md).[isSigner](KeyringSigner.md#issigner)
diff --git a/packages/ddc-client/docs/classes/KeyringSigner.md b/packages/ddc-client/docs/classes/KeyringSigner.md
@@ -0,0 +1,49 @@
+[@cere-ddc-sdk/ddc-client](../README.md) / KeyringSigner
+
+# Class: KeyringSigner
+
+Signer that uses a keyring pair to sign data.
+
+**`Example`**
+
+```typescript
+const pair = new Keyring().addFromUri('//Alice');
+const keyringSigner = new KeyringSigner(pair);
+const signature = await keyringSigner.sign('data');
+
+console.log(signature);
+```
+
+## Hierarchy
+
+- [`Signer`](Signer.md)
+
+  ↳ **`KeyringSigner`**
+
+  ↳↳ [`UriSigner`](UriSigner.md)
+
+  ↳↳ [`JsonSigner`](JsonSigner.md)
+
+## Methods
+
+### isSigner
+
+▸ **isSigner**(`signer`): signer is Signer
+
+Checks if an object is a signer.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `signer` | `unknown` | The object to check. |
+
+#### Returns
+
+signer is Signer
+
+A boolean indicating whether the object is a signer.
+
+#### Inherited from
+
+[Signer](Signer.md).[isSigner](Signer.md#issigner)