diff --git a/docs/GLOSSARY.html b/docs/GLOSSARY.html index ca001aa78e..36621bb3b9 100644 --- a/docs/GLOSSARY.html +++ b/docs/GLOSSARY.html @@ -426,7 +426,7 @@ diff --git a/docs/METHODS_EVENTS.html b/docs/METHODS_EVENTS.html index d850aea89c..3193bc2589 100644 --- a/docs/METHODS_EVENTS.html +++ b/docs/METHODS_EVENTS.html @@ -600,7 +600,7 @@ diff --git a/docs/METHODS_EXTRINSICS.html b/docs/METHODS_EXTRINSICS.html index 0c785faa13..46b6c4f791 100644 --- a/docs/METHODS_EXTRINSICS.html +++ b/docs/METHODS_EXTRINSICS.html @@ -546,7 +546,7 @@ diff --git a/docs/METHODS_RPC.html b/docs/METHODS_RPC.html index a53c6f4fdc..59391dcfa6 100644 --- a/docs/METHODS_RPC.html +++ b/docs/METHODS_RPC.html @@ -556,7 +556,7 @@ diff --git a/docs/METHODS_STORAGE.html b/docs/METHODS_STORAGE.html index bf10c14ad3..261d0d2722 100644 --- a/docs/METHODS_STORAGE.html +++ b/docs/METHODS_STORAGE.html @@ -887,7 +887,7 @@ diff --git a/docs/api-observable/classes/_base_.apibase.md b/docs/api-observable/classes/_base_.apibase.md index 7c309cb5dc..9bbb36ba04 100644 --- a/docs/api-observable/classes/_base_.apibase.md +++ b/docs/api-observable/classes/_base_.apibase.md @@ -14,7 +14,7 @@ ⊕ **new ApiBase**(api: *`RpcRxInterface`*): [ApiBase](_base_.apibase.md) -*Defined in [Base.ts:34](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Base.ts#L34)* +*Defined in [Base.ts:34](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Base.ts#L34)* **Parameters:** @@ -34,7 +34,7 @@ ___ **● whenReady**: *`Observable`<`boolean`>* -*Defined in [Base.ts:34](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Base.ts#L34)* +*Defined in [Base.ts:34](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Base.ts#L34)* ___ @@ -43,7 +43,7 @@ ___ **● extrinsics**: *`Extrinsics`* = extrinsicsStatic -*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Base.ts#L42)* +*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Base.ts#L42)* ___ @@ -52,7 +52,7 @@ ___ **● storage**: *`Storage`* = storageStatic -*Defined in [Base.ts:43](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Base.ts#L43)* +*Defined in [Base.ts:43](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Base.ts#L43)* ___ @@ -64,7 +64,7 @@ ___ getgenesisHash(): `Hash` -*Defined in [Base.ts:88](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Base.ts#L88)* +*Defined in [Base.ts:88](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Base.ts#L88)* **Returns:** `Hash` @@ -78,7 +78,7 @@ ___ ▸ **isConnected**(): `Observable`<`boolean`> -*Defined in [Base.ts:92](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Base.ts#L92)* +*Defined in [Base.ts:92](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Base.ts#L92)* **Returns:** `Observable`<`boolean`> @@ -89,7 +89,7 @@ ___ ▸ **rawCall**<`T`>(__namedParameters: *`object`*, ...params: *`Array`<`any`>*): `Observable`<`T`> -*Defined in [Base.ts:96](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Base.ts#L96)* +*Defined in [Base.ts:96](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Base.ts#L96)* **Type parameters:** @@ -110,7 +110,7 @@ ___ ▸ **rawStorage**<`T`>(key: * `Uint8Array` | `StorageFunction`*, ...params: *`Array`<`any`>*): `Observable`< `T` | `undefined`> -*Defined in [Base.ts:109](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Base.ts#L109)* +*Defined in [Base.ts:109](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Base.ts#L109)* **Type parameters:** @@ -131,7 +131,7 @@ ___ ▸ **rawStorageMulti**<`T`>(...keys: *`Array`< `Uint8Array` | [`StorageFunction`] | [`StorageFunction`, `any`]>*): `Observable`<`T`> -*Defined in [Base.ts:126](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Base.ts#L126)* +*Defined in [Base.ts:126](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Base.ts#L126)* **Type parameters:** diff --git a/docs/api-observable/classes/_calls_.apicalls.md b/docs/api-observable/classes/_calls_.apicalls.md index f43d38eb53..5a9cb5d235 100644 --- a/docs/api-observable/classes/_calls_.apicalls.md +++ b/docs/api-observable/classes/_calls_.apicalls.md @@ -18,7 +18,7 @@ *Inherited from [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)* -*Defined in [Base.ts:34](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Base.ts#L34)* +*Defined in [Base.ts:34](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Base.ts#L34)* **Parameters:** @@ -40,7 +40,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[whenReady](_base_.apibase.md#whenready)* -*Defined in [Base.ts:34](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Base.ts#L34)* +*Defined in [Base.ts:34](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Base.ts#L34)* ___ @@ -51,7 +51,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[extrinsics](_base_.apibase.md#extrinsics)* -*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Base.ts#L42)* +*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Base.ts#L42)* ___ @@ -62,7 +62,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[storage](_base_.apibase.md#storage)* -*Defined in [Base.ts:43](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Base.ts#L43)* +*Defined in [Base.ts:43](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Base.ts#L43)* ___ @@ -76,7 +76,7 @@ getgenesisHash(): `Hash` *Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)* -*Defined in [Base.ts:88](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Base.ts#L88)* +*Defined in [Base.ts:88](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Base.ts#L88)* **Returns:** `Hash` @@ -92,7 +92,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[accountNonce](_queries_.apiqueries.md#accountnonce)* -*Defined in [Queries.ts:21](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L21)* +*Defined in [Queries.ts:21](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L21)* **Parameters:** @@ -111,7 +111,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[balanceFree](_queries_.apiqueries.md#balancefree)* -*Defined in [Queries.ts:25](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L25)* +*Defined in [Queries.ts:25](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L25)* **Parameters:** @@ -130,7 +130,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[balanceReserved](_queries_.apiqueries.md#balancereserved)* -*Defined in [Queries.ts:29](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L29)* +*Defined in [Queries.ts:29](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L29)* **Parameters:** @@ -147,7 +147,7 @@ ___ ▸ **bestNumber**(): `Observable`< `BlockNumber` | `undefined`> -*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Calls.ts#L13)* +*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Calls.ts#L13)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -160,7 +160,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[blockNow](_queries_.apiqueries.md#blocknow)* -*Defined in [Queries.ts:37](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L37)* +*Defined in [Queries.ts:37](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L37)* **Returns:** `Observable`< `Moment` | `undefined`> @@ -173,7 +173,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[blockPeriod](_queries_.apiqueries.md#blockperiod)* -*Defined in [Queries.ts:33](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L33)* +*Defined in [Queries.ts:33](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L33)* **Returns:** `Observable`< `Moment` | `undefined`> @@ -184,7 +184,7 @@ ___ ▸ **chain**(): `Observable`< `Text` | `undefined`> -*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Calls.ts#L25)* +*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Calls.ts#L25)* **Returns:** `Observable`< `Text` | `undefined`> @@ -197,7 +197,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyLaunchPeriod](_queries_.apiqueries.md#democracylaunchperiod)* -*Defined in [Queries.ts:41](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L41)* +*Defined in [Queries.ts:41](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L41)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -210,7 +210,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyNextTally](_queries_.apiqueries.md#democracynexttally)* -*Defined in [Queries.ts:45](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L45)* +*Defined in [Queries.ts:45](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L45)* **Returns:** `Observable`< `ReferendumIndex` | `undefined`> @@ -223,7 +223,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyVotingPeriod](_queries_.apiqueries.md#democracyvotingperiod)* -*Defined in [Queries.ts:135](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L135)* +*Defined in [Queries.ts:135](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L135)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -236,7 +236,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[eraLastLengthChange](_queries_.apiqueries.md#eralastlengthchange)* -*Defined in [Queries.ts:160](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L160)* +*Defined in [Queries.ts:160](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L160)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -249,7 +249,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[fees](_queries_.apiqueries.md#fees)* -*Defined in [Queries.ts:139](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L139)* +*Defined in [Queries.ts:139](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L139)* **Returns:** `Observable`<`RxFees`> @@ -262,7 +262,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[getAccountEnumSet](_queries_.apiqueries.md#getaccountenumset)* -*Defined in [Queries.ts:49](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L49)* +*Defined in [Queries.ts:49](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L49)* **Parameters:** @@ -279,7 +279,7 @@ ___ ▸ **getBlock**(hash: *`Uint8Array`*): `Observable`< `SignedBlock` | `undefined`> -*Defined in [Calls.ts:29](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Calls.ts#L29)* +*Defined in [Calls.ts:29](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Calls.ts#L29)* **Parameters:** @@ -298,7 +298,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[isConnected](_base_.apibase.md#isconnected)* -*Defined in [Base.ts:92](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Base.ts#L92)* +*Defined in [Base.ts:92](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Base.ts#L92)* **Returns:** `Observable`<`boolean`> @@ -311,7 +311,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[nextAccountEnumSet](_queries_.apiqueries.md#nextaccountenumset)* -*Defined in [Queries.ts:63](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L63)* +*Defined in [Queries.ts:63](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L63)* **Returns:** `Observable`< `AccountIndex` | `undefined`> @@ -324,7 +324,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[proposalDeposits](_queries_.apiqueries.md#proposaldeposits)* -*Defined in [Queries.ts:67](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L67)* +*Defined in [Queries.ts:67](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L67)* **Parameters:** @@ -343,7 +343,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[publicProposals](_queries_.apiqueries.md#publicproposals)* -*Defined in [Queries.ts:80](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L80)* +*Defined in [Queries.ts:80](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L80)* **Returns:** `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>> @@ -356,7 +356,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[rawCall](_base_.apibase.md#rawcall)* -*Defined in [Base.ts:96](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Base.ts#L96)* +*Defined in [Base.ts:96](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Base.ts#L96)* **Type parameters:** @@ -379,7 +379,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[rawStorage](_base_.apibase.md#rawstorage)* -*Defined in [Base.ts:109](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Base.ts#L109)* +*Defined in [Base.ts:109](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Base.ts#L109)* **Type parameters:** @@ -402,7 +402,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[rawStorageMulti](_base_.apibase.md#rawstoragemulti)* -*Defined in [Base.ts:126](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Base.ts#L126)* +*Defined in [Base.ts:126](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Base.ts#L126)* **Type parameters:** @@ -424,7 +424,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumCount](_queries_.apiqueries.md#referendumcount)* -*Defined in [Queries.ts:100](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L100)* +*Defined in [Queries.ts:100](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L100)* **Returns:** `Observable`< `ReferendumIndex` | `undefined`> @@ -437,7 +437,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumInfo](_queries_.apiqueries.md#referenduminfo)* -*Defined in [Queries.ts:104](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L104)* +*Defined in [Queries.ts:104](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L104)* **Parameters:** @@ -456,7 +456,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumVote](_queries_.apiqueries.md#referendumvote)* -*Defined in [Queries.ts:117](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L117)* +*Defined in [Queries.ts:117](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L117)* **Parameters:** @@ -476,7 +476,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumVoters](_queries_.apiqueries.md#referendumvoters)* -*Defined in [Queries.ts:121](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L121)* +*Defined in [Queries.ts:121](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L121)* **Parameters:** @@ -495,7 +495,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentIndex](_queries_.apiqueries.md#sessioncurrentindex)* -*Defined in [Queries.ts:172](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L172)* +*Defined in [Queries.ts:172](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L172)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -508,7 +508,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentStart](_queries_.apiqueries.md#sessioncurrentstart)* -*Defined in [Queries.ts:176](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L176)* +*Defined in [Queries.ts:176](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L176)* **Returns:** `Observable`< `Moment` | `undefined`> @@ -521,7 +521,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLastLengthChange](_queries_.apiqueries.md#sessionlastlengthchange)* -*Defined in [Queries.ts:180](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L180)* +*Defined in [Queries.ts:180](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L180)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -534,7 +534,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLength](_queries_.apiqueries.md#sessionlength)* -*Defined in [Queries.ts:184](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L184)* +*Defined in [Queries.ts:184](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L184)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -547,7 +547,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionReward](_queries_.apiqueries.md#sessionreward)* -*Defined in [Queries.ts:164](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L164)* +*Defined in [Queries.ts:164](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L164)* **Returns:** `Observable`< `Perbill` | `undefined`> @@ -560,7 +560,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionRewardCurrent](_queries_.apiqueries.md#sessionrewardcurrent)* -*Defined in [Queries.ts:168](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L168)* +*Defined in [Queries.ts:168](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L168)* **Returns:** `Observable`< `Balance` | `undefined`> @@ -573,7 +573,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionValidators](_queries_.apiqueries.md#sessionvalidators)* -*Defined in [Queries.ts:192](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L192)* +*Defined in [Queries.ts:192](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L192)* **Returns:** `Observable`<`Array`<`AccountId`>> @@ -586,7 +586,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionsPerEra](_queries_.apiqueries.md#sessionsperera)* -*Defined in [Queries.ts:188](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L188)* +*Defined in [Queries.ts:188](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L188)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -599,7 +599,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingIntentions](_queries_.apiqueries.md#stakingintentions)* -*Defined in [Queries.ts:206](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L206)* +*Defined in [Queries.ts:206](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L206)* **Returns:** `Observable`<`Array`<`AccountId`>> @@ -612,7 +612,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominating](_queries_.apiqueries.md#stakingnominating)* -*Defined in [Queries.ts:234](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L234)* +*Defined in [Queries.ts:234](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L234)* **Parameters:** @@ -631,7 +631,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominatorsFor](_queries_.apiqueries.md#stakingnominatorsfor)* -*Defined in [Queries.ts:220](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L220)* +*Defined in [Queries.ts:220](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L220)* **Parameters:** @@ -648,7 +648,7 @@ ___ ▸ **submitAndWatchExtrinsic**(extrinsic: *`Extrinsic`*): `Observable`< `ExtrinsicStatus` | `undefined`> -*Defined in [Calls.ts:51](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Calls.ts#L51)* +*Defined in [Calls.ts:51](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Calls.ts#L51)* **Parameters:** @@ -665,7 +665,7 @@ ___ ▸ **submitExtrinsic**(extrinsic: *`Extrinsic`*): `Observable`< `Hash` | `undefined`> -*Defined in [Calls.ts:47](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Calls.ts#L47)* +*Defined in [Calls.ts:47](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Calls.ts#L47)* **Parameters:** @@ -682,7 +682,7 @@ ___ ▸ **subscribeNewHead**(): `Observable`< `Header` | `undefined`> -*Defined in [Calls.ts:33](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Calls.ts#L33)* +*Defined in [Calls.ts:33](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Calls.ts#L33)* **Returns:** `Observable`< `Header` | `undefined`> @@ -695,7 +695,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[systemEvents](_queries_.apiqueries.md#systemevents)* -*Defined in [Queries.ts:238](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L238)* +*Defined in [Queries.ts:238](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L238)* **Returns:** `Observable`<`Array`<`EventRecord`>> @@ -706,7 +706,7 @@ ___ ▸ **systemName**(): `Observable`< `Text` | `undefined`> -*Defined in [Calls.ts:39](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Calls.ts#L39)* +*Defined in [Calls.ts:39](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Calls.ts#L39)* **Returns:** `Observable`< `Text` | `undefined`> @@ -717,7 +717,7 @@ ___ ▸ **systemVersion**(): `Observable`< `Text` | `undefined`> -*Defined in [Calls.ts:43](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Calls.ts#L43)* +*Defined in [Calls.ts:43](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Calls.ts#L43)* **Returns:** `Observable`< `Text` | `undefined`> @@ -730,7 +730,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[validatorCount](_queries_.apiqueries.md#validatorcount)* -*Defined in [Queries.ts:252](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L252)* +*Defined in [Queries.ts:252](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L252)* **Returns:** `Observable`< `u32` | `undefined`> diff --git a/docs/api-observable/classes/_classes_.rxproposal.md b/docs/api-observable/classes/_classes_.rxproposal.md index 67bf4e98d1..f39ca1441e 100644 --- a/docs/api-observable/classes/_classes_.rxproposal.md +++ b/docs/api-observable/classes/_classes_.rxproposal.md @@ -25,7 +25,7 @@ *Overrides Struct.__constructor* -*Defined in [classes.ts:12](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/classes.ts#L12)* +*Defined in [classes.ts:12](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/classes.ts#L12)* **Parameters:** @@ -58,7 +58,7 @@ ___ *Inherited from Struct.raw* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L25)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L25)* ___ @@ -83,7 +83,7 @@ getType(): `E` *Inherited from Struct.Type* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L123)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -94,7 +94,7 @@ ___ getaddress(): `AccountId` -*Defined in [classes.ts:21](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/classes.ts#L21)* +*Defined in [classes.ts:21](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/classes.ts#L21)* **Returns:** `AccountId` @@ -107,7 +107,7 @@ getencodedLength(): `number` *Inherited from Struct.encodedLength* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L127)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -118,7 +118,7 @@ ___ getid(): `PropIndex` -*Defined in [classes.ts:25](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/classes.ts#L25)* +*Defined in [classes.ts:25](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/classes.ts#L25)* **Returns:** `PropIndex` @@ -129,7 +129,7 @@ ___ getproposal(): `Proposal` -*Defined in [classes.ts:29](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/classes.ts#L29)* +*Defined in [classes.ts:29](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/classes.ts#L29)* **Returns:** `Proposal` @@ -246,7 +246,7 @@ ___ *Inherited from Struct.getAtIndex* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L133)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -319,7 +319,7 @@ ___ *Inherited from Struct.toArray* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L137)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<`Base`> @@ -332,7 +332,7 @@ ___ *Inherited from Struct.toHex* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L141)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -345,7 +345,7 @@ ___ *Inherited from Struct.toJSON* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L145)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L145)* **Returns:** `any` @@ -358,7 +358,7 @@ ___ *Inherited from Struct.toString* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L156)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -371,7 +371,7 @@ ___ *Inherited from Struct.toU8a* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L160)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -405,7 +405,7 @@ ___ *Inherited from Struct.with* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L113)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/api-observable/classes/_classes_.rxproposaldeposits.md b/docs/api-observable/classes/_classes_.rxproposaldeposits.md index 6f3d2d6d90..f135d1b37e 100644 --- a/docs/api-observable/classes/_classes_.rxproposaldeposits.md +++ b/docs/api-observable/classes/_classes_.rxproposaldeposits.md @@ -25,7 +25,7 @@ *Overrides Struct.__constructor* -*Defined in [classes.ts:36](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/classes.ts#L36)* +*Defined in [classes.ts:36](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/classes.ts#L36)* **Parameters:** @@ -58,7 +58,7 @@ ___ *Inherited from Struct.raw* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L25)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L25)* ___ @@ -83,7 +83,7 @@ getType(): `E` *Inherited from Struct.Type* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L123)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -94,7 +94,7 @@ ___ getaddresses(): `Vector`<`AccountId`> -*Defined in [classes.ts:44](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/classes.ts#L44)* +*Defined in [classes.ts:44](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/classes.ts#L44)* **Returns:** `Vector`<`AccountId`> @@ -105,7 +105,7 @@ ___ getbalance(): `Balance` -*Defined in [classes.ts:48](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/classes.ts#L48)* +*Defined in [classes.ts:48](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/classes.ts#L48)* **Returns:** `Balance` @@ -118,7 +118,7 @@ getencodedLength(): `number` *Inherited from Struct.encodedLength* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L127)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -235,7 +235,7 @@ ___ *Inherited from Struct.getAtIndex* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L133)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -308,7 +308,7 @@ ___ *Inherited from Struct.toArray* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L137)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<`Base`> @@ -321,7 +321,7 @@ ___ *Inherited from Struct.toHex* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L141)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -334,7 +334,7 @@ ___ *Inherited from Struct.toJSON* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L145)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L145)* **Returns:** `any` @@ -347,7 +347,7 @@ ___ *Inherited from Struct.toString* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L156)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -360,7 +360,7 @@ ___ *Inherited from Struct.toU8a* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L160)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -394,7 +394,7 @@ ___ *Inherited from Struct.with* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L113)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/api-observable/classes/_classes_.rxreferendum.md b/docs/api-observable/classes/_classes_.rxreferendum.md index 962b2e3212..cef248d0be 100644 --- a/docs/api-observable/classes/_classes_.rxreferendum.md +++ b/docs/api-observable/classes/_classes_.rxreferendum.md @@ -25,7 +25,7 @@ *Overrides Struct.__constructor* -*Defined in [classes.ts:55](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/classes.ts#L55)* +*Defined in [classes.ts:55](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/classes.ts#L55)* **Parameters:** @@ -59,7 +59,7 @@ ___ *Inherited from Struct.raw* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L25)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L25)* ___ @@ -84,7 +84,7 @@ getType(): `E` *Inherited from Struct.Type* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L123)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -95,7 +95,7 @@ ___ getblockNumber(): `BlockNumber` -*Defined in [classes.ts:65](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/classes.ts#L65)* +*Defined in [classes.ts:65](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/classes.ts#L65)* **Returns:** `BlockNumber` @@ -108,7 +108,7 @@ getencodedLength(): `number` *Inherited from Struct.encodedLength* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L127)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -119,7 +119,7 @@ ___ getid(): `ReferendumIndex` -*Defined in [classes.ts:69](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/classes.ts#L69)* +*Defined in [classes.ts:69](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/classes.ts#L69)* **Returns:** `ReferendumIndex` @@ -130,7 +130,7 @@ ___ getproposal(): `Proposal` -*Defined in [classes.ts:73](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/classes.ts#L73)* +*Defined in [classes.ts:73](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/classes.ts#L73)* **Returns:** `Proposal` @@ -141,7 +141,7 @@ ___ getvoteThreshold(): `VoteThreshold` -*Defined in [classes.ts:77](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/classes.ts#L77)* +*Defined in [classes.ts:77](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/classes.ts#L77)* **Returns:** `VoteThreshold` @@ -258,7 +258,7 @@ ___ *Inherited from Struct.getAtIndex* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L133)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -331,7 +331,7 @@ ___ *Inherited from Struct.toArray* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L137)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<`Base`> @@ -344,7 +344,7 @@ ___ *Inherited from Struct.toHex* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L141)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -357,7 +357,7 @@ ___ *Inherited from Struct.toJSON* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L145)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L145)* **Returns:** `any` @@ -370,7 +370,7 @@ ___ *Inherited from Struct.toString* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L156)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -383,7 +383,7 @@ ___ *Inherited from Struct.toU8a* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L160)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -417,7 +417,7 @@ ___ *Inherited from Struct.with* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L113)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/api-observable/classes/_combined_.apicombined.md b/docs/api-observable/classes/_combined_.apicombined.md index 8f848dd8b8..d8f19ab2ce 100644 --- a/docs/api-observable/classes/_combined_.apicombined.md +++ b/docs/api-observable/classes/_combined_.apicombined.md @@ -18,7 +18,7 @@ *Inherited from [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)* -*Defined in [Base.ts:34](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Base.ts#L34)* +*Defined in [Base.ts:34](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Base.ts#L34)* **Parameters:** @@ -40,7 +40,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[whenReady](_base_.apibase.md#whenready)* -*Defined in [Base.ts:34](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Base.ts#L34)* +*Defined in [Base.ts:34](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Base.ts#L34)* ___ @@ -51,7 +51,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[extrinsics](_base_.apibase.md#extrinsics)* -*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Base.ts#L42)* +*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Base.ts#L42)* ___ @@ -62,7 +62,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[storage](_base_.apibase.md#storage)* -*Defined in [Base.ts:43](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Base.ts#L43)* +*Defined in [Base.ts:43](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Base.ts#L43)* ___ @@ -76,7 +76,7 @@ getgenesisHash(): `Hash` *Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)* -*Defined in [Base.ts:88](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Base.ts#L88)* +*Defined in [Base.ts:88](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Base.ts#L88)* **Returns:** `Hash` @@ -90,7 +90,7 @@ ___ ▸ **accountIdAndIndex**(address?: * `AccountId` | `AccountIndex` | `string` | `null`*): `Observable`<[`AccountId` | `undefined`, `AccountIndex` | `undefined`]> -*Defined in [Combined.ts:81](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Combined.ts#L81)* +*Defined in [Combined.ts:79](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Combined.ts#L79)* **Parameters:** @@ -107,7 +107,7 @@ ___ ▸ **accountIdFromIndex**(_accountIndex: * `AccountIndex` | `string`*): `Observable`< `AccountId` | `undefined`> -*Defined in [Combined.ts:55](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Combined.ts#L55)* +*Defined in [Combined.ts:53](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Combined.ts#L53)* **Parameters:** @@ -124,7 +124,7 @@ ___ ▸ **accountIndexFromId**(accountId: * `AccountId` | `string`*): `Observable`< `AccountIndex` | `undefined`> -*Defined in [Combined.ts:70](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Combined.ts#L70)* +*Defined in [Combined.ts:68](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Combined.ts#L68)* **Parameters:** @@ -141,7 +141,7 @@ ___ ▸ **accountIndexes**(): `Observable`<`object`> -*Defined in [Combined.ts:23](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Combined.ts#L23)* +*Defined in [Combined.ts:23](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Combined.ts#L23)* **Returns:** `Observable`<`object`> @@ -154,7 +154,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[accountNonce](_queries_.apiqueries.md#accountnonce)* -*Defined in [Queries.ts:21](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L21)* +*Defined in [Queries.ts:21](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L21)* **Parameters:** @@ -173,7 +173,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[balanceFree](_queries_.apiqueries.md#balancefree)* -*Defined in [Queries.ts:25](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L25)* +*Defined in [Queries.ts:25](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L25)* **Parameters:** @@ -192,7 +192,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[balanceReserved](_queries_.apiqueries.md#balancereserved)* -*Defined in [Queries.ts:29](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L29)* +*Defined in [Queries.ts:29](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L29)* **Parameters:** @@ -211,7 +211,7 @@ ___ *Inherited from [ApiCalls](_calls_.apicalls.md).[bestNumber](_calls_.apicalls.md#bestnumber)* -*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Calls.ts#L13)* +*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Calls.ts#L13)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -224,7 +224,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[blockNow](_queries_.apiqueries.md#blocknow)* -*Defined in [Queries.ts:37](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L37)* +*Defined in [Queries.ts:37](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L37)* **Returns:** `Observable`< `Moment` | `undefined`> @@ -237,7 +237,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[blockPeriod](_queries_.apiqueries.md#blockperiod)* -*Defined in [Queries.ts:33](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L33)* +*Defined in [Queries.ts:33](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L33)* **Returns:** `Observable`< `Moment` | `undefined`> @@ -250,7 +250,7 @@ ___ *Inherited from [ApiCalls](_calls_.apicalls.md).[chain](_calls_.apicalls.md#chain)* -*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Calls.ts#L25)* +*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Calls.ts#L25)* **Returns:** `Observable`< `Text` | `undefined`> @@ -263,7 +263,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyLaunchPeriod](_queries_.apiqueries.md#democracylaunchperiod)* -*Defined in [Queries.ts:41](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L41)* +*Defined in [Queries.ts:41](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L41)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -276,7 +276,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyNextTally](_queries_.apiqueries.md#democracynexttally)* -*Defined in [Queries.ts:45](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L45)* +*Defined in [Queries.ts:45](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L45)* **Returns:** `Observable`< `ReferendumIndex` | `undefined`> @@ -287,7 +287,7 @@ ___ ▸ **democracyReferendumVoters**(referendumId: * `ReferendumIndex` | `BN` | `number`*): `Observable`<`Array`<`RxReferendumVote`>> -*Defined in [Combined.ts:139](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Combined.ts#L139)* +*Defined in [Combined.ts:137](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Combined.ts#L137)* **Parameters:** @@ -304,7 +304,7 @@ ___ ▸ **democracyVotersBalancesOf**(referendumId: * `ReferendumIndex` | `BN` | `number`*): `Observable`<`Array`<`Balance`>> -*Defined in [Combined.ts:184](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Combined.ts#L184)* +*Defined in [Combined.ts:182](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Combined.ts#L182)* **Parameters:** @@ -321,7 +321,7 @@ ___ ▸ **democracyVotersVotesOf**(referendumId: * `ReferendumIndex` | `BN` | `number`*): `Observable`<`Array`<`Bool`>> -*Defined in [Combined.ts:200](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Combined.ts#L200)* +*Defined in [Combined.ts:198](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Combined.ts#L198)* **Parameters:** @@ -340,7 +340,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyVotingPeriod](_queries_.apiqueries.md#democracyvotingperiod)* -*Defined in [Queries.ts:135](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L135)* +*Defined in [Queries.ts:135](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L135)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -351,7 +351,7 @@ ___ ▸ **eraBlockLength**(): `Observable`< `BlockNumber` | `undefined`> -*Defined in [Combined.ts:211](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Combined.ts#L211)* +*Defined in [Combined.ts:209](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Combined.ts#L209)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -362,7 +362,7 @@ ___ ▸ **eraBlockProgress**(): `Observable`< `BlockNumber` | `undefined`> -*Defined in [Combined.ts:226](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Combined.ts#L226)* +*Defined in [Combined.ts:224](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Combined.ts#L224)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -373,7 +373,7 @@ ___ ▸ **eraBlockRemaining**(): `Observable`< `BlockNumber` | `undefined`> -*Defined in [Combined.ts:249](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Combined.ts#L249)* +*Defined in [Combined.ts:247](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Combined.ts#L247)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -386,7 +386,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[eraLastLengthChange](_queries_.apiqueries.md#eralastlengthchange)* -*Defined in [Queries.ts:160](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L160)* +*Defined in [Queries.ts:160](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L160)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -399,7 +399,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[fees](_queries_.apiqueries.md#fees)* -*Defined in [Queries.ts:139](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L139)* +*Defined in [Queries.ts:139](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L139)* **Returns:** `Observable`<`RxFees`> @@ -412,7 +412,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[getAccountEnumSet](_queries_.apiqueries.md#getaccountenumset)* -*Defined in [Queries.ts:49](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L49)* +*Defined in [Queries.ts:49](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L49)* **Parameters:** @@ -431,7 +431,7 @@ ___ *Inherited from [ApiCalls](_calls_.apicalls.md).[getBlock](_calls_.apicalls.md#getblock)* -*Defined in [Calls.ts:29](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Calls.ts#L29)* +*Defined in [Calls.ts:29](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Calls.ts#L29)* **Parameters:** @@ -450,7 +450,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[isConnected](_base_.apibase.md#isconnected)* -*Defined in [Base.ts:92](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Base.ts#L92)* +*Defined in [Base.ts:92](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Base.ts#L92)* **Returns:** `Observable`<`boolean`> @@ -463,7 +463,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[nextAccountEnumSet](_queries_.apiqueries.md#nextaccountenumset)* -*Defined in [Queries.ts:63](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L63)* +*Defined in [Queries.ts:63](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L63)* **Returns:** `Observable`< `AccountIndex` | `undefined`> @@ -476,7 +476,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[proposalDeposits](_queries_.apiqueries.md#proposaldeposits)* -*Defined in [Queries.ts:67](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L67)* +*Defined in [Queries.ts:67](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L67)* **Parameters:** @@ -493,7 +493,7 @@ ___ ▸ **publicProposalCount**(): `Observable`<`number`> -*Defined in [Combined.ts:117](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Combined.ts#L117)* +*Defined in [Combined.ts:115](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Combined.ts#L115)* **Returns:** `Observable`<`number`> @@ -506,7 +506,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[publicProposals](_queries_.apiqueries.md#publicproposals)* -*Defined in [Queries.ts:80](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L80)* +*Defined in [Queries.ts:80](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L80)* **Returns:** `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>> @@ -519,7 +519,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[rawCall](_base_.apibase.md#rawcall)* -*Defined in [Base.ts:96](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Base.ts#L96)* +*Defined in [Base.ts:96](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Base.ts#L96)* **Type parameters:** @@ -542,7 +542,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[rawStorage](_base_.apibase.md#rawstorage)* -*Defined in [Base.ts:109](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Base.ts#L109)* +*Defined in [Base.ts:109](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Base.ts#L109)* **Type parameters:** @@ -565,7 +565,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[rawStorageMulti](_base_.apibase.md#rawstoragemulti)* -*Defined in [Base.ts:126](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Base.ts#L126)* +*Defined in [Base.ts:126](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Base.ts#L126)* **Type parameters:** @@ -587,7 +587,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumCount](_queries_.apiqueries.md#referendumcount)* -*Defined in [Queries.ts:100](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L100)* +*Defined in [Queries.ts:100](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L100)* **Returns:** `Observable`< `ReferendumIndex` | `undefined`> @@ -600,7 +600,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumInfo](_queries_.apiqueries.md#referenduminfo)* -*Defined in [Queries.ts:104](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L104)* +*Defined in [Queries.ts:104](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L104)* **Parameters:** @@ -619,7 +619,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumVote](_queries_.apiqueries.md#referendumvote)* -*Defined in [Queries.ts:117](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L117)* +*Defined in [Queries.ts:117](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L117)* **Parameters:** @@ -639,7 +639,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumVoters](_queries_.apiqueries.md#referendumvoters)* -*Defined in [Queries.ts:121](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L121)* +*Defined in [Queries.ts:121](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L121)* **Parameters:** @@ -656,7 +656,7 @@ ___ ▸ **referendumVotes**(index: * `ReferendumIndex` | `BN` | `number`*, addresses: *`Array`< `AccountId` | `string`>*): `Observable`<`boolean`> -*Defined in [Combined.ts:176](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Combined.ts#L176)* +*Defined in [Combined.ts:174](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Combined.ts#L174)* **Parameters:** @@ -674,7 +674,7 @@ ___ ▸ **referendums**(): `Observable`<`Array`<[RxReferendum](_classes_.rxreferendum.md)>> -*Defined in [Combined.ts:155](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Combined.ts#L155)* +*Defined in [Combined.ts:153](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Combined.ts#L153)* **Returns:** `Observable`<`Array`<[RxReferendum](_classes_.rxreferendum.md)>> @@ -685,7 +685,7 @@ ___ ▸ **referendumsInfo**(referendumIds: *`Array`< `ReferendumIndex` | `BN` | `number`>*): `Observable`<`Array`<[RxReferendum](_classes_.rxreferendum.md)>> -*Defined in [Combined.ts:127](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Combined.ts#L127)* +*Defined in [Combined.ts:125](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Combined.ts#L125)* **Parameters:** @@ -702,7 +702,7 @@ ___ ▸ **sessionBlockProgress**(): `Observable`< `BlockNumber` | `undefined`> -*Defined in [Combined.ts:264](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Combined.ts#L264)* +*Defined in [Combined.ts:262](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Combined.ts#L262)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -713,7 +713,7 @@ ___ ▸ **sessionBlockRemaining**(): `Observable`< `BlockNumber` | `undefined`> -*Defined in [Combined.ts:284](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Combined.ts#L284)* +*Defined in [Combined.ts:282](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Combined.ts#L282)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -724,7 +724,7 @@ ___ ▸ **sessionBrokenValue**(): `Observable`< `Moment` | `undefined`> -*Defined in [Combined.ts:299](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Combined.ts#L299)* +*Defined in [Combined.ts:297](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Combined.ts#L297)* **Returns:** `Observable`< `Moment` | `undefined`> @@ -737,7 +737,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentIndex](_queries_.apiqueries.md#sessioncurrentindex)* -*Defined in [Queries.ts:172](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L172)* +*Defined in [Queries.ts:172](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L172)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -750,7 +750,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentStart](_queries_.apiqueries.md#sessioncurrentstart)* -*Defined in [Queries.ts:176](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L176)* +*Defined in [Queries.ts:176](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L176)* **Returns:** `Observable`< `Moment` | `undefined`> @@ -763,7 +763,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLastLengthChange](_queries_.apiqueries.md#sessionlastlengthchange)* -*Defined in [Queries.ts:180](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L180)* +*Defined in [Queries.ts:180](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L180)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -776,7 +776,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLength](_queries_.apiqueries.md#sessionlength)* -*Defined in [Queries.ts:184](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L184)* +*Defined in [Queries.ts:184](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L184)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -789,7 +789,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionReward](_queries_.apiqueries.md#sessionreward)* -*Defined in [Queries.ts:164](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L164)* +*Defined in [Queries.ts:164](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L164)* **Returns:** `Observable`< `Perbill` | `undefined`> @@ -802,7 +802,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionRewardCurrent](_queries_.apiqueries.md#sessionrewardcurrent)* -*Defined in [Queries.ts:168](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L168)* +*Defined in [Queries.ts:168](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L168)* **Returns:** `Observable`< `Balance` | `undefined`> @@ -813,7 +813,7 @@ ___ ▸ **sessionTimeExpected**(): `Observable`< `Moment` | `undefined`> -*Defined in [Combined.ts:318](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Combined.ts#L318)* +*Defined in [Combined.ts:316](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Combined.ts#L316)* **Returns:** `Observable`< `Moment` | `undefined`> @@ -824,7 +824,7 @@ ___ ▸ **sessionTimeRemaining**(): `Observable`< `Moment` | `undefined`> -*Defined in [Combined.ts:333](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Combined.ts#L333)* +*Defined in [Combined.ts:331](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Combined.ts#L331)* **Returns:** `Observable`< `Moment` | `undefined`> @@ -837,7 +837,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionValidators](_queries_.apiqueries.md#sessionvalidators)* -*Defined in [Queries.ts:192](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L192)* +*Defined in [Queries.ts:192](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L192)* **Returns:** `Observable`<`Array`<`AccountId`>> @@ -850,7 +850,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionsPerEra](_queries_.apiqueries.md#sessionsperera)* -*Defined in [Queries.ts:188](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L188)* +*Defined in [Queries.ts:188](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L188)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -863,7 +863,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingIntentions](_queries_.apiqueries.md#stakingintentions)* -*Defined in [Queries.ts:206](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L206)* +*Defined in [Queries.ts:206](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L206)* **Returns:** `Observable`<`Array`<`AccountId`>> @@ -876,7 +876,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominating](_queries_.apiqueries.md#stakingnominating)* -*Defined in [Queries.ts:234](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L234)* +*Defined in [Queries.ts:234](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L234)* **Parameters:** @@ -895,7 +895,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominatorsFor](_queries_.apiqueries.md#stakingnominatorsfor)* -*Defined in [Queries.ts:220](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L220)* +*Defined in [Queries.ts:220](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L220)* **Parameters:** @@ -914,7 +914,7 @@ ___ *Inherited from [ApiCalls](_calls_.apicalls.md).[submitAndWatchExtrinsic](_calls_.apicalls.md#submitandwatchextrinsic)* -*Defined in [Calls.ts:51](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Calls.ts#L51)* +*Defined in [Calls.ts:51](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Calls.ts#L51)* **Parameters:** @@ -933,7 +933,7 @@ ___ *Inherited from [ApiCalls](_calls_.apicalls.md).[submitExtrinsic](_calls_.apicalls.md#submitextrinsic)* -*Defined in [Calls.ts:47](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Calls.ts#L47)* +*Defined in [Calls.ts:47](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Calls.ts#L47)* **Parameters:** @@ -952,7 +952,7 @@ ___ *Inherited from [ApiCalls](_calls_.apicalls.md).[subscribeNewHead](_calls_.apicalls.md#subscribenewhead)* -*Defined in [Calls.ts:33](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Calls.ts#L33)* +*Defined in [Calls.ts:33](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Calls.ts#L33)* **Returns:** `Observable`< `Header` | `undefined`> @@ -965,7 +965,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[systemEvents](_queries_.apiqueries.md#systemevents)* -*Defined in [Queries.ts:238](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L238)* +*Defined in [Queries.ts:238](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L238)* **Returns:** `Observable`<`Array`<`EventRecord`>> @@ -978,7 +978,7 @@ ___ *Inherited from [ApiCalls](_calls_.apicalls.md).[systemName](_calls_.apicalls.md#systemname)* -*Defined in [Calls.ts:39](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Calls.ts#L39)* +*Defined in [Calls.ts:39](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Calls.ts#L39)* **Returns:** `Observable`< `Text` | `undefined`> @@ -991,7 +991,7 @@ ___ *Inherited from [ApiCalls](_calls_.apicalls.md).[systemVersion](_calls_.apicalls.md#systemversion)* -*Defined in [Calls.ts:43](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Calls.ts#L43)* +*Defined in [Calls.ts:43](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Calls.ts#L43)* **Returns:** `Observable`< `Text` | `undefined`> @@ -1002,7 +1002,7 @@ ___ ▸ **validatingBalance**(address: * `AccountId` | `string`*): `Observable`<`RxBalance`> -*Defined in [Combined.ts:348](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Combined.ts#L348)* +*Defined in [Combined.ts:346](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Combined.ts#L346)* **Parameters:** @@ -1019,7 +1019,7 @@ ___ ▸ **validatingBalances**(...addresses: *`Array`< `AccountId` | `string`>*): `Observable`<`RxBalanceMap`> -*Defined in [Combined.ts:373](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Combined.ts#L373)* +*Defined in [Combined.ts:371](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Combined.ts#L371)* **Parameters:** @@ -1038,7 +1038,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[validatorCount](_queries_.apiqueries.md#validatorcount)* -*Defined in [Queries.ts:252](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L252)* +*Defined in [Queries.ts:252](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L252)* **Returns:** `Observable`< `u32` | `undefined`> @@ -1049,7 +1049,7 @@ ___ ▸ **votingBalance**(address: * `AccountIndex` | `AccountId` | `string`*): `Observable`<`RxBalance`> -*Defined in [Combined.ts:387](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Combined.ts#L387)* +*Defined in [Combined.ts:385](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Combined.ts#L385)* **Parameters:** @@ -1066,7 +1066,7 @@ ___ ▸ **votingBalances**(...addresses: *`Array`< `AccountId` | `string`>*): `Observable`<`RxBalance`[]> -*Defined in [Combined.ts:427](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Combined.ts#L427)* +*Defined in [Combined.ts:425](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Combined.ts#L425)* **Parameters:** @@ -1083,7 +1083,7 @@ ___ ▸ **votingBalancesNominatorsFor**(address: * `AccountId` | `string`*): `Observable`<`any`> -*Defined in [Combined.ts:416](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Combined.ts#L416)* +*Defined in [Combined.ts:414](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Combined.ts#L414)* **Parameters:** diff --git a/docs/api-observable/classes/_index_.api.md b/docs/api-observable/classes/_index_.api.md index f867ca9dd7..582e4acd8e 100644 --- a/docs/api-observable/classes/_index_.api.md +++ b/docs/api-observable/classes/_index_.api.md @@ -16,7 +16,7 @@ *Inherited from [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)* -*Defined in [Base.ts:34](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Base.ts#L34)* +*Defined in [Base.ts:34](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Base.ts#L34)* **Parameters:** @@ -38,7 +38,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[whenReady](_base_.apibase.md#whenready)* -*Defined in [Base.ts:34](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Base.ts#L34)* +*Defined in [Base.ts:34](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Base.ts#L34)* ___ @@ -49,7 +49,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[extrinsics](_base_.apibase.md#extrinsics)* -*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Base.ts#L42)* +*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Base.ts#L42)* ___ @@ -60,7 +60,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[storage](_base_.apibase.md#storage)* -*Defined in [Base.ts:43](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Base.ts#L43)* +*Defined in [Base.ts:43](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Base.ts#L43)* ___ @@ -74,7 +74,7 @@ getgenesisHash(): `Hash` *Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)* -*Defined in [Base.ts:88](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Base.ts#L88)* +*Defined in [Base.ts:88](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Base.ts#L88)* **Returns:** `Hash` @@ -90,7 +90,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[accountIdAndIndex](_combined_.apicombined.md#accountidandindex)* -*Defined in [Combined.ts:81](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Combined.ts#L81)* +*Defined in [Combined.ts:79](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Combined.ts#L79)* **Parameters:** @@ -109,7 +109,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[accountIdFromIndex](_combined_.apicombined.md#accountidfromindex)* -*Defined in [Combined.ts:55](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Combined.ts#L55)* +*Defined in [Combined.ts:53](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Combined.ts#L53)* **Parameters:** @@ -128,7 +128,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[accountIndexFromId](_combined_.apicombined.md#accountindexfromid)* -*Defined in [Combined.ts:70](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Combined.ts#L70)* +*Defined in [Combined.ts:68](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Combined.ts#L68)* **Parameters:** @@ -147,7 +147,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[accountIndexes](_combined_.apicombined.md#accountindexes)* -*Defined in [Combined.ts:23](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Combined.ts#L23)* +*Defined in [Combined.ts:23](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Combined.ts#L23)* **Returns:** `Observable`<`object`> @@ -160,7 +160,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[accountNonce](_queries_.apiqueries.md#accountnonce)* -*Defined in [Queries.ts:21](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L21)* +*Defined in [Queries.ts:21](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L21)* **Parameters:** @@ -179,7 +179,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[balanceFree](_queries_.apiqueries.md#balancefree)* -*Defined in [Queries.ts:25](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L25)* +*Defined in [Queries.ts:25](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L25)* **Parameters:** @@ -198,7 +198,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[balanceReserved](_queries_.apiqueries.md#balancereserved)* -*Defined in [Queries.ts:29](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L29)* +*Defined in [Queries.ts:29](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L29)* **Parameters:** @@ -217,7 +217,7 @@ ___ *Inherited from [ApiCalls](_calls_.apicalls.md).[bestNumber](_calls_.apicalls.md#bestnumber)* -*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Calls.ts#L13)* +*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Calls.ts#L13)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -230,7 +230,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[blockNow](_queries_.apiqueries.md#blocknow)* -*Defined in [Queries.ts:37](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L37)* +*Defined in [Queries.ts:37](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L37)* **Returns:** `Observable`< `Moment` | `undefined`> @@ -243,7 +243,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[blockPeriod](_queries_.apiqueries.md#blockperiod)* -*Defined in [Queries.ts:33](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L33)* +*Defined in [Queries.ts:33](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L33)* **Returns:** `Observable`< `Moment` | `undefined`> @@ -256,7 +256,7 @@ ___ *Inherited from [ApiCalls](_calls_.apicalls.md).[chain](_calls_.apicalls.md#chain)* -*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Calls.ts#L25)* +*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Calls.ts#L25)* **Returns:** `Observable`< `Text` | `undefined`> @@ -269,7 +269,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyLaunchPeriod](_queries_.apiqueries.md#democracylaunchperiod)* -*Defined in [Queries.ts:41](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L41)* +*Defined in [Queries.ts:41](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L41)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -282,7 +282,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyNextTally](_queries_.apiqueries.md#democracynexttally)* -*Defined in [Queries.ts:45](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L45)* +*Defined in [Queries.ts:45](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L45)* **Returns:** `Observable`< `ReferendumIndex` | `undefined`> @@ -295,7 +295,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[democracyReferendumVoters](_combined_.apicombined.md#democracyreferendumvoters)* -*Defined in [Combined.ts:139](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Combined.ts#L139)* +*Defined in [Combined.ts:137](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Combined.ts#L137)* **Parameters:** @@ -314,7 +314,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[democracyVotersBalancesOf](_combined_.apicombined.md#democracyvotersbalancesof)* -*Defined in [Combined.ts:184](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Combined.ts#L184)* +*Defined in [Combined.ts:182](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Combined.ts#L182)* **Parameters:** @@ -333,7 +333,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[democracyVotersVotesOf](_combined_.apicombined.md#democracyvotersvotesof)* -*Defined in [Combined.ts:200](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Combined.ts#L200)* +*Defined in [Combined.ts:198](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Combined.ts#L198)* **Parameters:** @@ -352,7 +352,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyVotingPeriod](_queries_.apiqueries.md#democracyvotingperiod)* -*Defined in [Queries.ts:135](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L135)* +*Defined in [Queries.ts:135](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L135)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -365,7 +365,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[eraBlockLength](_combined_.apicombined.md#erablocklength)* -*Defined in [Combined.ts:211](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Combined.ts#L211)* +*Defined in [Combined.ts:209](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Combined.ts#L209)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -378,7 +378,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[eraBlockProgress](_combined_.apicombined.md#erablockprogress)* -*Defined in [Combined.ts:226](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Combined.ts#L226)* +*Defined in [Combined.ts:224](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Combined.ts#L224)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -391,7 +391,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[eraBlockRemaining](_combined_.apicombined.md#erablockremaining)* -*Defined in [Combined.ts:249](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Combined.ts#L249)* +*Defined in [Combined.ts:247](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Combined.ts#L247)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -404,7 +404,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[eraLastLengthChange](_queries_.apiqueries.md#eralastlengthchange)* -*Defined in [Queries.ts:160](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L160)* +*Defined in [Queries.ts:160](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L160)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -417,7 +417,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[fees](_queries_.apiqueries.md#fees)* -*Defined in [Queries.ts:139](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L139)* +*Defined in [Queries.ts:139](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L139)* **Returns:** `Observable`<`RxFees`> @@ -430,7 +430,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[getAccountEnumSet](_queries_.apiqueries.md#getaccountenumset)* -*Defined in [Queries.ts:49](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L49)* +*Defined in [Queries.ts:49](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L49)* **Parameters:** @@ -449,7 +449,7 @@ ___ *Inherited from [ApiCalls](_calls_.apicalls.md).[getBlock](_calls_.apicalls.md#getblock)* -*Defined in [Calls.ts:29](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Calls.ts#L29)* +*Defined in [Calls.ts:29](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Calls.ts#L29)* **Parameters:** @@ -468,7 +468,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[isConnected](_base_.apibase.md#isconnected)* -*Defined in [Base.ts:92](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Base.ts#L92)* +*Defined in [Base.ts:92](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Base.ts#L92)* **Returns:** `Observable`<`boolean`> @@ -481,7 +481,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[nextAccountEnumSet](_queries_.apiqueries.md#nextaccountenumset)* -*Defined in [Queries.ts:63](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L63)* +*Defined in [Queries.ts:63](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L63)* **Returns:** `Observable`< `AccountIndex` | `undefined`> @@ -494,7 +494,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[proposalDeposits](_queries_.apiqueries.md#proposaldeposits)* -*Defined in [Queries.ts:67](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L67)* +*Defined in [Queries.ts:67](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L67)* **Parameters:** @@ -513,7 +513,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[publicProposalCount](_combined_.apicombined.md#publicproposalcount)* -*Defined in [Combined.ts:117](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Combined.ts#L117)* +*Defined in [Combined.ts:115](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Combined.ts#L115)* **Returns:** `Observable`<`number`> @@ -526,7 +526,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[publicProposals](_queries_.apiqueries.md#publicproposals)* -*Defined in [Queries.ts:80](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L80)* +*Defined in [Queries.ts:80](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L80)* **Returns:** `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>> @@ -539,7 +539,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[rawCall](_base_.apibase.md#rawcall)* -*Defined in [Base.ts:96](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Base.ts#L96)* +*Defined in [Base.ts:96](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Base.ts#L96)* **Type parameters:** @@ -562,7 +562,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[rawStorage](_base_.apibase.md#rawstorage)* -*Defined in [Base.ts:109](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Base.ts#L109)* +*Defined in [Base.ts:109](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Base.ts#L109)* **Type parameters:** @@ -585,7 +585,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[rawStorageMulti](_base_.apibase.md#rawstoragemulti)* -*Defined in [Base.ts:126](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Base.ts#L126)* +*Defined in [Base.ts:126](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Base.ts#L126)* **Type parameters:** @@ -607,7 +607,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumCount](_queries_.apiqueries.md#referendumcount)* -*Defined in [Queries.ts:100](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L100)* +*Defined in [Queries.ts:100](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L100)* **Returns:** `Observable`< `ReferendumIndex` | `undefined`> @@ -620,7 +620,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumInfo](_queries_.apiqueries.md#referenduminfo)* -*Defined in [Queries.ts:104](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L104)* +*Defined in [Queries.ts:104](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L104)* **Parameters:** @@ -639,7 +639,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumVote](_queries_.apiqueries.md#referendumvote)* -*Defined in [Queries.ts:117](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L117)* +*Defined in [Queries.ts:117](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L117)* **Parameters:** @@ -659,7 +659,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumVoters](_queries_.apiqueries.md#referendumvoters)* -*Defined in [Queries.ts:121](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L121)* +*Defined in [Queries.ts:121](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L121)* **Parameters:** @@ -678,7 +678,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[referendumVotes](_combined_.apicombined.md#referendumvotes)* -*Defined in [Combined.ts:176](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Combined.ts#L176)* +*Defined in [Combined.ts:174](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Combined.ts#L174)* **Parameters:** @@ -698,7 +698,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[referendums](_combined_.apicombined.md#referendums)* -*Defined in [Combined.ts:155](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Combined.ts#L155)* +*Defined in [Combined.ts:153](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Combined.ts#L153)* **Returns:** `Observable`<`Array`<[RxReferendum](_classes_.rxreferendum.md)>> @@ -711,7 +711,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[referendumsInfo](_combined_.apicombined.md#referendumsinfo)* -*Defined in [Combined.ts:127](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Combined.ts#L127)* +*Defined in [Combined.ts:125](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Combined.ts#L125)* **Parameters:** @@ -730,7 +730,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[sessionBlockProgress](_combined_.apicombined.md#sessionblockprogress)* -*Defined in [Combined.ts:264](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Combined.ts#L264)* +*Defined in [Combined.ts:262](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Combined.ts#L262)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -743,7 +743,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[sessionBlockRemaining](_combined_.apicombined.md#sessionblockremaining)* -*Defined in [Combined.ts:284](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Combined.ts#L284)* +*Defined in [Combined.ts:282](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Combined.ts#L282)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -756,7 +756,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[sessionBrokenValue](_combined_.apicombined.md#sessionbrokenvalue)* -*Defined in [Combined.ts:299](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Combined.ts#L299)* +*Defined in [Combined.ts:297](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Combined.ts#L297)* **Returns:** `Observable`< `Moment` | `undefined`> @@ -769,7 +769,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentIndex](_queries_.apiqueries.md#sessioncurrentindex)* -*Defined in [Queries.ts:172](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L172)* +*Defined in [Queries.ts:172](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L172)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -782,7 +782,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentStart](_queries_.apiqueries.md#sessioncurrentstart)* -*Defined in [Queries.ts:176](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L176)* +*Defined in [Queries.ts:176](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L176)* **Returns:** `Observable`< `Moment` | `undefined`> @@ -795,7 +795,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLastLengthChange](_queries_.apiqueries.md#sessionlastlengthchange)* -*Defined in [Queries.ts:180](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L180)* +*Defined in [Queries.ts:180](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L180)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -808,7 +808,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLength](_queries_.apiqueries.md#sessionlength)* -*Defined in [Queries.ts:184](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L184)* +*Defined in [Queries.ts:184](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L184)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -821,7 +821,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionReward](_queries_.apiqueries.md#sessionreward)* -*Defined in [Queries.ts:164](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L164)* +*Defined in [Queries.ts:164](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L164)* **Returns:** `Observable`< `Perbill` | `undefined`> @@ -834,7 +834,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionRewardCurrent](_queries_.apiqueries.md#sessionrewardcurrent)* -*Defined in [Queries.ts:168](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L168)* +*Defined in [Queries.ts:168](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L168)* **Returns:** `Observable`< `Balance` | `undefined`> @@ -847,7 +847,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[sessionTimeExpected](_combined_.apicombined.md#sessiontimeexpected)* -*Defined in [Combined.ts:318](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Combined.ts#L318)* +*Defined in [Combined.ts:316](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Combined.ts#L316)* **Returns:** `Observable`< `Moment` | `undefined`> @@ -860,7 +860,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[sessionTimeRemaining](_combined_.apicombined.md#sessiontimeremaining)* -*Defined in [Combined.ts:333](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Combined.ts#L333)* +*Defined in [Combined.ts:331](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Combined.ts#L331)* **Returns:** `Observable`< `Moment` | `undefined`> @@ -873,7 +873,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionValidators](_queries_.apiqueries.md#sessionvalidators)* -*Defined in [Queries.ts:192](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L192)* +*Defined in [Queries.ts:192](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L192)* **Returns:** `Observable`<`Array`<`AccountId`>> @@ -886,7 +886,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionsPerEra](_queries_.apiqueries.md#sessionsperera)* -*Defined in [Queries.ts:188](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L188)* +*Defined in [Queries.ts:188](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L188)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -899,7 +899,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingIntentions](_queries_.apiqueries.md#stakingintentions)* -*Defined in [Queries.ts:206](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L206)* +*Defined in [Queries.ts:206](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L206)* **Returns:** `Observable`<`Array`<`AccountId`>> @@ -912,7 +912,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominating](_queries_.apiqueries.md#stakingnominating)* -*Defined in [Queries.ts:234](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L234)* +*Defined in [Queries.ts:234](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L234)* **Parameters:** @@ -931,7 +931,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominatorsFor](_queries_.apiqueries.md#stakingnominatorsfor)* -*Defined in [Queries.ts:220](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L220)* +*Defined in [Queries.ts:220](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L220)* **Parameters:** @@ -950,7 +950,7 @@ ___ *Inherited from [ApiCalls](_calls_.apicalls.md).[submitAndWatchExtrinsic](_calls_.apicalls.md#submitandwatchextrinsic)* -*Defined in [Calls.ts:51](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Calls.ts#L51)* +*Defined in [Calls.ts:51](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Calls.ts#L51)* **Parameters:** @@ -969,7 +969,7 @@ ___ *Inherited from [ApiCalls](_calls_.apicalls.md).[submitExtrinsic](_calls_.apicalls.md#submitextrinsic)* -*Defined in [Calls.ts:47](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Calls.ts#L47)* +*Defined in [Calls.ts:47](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Calls.ts#L47)* **Parameters:** @@ -988,7 +988,7 @@ ___ *Inherited from [ApiCalls](_calls_.apicalls.md).[subscribeNewHead](_calls_.apicalls.md#subscribenewhead)* -*Defined in [Calls.ts:33](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Calls.ts#L33)* +*Defined in [Calls.ts:33](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Calls.ts#L33)* **Returns:** `Observable`< `Header` | `undefined`> @@ -1001,7 +1001,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[systemEvents](_queries_.apiqueries.md#systemevents)* -*Defined in [Queries.ts:238](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L238)* +*Defined in [Queries.ts:238](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L238)* **Returns:** `Observable`<`Array`<`EventRecord`>> @@ -1014,7 +1014,7 @@ ___ *Inherited from [ApiCalls](_calls_.apicalls.md).[systemName](_calls_.apicalls.md#systemname)* -*Defined in [Calls.ts:39](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Calls.ts#L39)* +*Defined in [Calls.ts:39](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Calls.ts#L39)* **Returns:** `Observable`< `Text` | `undefined`> @@ -1027,7 +1027,7 @@ ___ *Inherited from [ApiCalls](_calls_.apicalls.md).[systemVersion](_calls_.apicalls.md#systemversion)* -*Defined in [Calls.ts:43](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Calls.ts#L43)* +*Defined in [Calls.ts:43](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Calls.ts#L43)* **Returns:** `Observable`< `Text` | `undefined`> @@ -1040,7 +1040,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[validatingBalance](_combined_.apicombined.md#validatingbalance)* -*Defined in [Combined.ts:348](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Combined.ts#L348)* +*Defined in [Combined.ts:346](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Combined.ts#L346)* **Parameters:** @@ -1059,7 +1059,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[validatingBalances](_combined_.apicombined.md#validatingbalances)* -*Defined in [Combined.ts:373](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Combined.ts#L373)* +*Defined in [Combined.ts:371](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Combined.ts#L371)* **Parameters:** @@ -1078,7 +1078,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[validatorCount](_queries_.apiqueries.md#validatorcount)* -*Defined in [Queries.ts:252](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L252)* +*Defined in [Queries.ts:252](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L252)* **Returns:** `Observable`< `u32` | `undefined`> @@ -1091,7 +1091,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[votingBalance](_combined_.apicombined.md#votingbalance)* -*Defined in [Combined.ts:387](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Combined.ts#L387)* +*Defined in [Combined.ts:385](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Combined.ts#L385)* **Parameters:** @@ -1110,7 +1110,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[votingBalances](_combined_.apicombined.md#votingbalances)* -*Defined in [Combined.ts:427](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Combined.ts#L427)* +*Defined in [Combined.ts:425](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Combined.ts#L425)* **Parameters:** @@ -1129,7 +1129,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[votingBalancesNominatorsFor](_combined_.apicombined.md#votingbalancesnominatorsfor)* -*Defined in [Combined.ts:416](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Combined.ts#L416)* +*Defined in [Combined.ts:414](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Combined.ts#L414)* **Parameters:** diff --git a/docs/api-observable/classes/_queries_.apiqueries.md b/docs/api-observable/classes/_queries_.apiqueries.md index 0b6274ceb1..6f032d3075 100644 --- a/docs/api-observable/classes/_queries_.apiqueries.md +++ b/docs/api-observable/classes/_queries_.apiqueries.md @@ -18,7 +18,7 @@ *Inherited from [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)* -*Defined in [Base.ts:34](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Base.ts#L34)* +*Defined in [Base.ts:34](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Base.ts#L34)* **Parameters:** @@ -40,7 +40,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[whenReady](_base_.apibase.md#whenready)* -*Defined in [Base.ts:34](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Base.ts#L34)* +*Defined in [Base.ts:34](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Base.ts#L34)* ___ @@ -51,7 +51,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[extrinsics](_base_.apibase.md#extrinsics)* -*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Base.ts#L42)* +*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Base.ts#L42)* ___ @@ -62,7 +62,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[storage](_base_.apibase.md#storage)* -*Defined in [Base.ts:43](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Base.ts#L43)* +*Defined in [Base.ts:43](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Base.ts#L43)* ___ @@ -76,7 +76,7 @@ getgenesisHash(): `Hash` *Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)* -*Defined in [Base.ts:88](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Base.ts#L88)* +*Defined in [Base.ts:88](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Base.ts#L88)* **Returns:** `Hash` @@ -90,7 +90,7 @@ ___ ▸ **accountNonce**(address: * `AccountId` | `string`*): `Observable`< `Index` | `undefined`> -*Defined in [Queries.ts:21](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L21)* +*Defined in [Queries.ts:21](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L21)* **Parameters:** @@ -107,7 +107,7 @@ ___ ▸ **balanceFree**(address: * `AccountId` | `string`*): `Observable`< `Balance` | `undefined`> -*Defined in [Queries.ts:25](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L25)* +*Defined in [Queries.ts:25](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L25)* **Parameters:** @@ -124,7 +124,7 @@ ___ ▸ **balanceReserved**(address: * `AccountId` | `string`*): `Observable`< `Balance` | `undefined`> -*Defined in [Queries.ts:29](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L29)* +*Defined in [Queries.ts:29](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L29)* **Parameters:** @@ -141,7 +141,7 @@ ___ ▸ **blockNow**(): `Observable`< `Moment` | `undefined`> -*Defined in [Queries.ts:37](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L37)* +*Defined in [Queries.ts:37](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L37)* **Returns:** `Observable`< `Moment` | `undefined`> @@ -152,7 +152,7 @@ ___ ▸ **blockPeriod**(): `Observable`< `Moment` | `undefined`> -*Defined in [Queries.ts:33](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L33)* +*Defined in [Queries.ts:33](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L33)* **Returns:** `Observable`< `Moment` | `undefined`> @@ -163,7 +163,7 @@ ___ ▸ **democracyLaunchPeriod**(): `Observable`< `BlockNumber` | `undefined`> -*Defined in [Queries.ts:41](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L41)* +*Defined in [Queries.ts:41](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L41)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -174,7 +174,7 @@ ___ ▸ **democracyNextTally**(): `Observable`< `ReferendumIndex` | `undefined`> -*Defined in [Queries.ts:45](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L45)* +*Defined in [Queries.ts:45](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L45)* **Returns:** `Observable`< `ReferendumIndex` | `undefined`> @@ -185,7 +185,7 @@ ___ ▸ **democracyVotingPeriod**(): `Observable`< `BlockNumber` | `undefined`> -*Defined in [Queries.ts:135](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L135)* +*Defined in [Queries.ts:135](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L135)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -196,7 +196,7 @@ ___ ▸ **eraLastLengthChange**(): `Observable`< `BlockNumber` | `undefined`> -*Defined in [Queries.ts:160](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L160)* +*Defined in [Queries.ts:160](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L160)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -207,7 +207,7 @@ ___ ▸ **fees**(): `Observable`<`RxFees`> -*Defined in [Queries.ts:139](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L139)* +*Defined in [Queries.ts:139](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L139)* **Returns:** `Observable`<`RxFees`> @@ -218,7 +218,7 @@ ___ ▸ **getAccountEnumSet**(index: * `AccountIndex` | `BN` | `number`*): `Observable`< `Array`<`AccountId`> | `undefined`> -*Defined in [Queries.ts:49](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L49)* +*Defined in [Queries.ts:49](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L49)* **Parameters:** @@ -237,7 +237,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[isConnected](_base_.apibase.md#isconnected)* -*Defined in [Base.ts:92](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Base.ts#L92)* +*Defined in [Base.ts:92](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Base.ts#L92)* **Returns:** `Observable`<`boolean`> @@ -248,7 +248,7 @@ ___ ▸ **nextAccountEnumSet**(): `Observable`< `AccountIndex` | `undefined`> -*Defined in [Queries.ts:63](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L63)* +*Defined in [Queries.ts:63](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L63)* **Returns:** `Observable`< `AccountIndex` | `undefined`> @@ -259,7 +259,7 @@ ___ ▸ **proposalDeposits**(proposalId: * `PropIndex` | `BN` | `number`*): `Observable`< [RxProposalDeposits](_classes_.rxproposaldeposits.md) | `undefined`> -*Defined in [Queries.ts:67](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L67)* +*Defined in [Queries.ts:67](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L67)* **Parameters:** @@ -276,7 +276,7 @@ ___ ▸ **publicProposals**(): `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>> -*Defined in [Queries.ts:80](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L80)* +*Defined in [Queries.ts:80](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L80)* **Returns:** `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>> @@ -289,7 +289,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[rawCall](_base_.apibase.md#rawcall)* -*Defined in [Base.ts:96](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Base.ts#L96)* +*Defined in [Base.ts:96](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Base.ts#L96)* **Type parameters:** @@ -312,7 +312,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[rawStorage](_base_.apibase.md#rawstorage)* -*Defined in [Base.ts:109](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Base.ts#L109)* +*Defined in [Base.ts:109](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Base.ts#L109)* **Type parameters:** @@ -335,7 +335,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[rawStorageMulti](_base_.apibase.md#rawstoragemulti)* -*Defined in [Base.ts:126](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Base.ts#L126)* +*Defined in [Base.ts:126](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Base.ts#L126)* **Type parameters:** @@ -355,7 +355,7 @@ ___ ▸ **referendumCount**(): `Observable`< `ReferendumIndex` | `undefined`> -*Defined in [Queries.ts:100](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L100)* +*Defined in [Queries.ts:100](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L100)* **Returns:** `Observable`< `ReferendumIndex` | `undefined`> @@ -366,7 +366,7 @@ ___ ▸ **referendumInfo**(referendumId: * `ReferendumIndex` | `BN` | `number`*): `Observable`< [RxReferendum](_classes_.rxreferendum.md) | `undefined`> -*Defined in [Queries.ts:104](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L104)* +*Defined in [Queries.ts:104](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L104)* **Parameters:** @@ -383,7 +383,7 @@ ___ ▸ **referendumVote**(index: * `ReferendumIndex` | `BN` | `number`*, address: * `AccountId` | `string`*): `Observable`< `Bool` | `undefined`> -*Defined in [Queries.ts:117](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L117)* +*Defined in [Queries.ts:117](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L117)* **Parameters:** @@ -401,7 +401,7 @@ ___ ▸ **referendumVoters**(index: * `ReferendumIndex` | `BN` | `number`*): `Observable`<`Array`<`AccountId`>> -*Defined in [Queries.ts:121](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L121)* +*Defined in [Queries.ts:121](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L121)* **Parameters:** @@ -418,7 +418,7 @@ ___ ▸ **sessionCurrentIndex**(): `Observable`< `BlockNumber` | `undefined`> -*Defined in [Queries.ts:172](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L172)* +*Defined in [Queries.ts:172](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L172)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -429,7 +429,7 @@ ___ ▸ **sessionCurrentStart**(): `Observable`< `Moment` | `undefined`> -*Defined in [Queries.ts:176](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L176)* +*Defined in [Queries.ts:176](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L176)* **Returns:** `Observable`< `Moment` | `undefined`> @@ -440,7 +440,7 @@ ___ ▸ **sessionLastLengthChange**(): `Observable`< `BlockNumber` | `undefined`> -*Defined in [Queries.ts:180](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L180)* +*Defined in [Queries.ts:180](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L180)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -451,7 +451,7 @@ ___ ▸ **sessionLength**(): `Observable`< `BlockNumber` | `undefined`> -*Defined in [Queries.ts:184](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L184)* +*Defined in [Queries.ts:184](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L184)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -462,7 +462,7 @@ ___ ▸ **sessionReward**(): `Observable`< `Perbill` | `undefined`> -*Defined in [Queries.ts:164](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L164)* +*Defined in [Queries.ts:164](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L164)* **Returns:** `Observable`< `Perbill` | `undefined`> @@ -473,7 +473,7 @@ ___ ▸ **sessionRewardCurrent**(): `Observable`< `Balance` | `undefined`> -*Defined in [Queries.ts:168](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L168)* +*Defined in [Queries.ts:168](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L168)* **Returns:** `Observable`< `Balance` | `undefined`> @@ -484,7 +484,7 @@ ___ ▸ **sessionValidators**(): `Observable`<`Array`<`AccountId`>> -*Defined in [Queries.ts:192](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L192)* +*Defined in [Queries.ts:192](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L192)* **Returns:** `Observable`<`Array`<`AccountId`>> @@ -495,7 +495,7 @@ ___ ▸ **sessionsPerEra**(): `Observable`< `BlockNumber` | `undefined`> -*Defined in [Queries.ts:188](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L188)* +*Defined in [Queries.ts:188](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L188)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -506,7 +506,7 @@ ___ ▸ **stakingIntentions**(): `Observable`<`Array`<`AccountId`>> -*Defined in [Queries.ts:206](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L206)* +*Defined in [Queries.ts:206](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L206)* **Returns:** `Observable`<`Array`<`AccountId`>> @@ -517,7 +517,7 @@ ___ ▸ **stakingNominating**(address: * `AccountId` | `string`*): `Observable`< `AccountId` | `undefined`> -*Defined in [Queries.ts:234](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L234)* +*Defined in [Queries.ts:234](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L234)* **Parameters:** @@ -534,7 +534,7 @@ ___ ▸ **stakingNominatorsFor**(address: * `AccountId` | `string`*): `Observable`<`Array`<`AccountId`>> -*Defined in [Queries.ts:220](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L220)* +*Defined in [Queries.ts:220](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L220)* **Parameters:** @@ -551,7 +551,7 @@ ___ ▸ **systemEvents**(): `Observable`<`Array`<`EventRecord`>> -*Defined in [Queries.ts:238](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L238)* +*Defined in [Queries.ts:238](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L238)* **Returns:** `Observable`<`Array`<`EventRecord`>> @@ -562,7 +562,7 @@ ___ ▸ **validatorCount**(): `Observable`< `u32` | `undefined`> -*Defined in [Queries.ts:252](https://github.com/polkadot-js/api/blob/67dd498/packages/api-observable/src/Queries.ts#L252)* +*Defined in [Queries.ts:252](https://github.com/polkadot-js/api/blob/d097a7a/packages/api-observable/src/Queries.ts#L252)* **Returns:** `Observable`< `u32` | `undefined`> diff --git a/docs/api/classes/_base_.apibase.md b/docs/api/classes/_base_.apibase.md index 9f940020bf..5f9b9322a5 100644 --- a/docs/api/classes/_base_.apibase.md +++ b/docs/api/classes/_base_.apibase.md @@ -24,7 +24,7 @@ ⊕ **new ApiBase**(wsProvider?: *`WsProvider`*): [ApiBase](_base_.apibase.md) -*Defined in [Base.ts:39](https://github.com/polkadot-js/api/blob/67dd498/packages/api/src/Base.ts#L39)* +*Defined in [Base.ts:39](https://github.com/polkadot-js/api/blob/d097a7a/packages/api/src/Base.ts#L39)* *__description__*: Create an instance of the class @@ -58,7 +58,7 @@ ___ getgenesisHash(): `Hash` -*Defined in [Base.ts:70](https://github.com/polkadot-js/api/blob/67dd498/packages/api/src/Base.ts#L70)* +*Defined in [Base.ts:70](https://github.com/polkadot-js/api/blob/d097a7a/packages/api/src/Base.ts#L70)* *__description__*: Contains the genesis Hash of the attached chain. Apart from being useful to determine the actual chain, it can also be used to sign immortal transactions. @@ -71,7 +71,7 @@ ___ getquery(): `S` -*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/67dd498/packages/api/src/Base.ts#L108)* +*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/d097a7a/packages/api/src/Base.ts#L108)* *__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata. @@ -94,7 +94,7 @@ ___ getrpc(): `R` -*Defined in [Base.ts:128](https://github.com/polkadot-js/api/blob/67dd498/packages/api/src/Base.ts#L128)* +*Defined in [Base.ts:128](https://github.com/polkadot-js/api/blob/d097a7a/packages/api/src/Base.ts#L128)* *__description__*: Contains all the raw rpc sections and their subsequent methods in the API as defined by the jsonrpc interface definitions. Unlike the dynamic `api.query` and `api.tx` sections, these methods are fixed (although extensible with node upgrades) and not determined by the runtime. @@ -117,7 +117,7 @@ ___ getruntimeMetadata(): `RuntimeMetadata` -*Defined in [Base.ts:79](https://github.com/polkadot-js/api/blob/67dd498/packages/api/src/Base.ts#L79)* +*Defined in [Base.ts:79](https://github.com/polkadot-js/api/blob/d097a7a/packages/api/src/Base.ts#L79)* *__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection. @@ -130,7 +130,7 @@ ___ getruntimeVersion(): `RuntimeVersion` -*Defined in [Base.ts:88](https://github.com/polkadot-js/api/blob/67dd498/packages/api/src/Base.ts#L88)* +*Defined in [Base.ts:88](https://github.com/polkadot-js/api/blob/d097a7a/packages/api/src/Base.ts#L88)* *__description__*: Contains the version information for the current runtime. @@ -143,7 +143,7 @@ ___ gettx(): `E` -*Defined in [Base.ts:147](https://github.com/polkadot-js/api/blob/67dd498/packages/api/src/Base.ts#L147)* +*Defined in [Base.ts:147](https://github.com/polkadot-js/api/blob/d097a7a/packages/api/src/Base.ts#L147)* *__description__*: Contains all the extrinsic modules and their subsequent methods in the API. It allows for the construction of transactions and the submission thereof. These are attached dynamically from the runtime metadata. @@ -170,7 +170,7 @@ ___ ▸ **on**(type: *`ApiInterface$Events`*, handler: *`function`*): `void` -*Defined in [Base.ts:172](https://github.com/polkadot-js/api/blob/67dd498/packages/api/src/Base.ts#L172)* +*Defined in [Base.ts:172](https://github.com/polkadot-js/api/blob/d097a7a/packages/api/src/Base.ts#L172)* *__description__*: Attach an eventemitter handler to listen to a specific event diff --git a/docs/api/classes/_promise_combinator_.combinator.md b/docs/api/classes/_promise_combinator_.combinator.md index ff3c969c61..d2c9efdfeb 100644 --- a/docs/api/classes/_promise_combinator_.combinator.md +++ b/docs/api/classes/_promise_combinator_.combinator.md @@ -12,7 +12,7 @@ ⊕ **new Combinator**(fns: *`Array`<[CombinatorFunction](../modules/_promise_combinator_.md#combinatorfunction)>*, callback: *[CombinatorCallback](../modules/_promise_combinator_.md#combinatorcallback)*): [Combinator](_promise_combinator_.combinator.md) -*Defined in [promise/Combinator.ts:14](https://github.com/polkadot-js/api/blob/67dd498/packages/api/src/promise/Combinator.ts#L14)* +*Defined in [promise/Combinator.ts:14](https://github.com/polkadot-js/api/blob/d097a7a/packages/api/src/promise/Combinator.ts#L14)* **Parameters:** diff --git a/docs/api/classes/_promise_index_.apipromise.html b/docs/api/classes/_promise_index_.apipromise.html index 0d8b8b38f8..e0fc57d661 100644 --- a/docs/api/classes/_promise_index_.apipromise.html +++ b/docs/api/classes/_promise_index_.apipromise.html @@ -469,7 +469,7 @@

constructor

⊕ new ApiPromise(wsProvider?: WsProvider): ApiPromise

Overrides ApiBase.constructor

-

Defined in promise/index.ts:128

+

Defined in promise/index.ts:128

description: Creates an instance of the ApiPromise class

example:

import Api from '@polkadot/api/promise';
@@ -504,14 +504,14 @@
 

genesisHash

getgenesisHash(): Hash

Inherited from ApiBase.genesisHash

-

Defined in Base.ts:70

+

Defined in Base.ts:70

description: Contains the genesis Hash of the attached chain. Apart from being useful to determine the actual chain, it can also be used to sign immortal transactions.

Returns: Hash


isReady

getisReady(): Promise<ApiPromise>

-

Defined in promise/index.ts:161

+

Defined in promise/index.ts:161

description: Promise that returns the first time we are connected and loaded

Returns: Promise<ApiPromise>


@@ -519,7 +519,7 @@

query

getquery(): QueryableStorage

Inherited from ApiBase.query

-

Defined in Base.ts:108

+

Defined in Base.ts:108

description: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata.

All calls inside the namespace, is denoted by section.method and may take an optional query parameter. As an example, api.query.timestamp.now() (current block timestamp) does not take parameters, while api.query.system.accountNonce(<accountId>) (retrieving the associated nonce for an account), takes the AccountId as a parameter.

example:

@@ -533,7 +533,7 @@

rpc

getrpc(): Rpc

Inherited from ApiBase.rpc

-

Defined in Base.ts:128

+

Defined in Base.ts:128

description: Contains all the raw rpc sections and their subsequent methods in the API as defined by the jsonrpc interface definitions. Unlike the dynamic api.query and api.tx sections, these methods are fixed (although extensible with node upgrades) and not determined by the runtime.

RPC endpoints available here allow for the query of chain, node and system information, in addition to providing interfaces for the raw queries of state (usine known keys) and the submission of transactions.

example:

@@ -547,7 +547,7 @@

runtimeMetadata

getruntimeMetadata(): RuntimeMetadata

Inherited from ApiBase.runtimeMetadata

-

Defined in Base.ts:79

+

Defined in Base.ts:79

description: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.

Returns: RuntimeMetadata


@@ -555,7 +555,7 @@

runtimeVersion

getruntimeVersion(): RuntimeVersion

Inherited from ApiBase.runtimeVersion

-

Defined in Base.ts:88

+

Defined in Base.ts:88

description: Contains the version information for the current runtime.

Returns: RuntimeVersion


@@ -563,7 +563,7 @@

tx

gettx(): SubmittableExtrinsics

Inherited from ApiBase.tx

-

Defined in Base.ts:147

+

Defined in Base.ts:147

description: Contains all the extrinsic modules and their subsequent methods in the API. It allows for the construction of transactions and the submission thereof. These are attached dynamically from the runtime metadata.

example:

api.tx.balances
@@ -579,7 +579,7 @@
 

combineLatest

▸ combineLatest(fns: Array<CombinatorFunction>, callback: CombinatorCallback): Combinator

-

Defined in promise/index.ts:189

+

Defined in promise/index.ts:189

description: Creates a combinator that can be used to combine the latest results from multiple subscriptions

example:

const address = '5DTestUPts3kjeXSTMyerHihn1uwMfLj8vU8sqF7qYrFacT7';
@@ -621,7 +621,7 @@
 

on

▸ on(type: ApiInterface$Events, handler: function): void

Inherited from ApiBase.on

-

Defined in Base.ts:172

+

Defined in Base.ts:172

description: Attach an eventemitter handler to listen to a specific event

example:

api.on('disconnected', () => {
@@ -659,7 +659,7 @@
 

<Static> create

▸ create(wsProvider?: WsProvider): Promise<ApiPromise>

-

Defined in promise/index.ts:126

+

Defined in promise/index.ts:126

description: Creates an ApiPromise instance using the supplied provider. Returns an Promise containing the actual Api instance.

example:

import Api from '@polkadot/api/promise';
@@ -732,7 +732,7 @@
     
 
diff --git a/docs/api/classes/_promise_index_.apipromise.md b/docs/api/classes/_promise_index_.apipromise.md index 828a2ec6d2..a422861f0a 100644 --- a/docs/api/classes/_promise_index_.apipromise.md +++ b/docs/api/classes/_promise_index_.apipromise.md @@ -106,7 +106,7 @@ ApiPromise.create().then((api) => { *Overrides [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)* -*Defined in [promise/index.ts:128](https://github.com/polkadot-js/api/blob/67dd498/packages/api/src/promise/index.ts#L128)* +*Defined in [promise/index.ts:128](https://github.com/polkadot-js/api/blob/d097a7a/packages/api/src/promise/index.ts#L128)* *__description__*: Creates an instance of the ApiPromise class @@ -142,7 +142,7 @@ getgenesisHash(): `Hash` *Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)* -*Defined in [Base.ts:70](https://github.com/polkadot-js/api/blob/67dd498/packages/api/src/Base.ts#L70)* +*Defined in [Base.ts:70](https://github.com/polkadot-js/api/blob/d097a7a/packages/api/src/Base.ts#L70)* *__description__*: Contains the genesis Hash of the attached chain. Apart from being useful to determine the actual chain, it can also be used to sign immortal transactions. @@ -155,7 +155,7 @@ ___ getisReady(): `Promise`<[ApiPromise](_promise_index_.apipromise.md)> -*Defined in [promise/index.ts:161](https://github.com/polkadot-js/api/blob/67dd498/packages/api/src/promise/index.ts#L161)* +*Defined in [promise/index.ts:161](https://github.com/polkadot-js/api/blob/d097a7a/packages/api/src/promise/index.ts#L161)* *__description__*: Promise that returns the first time we are connected and loaded @@ -170,7 +170,7 @@ getquery(): `QueryableStorage` *Inherited from [ApiBase](_base_.apibase.md).[query](_base_.apibase.md#query)* -*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/67dd498/packages/api/src/Base.ts#L108)* +*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/d097a7a/packages/api/src/Base.ts#L108)* *__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata. @@ -195,7 +195,7 @@ getrpc(): `Rpc` *Inherited from [ApiBase](_base_.apibase.md).[rpc](_base_.apibase.md#rpc)* -*Defined in [Base.ts:128](https://github.com/polkadot-js/api/blob/67dd498/packages/api/src/Base.ts#L128)* +*Defined in [Base.ts:128](https://github.com/polkadot-js/api/blob/d097a7a/packages/api/src/Base.ts#L128)* *__description__*: Contains all the raw rpc sections and their subsequent methods in the API as defined by the jsonrpc interface definitions. Unlike the dynamic `api.query` and `api.tx` sections, these methods are fixed (although extensible with node upgrades) and not determined by the runtime. @@ -220,7 +220,7 @@ getruntimeMetadata(): `RuntimeMetadata` *Inherited from [ApiBase](_base_.apibase.md).[runtimeMetadata](_base_.apibase.md#runtimemetadata)* -*Defined in [Base.ts:79](https://github.com/polkadot-js/api/blob/67dd498/packages/api/src/Base.ts#L79)* +*Defined in [Base.ts:79](https://github.com/polkadot-js/api/blob/d097a7a/packages/api/src/Base.ts#L79)* *__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection. @@ -235,7 +235,7 @@ getruntimeVersion(): `RuntimeVersion` *Inherited from [ApiBase](_base_.apibase.md).[runtimeVersion](_base_.apibase.md#runtimeversion)* -*Defined in [Base.ts:88](https://github.com/polkadot-js/api/blob/67dd498/packages/api/src/Base.ts#L88)* +*Defined in [Base.ts:88](https://github.com/polkadot-js/api/blob/d097a7a/packages/api/src/Base.ts#L88)* *__description__*: Contains the version information for the current runtime. @@ -250,7 +250,7 @@ gettx(): `SubmittableExtrinsics` *Inherited from [ApiBase](_base_.apibase.md).[tx](_base_.apibase.md#tx)* -*Defined in [Base.ts:147](https://github.com/polkadot-js/api/blob/67dd498/packages/api/src/Base.ts#L147)* +*Defined in [Base.ts:147](https://github.com/polkadot-js/api/blob/d097a7a/packages/api/src/Base.ts#L147)* *__description__*: Contains all the extrinsic modules and their subsequent methods in the API. It allows for the construction of transactions and the submission thereof. These are attached dynamically from the runtime metadata. @@ -277,7 +277,7 @@ ___ ▸ **combineLatest**(fns: *`Array`<[CombinatorFunction](../modules/_promise_combinator_.md#combinatorfunction)>*, callback: *[CombinatorCallback](../modules/_promise_combinator_.md#combinatorcallback)*): [Combinator](_promise_combinator_.combinator.md) -*Defined in [promise/index.ts:189](https://github.com/polkadot-js/api/blob/67dd498/packages/api/src/promise/index.ts#L189)* +*Defined in [promise/index.ts:189](https://github.com/polkadot-js/api/blob/d097a7a/packages/api/src/promise/index.ts#L189)* *__description__*: Creates a combinator that can be used to combine the latest results from multiple subscriptions @@ -314,7 +314,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[on](_base_.apibase.md#on)* -*Defined in [Base.ts:172](https://github.com/polkadot-js/api/blob/67dd498/packages/api/src/Base.ts#L172)* +*Defined in [Base.ts:172](https://github.com/polkadot-js/api/blob/d097a7a/packages/api/src/Base.ts#L172)* *__description__*: Attach an eventemitter handler to listen to a specific event @@ -346,7 +346,7 @@ ___ ▸ **create**(wsProvider?: *`WsProvider`*): `Promise`<[ApiPromise](_promise_index_.apipromise.md)> -*Defined in [promise/index.ts:126](https://github.com/polkadot-js/api/blob/67dd498/packages/api/src/promise/index.ts#L126)* +*Defined in [promise/index.ts:126](https://github.com/polkadot-js/api/blob/d097a7a/packages/api/src/promise/index.ts#L126)* *__description__*: Creates an ApiPromise instance using the supplied provider. Returns an Promise containing the actual Api instance. diff --git a/docs/api/classes/_promise_submittableextrinsic_.submittableextrinsic.md b/docs/api/classes/_promise_submittableextrinsic_.submittableextrinsic.md index 8c18f99e3b..ea63e5aabf 100644 --- a/docs/api/classes/_promise_submittableextrinsic_.submittableextrinsic.md +++ b/docs/api/classes/_promise_submittableextrinsic_.submittableextrinsic.md @@ -25,7 +25,7 @@ *Overrides Extrinsic.__constructor* -*Defined in [promise/SubmittableExtrinsic.ts:12](https://github.com/polkadot-js/api/blob/67dd498/packages/api/src/promise/SubmittableExtrinsic.ts#L12)* +*Defined in [promise/SubmittableExtrinsic.ts:12](https://github.com/polkadot-js/api/blob/d097a7a/packages/api/src/promise/SubmittableExtrinsic.ts#L12)* **Parameters:** @@ -59,7 +59,7 @@ ___ *Inherited from Struct.raw* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L25)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L25)* ___ @@ -84,7 +84,7 @@ getType(): `E` *Inherited from Struct.Type* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L123)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -97,7 +97,7 @@ getargs(): `Array`<`Base`> *Inherited from Extrinsic.args* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:70](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Extrinsic.ts#L70)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:70](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Extrinsic.ts#L70)* **Returns:** `Array`<`Base`> @@ -110,7 +110,7 @@ getcallIndex(): `Uint8Array` *Inherited from Extrinsic.callIndex* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:75](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Extrinsic.ts#L75)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:75](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Extrinsic.ts#L75)* **Returns:** `Uint8Array` @@ -123,7 +123,7 @@ getdata(): `Uint8Array` *Inherited from Extrinsic.data* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:79](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Extrinsic.ts#L79)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:79](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Extrinsic.ts#L79)* **Returns:** `Uint8Array` @@ -138,7 +138,7 @@ getencodedLength(): `number` *Overrides Struct.encodedLength* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:110](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Extrinsic.ts#L110)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:110](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Extrinsic.ts#L110)* **Returns:** `number` @@ -151,7 +151,7 @@ gethash(): `Hash` *Inherited from Extrinsic.hash* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:84](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Extrinsic.ts#L84)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:84](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Extrinsic.ts#L84)* **Returns:** `Hash` @@ -164,7 +164,7 @@ getisSigned(): `boolean` *Inherited from Extrinsic.isSigned* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:90](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Extrinsic.ts#L90)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:90](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Extrinsic.ts#L90)* **Returns:** `boolean` @@ -177,7 +177,7 @@ getlength(): `number` *Inherited from Extrinsic.length* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:94](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Extrinsic.ts#L94)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:94](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Extrinsic.ts#L94)* **Returns:** `number` @@ -190,7 +190,7 @@ getmeta(): `FunctionMetadata` *Inherited from Extrinsic.meta* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:98](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Extrinsic.ts#L98)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:98](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Extrinsic.ts#L98)* **Returns:** `FunctionMetadata` @@ -203,7 +203,7 @@ getmethod(): `Method` *Inherited from Extrinsic.method* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:102](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Extrinsic.ts#L102)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:102](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Extrinsic.ts#L102)* **Returns:** `Method` @@ -216,7 +216,7 @@ getsignature(): `ExtrinsicSignature` *Inherited from Extrinsic.signature* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:106](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Extrinsic.ts#L106)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:106](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Extrinsic.ts#L106)* **Returns:** `ExtrinsicSignature` @@ -333,7 +333,7 @@ ___ *Inherited from Struct.getAtIndex* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L133)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -384,7 +384,7 @@ ___ ▸ **send**(statusCb?: * `undefined` | `function`*): `Promise`<`Hash`> -*Defined in [promise/SubmittableExtrinsic.ts:20](https://github.com/polkadot-js/api/blob/67dd498/packages/api/src/promise/SubmittableExtrinsic.ts#L20)* +*Defined in [promise/SubmittableExtrinsic.ts:20](https://github.com/polkadot-js/api/blob/d097a7a/packages/api/src/promise/SubmittableExtrinsic.ts#L20)* **Parameters:** @@ -423,7 +423,7 @@ ___ *Overrides Extrinsic.sign* -*Defined in [promise/SubmittableExtrinsic.ts:28](https://github.com/polkadot-js/api/blob/67dd498/packages/api/src/promise/SubmittableExtrinsic.ts#L28)* +*Defined in [promise/SubmittableExtrinsic.ts:28](https://github.com/polkadot-js/api/blob/d097a7a/packages/api/src/promise/SubmittableExtrinsic.ts#L28)* **Parameters:** @@ -444,7 +444,7 @@ ___ *Inherited from Struct.toArray* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L137)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<`Base`> @@ -459,7 +459,7 @@ ___ *Overrides Struct.toHex* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:133](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Extrinsic.ts#L133)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:133](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Extrinsic.ts#L133)* **Returns:** `string` @@ -474,7 +474,7 @@ ___ *Overrides Struct.toJSON* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:137](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Extrinsic.ts#L137)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:137](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Extrinsic.ts#L137)* **Returns:** `any` @@ -487,7 +487,7 @@ ___ *Inherited from Struct.toString* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L156)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -502,7 +502,7 @@ ___ *Overrides Struct.toU8a* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:122](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Extrinsic.ts#L122)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:122](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Extrinsic.ts#L122)* **Parameters:** @@ -536,7 +536,7 @@ ___ *Inherited from Extrinsic.decodeExtrinsic* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:42](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Extrinsic.ts#L42)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:42](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Extrinsic.ts#L42)* **Parameters:** @@ -555,7 +555,7 @@ ___ *Inherited from Struct.with* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L113)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/api/classes/_rx_index_.apirx.html b/docs/api/classes/_rx_index_.apirx.html index 456105c11d..0ca7fbafff 100644 --- a/docs/api/classes/_rx_index_.apirx.html +++ b/docs/api/classes/_rx_index_.apirx.html @@ -480,7 +480,7 @@

constructor

⊕ new ApiRx(wsProvider?: WsProvider): ApiRx

Overrides ApiBase.constructor

-

Defined in rx/index.ts:143

+

Defined in rx/index.ts:143

description: Create an instance of the ApiRx class

example:

import Api from '@polkadot/api/rx';
@@ -515,21 +515,21 @@
 

genesisHash

getgenesisHash(): Hash

Inherited from ApiBase.genesisHash

-

Defined in Base.ts:70

+

Defined in Base.ts:70

description: Contains the genesis Hash of the attached chain. Apart from being useful to determine the actual chain, it can also be used to sign immortal transactions.

Returns: Hash


isConnected

getisConnected(): Observable<boolean>

-

Defined in rx/index.ts:179

+

Defined in rx/index.ts:179

description: Observable that carries the connected state for the provider. Results in a boolean flag that is true/false based on the connectivity.

Returns: Observable<boolean>


isReady

getisReady(): Observable<ApiRx>

-

Defined in rx/index.ts:186

+

Defined in rx/index.ts:186

description: Observable that returns the first time we are connected and loaded

Returns: Observable<ApiRx>


@@ -537,7 +537,7 @@

query

getquery(): QueryableStorage

Inherited from ApiBase.query

-

Defined in Base.ts:108

+

Defined in Base.ts:108

description: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata.

All calls inside the namespace, is denoted by section.method and may take an optional query parameter. As an example, api.query.timestamp.now() (current block timestamp) does not take parameters, while api.query.system.accountNonce(<accountId>) (retrieving the associated nonce for an account), takes the AccountId as a parameter.

example:

@@ -551,7 +551,7 @@

rpc

getrpc(): RpcRx

Inherited from ApiBase.rpc

-

Defined in Base.ts:128

+

Defined in Base.ts:128

description: Contains all the raw rpc sections and their subsequent methods in the API as defined by the jsonrpc interface definitions. Unlike the dynamic api.query and api.tx sections, these methods are fixed (although extensible with node upgrades) and not determined by the runtime.

RPC endpoints available here allow for the query of chain, node and system information, in addition to providing interfaces for the raw queries of state (usine known keys) and the submission of transactions.

example:

@@ -565,7 +565,7 @@

runtimeMetadata

getruntimeMetadata(): RuntimeMetadata

Inherited from ApiBase.runtimeMetadata

-

Defined in Base.ts:79

+

Defined in Base.ts:79

description: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.

Returns: RuntimeMetadata


@@ -573,7 +573,7 @@

runtimeVersion

getruntimeVersion(): RuntimeVersion

Inherited from ApiBase.runtimeVersion

-

Defined in Base.ts:88

+

Defined in Base.ts:88

description: Contains the version information for the current runtime.

Returns: RuntimeVersion


@@ -581,7 +581,7 @@

tx

gettx(): SubmittableExtrinsics

Inherited from ApiBase.tx

-

Defined in Base.ts:147

+

Defined in Base.ts:147

description: Contains all the extrinsic modules and their subsequent methods in the API. It allows for the construction of transactions and the submission thereof. These are attached dynamically from the runtime metadata.

example:

api.tx.balances
@@ -598,7 +598,7 @@
 

on

▸ on(type: ApiInterface$Events, handler: function): void

Inherited from ApiBase.on

-

Defined in Base.ts:172

+

Defined in Base.ts:172

description: Attach an eventemitter handler to listen to a specific event

example:

api.on('disconnected', () => {
@@ -636,7 +636,7 @@
 

<Static> create

▸ create(wsProvider?: WsProvider): Observable<ApiRx>

-

Defined in rx/index.ts:141

+

Defined in rx/index.ts:141

description: Creates an ApiRx instance using the supplied provider. Returns an Observable containing the actual Api instance.

example:

import Api from '@polkadot/api/rx';
@@ -709,7 +709,7 @@
     
 
diff --git a/docs/api/classes/_rx_index_.apirx.md b/docs/api/classes/_rx_index_.apirx.md index 32a9213d99..834b1e4c8a 100644 --- a/docs/api/classes/_rx_index_.apirx.md +++ b/docs/api/classes/_rx_index_.apirx.md @@ -117,7 +117,7 @@ api.query.system *Overrides [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)* -*Defined in [rx/index.ts:143](https://github.com/polkadot-js/api/blob/67dd498/packages/api/src/rx/index.ts#L143)* +*Defined in [rx/index.ts:143](https://github.com/polkadot-js/api/blob/d097a7a/packages/api/src/rx/index.ts#L143)* *__description__*: Create an instance of the ApiRx class @@ -153,7 +153,7 @@ getgenesisHash(): `Hash` *Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)* -*Defined in [Base.ts:70](https://github.com/polkadot-js/api/blob/67dd498/packages/api/src/Base.ts#L70)* +*Defined in [Base.ts:70](https://github.com/polkadot-js/api/blob/d097a7a/packages/api/src/Base.ts#L70)* *__description__*: Contains the genesis Hash of the attached chain. Apart from being useful to determine the actual chain, it can also be used to sign immortal transactions. @@ -166,7 +166,7 @@ ___ getisConnected(): `Observable`<`boolean`> -*Defined in [rx/index.ts:179](https://github.com/polkadot-js/api/blob/67dd498/packages/api/src/rx/index.ts#L179)* +*Defined in [rx/index.ts:179](https://github.com/polkadot-js/api/blob/d097a7a/packages/api/src/rx/index.ts#L179)* *__description__*: Observable that carries the connected state for the provider. Results in a boolean flag that is true/false based on the connectivity. @@ -179,7 +179,7 @@ ___ getisReady(): `Observable`<[ApiRx](_rx_index_.apirx.md)> -*Defined in [rx/index.ts:186](https://github.com/polkadot-js/api/blob/67dd498/packages/api/src/rx/index.ts#L186)* +*Defined in [rx/index.ts:186](https://github.com/polkadot-js/api/blob/d097a7a/packages/api/src/rx/index.ts#L186)* *__description__*: Observable that returns the first time we are connected and loaded @@ -194,7 +194,7 @@ getquery(): `QueryableStorage` *Inherited from [ApiBase](_base_.apibase.md).[query](_base_.apibase.md#query)* -*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/67dd498/packages/api/src/Base.ts#L108)* +*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/d097a7a/packages/api/src/Base.ts#L108)* *__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata. @@ -219,7 +219,7 @@ getrpc(): `RpcRx` *Inherited from [ApiBase](_base_.apibase.md).[rpc](_base_.apibase.md#rpc)* -*Defined in [Base.ts:128](https://github.com/polkadot-js/api/blob/67dd498/packages/api/src/Base.ts#L128)* +*Defined in [Base.ts:128](https://github.com/polkadot-js/api/blob/d097a7a/packages/api/src/Base.ts#L128)* *__description__*: Contains all the raw rpc sections and their subsequent methods in the API as defined by the jsonrpc interface definitions. Unlike the dynamic `api.query` and `api.tx` sections, these methods are fixed (although extensible with node upgrades) and not determined by the runtime. @@ -244,7 +244,7 @@ getruntimeMetadata(): `RuntimeMetadata` *Inherited from [ApiBase](_base_.apibase.md).[runtimeMetadata](_base_.apibase.md#runtimemetadata)* -*Defined in [Base.ts:79](https://github.com/polkadot-js/api/blob/67dd498/packages/api/src/Base.ts#L79)* +*Defined in [Base.ts:79](https://github.com/polkadot-js/api/blob/d097a7a/packages/api/src/Base.ts#L79)* *__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection. @@ -259,7 +259,7 @@ getruntimeVersion(): `RuntimeVersion` *Inherited from [ApiBase](_base_.apibase.md).[runtimeVersion](_base_.apibase.md#runtimeversion)* -*Defined in [Base.ts:88](https://github.com/polkadot-js/api/blob/67dd498/packages/api/src/Base.ts#L88)* +*Defined in [Base.ts:88](https://github.com/polkadot-js/api/blob/d097a7a/packages/api/src/Base.ts#L88)* *__description__*: Contains the version information for the current runtime. @@ -274,7 +274,7 @@ gettx(): `SubmittableExtrinsics` *Inherited from [ApiBase](_base_.apibase.md).[tx](_base_.apibase.md#tx)* -*Defined in [Base.ts:147](https://github.com/polkadot-js/api/blob/67dd498/packages/api/src/Base.ts#L147)* +*Defined in [Base.ts:147](https://github.com/polkadot-js/api/blob/d097a7a/packages/api/src/Base.ts#L147)* *__description__*: Contains all the extrinsic modules and their subsequent methods in the API. It allows for the construction of transactions and the submission thereof. These are attached dynamically from the runtime metadata. @@ -303,7 +303,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[on](_base_.apibase.md#on)* -*Defined in [Base.ts:172](https://github.com/polkadot-js/api/blob/67dd498/packages/api/src/Base.ts#L172)* +*Defined in [Base.ts:172](https://github.com/polkadot-js/api/blob/d097a7a/packages/api/src/Base.ts#L172)* *__description__*: Attach an eventemitter handler to listen to a specific event @@ -335,7 +335,7 @@ ___ ▸ **create**(wsProvider?: *`WsProvider`*): `Observable`<[ApiRx](_rx_index_.apirx.md)> -*Defined in [rx/index.ts:141](https://github.com/polkadot-js/api/blob/67dd498/packages/api/src/rx/index.ts#L141)* +*Defined in [rx/index.ts:141](https://github.com/polkadot-js/api/blob/d097a7a/packages/api/src/rx/index.ts#L141)* *__description__*: Creates an ApiRx instance using the supplied provider. Returns an Observable containing the actual Api instance. diff --git a/docs/api/classes/_rx_submittableextrinsic_.submittableextrinsic.md b/docs/api/classes/_rx_submittableextrinsic_.submittableextrinsic.md index 7e7b6b76d2..1a2cc8cbe6 100644 --- a/docs/api/classes/_rx_submittableextrinsic_.submittableextrinsic.md +++ b/docs/api/classes/_rx_submittableextrinsic_.submittableextrinsic.md @@ -25,7 +25,7 @@ *Overrides Extrinsic.__constructor* -*Defined in [rx/SubmittableExtrinsic.ts:13](https://github.com/polkadot-js/api/blob/67dd498/packages/api/src/rx/SubmittableExtrinsic.ts#L13)* +*Defined in [rx/SubmittableExtrinsic.ts:13](https://github.com/polkadot-js/api/blob/d097a7a/packages/api/src/rx/SubmittableExtrinsic.ts#L13)* **Parameters:** @@ -59,7 +59,7 @@ ___ *Inherited from Struct.raw* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L25)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L25)* ___ @@ -84,7 +84,7 @@ getType(): `E` *Inherited from Struct.Type* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L123)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -97,7 +97,7 @@ getargs(): `Array`<`Base`> *Inherited from Extrinsic.args* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:70](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Extrinsic.ts#L70)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:70](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Extrinsic.ts#L70)* **Returns:** `Array`<`Base`> @@ -110,7 +110,7 @@ getcallIndex(): `Uint8Array` *Inherited from Extrinsic.callIndex* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:75](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Extrinsic.ts#L75)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:75](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Extrinsic.ts#L75)* **Returns:** `Uint8Array` @@ -123,7 +123,7 @@ getdata(): `Uint8Array` *Inherited from Extrinsic.data* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:79](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Extrinsic.ts#L79)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:79](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Extrinsic.ts#L79)* **Returns:** `Uint8Array` @@ -138,7 +138,7 @@ getencodedLength(): `number` *Overrides Struct.encodedLength* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:110](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Extrinsic.ts#L110)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:110](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Extrinsic.ts#L110)* **Returns:** `number` @@ -151,7 +151,7 @@ gethash(): `Hash` *Inherited from Extrinsic.hash* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:84](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Extrinsic.ts#L84)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:84](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Extrinsic.ts#L84)* **Returns:** `Hash` @@ -164,7 +164,7 @@ getisSigned(): `boolean` *Inherited from Extrinsic.isSigned* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:90](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Extrinsic.ts#L90)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:90](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Extrinsic.ts#L90)* **Returns:** `boolean` @@ -177,7 +177,7 @@ getlength(): `number` *Inherited from Extrinsic.length* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:94](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Extrinsic.ts#L94)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:94](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Extrinsic.ts#L94)* **Returns:** `number` @@ -190,7 +190,7 @@ getmeta(): `FunctionMetadata` *Inherited from Extrinsic.meta* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:98](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Extrinsic.ts#L98)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:98](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Extrinsic.ts#L98)* **Returns:** `FunctionMetadata` @@ -203,7 +203,7 @@ getmethod(): `Method` *Inherited from Extrinsic.method* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:102](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Extrinsic.ts#L102)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:102](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Extrinsic.ts#L102)* **Returns:** `Method` @@ -216,7 +216,7 @@ getsignature(): `ExtrinsicSignature` *Inherited from Extrinsic.signature* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:106](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Extrinsic.ts#L106)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:106](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Extrinsic.ts#L106)* **Returns:** `ExtrinsicSignature` @@ -333,7 +333,7 @@ ___ *Inherited from Struct.getAtIndex* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L133)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -384,7 +384,7 @@ ___ ▸ **send**(): `Observable`<`ExtrinsicStatus`> -*Defined in [rx/SubmittableExtrinsic.ts:21](https://github.com/polkadot-js/api/blob/67dd498/packages/api/src/rx/SubmittableExtrinsic.ts#L21)* +*Defined in [rx/SubmittableExtrinsic.ts:21](https://github.com/polkadot-js/api/blob/d097a7a/packages/api/src/rx/SubmittableExtrinsic.ts#L21)* **Returns:** `Observable`<`ExtrinsicStatus`> @@ -417,7 +417,7 @@ ___ *Overrides Extrinsic.sign* -*Defined in [rx/SubmittableExtrinsic.ts:25](https://github.com/polkadot-js/api/blob/67dd498/packages/api/src/rx/SubmittableExtrinsic.ts#L25)* +*Defined in [rx/SubmittableExtrinsic.ts:25](https://github.com/polkadot-js/api/blob/d097a7a/packages/api/src/rx/SubmittableExtrinsic.ts#L25)* **Parameters:** @@ -438,7 +438,7 @@ ___ *Inherited from Struct.toArray* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L137)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<`Base`> @@ -453,7 +453,7 @@ ___ *Overrides Struct.toHex* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:133](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Extrinsic.ts#L133)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:133](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Extrinsic.ts#L133)* **Returns:** `string` @@ -468,7 +468,7 @@ ___ *Overrides Struct.toJSON* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:137](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Extrinsic.ts#L137)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:137](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Extrinsic.ts#L137)* **Returns:** `any` @@ -481,7 +481,7 @@ ___ *Inherited from Struct.toString* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L156)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -496,7 +496,7 @@ ___ *Overrides Struct.toU8a* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:122](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Extrinsic.ts#L122)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:122](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Extrinsic.ts#L122)* **Parameters:** @@ -530,7 +530,7 @@ ___ *Inherited from Extrinsic.decodeExtrinsic* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:42](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Extrinsic.ts#L42)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:42](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Extrinsic.ts#L42)* **Parameters:** @@ -549,7 +549,7 @@ ___ *Inherited from Struct.with* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L113)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/api/index.html b/docs/api/index.html index 25d24087cf..7c5f1c4678 100644 --- a/docs/api/index.html +++ b/docs/api/index.html @@ -495,7 +495,7 @@
diff --git a/docs/api/modules/_promise_combinator_.md b/docs/api/modules/_promise_combinator_.md index a18f0a3641..8e8ac4d1ae 100644 --- a/docs/api/modules/_promise_combinator_.md +++ b/docs/api/modules/_promise_combinator_.md @@ -21,7 +21,7 @@ **Ƭ CombinatorCallback**: *`function`* -*Defined in [promise/Combinator.ts:7](https://github.com/polkadot-js/api/blob/67dd498/packages/api/src/promise/Combinator.ts#L7)* +*Defined in [promise/Combinator.ts:7](https://github.com/polkadot-js/api/blob/d097a7a/packages/api/src/promise/Combinator.ts#L7)* #### Type declaration ▸(value: *`Array`<`any`>*): `any` @@ -41,7 +41,7 @@ ___ **Ƭ CombinatorFunction**: *`function`* -*Defined in [promise/Combinator.ts:8](https://github.com/polkadot-js/api/blob/67dd498/packages/api/src/promise/Combinator.ts#L8)* +*Defined in [promise/Combinator.ts:8](https://github.com/polkadot-js/api/blob/d097a7a/packages/api/src/promise/Combinator.ts#L8)* #### Type declaration ▸(cb: *`function`*): `any` diff --git a/docs/examples/promise/01_simple_connect/index.html b/docs/examples/promise/01_simple_connect/index.html index fe73278003..b69b091f0d 100644 --- a/docs/examples/promise/01_simple_connect/index.html +++ b/docs/examples/promise/01_simple_connect/index.html @@ -461,7 +461,7 @@
diff --git a/docs/examples/promise/02_listen_to_blocks/index.html b/docs/examples/promise/02_listen_to_blocks/index.html index d11e9eb64f..9f93c2feed 100644 --- a/docs/examples/promise/02_listen_to_blocks/index.html +++ b/docs/examples/promise/02_listen_to_blocks/index.html @@ -463,7 +463,7 @@
diff --git a/docs/examples/promise/03_listen_to_balance_change/index.html b/docs/examples/promise/03_listen_to_balance_change/index.html index f1520e88bf..aa270d9251 100644 --- a/docs/examples/promise/03_listen_to_balance_change/index.html +++ b/docs/examples/promise/03_listen_to_balance_change/index.html @@ -474,7 +474,7 @@
diff --git a/docs/examples/promise/05_read_storage/index.html b/docs/examples/promise/05_read_storage/index.html index 0d0cc5944b..65d7942250 100644 --- a/docs/examples/promise/05_read_storage/index.html +++ b/docs/examples/promise/05_read_storage/index.html @@ -473,7 +473,7 @@
diff --git a/docs/examples/promise/07_transfer_dots/index.html b/docs/examples/promise/07_transfer_dots/index.html index 4600027626..7b4a05e61c 100644 --- a/docs/examples/promise/07_transfer_dots/index.html +++ b/docs/examples/promise/07_transfer_dots/index.html @@ -469,7 +469,7 @@
diff --git a/docs/examples/promise/index.html b/docs/examples/promise/index.html index 648b836ff5..94a7a379a5 100644 --- a/docs/examples/promise/index.html +++ b/docs/examples/promise/index.html @@ -451,7 +451,7 @@
diff --git a/docs/index.html b/docs/index.html index 6df6d89649..f0b15c1d2f 100644 --- a/docs/index.html +++ b/docs/index.html @@ -475,7 +475,7 @@
diff --git a/docs/rpc-core/classes/_index_.rpc.md b/docs/rpc-core/classes/_index_.rpc.md index 8fb58acb55..921fa08e8e 100644 --- a/docs/rpc-core/classes/_index_.rpc.md +++ b/docs/rpc-core/classes/_index_.rpc.md @@ -38,7 +38,7 @@ const api = new Api(provider); ⊕ **new Rpc**(provider?: *`ProviderInterface`*): [Rpc](_index_.rpc.md) -*Defined in [index.ts:43](https://github.com/polkadot-js/api/blob/67dd498/packages/rpc-core/src/index.ts#L43)* +*Defined in [index.ts:43](https://github.com/polkadot-js/api/blob/d097a7a/packages/rpc-core/src/index.ts#L43)* *__constructor__*: Default constructor for the Api Object @@ -60,7 +60,7 @@ ___ **● _provider**: *`ProviderInterface`* -*Defined in [index.ts:39](https://github.com/polkadot-js/api/blob/67dd498/packages/rpc-core/src/index.ts#L39)* +*Defined in [index.ts:39](https://github.com/polkadot-js/api/blob/d097a7a/packages/rpc-core/src/index.ts#L39)* ___ @@ -69,7 +69,7 @@ ___ **● author**: *`RpcInterface$Section`* -*Defined in [index.ts:40](https://github.com/polkadot-js/api/blob/67dd498/packages/rpc-core/src/index.ts#L40)* +*Defined in [index.ts:40](https://github.com/polkadot-js/api/blob/d097a7a/packages/rpc-core/src/index.ts#L40)* ___ @@ -78,7 +78,7 @@ ___ **● chain**: *`RpcInterface$Section`* -*Defined in [index.ts:41](https://github.com/polkadot-js/api/blob/67dd498/packages/rpc-core/src/index.ts#L41)* +*Defined in [index.ts:41](https://github.com/polkadot-js/api/blob/d097a7a/packages/rpc-core/src/index.ts#L41)* ___ @@ -87,7 +87,7 @@ ___ **● state**: *`RpcInterface$Section`* -*Defined in [index.ts:42](https://github.com/polkadot-js/api/blob/67dd498/packages/rpc-core/src/index.ts#L42)* +*Defined in [index.ts:42](https://github.com/polkadot-js/api/blob/d097a7a/packages/rpc-core/src/index.ts#L42)* ___ @@ -96,7 +96,7 @@ ___ **● system**: *`RpcInterface$Section`* -*Defined in [index.ts:43](https://github.com/polkadot-js/api/blob/67dd498/packages/rpc-core/src/index.ts#L43)* +*Defined in [index.ts:43](https://github.com/polkadot-js/api/blob/d097a7a/packages/rpc-core/src/index.ts#L43)* ___ @@ -108,7 +108,7 @@ ___ ▸ **signature**(__namedParameters: *`object`*): `string` -*Defined in [index.ts:76](https://github.com/polkadot-js/api/blob/67dd498/packages/rpc-core/src/index.ts#L76)* +*Defined in [index.ts:76](https://github.com/polkadot-js/api/blob/d097a7a/packages/rpc-core/src/index.ts#L76)* *__name__*: signature diff --git a/docs/rpc-provider/classes/_coder_index_.rpccoder.md b/docs/rpc-provider/classes/_coder_index_.rpccoder.md index 7578647389..bd5613a92f 100644 --- a/docs/rpc-provider/classes/_coder_index_.rpccoder.md +++ b/docs/rpc-provider/classes/_coder_index_.rpccoder.md @@ -12,7 +12,7 @@ ▸ **decodeResponse**(response: *`JsonRpcResponse`*): `any` -*Defined in [coder/index.ts:12](https://github.com/polkadot-js/api/blob/67dd498/packages/rpc-provider/src/coder/index.ts#L12)* +*Defined in [coder/index.ts:12](https://github.com/polkadot-js/api/blob/d097a7a/packages/rpc-provider/src/coder/index.ts#L12)* **Parameters:** @@ -29,7 +29,7 @@ ___ ▸ **encodeJson**(method: *`string`*, params: * `any` | `Array`<`any`>*): `string` -*Defined in [coder/index.ts:33](https://github.com/polkadot-js/api/blob/67dd498/packages/rpc-provider/src/coder/index.ts#L33)* +*Defined in [coder/index.ts:33](https://github.com/polkadot-js/api/blob/d097a7a/packages/rpc-provider/src/coder/index.ts#L33)* **Parameters:** @@ -47,7 +47,7 @@ ___ ▸ **encodeObject**(method: *`string`*, params: * `any` | `Array`<`any`>*): `JsonRpcRequest` -*Defined in [coder/index.ts:39](https://github.com/polkadot-js/api/blob/67dd498/packages/rpc-provider/src/coder/index.ts#L39)* +*Defined in [coder/index.ts:39](https://github.com/polkadot-js/api/blob/d097a7a/packages/rpc-provider/src/coder/index.ts#L39)* **Parameters:** @@ -65,7 +65,7 @@ ___ ▸ **getId**(): `number` -*Defined in [coder/index.ts:48](https://github.com/polkadot-js/api/blob/67dd498/packages/rpc-provider/src/coder/index.ts#L48)* +*Defined in [coder/index.ts:48](https://github.com/polkadot-js/api/blob/d097a7a/packages/rpc-provider/src/coder/index.ts#L48)* **Returns:** `number` diff --git a/docs/rpc-provider/classes/_http_index_.httpprovider.html b/docs/rpc-provider/classes/_http_index_.httpprovider.html index a8afb7abc5..7d630e4c0c 100644 --- a/docs/rpc-provider/classes/_http_index_.httpprovider.html +++ b/docs/rpc-provider/classes/_http_index_.httpprovider.html @@ -414,7 +414,7 @@

constructor

⊕ new HttpProvider(endpoint?: string): HttpProvider

-

Defined in http/index.ts:40

+

Defined in http/index.ts:40

Parameters:

@@ -440,7 +440,7 @@

isConnected

▸ isConnected(): boolean

-

Defined in http/index.ts:56

+

Defined in http/index.ts:56

summary: Whether the node is connected or not.

Returns: boolean true if connected

@@ -448,7 +448,7 @@ true if connected

on

▸ on(type: ProviderInterface$Emitted, sub: ProviderInterface$EmitCb): void

-

Defined in http/index.ts:64

+

Defined in http/index.ts:64

summary: Events are not supported with the HttpProvider, see WsProvider.

description: HTTP Provider does not have 'on' emitters. WebSockets should be used instead.

Parameters:

@@ -475,7 +475,7 @@ true if connected

send

▸ send(method: string, params: Array<any>): Promise<any>

-

Defined in http/index.ts:71

+

Defined in http/index.ts:71

summary: Send HTTP POST Request with Body to configured HTTP Endpoint.

Parameters:

@@ -501,7 +501,7 @@ true if connected

subscribe

▸ subscribe(types: string, method: string, params: Array<any>, cb: ProviderInterface$Callback): Promise<number>

-

Defined in http/index.ts:93

+

Defined in http/index.ts:93

summary: Subscriptions are not supported with the HttpProvider, see WsProvider.

Parameters:

@@ -535,7 +535,7 @@ true if connected

unsubscribe

▸ unsubscribe(type: string, method: string, id: number): Promise<boolean>

-

Defined in http/index.ts:102

+

Defined in http/index.ts:102

summary: Subscriptions are not supported with the HttpProvider, see WsProvider.

Parameters:

@@ -605,7 +605,7 @@ true if connected

diff --git a/docs/rpc-provider/classes/_http_index_.httpprovider.md b/docs/rpc-provider/classes/_http_index_.httpprovider.md index 2cffba21ee..71eeea7678 100644 --- a/docs/rpc-provider/classes/_http_index_.httpprovider.md +++ b/docs/rpc-provider/classes/_http_index_.httpprovider.md @@ -34,7 +34,7 @@ const api = new Api(provider); ⊕ **new HttpProvider**(endpoint?: *`string`*): [HttpProvider](_http_index_.httpprovider.md) -*Defined in [http/index.ts:40](https://github.com/polkadot-js/api/blob/67dd498/packages/rpc-provider/src/http/index.ts#L40)* +*Defined in [http/index.ts:40](https://github.com/polkadot-js/api/blob/d097a7a/packages/rpc-provider/src/http/index.ts#L40)* **Parameters:** @@ -54,7 +54,7 @@ ___ ▸ **isConnected**(): `boolean` -*Defined in [http/index.ts:56](https://github.com/polkadot-js/api/blob/67dd498/packages/rpc-provider/src/http/index.ts#L56)* +*Defined in [http/index.ts:56](https://github.com/polkadot-js/api/blob/d097a7a/packages/rpc-provider/src/http/index.ts#L56)* *__summary__*: Whether the node is connected or not. @@ -68,7 +68,7 @@ ___ ▸ **on**(type: *`ProviderInterface$Emitted`*, sub: *`ProviderInterface$EmitCb`*): `void` -*Defined in [http/index.ts:64](https://github.com/polkadot-js/api/blob/67dd498/packages/rpc-provider/src/http/index.ts#L64)* +*Defined in [http/index.ts:64](https://github.com/polkadot-js/api/blob/d097a7a/packages/rpc-provider/src/http/index.ts#L64)* *__summary__*: Events are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md). @@ -90,7 +90,7 @@ ___ ▸ **send**(method: *`string`*, params: *`Array`<`any`>*): `Promise`<`any`> -*Defined in [http/index.ts:71](https://github.com/polkadot-js/api/blob/67dd498/packages/rpc-provider/src/http/index.ts#L71)* +*Defined in [http/index.ts:71](https://github.com/polkadot-js/api/blob/d097a7a/packages/rpc-provider/src/http/index.ts#L71)* *__summary__*: Send HTTP POST Request with Body to configured HTTP Endpoint. @@ -110,7 +110,7 @@ ___ ▸ **subscribe**(types: *`string`*, method: *`string`*, params: *`Array`<`any`>*, cb: *`ProviderInterface$Callback`*): `Promise`<`number`> -*Defined in [http/index.ts:93](https://github.com/polkadot-js/api/blob/67dd498/packages/rpc-provider/src/http/index.ts#L93)* +*Defined in [http/index.ts:93](https://github.com/polkadot-js/api/blob/d097a7a/packages/rpc-provider/src/http/index.ts#L93)* *__summary__*: Subscriptions are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md). @@ -132,7 +132,7 @@ ___ ▸ **unsubscribe**(type: *`string`*, method: *`string`*, id: *`number`*): `Promise`<`boolean`> -*Defined in [http/index.ts:102](https://github.com/polkadot-js/api/blob/67dd498/packages/rpc-provider/src/http/index.ts#L102)* +*Defined in [http/index.ts:102](https://github.com/polkadot-js/api/blob/d097a7a/packages/rpc-provider/src/http/index.ts#L102)* *__summary__*: Subscriptions are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md). diff --git a/docs/rpc-provider/classes/_mock_index_.mock.md b/docs/rpc-provider/classes/_mock_index_.mock.md index 873befe0ba..e126334e85 100644 --- a/docs/rpc-provider/classes/_mock_index_.mock.md +++ b/docs/rpc-provider/classes/_mock_index_.mock.md @@ -19,7 +19,7 @@ A mock provider mainly used for testing. ⊕ **new Mock**(): [Mock](_mock_index_.mock.md) -*Defined in [mock/index.ts:64](https://github.com/polkadot-js/api/blob/67dd498/packages/rpc-provider/src/mock/index.ts#L64)* +*Defined in [mock/index.ts:64](https://github.com/polkadot-js/api/blob/d097a7a/packages/rpc-provider/src/mock/index.ts#L64)* **Returns:** [Mock](_mock_index_.mock.md) @@ -33,7 +33,7 @@ ___ **● isUpdating**: *`boolean`* = true -*Defined in [mock/index.ts:42](https://github.com/polkadot-js/api/blob/67dd498/packages/rpc-provider/src/mock/index.ts#L42)* +*Defined in [mock/index.ts:42](https://github.com/polkadot-js/api/blob/d097a7a/packages/rpc-provider/src/mock/index.ts#L42)* ___ @@ -49,7 +49,7 @@ ___ return subs; }, ({} as MockState$Subscriptions)) -*Defined in [mock/index.ts:53](https://github.com/polkadot-js/api/blob/67dd498/packages/rpc-provider/src/mock/index.ts#L53)* +*Defined in [mock/index.ts:53](https://github.com/polkadot-js/api/blob/d097a7a/packages/rpc-provider/src/mock/index.ts#L53)* ___ @@ -61,7 +61,7 @@ ___ ▸ **isConnected**(): `boolean` -*Defined in [mock/index.ts:70](https://github.com/polkadot-js/api/blob/67dd498/packages/rpc-provider/src/mock/index.ts#L70)* +*Defined in [mock/index.ts:70](https://github.com/polkadot-js/api/blob/d097a7a/packages/rpc-provider/src/mock/index.ts#L70)* **Returns:** `boolean` @@ -72,7 +72,7 @@ ___ ▸ **on**(type: *`ProviderInterface$Emitted`*, sub: *`ProviderInterface$EmitCb`*): `void` -*Defined in [mock/index.ts:74](https://github.com/polkadot-js/api/blob/67dd498/packages/rpc-provider/src/mock/index.ts#L74)* +*Defined in [mock/index.ts:74](https://github.com/polkadot-js/api/blob/d097a7a/packages/rpc-provider/src/mock/index.ts#L74)* **Parameters:** @@ -90,7 +90,7 @@ ___ ▸ **send**(method: *`string`*, params: *`Array`<`any`>*): `Promise`<`any`> -*Defined in [mock/index.ts:78](https://github.com/polkadot-js/api/blob/67dd498/packages/rpc-provider/src/mock/index.ts#L78)* +*Defined in [mock/index.ts:78](https://github.com/polkadot-js/api/blob/d097a7a/packages/rpc-provider/src/mock/index.ts#L78)* **Parameters:** @@ -108,7 +108,7 @@ ___ ▸ **subscribe**(type: *`string`*, method: *`string`*, ...params: *`Array`<`any`>*): `Promise`<`number`> -*Defined in [mock/index.ts:86](https://github.com/polkadot-js/api/blob/67dd498/packages/rpc-provider/src/mock/index.ts#L86)* +*Defined in [mock/index.ts:86](https://github.com/polkadot-js/api/blob/d097a7a/packages/rpc-provider/src/mock/index.ts#L86)* **Parameters:** @@ -127,7 +127,7 @@ ___ ▸ **unsubscribe**(type: *`string`*, method: *`string`*, id: *`number`*): `Promise`<`boolean`> -*Defined in [mock/index.ts:106](https://github.com/polkadot-js/api/blob/67dd498/packages/rpc-provider/src/mock/index.ts#L106)* +*Defined in [mock/index.ts:106](https://github.com/polkadot-js/api/blob/d097a7a/packages/rpc-provider/src/mock/index.ts#L106)* **Parameters:** diff --git a/docs/rpc-provider/classes/_ws_index_.wsprovider.html b/docs/rpc-provider/classes/_ws_index_.wsprovider.html index 4192422bfd..cf37da4b59 100644 --- a/docs/rpc-provider/classes/_ws_index_.wsprovider.html +++ b/docs/rpc-provider/classes/_ws_index_.wsprovider.html @@ -414,7 +414,7 @@

constructor

⊕ new WsProvider(endpoint?: string, autoConnect?: boolean): WsProvider

-

Defined in ws/index.ts:75

+

Defined in ws/index.ts:75

Parameters:

@@ -446,7 +446,7 @@

connect

▸ connect(): void

-

Defined in ws/index.ts:103

+

Defined in ws/index.ts:103

summary: Manually connect

description: The WsProvider connects automatically by default, however if you decided otherwise, you may connect manually using this method.

Returns: void

@@ -454,7 +454,7 @@

isConnected

▸ isConnected(): boolean

-

Defined in ws/index.ts:120

+

Defined in ws/index.ts:120

summary: Whether the node is connected or not.

Returns: boolean true if connected

@@ -462,7 +462,7 @@ true if connected

on

▸ on(type: ProviderInterface$Emitted, sub: ProviderInterface$EmitCb): void

-

Defined in ws/index.ts:129

+

Defined in ws/index.ts:129

summary: Listens on events after having subscribed using the subscribe function.

Parameters:

@@ -491,7 +491,7 @@ true if connected

send

▸ send(method: string, params: Array<any>, subscription?: SubscriptionHandler): Promise<any>

-

Defined in ws/index.ts:139

+

Defined in ws/index.ts:139

summary: Send JSON data using WebSockets to configured HTTP Endpoint or queue.

Parameters:

@@ -525,7 +525,7 @@ true if connected

subscribe

▸ subscribe(type: string, method: string, params: Array<any>, callback: ProviderInterface$Callback): Promise<number>

-

Defined in ws/index.ts:195

+

Defined in ws/index.ts:195

name: subscribe

summary: Allows subscribing to a specific event.

example:

@@ -576,7 +576,7 @@ Promise resolving to the dd of the subscription you can use with [[unsubscribe]]

unsubscribe

▸ unsubscribe(type: string, method: string, id: number): Promise<boolean>

-

Defined in ws/index.ts:204

+

Defined in ws/index.ts:204

summary: Allows unsubscribing to subscriptions made with subscribe.

Parameters:

@@ -646,7 +646,7 @@ Promise resolving to the dd of the subscription you can use with [[unsubscribe]] diff --git a/docs/rpc-provider/classes/_ws_index_.wsprovider.md b/docs/rpc-provider/classes/_ws_index_.wsprovider.md index 573ed93233..78103014aa 100644 --- a/docs/rpc-provider/classes/_ws_index_.wsprovider.md +++ b/docs/rpc-provider/classes/_ws_index_.wsprovider.md @@ -34,7 +34,7 @@ const api = new Api(provider); ⊕ **new WsProvider**(endpoint?: *`string`*, autoConnect?: *`boolean`*): [WsProvider](_ws_index_.wsprovider.md) -*Defined in [ws/index.ts:75](https://github.com/polkadot-js/api/blob/67dd498/packages/rpc-provider/src/ws/index.ts#L75)* +*Defined in [ws/index.ts:75](https://github.com/polkadot-js/api/blob/d097a7a/packages/rpc-provider/src/ws/index.ts#L75)* **Parameters:** @@ -55,7 +55,7 @@ ___ ▸ **connect**(): `void` -*Defined in [ws/index.ts:103](https://github.com/polkadot-js/api/blob/67dd498/packages/rpc-provider/src/ws/index.ts#L103)* +*Defined in [ws/index.ts:103](https://github.com/polkadot-js/api/blob/d097a7a/packages/rpc-provider/src/ws/index.ts#L103)* *__summary__*: Manually connect @@ -70,7 +70,7 @@ ___ ▸ **isConnected**(): `boolean` -*Defined in [ws/index.ts:120](https://github.com/polkadot-js/api/blob/67dd498/packages/rpc-provider/src/ws/index.ts#L120)* +*Defined in [ws/index.ts:120](https://github.com/polkadot-js/api/blob/d097a7a/packages/rpc-provider/src/ws/index.ts#L120)* *__summary__*: Whether the node is connected or not. @@ -84,7 +84,7 @@ ___ ▸ **on**(type: *`ProviderInterface$Emitted`*, sub: *`ProviderInterface$EmitCb`*): `void` -*Defined in [ws/index.ts:129](https://github.com/polkadot-js/api/blob/67dd498/packages/rpc-provider/src/ws/index.ts#L129)* +*Defined in [ws/index.ts:129](https://github.com/polkadot-js/api/blob/d097a7a/packages/rpc-provider/src/ws/index.ts#L129)* *__summary__*: Listens on events after having subscribed using the [subscribe](_ws_index_.wsprovider.md#subscribe) function. @@ -104,7 +104,7 @@ ___ ▸ **send**(method: *`string`*, params: *`Array`<`any`>*, subscription?: *`SubscriptionHandler`*): `Promise`<`any`> -*Defined in [ws/index.ts:139](https://github.com/polkadot-js/api/blob/67dd498/packages/rpc-provider/src/ws/index.ts#L139)* +*Defined in [ws/index.ts:139](https://github.com/polkadot-js/api/blob/d097a7a/packages/rpc-provider/src/ws/index.ts#L139)* *__summary__*: Send JSON data using WebSockets to configured HTTP Endpoint or queue. @@ -125,7 +125,7 @@ ___ ▸ **subscribe**(type: *`string`*, method: *`string`*, params: *`Array`<`any`>*, callback: *`ProviderInterface$Callback`*): `Promise`<`number`> -*Defined in [ws/index.ts:195](https://github.com/polkadot-js/api/blob/67dd498/packages/rpc-provider/src/ws/index.ts#L195)* +*Defined in [ws/index.ts:195](https://github.com/polkadot-js/api/blob/d097a7a/packages/rpc-provider/src/ws/index.ts#L195)* *__name__*: subscribe @@ -163,7 +163,7 @@ ___ ▸ **unsubscribe**(type: *`string`*, method: *`string`*, id: *`number`*): `Promise`<`boolean`> -*Defined in [ws/index.ts:204](https://github.com/polkadot-js/api/blob/67dd498/packages/rpc-provider/src/ws/index.ts#L204)* +*Defined in [ws/index.ts:204](https://github.com/polkadot-js/api/blob/d097a7a/packages/rpc-provider/src/ws/index.ts#L204)* *__summary__*: Allows unsubscribing to subscriptions made with [subscribe](_ws_index_.wsprovider.md#subscribe). diff --git a/docs/rpc-provider/index.html b/docs/rpc-provider/index.html index 19df8b9843..3dec1cc47e 100644 --- a/docs/rpc-provider/index.html +++ b/docs/rpc-provider/index.html @@ -462,7 +462,7 @@ diff --git a/docs/rpc-rx/classes/_index_.rpcrx.md b/docs/rpc-rx/classes/_index_.rpcrx.md index dbf4336348..eaa5452a9f 100644 --- a/docs/rpc-rx/classes/_index_.rpcrx.md +++ b/docs/rpc-rx/classes/_index_.rpcrx.md @@ -32,7 +32,7 @@ const api = new RpcRx(provider); ⊕ **new RpcRx**(providerOrRpc?: * `Rpc` | `ProviderInterface`*): [RpcRx](_index_.rpcrx.md) -*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/67dd498/packages/rpc-rx/src/index.ts#L45)* +*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/d097a7a/packages/rpc-rx/src/index.ts#L45)* **Parameters:** @@ -52,7 +52,7 @@ ___ **● author**: *`RpcRxInterface$Section`* -*Defined in [index.ts:42](https://github.com/polkadot-js/api/blob/67dd498/packages/rpc-rx/src/index.ts#L42)* +*Defined in [index.ts:42](https://github.com/polkadot-js/api/blob/d097a7a/packages/rpc-rx/src/index.ts#L42)* ___ @@ -61,7 +61,7 @@ ___ **● chain**: *`RpcRxInterface$Section`* -*Defined in [index.ts:43](https://github.com/polkadot-js/api/blob/67dd498/packages/rpc-rx/src/index.ts#L43)* +*Defined in [index.ts:43](https://github.com/polkadot-js/api/blob/d097a7a/packages/rpc-rx/src/index.ts#L43)* ___ @@ -70,7 +70,7 @@ ___ **● state**: *`RpcRxInterface$Section`* -*Defined in [index.ts:44](https://github.com/polkadot-js/api/blob/67dd498/packages/rpc-rx/src/index.ts#L44)* +*Defined in [index.ts:44](https://github.com/polkadot-js/api/blob/d097a7a/packages/rpc-rx/src/index.ts#L44)* ___ @@ -79,7 +79,7 @@ ___ **● system**: *`RpcRxInterface$Section`* -*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/67dd498/packages/rpc-rx/src/index.ts#L45)* +*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/d097a7a/packages/rpc-rx/src/index.ts#L45)* ___ @@ -91,7 +91,7 @@ ___ ▸ **isConnected**(): `BehaviorSubject`<`boolean`> -*Defined in [index.ts:66](https://github.com/polkadot-js/api/blob/67dd498/packages/rpc-rx/src/index.ts#L66)* +*Defined in [index.ts:66](https://github.com/polkadot-js/api/blob/d097a7a/packages/rpc-rx/src/index.ts#L66)* **Returns:** `BehaviorSubject`<`boolean`> @@ -102,7 +102,7 @@ ___ ▸ **on**(type: *`RpcRxInterface$Events`*, handler: *`function`*): `void` -*Defined in [index.ts:70](https://github.com/polkadot-js/api/blob/67dd498/packages/rpc-rx/src/index.ts#L70)* +*Defined in [index.ts:70](https://github.com/polkadot-js/api/blob/d097a7a/packages/rpc-rx/src/index.ts#L70)* **Parameters:** diff --git a/docs/type-extrinsics/modules/_frommetadata_.md b/docs/type-extrinsics/modules/_frommetadata_.md index b5bb6fabb1..e720746647 100644 --- a/docs/type-extrinsics/modules/_frommetadata_.md +++ b/docs/type-extrinsics/modules/_frommetadata_.md @@ -8,7 +8,7 @@ ▸ **fromMetadata**(metadata: *`Metadata`*): `Extrinsics` -*Defined in [fromMetadata.ts:20](https://github.com/polkadot-js/api/blob/67dd498/packages/type-extrinsics/src/fromMetadata.ts#L20)* +*Defined in [fromMetadata.ts:20](https://github.com/polkadot-js/api/blob/d097a7a/packages/type-extrinsics/src/fromMetadata.ts#L20)* Extend a storage object with the storage modules & module functions present in the metadata. diff --git a/docs/type-extrinsics/modules/_utils_createunchecked_.md b/docs/type-extrinsics/modules/_utils_createunchecked_.md index 80713cb3e5..ac9e800fed 100644 --- a/docs/type-extrinsics/modules/_utils_createunchecked_.md +++ b/docs/type-extrinsics/modules/_utils_createunchecked_.md @@ -8,7 +8,7 @@ ▸ **createDescriptor**(section: *`string`*, method: *`string`*, index: *`number`*, meta: *`FunctionMetadata`*): `ExtrinsicFunction` -*Defined in [utils/createUnchecked.ts:17](https://github.com/polkadot-js/api/blob/67dd498/packages/type-extrinsics/src/utils/createUnchecked.ts#L17)* +*Defined in [utils/createUnchecked.ts:17](https://github.com/polkadot-js/api/blob/d097a7a/packages/type-extrinsics/src/utils/createUnchecked.ts#L17)* From the metadata of a function in the module's storage, generate the function that will return the an UncheckExtrinsic. diff --git a/docs/type-jsonrpc/modules/_create_method_.md b/docs/type-jsonrpc/modules/_create_method_.md index 205163c653..769e9e75d5 100644 --- a/docs/type-jsonrpc/modules/_create_method_.md +++ b/docs/type-jsonrpc/modules/_create_method_.md @@ -8,7 +8,7 @@ ▸ **createMethod**(section: *`string`*, method: *`string`*, __namedParameters: *`object`*): `RpcMethod` -*Defined in [create/method.ts:9](https://github.com/polkadot-js/api/blob/67dd498/packages/type-jsonrpc/src/create/method.ts#L9)* +*Defined in [create/method.ts:9](https://github.com/polkadot-js/api/blob/d097a7a/packages/type-jsonrpc/src/create/method.ts#L9)* **Parameters:** diff --git a/docs/type-jsonrpc/modules/_create_param_.md b/docs/type-jsonrpc/modules/_create_param_.md index 52a7ecf133..8f6be977ef 100644 --- a/docs/type-jsonrpc/modules/_create_param_.md +++ b/docs/type-jsonrpc/modules/_create_param_.md @@ -8,7 +8,7 @@ ▸ **createParam**(name: *`string`*, type: *`CodecTypes`*, __namedParameters?: *`object`*): `RpcParam` -*Defined in [create/param.ts:12](https://github.com/polkadot-js/api/blob/67dd498/packages/type-jsonrpc/src/create/param.ts#L12)* +*Defined in [create/param.ts:12](https://github.com/polkadot-js/api/blob/d097a7a/packages/type-jsonrpc/src/create/param.ts#L12)* **Parameters:** diff --git a/docs/type-storage/interfaces/_utils_createfunction_.createitemoptions.md b/docs/type-storage/interfaces/_utils_createfunction_.createitemoptions.md index ba9288620a..d2b76da58d 100644 --- a/docs/type-storage/interfaces/_utils_createfunction_.createitemoptions.md +++ b/docs/type-storage/interfaces/_utils_createfunction_.createitemoptions.md @@ -13,7 +13,7 @@ **● isUnhashed**: * `undefined` | `false` | `true` * -*Defined in [utils/createFunction.ts:14](https://github.com/polkadot-js/api/blob/67dd498/packages/type-storage/src/utils/createFunction.ts#L14)* +*Defined in [utils/createFunction.ts:14](https://github.com/polkadot-js/api/blob/d097a7a/packages/type-storage/src/utils/createFunction.ts#L14)* ___ @@ -23,7 +23,7 @@ ___ **● method**: * `undefined` | `string` * -*Defined in [utils/createFunction.ts:15](https://github.com/polkadot-js/api/blob/67dd498/packages/type-storage/src/utils/createFunction.ts#L15)* +*Defined in [utils/createFunction.ts:15](https://github.com/polkadot-js/api/blob/d097a7a/packages/type-storage/src/utils/createFunction.ts#L15)* ___ diff --git a/docs/type-storage/modules/_frommetadata_.md b/docs/type-storage/modules/_frommetadata_.md index a523534fb3..f27a1b3015 100644 --- a/docs/type-storage/modules/_frommetadata_.md +++ b/docs/type-storage/modules/_frommetadata_.md @@ -8,7 +8,7 @@ ▸ **fromMetadata**(metadata: *`Metadata`*): `Storage` -*Defined in [fromMetadata.ts:20](https://github.com/polkadot-js/api/blob/67dd498/packages/type-storage/src/fromMetadata.ts#L20)* +*Defined in [fromMetadata.ts:20](https://github.com/polkadot-js/api/blob/d097a7a/packages/type-storage/src/fromMetadata.ts#L20)* Extend a storage object with the storage modules & module functions present in the metadata. diff --git a/docs/type-storage/modules/_storage_.md b/docs/type-storage/modules/_storage_.md index de8eb8f83d..c4e991efca 100644 --- a/docs/type-storage/modules/_storage_.md +++ b/docs/type-storage/modules/_storage_.md @@ -8,7 +8,7 @@ **storage**: *`object`* -*Defined in [storage.ts:8](https://github.com/polkadot-js/api/blob/67dd498/packages/type-storage/src/storage.ts#L8)* +*Defined in [storage.ts:8](https://github.com/polkadot-js/api/blob/d097a7a/packages/type-storage/src/storage.ts#L8)* @@ -16,7 +16,7 @@ **● substrate**: *["substrate"](_substrate_.md)* -*Defined in [storage.ts:9](https://github.com/polkadot-js/api/blob/67dd498/packages/type-storage/src/storage.ts#L9)* +*Defined in [storage.ts:9](https://github.com/polkadot-js/api/blob/d097a7a/packages/type-storage/src/storage.ts#L9)* ___ diff --git a/docs/type-storage/modules/_substrate_.md b/docs/type-storage/modules/_substrate_.md index 13822d088c..baffbfbd70 100644 --- a/docs/type-storage/modules/_substrate_.md +++ b/docs/type-storage/modules/_substrate_.md @@ -11,7 +11,7 @@ type: 'u32' }) -*Defined in [substrate.ts:45](https://github.com/polkadot-js/api/blob/67dd498/packages/type-storage/src/substrate.ts#L45)* +*Defined in [substrate.ts:45](https://github.com/polkadot-js/api/blob/d097a7a/packages/type-storage/src/substrate.ts#L45)* ___ @@ -23,7 +23,7 @@ ___ type: 'u32' }) -*Defined in [substrate.ts:50](https://github.com/polkadot-js/api/blob/67dd498/packages/type-storage/src/substrate.ts#L50)* +*Defined in [substrate.ts:50](https://github.com/polkadot-js/api/blob/d097a7a/packages/type-storage/src/substrate.ts#L50)* ___ @@ -35,7 +35,7 @@ ___ type: 'u32' }) -*Defined in [substrate.ts:60](https://github.com/polkadot-js/api/blob/67dd498/packages/type-storage/src/substrate.ts#L60)* +*Defined in [substrate.ts:60](https://github.com/polkadot-js/api/blob/d097a7a/packages/type-storage/src/substrate.ts#L60)* ___ @@ -47,7 +47,7 @@ ___ type: 'Bytes' }) -*Defined in [substrate.ts:35](https://github.com/polkadot-js/api/blob/67dd498/packages/type-storage/src/substrate.ts#L35)* +*Defined in [substrate.ts:35](https://github.com/polkadot-js/api/blob/d097a7a/packages/type-storage/src/substrate.ts#L35)* ___ @@ -59,7 +59,7 @@ ___ type: 'u32' }) -*Defined in [substrate.ts:55](https://github.com/polkadot-js/api/blob/67dd498/packages/type-storage/src/substrate.ts#L55)* +*Defined in [substrate.ts:55](https://github.com/polkadot-js/api/blob/d097a7a/packages/type-storage/src/substrate.ts#L55)* ___ @@ -71,7 +71,7 @@ ___ type: 'u64' }) -*Defined in [substrate.ts:40](https://github.com/polkadot-js/api/blob/67dd498/packages/type-storage/src/substrate.ts#L40)* +*Defined in [substrate.ts:40](https://github.com/polkadot-js/api/blob/d097a7a/packages/type-storage/src/substrate.ts#L40)* ___ diff --git a/docs/type-storage/modules/_utils_createfunction_.md b/docs/type-storage/modules/_utils_createfunction_.md index 50f930a9df..523e24656c 100644 --- a/docs/type-storage/modules/_utils_createfunction_.md +++ b/docs/type-storage/modules/_utils_createfunction_.md @@ -20,7 +20,7 @@ ▸ **createFunction**(section: *`Text`*, method: *`Text`*, meta: *`StorageFunctionMetadata`*, options?: *[CreateItemOptions](../interfaces/_utils_createfunction_.createitemoptions.md)*): `StorageFunction` -*Defined in [utils/createFunction.ts:28](https://github.com/polkadot-js/api/blob/67dd498/packages/type-storage/src/utils/createFunction.ts#L28)* +*Defined in [utils/createFunction.ts:28](https://github.com/polkadot-js/api/blob/d097a7a/packages/type-storage/src/utils/createFunction.ts#L28)* From the schema of a function in the module's storage, generate the function that will return the correct storage key. diff --git a/docs/types/SUMMARY.md b/docs/types/SUMMARY.md index 6902b50744..14b9b75a32 100644 --- a/docs/types/SUMMARY.md +++ b/docs/types/SUMMARY.md @@ -197,6 +197,7 @@ * ["codec/U8aFixed.spec"](modules/_codec_u8afixed_spec_.md) * ["codec/UInt"](modules/_codec_uint_.md) * [UInt](classes/_codec_uint_.uint.md) +* ["codec/UInt.spec"](modules/_codec_uint_spec_.md) * ["codec/Vector"](modules/_codec_vector_.md) * [Vector](classes/_codec_vector_.vector.md) * ["codec/createType"](modules/_codec_createtype_.md) diff --git a/docs/types/classes/_accountid_.accountid.md b/docs/types/classes/_accountid_.accountid.md index 40457dbab6..e0486945ce 100644 --- a/docs/types/classes/_accountid_.accountid.md +++ b/docs/types/classes/_accountid_.accountid.md @@ -25,7 +25,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [AccountId.ts:15](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/AccountId.ts#L15)* +*Defined in [AccountId.ts:15](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/AccountId.ts#L15)* **Parameters:** @@ -123,25 +123,12 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[raw](_codec_u8a_.u8a.md#raw)* -*Defined in [codec/U8a.ts:15](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L15)* +*Defined in [codec/U8a.ts:15](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L15)* ___ # Accessors - - -## bitLength - -getbitLength(): `number` - -*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* - -*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8aFixed.ts#L32)* - -**Returns:** `number` - -___ ## encodedLength @@ -150,7 +137,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:33](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L33)* +*Defined in [codec/U8a.ts:33](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L33)* **Returns:** `number` @@ -170,6 +157,19 @@ ___ **Returns:** `IterableIterator`<`number`> +___ + + +## bitLength + +▸ **bitLength**(): `number` + +*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* + +*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8aFixed.ts#L32)* + +**Returns:** `number` + ___ @@ -690,7 +690,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:39](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L39)* +*Defined in [codec/U8a.ts:39](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L39)* **Parameters:** @@ -710,7 +710,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L43)* **Returns:** `string` @@ -723,7 +723,7 @@ ___ *Overrides [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [AccountId.ts:39](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/AccountId.ts#L39)* +*Defined in [AccountId.ts:39](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/AccountId.ts#L39)* **Returns:** `any` @@ -751,7 +751,7 @@ ___ *Overrides [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* -*Defined in [AccountId.ts:43](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/AccountId.ts#L43)* +*Defined in [AccountId.ts:43](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/AccountId.ts#L43)* **Returns:** `string` @@ -764,7 +764,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:51](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L51)* +*Defined in [codec/U8a.ts:51](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L51)* **Parameters:** @@ -796,7 +796,7 @@ ___ ▸ **encode**(value: *`Uint8Array`*): `string` -*Defined in [AccountId.ts:23](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/AccountId.ts#L23)* +*Defined in [AccountId.ts:23](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/AccountId.ts#L23)* **Parameters:** diff --git a/docs/types/classes/_accountindex_.accountindex.md b/docs/types/classes/_accountindex_.accountindex.md index 034b4cb2f3..2cd6efb0b8 100644 --- a/docs/types/classes/_accountindex_.accountindex.md +++ b/docs/types/classes/_accountindex_.accountindex.md @@ -6,6 +6,10 @@ **↳ AccountIndex** +# Implements + +* `Codec` + # Constructors @@ -16,7 +20,7 @@ *Overrides [U32](_u32_.u32.md).[constructor](_u32_.u32.md#constructor)* -*Defined in [AccountIndex.ts:26](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/AccountIndex.ts#L26)* +*Defined in [AccountIndex.ts:26](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/AccountIndex.ts#L26)* **Parameters:** @@ -36,27 +40,14 @@ ___ **● raw**: *`BN`* -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* +*Inherited from [UInt](_codec_uint_.uint.md).[raw](_codec_uint_.uint.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/UInt.ts:23](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L23)* ___ # Accessors - - -## bitLength - -getbitLength(): [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) - -*Inherited from [UInt](_codec_uint_.uint.md).[bitLength](_codec_uint_.uint.md#bitlength)* - -*Defined in [codec/UInt.ts:50](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L50)* - -**Returns:** [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) - -___ ## encodedLength @@ -65,9 +56,7 @@ getencodedLength(): `number` *Inherited from [UInt](_codec_uint_.uint.md).[encodedLength](_codec_uint_.uint.md#encodedlength)* -*Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* - -*Defined in [codec/UInt.ts:54](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L54)* +*Defined in [codec/UInt.ts:55](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L55)* **Returns:** `number` @@ -75,21 +64,167 @@ ___ # Methods + + +## abs + +▸ **abs**(): `BN` + +*Inherited from BN.abs* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:254* + +*__description__*: absolute value + +**Returns:** `BN` + +___ ## add -▸ **add**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **add**(b: *`BN`*): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)* +*Inherited from BN.add* -*Defined in [codec/UInt.ts:86](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L86)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:264* + +*__description__*: addition **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | + +**Returns:** `BN` + +___ + + +## addn + +▸ **addn**(b: *`number`*): `BN` + +*Inherited from BN.addn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:274* + +*__description__*: addition + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## and + +▸ **and**(b: *`BN`*): `BN` + +*Inherited from BN.and* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:395* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## andln + +▸ **andln**(b: *`number`*): `BN` + +*Inherited from BN.andln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:415* + +*__description__*: and (NOTE: `andln` is going to be replaced with `andn` in future) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## bincn + +▸ **bincn**(b: *`number`*): `BN` + +*Inherited from BN.bincn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:499* + +*__description__*: add `1 << b` to the number + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## bitLength + +▸ **bitLength**(): [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) + +*Inherited from [UInt](_codec_uint_.uint.md).[bitLength](_codec_uint_.uint.md#bitlength)* + +*Overrides BN.bitLength* + +*Defined in [codec/UInt.ts:51](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L51)* + +**Returns:** [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) + +___ + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from BN.byteLength* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:144* + +*__description__*: return number of bytes occupied + +**Returns:** `number` + +___ + + +## clone + +▸ **clone**(): `BN` + +*Inherited from BN.clone* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:89* + +*__description__*: clone number **Returns:** `BN` @@ -98,74 +233,229 @@ ___ ## cmp -▸ **cmp**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `number` +▸ **cmp**(b: *`BN`*): `-1` | `0` | `1` -*Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)* +*Inherited from BN.cmp* -*Defined in [codec/UInt.ts:92](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L92)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:169* + +*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | -**Returns:** `number` +**Returns:** `-1` | `0` | `1` + +___ + + +## cmpn + +▸ **cmpn**(b: *`number`*): `-1` | `0` | `1` + +*Inherited from BN.cmpn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:179* + +*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `-1` | `0` | `1` ___ ## div -▸ **div**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **div**(b: *`BN`*): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)* +*Inherited from BN.div* -*Defined in [codec/UInt.ts:98](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L98)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:339* + +*__description__*: divide **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `BN` +___ + + +## divRound + +▸ **divRound**(b: *`BN`*): `BN` + +*Inherited from BN.divRound* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:370* + +*__description__*: rounded division + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## divn + +▸ **divn**(b: *`number`*): `BN` + +*Inherited from BN.divn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:344* + +*__description__*: divide + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## egcd + +▸ **egcd**(b: *`BN`*): `object` + +*Inherited from BN.egcd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:519* + +*__description__*: Extended GCD results `({ a: ..., b: ..., gcd: ... })` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `object` + ___ ## eq -▸ **eq**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **eq**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[eq](_codec_uint_.uint.md#eq)* +*Inherited from BN.eq* -*Defined in [codec/UInt.ts:104](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L104)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:224* + +*__description__*: a equals b **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` +___ + + +## eqn + +▸ **eqn**(b: *`number`*): `boolean` + +*Inherited from BN.eqn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:229* + +*__description__*: a equals b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## fromTwos + +▸ **fromTwos**(width: *`number`*): `BN` + +*Inherited from BN.fromTwos* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:239* + +*__description__*: convert from two's complement representation, where width is the bit width + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| width | `number` | + +**Returns:** `BN` + +___ + + +## gcd + +▸ **gcd**(b: *`BN`*): `BN` + +*Inherited from BN.gcd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:514* + +*__description__*: GCD + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + ___ ## gt -▸ **gt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **gt**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)* +*Inherited from BN.gt* -*Defined in [codec/UInt.ts:126](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L126)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:204* + +*__description__*: a greater than b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` @@ -174,17 +464,346 @@ ___ ## gte -▸ **gte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **gte**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)* +*Inherited from BN.gte* -*Defined in [codec/UInt.ts:132](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L132)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:214* + +*__description__*: a greater than or equals b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | + +**Returns:** `boolean` + +___ + + +## gten + +▸ **gten**(b: *`number`*): `boolean` + +*Inherited from BN.gten* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:219* + +*__description__*: a greater than or equals b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## gtn + +▸ **gtn**(b: *`number`*): `boolean` + +*Inherited from BN.gtn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:209* + +*__description__*: a greater than b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## iabs + +▸ **iabs**(): `BN` + +*Inherited from BN.iabs* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:259* + +*__description__*: absolute value + +**Returns:** `BN` + +___ + + +## iadd + +▸ **iadd**(b: *`BN`*): `BN` + +*Inherited from BN.iadd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:269* + +*__description__*: addition + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## iaddn + +▸ **iaddn**(b: *`number`*): `BN` + +*Inherited from BN.iaddn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:279* + +*__description__*: addition + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iand + +▸ **iand**(b: *`BN`*): `BN` + +*Inherited from BN.iand* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:400* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## idivn + +▸ **idivn**(b: *`number`*): `BN` + +*Inherited from BN.idivn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:349* + +*__description__*: divide + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## imaskn + +▸ **imaskn**(b: *`number`*): `BN` + +*Inherited from BN.imaskn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495* + +*__description__*: clear bits with indexes higher or equal to `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## imul + +▸ **imul**(b: *`BN`*): `BN` + +*Inherited from BN.imul* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:309* + +*__description__*: multiply + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## imuln + +▸ **imuln**(b: *`number`*): `BN` + +*Inherited from BN.imuln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:319* + +*__description__*: multiply + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## ineg + +▸ **ineg**(): `BN` + +*Inherited from BN.ineg* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:249* + +*__description__*: negate sign + +**Returns:** `BN` + +___ + + +## inotn + +▸ **inotn**(w: *`number`*): `BN` + +*Inherited from BN.inotn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:509* + +*__description__*: not (for the width specified by `w`) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| w | `number` | + +**Returns:** `BN` + +___ + + +## invm + +▸ **invm**(b: *`BN`*): `BN` + +*Inherited from BN.invm* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:524* + +*__description__*: inverse `a` modulo `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ior + +▸ **ior**(b: *`BN`*): `BN` + +*Inherited from BN.ior* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:380* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## isEven + +▸ **isEven**(): `boolean` + +*Inherited from BN.isEven* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:154* + +*__description__*: check if value is even + +**Returns:** `boolean` + +___ + + +## isNeg + +▸ **isNeg**(): `boolean` + +*Inherited from BN.isNeg* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:149* + +*__description__*: true if the number is negative + +**Returns:** `boolean` + +___ + + +## isOdd + +▸ **isOdd**(): `boolean` + +*Inherited from BN.isOdd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:159* + +*__description__*: check if value is odd **Returns:** `boolean` @@ -195,28 +814,257 @@ ___ ▸ **isZero**(): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)* +*Inherited from BN.isZero* -*Defined in [codec/UInt.ts:110](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L110)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:164* + +*__description__*: check if value is zero **Returns:** `boolean` +___ + + +## ishln + +▸ **ishln**(b: *`number`*): `BN` + +*Inherited from BN.ishln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:450* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## ishrn + +▸ **ishrn**(b: *`number`*): `BN` + +*Inherited from BN.ishrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:470* + +*__description__*: shift right (unimplemented [https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086](https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## isqr + +▸ **isqr**(): `BN` + +*Inherited from BN.isqr* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:329* + +*__description__*: square + +**Returns:** `BN` + +___ + + +## isub + +▸ **isub**(b: *`BN`*): `BN` + +*Inherited from BN.isub* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:289* + +*__description__*: subtraction + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## isubn + +▸ **isubn**(b: *`number`*): `BN` + +*Inherited from BN.isubn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:299* + +*__description__*: subtraction + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iuand + +▸ **iuand**(b: *`BN`*): `BN` + +*Inherited from BN.iuand* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:410* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## iuor + +▸ **iuor**(b: *`BN`*): `BN` + +*Inherited from BN.iuor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:390* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## iushln + +▸ **iushln**(b: *`number`*): `BN` + +*Inherited from BN.iushln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:460* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iushrn + +▸ **iushrn**(b: *`number`*): `BN` + +*Inherited from BN.iushrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480* + +*__description__*: shift right + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iuxor + +▸ **iuxor**(b: *`BN`*): `BN` + +*Inherited from BN.iuxor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:435* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ixor + +▸ **ixor**(b: *`BN`*): `BN` + +*Inherited from BN.ixor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:425* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + ___ ## lt -▸ **lt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **lt**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)* +*Inherited from BN.lt* -*Defined in [codec/UInt.ts:114](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L114)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:184* + +*__description__*: a less than b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` @@ -225,36 +1073,324 @@ ___ ## lte -▸ **lte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **lte**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)* +*Inherited from BN.lte* -*Defined in [codec/UInt.ts:120](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L120)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:194* + +*__description__*: a less than or equals b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` +___ + + +## lten + +▸ **lten**(b: *`number`*): `boolean` + +*Inherited from BN.lten* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:199* + +*__description__*: a less than or equals b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## ltn + +▸ **ltn**(b: *`number`*): `boolean` + +*Inherited from BN.ltn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:189* + +*__description__*: a less than b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## maskn + +▸ **maskn**(b: *`number`*): `BN` + +*Inherited from BN.maskn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490* + +*__description__*: clear bits with indexes higher or equal to `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## mod + +▸ **mod**(b: *`BN`*): `BN` + +*Inherited from BN.mod* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:354* + +*__description__*: reduct + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## modn + +▸ **modn**(b: *`number`*): `number` + +*Inherited from BN.modn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:365* + +*__see__*: API consistency [https://github.com/indutny/bn.js/pull/130](https://github.com/indutny/bn.js/pull/130) + +*__description__*: reduct + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `number` + ___ ## mul -▸ **mul**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **mul**(b: *`BN`*): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)* +*Inherited from BN.mul* -*Defined in [codec/UInt.ts:138](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L138)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:304* + +*__description__*: multiply **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | + +**Returns:** `BN` + +___ + + +## muln + +▸ **muln**(b: *`number`*): `BN` + +*Inherited from BN.muln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:314* + +*__description__*: multiply + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## neg + +▸ **neg**(): `BN` + +*Inherited from BN.neg* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:244* + +*__description__*: negate sign + +**Returns:** `BN` + +___ + + +## notn + +▸ **notn**(w: *`number`*): `BN` + +*Inherited from BN.notn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:504* + +*__description__*: not (for the width specified by `w`) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| w | `number` | + +**Returns:** `BN` + +___ + + +## or + +▸ **or**(b: *`BN`*): `BN` + +*Inherited from BN.or* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:375* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## pow + +▸ **pow**(b: *`BN`*): `BN` + +*Inherited from BN.pow* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:334* + +*__description__*: raise `a` to the power of `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## setn + +▸ **setn**(b: *`number`*): `BN` + +*Inherited from BN.setn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:440* + +*__description__*: set specified bit to 1 + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## shln + +▸ **shln**(b: *`number`*): `BN` + +*Inherited from BN.shln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:445* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## shrn + +▸ **shrn**(b: *`number`*): `BN` + +*Inherited from BN.shrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:465* + +*__description__*: shift right + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## sqr + +▸ **sqr**(): `BN` + +*Inherited from BN.sqr* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:324* + +*__description__*: square **Returns:** `BN` @@ -263,20 +1399,125 @@ ___ ## sub -▸ **sub**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **sub**(b: *`BN`*): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)* +*Inherited from BN.sub* -*Defined in [codec/UInt.ts:144](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L144)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:284* + +*__description__*: subtraction **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `BN` +___ + + +## subn + +▸ **subn**(b: *`number`*): `BN` + +*Inherited from BN.subn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:294* + +*__description__*: subtraction + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## testn + +▸ **testn**(b: *`number`*): `boolean` + +*Inherited from BN.testn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485* + +*__description__*: test if specified bit is set + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## toArray + +▸ **toArray**(endian?: *`Endianness`*, length?: * `undefined` | `number`*): `number`[] + +*Inherited from BN.toArray* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:109* + +*__description__*: convert to byte Array, and optionally zero pad to length, throwing if already exceeding + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `number`[] + +___ + + +## toArrayLike + +▸ **toArrayLike**(ArrayType: *`object`*, endian?: *`Endianness`*, length?: * `undefined` | `number`*): `Buffer` + +▸ **toArrayLike**(ArrayType: *`any`[]*, endian?: *`Endianness`*, length?: * `undefined` | `number`*): `any`[] + +*Inherited from BN.toArrayLike* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:114* + +*__description__*: convert to an instance of `type`, which must behave like an Array + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| ArrayType | `object` | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `Buffer` + +*Inherited from BN.toArrayLike* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| ArrayType | `any`[] | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `any`[] + ___ @@ -284,12 +1525,34 @@ ___ ▸ **toBn**(): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)* +*Overrides [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)* -*Defined in [codec/UInt.ts:76](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L76)* +*Defined in [AccountIndex.ts:86](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/AccountIndex.ts#L86)* **Returns:** `BN` +___ + + +## toBuffer + +▸ **toBuffer**(endian?: *`Endianness`*, length?: * `undefined` | `number`*): `Buffer` + +*Inherited from BN.toBuffer* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:129* + +*__description__*: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `Buffer` + ___ @@ -299,7 +1562,7 @@ ___ *Overrides [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* -*Defined in [AccountIndex.ts:86](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/AccountIndex.ts#L86)* +*Defined in [AccountIndex.ts:92](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/AccountIndex.ts#L92)* **Returns:** `string` @@ -312,7 +1575,7 @@ ___ *Overrides [UInt](_codec_uint_.uint.md).[toJSON](_codec_uint_.uint.md#tojson)* -*Defined in [AccountIndex.ts:90](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/AccountIndex.ts#L90)* +*Defined in [AccountIndex.ts:96](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/AccountIndex.ts#L96)* **Returns:** `any` @@ -323,12 +1586,35 @@ ___ ▸ **toNumber**(): `number` -*Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)* +*Inherited from BN.toNumber* -*Defined in [codec/UInt.ts:80](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L80)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:99* + +*__description__*: convert to Javascript Number (limited to 53 bits) **Returns:** `number` +___ + + +## toRed + +▸ **toRed**(reductionContext: *`ReductionContext`*): `RedBN` + +*Inherited from BN.toRed* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:84* + +*__description__*: Convert number to red + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| reductionContext | `ReductionContext` | + +**Returns:** `RedBN` + ___ @@ -336,12 +1622,33 @@ ___ ▸ **toString**(): `string` -*Overrides [UInt](_codec_uint_.uint.md).[toString](_codec_uint_.uint.md#tostring)* +*Overrides BN.toString* -*Defined in [AccountIndex.ts:94](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/AccountIndex.ts#L94)* +*Defined in [AccountIndex.ts:100](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/AccountIndex.ts#L100)* **Returns:** `string` +___ + + +## toTwos + +▸ **toTwos**(width: *`number`*): `BN` + +*Inherited from BN.toTwos* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:234* + +*__description__*: convert to two's complement representation, where width is bit width + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| width | `number` | + +**Returns:** `BN` + ___ @@ -351,7 +1658,7 @@ ___ *Overrides [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* -*Defined in [AccountIndex.ts:100](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/AccountIndex.ts#L100)* +*Defined in [AccountIndex.ts:106](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/AccountIndex.ts#L106)* **Parameters:** @@ -361,6 +1668,189 @@ ___ **Returns:** `Uint8Array` +___ + + +## uand + +▸ **uand**(b: *`BN`*): `BN` + +*Inherited from BN.uand* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:405* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ucmp + +▸ **ucmp**(b: *`BN`*): `-1` | `0` | `1` + +*Inherited from BN.ucmp* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:174* + +*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `-1` | `0` | `1` + +___ + + +## umod + +▸ **umod**(b: *`BN`*): `BN` + +*Inherited from BN.umod* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:359* + +*__description__*: reduct + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## uor + +▸ **uor**(b: *`BN`*): `BN` + +*Inherited from BN.uor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:385* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ushln + +▸ **ushln**(b: *`number`*): `BN` + +*Inherited from BN.ushln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:455* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## ushrn + +▸ **ushrn**(b: *`number`*): `BN` + +*Inherited from BN.ushrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475* + +*__description__*: shift right + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## uxor + +▸ **uxor**(b: *`BN`*): `BN` + +*Inherited from BN.uxor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:430* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## xor + +▸ **xor**(b: *`BN`*): `BN` + +*Inherited from BN.xor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:420* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## zeroBits + +▸ **zeroBits**(): `number` + +*Inherited from BN.zeroBits* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:139* + +*__description__*: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits) + +**Returns:** `number` + ___ @@ -368,7 +1858,7 @@ ___ ▸ **calcLength**(_value: * `BN` | `number`*): `number` -*Defined in [AccountIndex.ts:47](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/AccountIndex.ts#L47)* +*Defined in [AccountIndex.ts:49](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/AccountIndex.ts#L49)* **Parameters:** @@ -385,7 +1875,7 @@ ___ ▸ **decodeAccountIndex**(value: *`AnyNumber`*): `BN` | `Uint8Array` | `number` | `string` -*Defined in [AccountIndex.ts:33](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/AccountIndex.ts#L33)* +*Defined in [AccountIndex.ts:33](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/AccountIndex.ts#L33)* **Parameters:** @@ -400,11 +1890,11 @@ ___ ## `` decodeUInt -▸ **decodeUInt**(value: *`AnyNumber`*, bitLength: *[UIntBitLength](../modules/_codec_uint_.md#uintbitlength)*): `BN` +▸ **decodeUInt**(value: *`AnyNumber`*, bitLength: *[UIntBitLength](../modules/_codec_uint_.md#uintbitlength)*): `string` *Inherited from [UInt](_codec_uint_.uint.md).[decodeUInt](_codec_uint_.uint.md#decodeuint)* -*Defined in [codec/UInt.ts:35](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L35)* +*Defined in [codec/UInt.ts:35](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L35)* **Parameters:** @@ -413,8 +1903,94 @@ ___ | value | `AnyNumber` | | bitLength | [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) | +**Returns:** `string` + +___ + + +## `` isBN + +▸ **isBN**(b: *`any`*): `boolean` + +*Inherited from BN.isBN* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:69* + +*__description__*: returns true if the supplied object is a BN.js instance + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `any` | + +**Returns:** `boolean` + +___ + + +## `` max + +▸ **max**(left: *`BN`*, right: *`BN`*): `BN` + +*Inherited from BN.max* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:74* + +*__description__*: returns the maximum of 2 BN instances. + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| left | `BN` | +| right | `BN` | + **Returns:** `BN` +___ + + +## `` min + +▸ **min**(left: *`BN`*, right: *`BN`*): `BN` + +*Inherited from BN.min* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:79* + +*__description__*: returns the minimum of 2 BN instances. + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| left | `BN` | +| right | `BN` | + +**Returns:** `BN` + +___ + + +## `` mont + +▸ **mont**(num: *`BN`*): `ReductionContext` + +*Inherited from BN.mont* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:64* + +*__description__*: create a reduction context with the Montgomery trick. + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| num | `BN` | + +**Returns:** `ReductionContext` + ___ @@ -422,7 +1998,7 @@ ___ ▸ **readLength**(input: *`Uint8Array`*): [`number`, `number`] -*Defined in [AccountIndex.ts:61](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/AccountIndex.ts#L61)* +*Defined in [AccountIndex.ts:63](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/AccountIndex.ts#L63)* **Parameters:** @@ -432,6 +2008,27 @@ ___ **Returns:** [`number`, `number`] +___ + + +## `` red + +▸ **red**(reductionContext: * `BN` | `IPrimeName`*): `ReductionContext` + +*Inherited from BN.red* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:59* + +*__description__*: create a reduction context + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| reductionContext | `BN` | `IPrimeName`| + +**Returns:** `ReductionContext` + ___ @@ -439,7 +2036,7 @@ ___ ▸ **writeLength**(input: *`Uint8Array`*): `Uint8Array` -*Defined in [AccountIndex.ts:75](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/AccountIndex.ts#L75)* +*Defined in [AccountIndex.ts:77](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/AccountIndex.ts#L77)* **Parameters:** diff --git a/docs/types/classes/_address_.address.md b/docs/types/classes/_address_.address.md index b01d29c440..2778d49a70 100644 --- a/docs/types/classes/_address_.address.md +++ b/docs/types/classes/_address_.address.md @@ -16,7 +16,7 @@ *Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* -*Defined in [Address.ts:22](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Address.ts#L22)* +*Defined in [Address.ts:22](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Address.ts#L22)* **Parameters:** @@ -39,7 +39,7 @@ ___ *Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Base.ts#L19)* ___ @@ -53,7 +53,7 @@ getencodedLength(): `number` *Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* -*Defined in [Address.ts:67](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Address.ts#L67)* +*Defined in [Address.ts:67](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Address.ts#L67)* **Returns:** `number` @@ -64,7 +64,7 @@ ___ getrawLength(): `number` -*Defined in [Address.ts:61](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Address.ts#L61)* +*Defined in [Address.ts:61](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Address.ts#L61)* **Returns:** `number` @@ -78,7 +78,7 @@ ___ ▸ **toHex**(): `string` -*Defined in [Address.ts:78](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Address.ts#L78)* +*Defined in [Address.ts:78](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Address.ts#L78)* **Returns:** `string` @@ -91,7 +91,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* -*Defined in [Address.ts:82](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Address.ts#L82)* +*Defined in [Address.ts:82](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Address.ts#L82)* **Returns:** `any` @@ -104,7 +104,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* -*Defined in [Address.ts:86](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Address.ts#L86)* +*Defined in [Address.ts:86](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Address.ts#L86)* **Returns:** `string` @@ -117,7 +117,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* -*Defined in [Address.ts:90](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Address.ts#L90)* +*Defined in [Address.ts:90](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Address.ts#L90)* **Parameters:** @@ -134,7 +134,7 @@ ___ ▸ **decodeAddress**(value: *`AnyAddress`*): [AccountId](_accountid_.accountid.md) | [AccountIndex](_accountindex_.accountindex.md) -*Defined in [Address.ts:29](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Address.ts#L29)* +*Defined in [Address.ts:29](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Address.ts#L29)* **Parameters:** diff --git a/docs/types/classes/_authorityid_.authorityid.md b/docs/types/classes/_authorityid_.authorityid.md index cbd8466c3b..3c47d48970 100644 --- a/docs/types/classes/_authorityid_.authorityid.md +++ b/docs/types/classes/_authorityid_.authorityid.md @@ -25,7 +25,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [AccountId.ts:15](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/AccountId.ts#L15)* +*Defined in [AccountId.ts:15](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/AccountId.ts#L15)* **Parameters:** @@ -123,25 +123,12 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[raw](_codec_u8a_.u8a.md#raw)* -*Defined in [codec/U8a.ts:15](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L15)* +*Defined in [codec/U8a.ts:15](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L15)* ___ # Accessors - - -## bitLength - -getbitLength(): `number` - -*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* - -*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8aFixed.ts#L32)* - -**Returns:** `number` - -___ ## encodedLength @@ -150,7 +137,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:33](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L33)* +*Defined in [codec/U8a.ts:33](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L33)* **Returns:** `number` @@ -170,6 +157,19 @@ ___ **Returns:** `IterableIterator`<`number`> +___ + + +## bitLength + +▸ **bitLength**(): `number` + +*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* + +*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8aFixed.ts#L32)* + +**Returns:** `number` + ___ @@ -690,7 +690,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:39](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L39)* +*Defined in [codec/U8a.ts:39](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L39)* **Parameters:** @@ -710,7 +710,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L43)* **Returns:** `string` @@ -725,7 +725,7 @@ ___ *Overrides [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [AccountId.ts:39](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/AccountId.ts#L39)* +*Defined in [AccountId.ts:39](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/AccountId.ts#L39)* **Returns:** `any` @@ -755,7 +755,7 @@ ___ *Overrides [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* -*Defined in [AccountId.ts:43](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/AccountId.ts#L43)* +*Defined in [AccountId.ts:43](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/AccountId.ts#L43)* **Returns:** `string` @@ -768,7 +768,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:51](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L51)* +*Defined in [codec/U8a.ts:51](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L51)* **Parameters:** @@ -802,7 +802,7 @@ ___ *Inherited from [AccountId](_accountid_.accountid.md).[encode](_accountid_.accountid.md#encode)* -*Defined in [AccountId.ts:23](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/AccountId.ts#L23)* +*Defined in [AccountId.ts:23](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/AccountId.ts#L23)* **Parameters:** diff --git a/docs/types/classes/_balance_.balance.md b/docs/types/classes/_balance_.balance.md index 8a779c6cdb..e0ac0c82f9 100644 --- a/docs/types/classes/_balance_.balance.md +++ b/docs/types/classes/_balance_.balance.md @@ -6,6 +6,10 @@ **↳ Balance** +# Implements + +* `Codec` + # Constructors @@ -18,7 +22,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U128.ts:9](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/U128.ts#L9)* +*Defined in [U128.ts:9](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/U128.ts#L9)* **Parameters:** @@ -38,27 +42,14 @@ ___ **● raw**: *`BN`* -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* +*Inherited from [UInt](_codec_uint_.uint.md).[raw](_codec_uint_.uint.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/UInt.ts:23](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L23)* ___ # Accessors - - -## bitLength - -getbitLength(): [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) - -*Inherited from [UInt](_codec_uint_.uint.md).[bitLength](_codec_uint_.uint.md#bitlength)* - -*Defined in [codec/UInt.ts:50](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L50)* - -**Returns:** [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) - -___ ## encodedLength @@ -67,9 +58,7 @@ getencodedLength(): `number` *Inherited from [UInt](_codec_uint_.uint.md).[encodedLength](_codec_uint_.uint.md#encodedlength)* -*Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* - -*Defined in [codec/UInt.ts:54](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L54)* +*Defined in [codec/UInt.ts:55](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L55)* **Returns:** `number` @@ -77,21 +66,167 @@ ___ # Methods + + +## abs + +▸ **abs**(): `BN` + +*Inherited from BN.abs* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:254* + +*__description__*: absolute value + +**Returns:** `BN` + +___ ## add -▸ **add**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **add**(b: *`BN`*): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)* +*Inherited from BN.add* -*Defined in [codec/UInt.ts:86](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L86)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:264* + +*__description__*: addition **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | + +**Returns:** `BN` + +___ + + +## addn + +▸ **addn**(b: *`number`*): `BN` + +*Inherited from BN.addn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:274* + +*__description__*: addition + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## and + +▸ **and**(b: *`BN`*): `BN` + +*Inherited from BN.and* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:395* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## andln + +▸ **andln**(b: *`number`*): `BN` + +*Inherited from BN.andln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:415* + +*__description__*: and (NOTE: `andln` is going to be replaced with `andn` in future) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## bincn + +▸ **bincn**(b: *`number`*): `BN` + +*Inherited from BN.bincn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:499* + +*__description__*: add `1 << b` to the number + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## bitLength + +▸ **bitLength**(): [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) + +*Inherited from [UInt](_codec_uint_.uint.md).[bitLength](_codec_uint_.uint.md#bitlength)* + +*Overrides BN.bitLength* + +*Defined in [codec/UInt.ts:51](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L51)* + +**Returns:** [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) + +___ + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from BN.byteLength* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:144* + +*__description__*: return number of bytes occupied + +**Returns:** `number` + +___ + + +## clone + +▸ **clone**(): `BN` + +*Inherited from BN.clone* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:89* + +*__description__*: clone number **Returns:** `BN` @@ -100,74 +235,229 @@ ___ ## cmp -▸ **cmp**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `number` +▸ **cmp**(b: *`BN`*): `-1` | `0` | `1` -*Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)* +*Inherited from BN.cmp* -*Defined in [codec/UInt.ts:92](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L92)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:169* + +*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | -**Returns:** `number` +**Returns:** `-1` | `0` | `1` + +___ + + +## cmpn + +▸ **cmpn**(b: *`number`*): `-1` | `0` | `1` + +*Inherited from BN.cmpn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:179* + +*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `-1` | `0` | `1` ___ ## div -▸ **div**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **div**(b: *`BN`*): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)* +*Inherited from BN.div* -*Defined in [codec/UInt.ts:98](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L98)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:339* + +*__description__*: divide **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `BN` +___ + + +## divRound + +▸ **divRound**(b: *`BN`*): `BN` + +*Inherited from BN.divRound* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:370* + +*__description__*: rounded division + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## divn + +▸ **divn**(b: *`number`*): `BN` + +*Inherited from BN.divn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:344* + +*__description__*: divide + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## egcd + +▸ **egcd**(b: *`BN`*): `object` + +*Inherited from BN.egcd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:519* + +*__description__*: Extended GCD results `({ a: ..., b: ..., gcd: ... })` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `object` + ___ ## eq -▸ **eq**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **eq**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[eq](_codec_uint_.uint.md#eq)* +*Inherited from BN.eq* -*Defined in [codec/UInt.ts:104](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L104)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:224* + +*__description__*: a equals b **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` +___ + + +## eqn + +▸ **eqn**(b: *`number`*): `boolean` + +*Inherited from BN.eqn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:229* + +*__description__*: a equals b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## fromTwos + +▸ **fromTwos**(width: *`number`*): `BN` + +*Inherited from BN.fromTwos* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:239* + +*__description__*: convert from two's complement representation, where width is the bit width + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| width | `number` | + +**Returns:** `BN` + +___ + + +## gcd + +▸ **gcd**(b: *`BN`*): `BN` + +*Inherited from BN.gcd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:514* + +*__description__*: GCD + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + ___ ## gt -▸ **gt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **gt**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)* +*Inherited from BN.gt* -*Defined in [codec/UInt.ts:126](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L126)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:204* + +*__description__*: a greater than b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` @@ -176,17 +466,346 @@ ___ ## gte -▸ **gte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **gte**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)* +*Inherited from BN.gte* -*Defined in [codec/UInt.ts:132](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L132)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:214* + +*__description__*: a greater than or equals b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | + +**Returns:** `boolean` + +___ + + +## gten + +▸ **gten**(b: *`number`*): `boolean` + +*Inherited from BN.gten* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:219* + +*__description__*: a greater than or equals b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## gtn + +▸ **gtn**(b: *`number`*): `boolean` + +*Inherited from BN.gtn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:209* + +*__description__*: a greater than b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## iabs + +▸ **iabs**(): `BN` + +*Inherited from BN.iabs* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:259* + +*__description__*: absolute value + +**Returns:** `BN` + +___ + + +## iadd + +▸ **iadd**(b: *`BN`*): `BN` + +*Inherited from BN.iadd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:269* + +*__description__*: addition + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## iaddn + +▸ **iaddn**(b: *`number`*): `BN` + +*Inherited from BN.iaddn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:279* + +*__description__*: addition + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iand + +▸ **iand**(b: *`BN`*): `BN` + +*Inherited from BN.iand* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:400* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## idivn + +▸ **idivn**(b: *`number`*): `BN` + +*Inherited from BN.idivn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:349* + +*__description__*: divide + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## imaskn + +▸ **imaskn**(b: *`number`*): `BN` + +*Inherited from BN.imaskn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495* + +*__description__*: clear bits with indexes higher or equal to `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## imul + +▸ **imul**(b: *`BN`*): `BN` + +*Inherited from BN.imul* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:309* + +*__description__*: multiply + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## imuln + +▸ **imuln**(b: *`number`*): `BN` + +*Inherited from BN.imuln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:319* + +*__description__*: multiply + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## ineg + +▸ **ineg**(): `BN` + +*Inherited from BN.ineg* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:249* + +*__description__*: negate sign + +**Returns:** `BN` + +___ + + +## inotn + +▸ **inotn**(w: *`number`*): `BN` + +*Inherited from BN.inotn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:509* + +*__description__*: not (for the width specified by `w`) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| w | `number` | + +**Returns:** `BN` + +___ + + +## invm + +▸ **invm**(b: *`BN`*): `BN` + +*Inherited from BN.invm* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:524* + +*__description__*: inverse `a` modulo `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ior + +▸ **ior**(b: *`BN`*): `BN` + +*Inherited from BN.ior* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:380* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## isEven + +▸ **isEven**(): `boolean` + +*Inherited from BN.isEven* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:154* + +*__description__*: check if value is even + +**Returns:** `boolean` + +___ + + +## isNeg + +▸ **isNeg**(): `boolean` + +*Inherited from BN.isNeg* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:149* + +*__description__*: true if the number is negative + +**Returns:** `boolean` + +___ + + +## isOdd + +▸ **isOdd**(): `boolean` + +*Inherited from BN.isOdd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:159* + +*__description__*: check if value is odd **Returns:** `boolean` @@ -197,28 +816,257 @@ ___ ▸ **isZero**(): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)* +*Inherited from BN.isZero* -*Defined in [codec/UInt.ts:110](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L110)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:164* + +*__description__*: check if value is zero **Returns:** `boolean` +___ + + +## ishln + +▸ **ishln**(b: *`number`*): `BN` + +*Inherited from BN.ishln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:450* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## ishrn + +▸ **ishrn**(b: *`number`*): `BN` + +*Inherited from BN.ishrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:470* + +*__description__*: shift right (unimplemented [https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086](https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## isqr + +▸ **isqr**(): `BN` + +*Inherited from BN.isqr* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:329* + +*__description__*: square + +**Returns:** `BN` + +___ + + +## isub + +▸ **isub**(b: *`BN`*): `BN` + +*Inherited from BN.isub* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:289* + +*__description__*: subtraction + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## isubn + +▸ **isubn**(b: *`number`*): `BN` + +*Inherited from BN.isubn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:299* + +*__description__*: subtraction + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iuand + +▸ **iuand**(b: *`BN`*): `BN` + +*Inherited from BN.iuand* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:410* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## iuor + +▸ **iuor**(b: *`BN`*): `BN` + +*Inherited from BN.iuor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:390* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## iushln + +▸ **iushln**(b: *`number`*): `BN` + +*Inherited from BN.iushln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:460* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iushrn + +▸ **iushrn**(b: *`number`*): `BN` + +*Inherited from BN.iushrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480* + +*__description__*: shift right + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iuxor + +▸ **iuxor**(b: *`BN`*): `BN` + +*Inherited from BN.iuxor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:435* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ixor + +▸ **ixor**(b: *`BN`*): `BN` + +*Inherited from BN.ixor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:425* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + ___ ## lt -▸ **lt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **lt**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)* +*Inherited from BN.lt* -*Defined in [codec/UInt.ts:114](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L114)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:184* + +*__description__*: a less than b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` @@ -227,36 +1075,324 @@ ___ ## lte -▸ **lte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **lte**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)* +*Inherited from BN.lte* -*Defined in [codec/UInt.ts:120](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L120)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:194* + +*__description__*: a less than or equals b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` +___ + + +## lten + +▸ **lten**(b: *`number`*): `boolean` + +*Inherited from BN.lten* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:199* + +*__description__*: a less than or equals b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## ltn + +▸ **ltn**(b: *`number`*): `boolean` + +*Inherited from BN.ltn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:189* + +*__description__*: a less than b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## maskn + +▸ **maskn**(b: *`number`*): `BN` + +*Inherited from BN.maskn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490* + +*__description__*: clear bits with indexes higher or equal to `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## mod + +▸ **mod**(b: *`BN`*): `BN` + +*Inherited from BN.mod* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:354* + +*__description__*: reduct + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## modn + +▸ **modn**(b: *`number`*): `number` + +*Inherited from BN.modn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:365* + +*__see__*: API consistency [https://github.com/indutny/bn.js/pull/130](https://github.com/indutny/bn.js/pull/130) + +*__description__*: reduct + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `number` + ___ ## mul -▸ **mul**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **mul**(b: *`BN`*): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)* +*Inherited from BN.mul* -*Defined in [codec/UInt.ts:138](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L138)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:304* + +*__description__*: multiply **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | + +**Returns:** `BN` + +___ + + +## muln + +▸ **muln**(b: *`number`*): `BN` + +*Inherited from BN.muln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:314* + +*__description__*: multiply + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## neg + +▸ **neg**(): `BN` + +*Inherited from BN.neg* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:244* + +*__description__*: negate sign + +**Returns:** `BN` + +___ + + +## notn + +▸ **notn**(w: *`number`*): `BN` + +*Inherited from BN.notn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:504* + +*__description__*: not (for the width specified by `w`) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| w | `number` | + +**Returns:** `BN` + +___ + + +## or + +▸ **or**(b: *`BN`*): `BN` + +*Inherited from BN.or* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:375* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## pow + +▸ **pow**(b: *`BN`*): `BN` + +*Inherited from BN.pow* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:334* + +*__description__*: raise `a` to the power of `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## setn + +▸ **setn**(b: *`number`*): `BN` + +*Inherited from BN.setn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:440* + +*__description__*: set specified bit to 1 + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## shln + +▸ **shln**(b: *`number`*): `BN` + +*Inherited from BN.shln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:445* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## shrn + +▸ **shrn**(b: *`number`*): `BN` + +*Inherited from BN.shrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:465* + +*__description__*: shift right + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## sqr + +▸ **sqr**(): `BN` + +*Inherited from BN.sqr* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:324* + +*__description__*: square **Returns:** `BN` @@ -265,20 +1401,125 @@ ___ ## sub -▸ **sub**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **sub**(b: *`BN`*): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)* +*Inherited from BN.sub* -*Defined in [codec/UInt.ts:144](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L144)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:284* + +*__description__*: subtraction **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `BN` +___ + + +## subn + +▸ **subn**(b: *`number`*): `BN` + +*Inherited from BN.subn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:294* + +*__description__*: subtraction + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## testn + +▸ **testn**(b: *`number`*): `boolean` + +*Inherited from BN.testn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485* + +*__description__*: test if specified bit is set + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## toArray + +▸ **toArray**(endian?: *`Endianness`*, length?: * `undefined` | `number`*): `number`[] + +*Inherited from BN.toArray* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:109* + +*__description__*: convert to byte Array, and optionally zero pad to length, throwing if already exceeding + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `number`[] + +___ + + +## toArrayLike + +▸ **toArrayLike**(ArrayType: *`object`*, endian?: *`Endianness`*, length?: * `undefined` | `number`*): `Buffer` + +▸ **toArrayLike**(ArrayType: *`any`[]*, endian?: *`Endianness`*, length?: * `undefined` | `number`*): `any`[] + +*Inherited from BN.toArrayLike* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:114* + +*__description__*: convert to an instance of `type`, which must behave like an Array + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| ArrayType | `object` | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `Buffer` + +*Inherited from BN.toArrayLike* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| ArrayType | `any`[] | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `any`[] + ___ @@ -288,10 +1529,32 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)* -*Defined in [codec/UInt.ts:76](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L76)* +*Defined in [codec/UInt.ts:73](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L73)* **Returns:** `BN` +___ + + +## toBuffer + +▸ **toBuffer**(endian?: *`Endianness`*, length?: * `undefined` | `number`*): `Buffer` + +*Inherited from BN.toBuffer* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:129* + +*__description__*: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `Buffer` + ___ @@ -301,7 +1564,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* -*Defined in [codec/UInt.ts:58](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L58)* +*Defined in [codec/UInt.ts:59](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L59)* **Returns:** `string` @@ -314,9 +1577,9 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toJSON](_codec_uint_.uint.md#tojson)* -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* +*Overrides BN.toJSON* -*Defined in [codec/UInt.ts:62](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L62)* +*Defined in [codec/UInt.ts:63](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L63)* **Returns:** `any` @@ -327,27 +1590,78 @@ ___ ▸ **toNumber**(): `number` -*Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)* +*Inherited from BN.toNumber* -*Defined in [codec/UInt.ts:80](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L80)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:99* + +*__description__*: convert to Javascript Number (limited to 53 bits) **Returns:** `number` +___ + + +## toRed + +▸ **toRed**(reductionContext: *`ReductionContext`*): `RedBN` + +*Inherited from BN.toRed* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:84* + +*__description__*: Convert number to red + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| reductionContext | `ReductionContext` | + +**Returns:** `RedBN` + ___ ## toString -▸ **toString**(): `string` +▸ **toString**(base?: * `number` | "hex"*, length?: * `undefined` | `number`*): `string` -*Inherited from [UInt](_codec_uint_.uint.md).[toString](_codec_uint_.uint.md#tostring)* +*Inherited from BN.toString* -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:94* -*Defined in [codec/UInt.ts:72](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L72)* +*__description__*: convert to base-string and pad with zeroes + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` base | `number` | "hex"| +| `Optional` length | `undefined` | `number`| **Returns:** `string` +___ + + +## toTwos + +▸ **toTwos**(width: *`number`*): `BN` + +*Inherited from BN.toTwos* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:234* + +*__description__*: convert to two's complement representation, where width is bit width + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| width | `number` | + +**Returns:** `BN` + ___ @@ -357,9 +1671,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/UInt.ts:68](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L68)* +*Defined in [codec/UInt.ts:69](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L69)* **Parameters:** @@ -369,16 +1681,199 @@ ___ **Returns:** `Uint8Array` +___ + + +## uand + +▸ **uand**(b: *`BN`*): `BN` + +*Inherited from BN.uand* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:405* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ucmp + +▸ **ucmp**(b: *`BN`*): `-1` | `0` | `1` + +*Inherited from BN.ucmp* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:174* + +*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `-1` | `0` | `1` + +___ + + +## umod + +▸ **umod**(b: *`BN`*): `BN` + +*Inherited from BN.umod* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:359* + +*__description__*: reduct + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## uor + +▸ **uor**(b: *`BN`*): `BN` + +*Inherited from BN.uor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:385* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ushln + +▸ **ushln**(b: *`number`*): `BN` + +*Inherited from BN.ushln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:455* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## ushrn + +▸ **ushrn**(b: *`number`*): `BN` + +*Inherited from BN.ushrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475* + +*__description__*: shift right + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## uxor + +▸ **uxor**(b: *`BN`*): `BN` + +*Inherited from BN.uxor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:430* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## xor + +▸ **xor**(b: *`BN`*): `BN` + +*Inherited from BN.xor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:420* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## zeroBits + +▸ **zeroBits**(): `number` + +*Inherited from BN.zeroBits* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:139* + +*__description__*: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits) + +**Returns:** `number` + ___ ## `` decodeUInt -▸ **decodeUInt**(value: *`AnyNumber`*, bitLength: *[UIntBitLength](../modules/_codec_uint_.md#uintbitlength)*): `BN` +▸ **decodeUInt**(value: *`AnyNumber`*, bitLength: *[UIntBitLength](../modules/_codec_uint_.md#uintbitlength)*): `string` *Inherited from [UInt](_codec_uint_.uint.md).[decodeUInt](_codec_uint_.uint.md#decodeuint)* -*Defined in [codec/UInt.ts:35](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L35)* +*Defined in [codec/UInt.ts:35](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L35)* **Parameters:** @@ -387,7 +1882,114 @@ ___ | value | `AnyNumber` | | bitLength | [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) | +**Returns:** `string` + +___ + + +## `` isBN + +▸ **isBN**(b: *`any`*): `boolean` + +*Inherited from BN.isBN* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:69* + +*__description__*: returns true if the supplied object is a BN.js instance + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `any` | + +**Returns:** `boolean` + +___ + + +## `` max + +▸ **max**(left: *`BN`*, right: *`BN`*): `BN` + +*Inherited from BN.max* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:74* + +*__description__*: returns the maximum of 2 BN instances. + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| left | `BN` | +| right | `BN` | + **Returns:** `BN` ___ + + +## `` min + +▸ **min**(left: *`BN`*, right: *`BN`*): `BN` + +*Inherited from BN.min* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:79* + +*__description__*: returns the minimum of 2 BN instances. + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| left | `BN` | +| right | `BN` | + +**Returns:** `BN` + +___ + + +## `` mont + +▸ **mont**(num: *`BN`*): `ReductionContext` + +*Inherited from BN.mont* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:64* + +*__description__*: create a reduction context with the Montgomery trick. + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| num | `BN` | + +**Returns:** `ReductionContext` + +___ + + +## `` red + +▸ **red**(reductionContext: * `BN` | `IPrimeName`*): `ReductionContext` + +*Inherited from BN.red* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:59* + +*__description__*: create a reduction context + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| reductionContext | `BN` | `IPrimeName`| + +**Returns:** `ReductionContext` + +___ diff --git a/docs/types/classes/_bft_.bftauthoritysignature.md b/docs/types/classes/_bft_.bftauthoritysignature.md index 6b94832587..8be9a68744 100644 --- a/docs/types/classes/_bft_.bftauthoritysignature.md +++ b/docs/types/classes/_bft_.bftauthoritysignature.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Bft.ts:23](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Bft.ts#L23)* +*Defined in [Bft.ts:23](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Bft.ts#L23)* **Parameters:** @@ -58,7 +58,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L25)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L25)* ___ @@ -83,7 +83,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L123)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -94,7 +94,7 @@ ___ getauthorityId(): [AuthorityId](_authorityid_.authorityid.md) -*Defined in [Bft.ts:31](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Bft.ts#L31)* +*Defined in [Bft.ts:31](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Bft.ts#L31)* **Returns:** [AuthorityId](_authorityid_.authorityid.md) @@ -107,7 +107,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L127)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -118,7 +118,7 @@ ___ getsignature(): [Signature](_signature_.signature.md) -*Defined in [Bft.ts:35](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Bft.ts#L35)* +*Defined in [Bft.ts:35](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Bft.ts#L35)* **Returns:** [Signature](_signature_.signature.md) @@ -235,7 +235,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L133)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -308,7 +308,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L137)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -321,7 +321,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L141)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -336,7 +336,7 @@ ___ *Overrides [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Tuple.ts:28](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Tuple.ts#L28)* +*Defined in [codec/Tuple.ts:28](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Tuple.ts#L28)* **Returns:** `any` @@ -349,7 +349,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L156)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -362,7 +362,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -398,7 +398,7 @@ ___ *Overrides [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Tuple.ts:18](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Tuple.ts#L18)* +*Defined in [codec/Tuple.ts:18](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Tuple.ts#L18)* **Type parameters:** diff --git a/docs/types/classes/_bft_.bfthashsignature.md b/docs/types/classes/_bft_.bfthashsignature.md index 1be805e7a9..1f0f9ffd42 100644 --- a/docs/types/classes/_bft_.bfthashsignature.md +++ b/docs/types/classes/_bft_.bfthashsignature.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Bft.ts:47](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Bft.ts#L47)* +*Defined in [Bft.ts:47](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Bft.ts#L47)* **Parameters:** @@ -58,7 +58,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L25)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L25)* ___ @@ -83,7 +83,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L123)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -96,7 +96,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L127)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -107,7 +107,7 @@ ___ gethash(): [Hash](_hash_.hash.md) -*Defined in [Bft.ts:55](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Bft.ts#L55)* +*Defined in [Bft.ts:55](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Bft.ts#L55)* **Returns:** [Hash](_hash_.hash.md) @@ -118,7 +118,7 @@ ___ getsignature(): [Signature](_signature_.signature.md) -*Defined in [Bft.ts:59](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Bft.ts#L59)* +*Defined in [Bft.ts:59](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Bft.ts#L59)* **Returns:** [Signature](_signature_.signature.md) @@ -235,7 +235,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L133)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -308,7 +308,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L137)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -321,7 +321,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L141)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -336,7 +336,7 @@ ___ *Overrides [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Tuple.ts:28](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Tuple.ts#L28)* +*Defined in [codec/Tuple.ts:28](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Tuple.ts#L28)* **Returns:** `any` @@ -349,7 +349,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L156)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -362,7 +362,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -398,7 +398,7 @@ ___ *Overrides [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Tuple.ts:18](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Tuple.ts#L18)* +*Defined in [codec/Tuple.ts:18](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Tuple.ts#L18)* **Type parameters:** diff --git a/docs/types/classes/_bft_.justification.md b/docs/types/classes/_bft_.justification.md index fc7f45c134..cc52bee137 100644 --- a/docs/types/classes/_bft_.justification.md +++ b/docs/types/classes/_bft_.justification.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Bft.ts:70](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Bft.ts#L70)* +*Defined in [Bft.ts:70](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Bft.ts#L70)* **Parameters:** @@ -58,7 +58,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L25)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L25)* ___ @@ -83,7 +83,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L123)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -96,7 +96,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L127)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -107,7 +107,7 @@ ___ gethash(): [Hash](_hash_.hash.md) -*Defined in [Bft.ts:81](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Bft.ts#L81)* +*Defined in [Bft.ts:81](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Bft.ts#L81)* **Returns:** [Hash](_hash_.hash.md) @@ -118,7 +118,7 @@ ___ getround(): [U32](_u32_.u32.md) -*Defined in [Bft.ts:85](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Bft.ts#L85)* +*Defined in [Bft.ts:85](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Bft.ts#L85)* **Returns:** [U32](_u32_.u32.md) @@ -129,7 +129,7 @@ ___ getsignatures(): [Vector](_codec_vector_.vector.md)<[BftAuthoritySignature](_bft_.bftauthoritysignature.md)> -*Defined in [Bft.ts:89](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Bft.ts#L89)* +*Defined in [Bft.ts:89](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Bft.ts#L89)* **Returns:** [Vector](_codec_vector_.vector.md)<[BftAuthoritySignature](_bft_.bftauthoritysignature.md)> @@ -246,7 +246,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L133)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -319,7 +319,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L137)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -332,7 +332,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L141)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -345,7 +345,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L145)* **Returns:** `any` @@ -358,7 +358,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L156)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -371,7 +371,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -405,7 +405,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L113)* +*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/types/classes/_block_.block.md b/docs/types/classes/_block_.block.md index 819beaaf8e..96ff25ffaf 100644 --- a/docs/types/classes/_block_.block.md +++ b/docs/types/classes/_block_.block.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Block.ts:21](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Block.ts#L21)* +*Defined in [Block.ts:21](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Block.ts#L21)* **Parameters:** @@ -58,7 +58,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L25)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L25)* ___ @@ -83,7 +83,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L123)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -96,7 +96,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L127)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -107,7 +107,7 @@ ___ getextrinsics(): [Extrinsics](_extrinsics_.extrinsics.md) -*Defined in [Block.ts:29](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Block.ts#L29)* +*Defined in [Block.ts:29](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Block.ts#L29)* **Returns:** [Extrinsics](_extrinsics_.extrinsics.md) @@ -118,7 +118,7 @@ ___ gethash(): [Hash](_hash_.hash.md) -*Defined in [Block.ts:34](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Block.ts#L34)* +*Defined in [Block.ts:34](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Block.ts#L34)* **Returns:** [Hash](_hash_.hash.md) @@ -129,7 +129,7 @@ ___ getheader(): [Header](_header_.header.md) -*Defined in [Block.ts:40](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Block.ts#L40)* +*Defined in [Block.ts:40](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Block.ts#L40)* **Returns:** [Header](_header_.header.md) @@ -246,7 +246,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L133)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -319,7 +319,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L137)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -332,7 +332,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L141)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -345,7 +345,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L145)* **Returns:** `any` @@ -358,7 +358,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L156)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -371,7 +371,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -405,7 +405,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L113)* +*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/types/classes/_blocknumber_.blocknumber.md b/docs/types/classes/_blocknumber_.blocknumber.md index e279af6cbd..8e4cc90437 100644 --- a/docs/types/classes/_blocknumber_.blocknumber.md +++ b/docs/types/classes/_blocknumber_.blocknumber.md @@ -6,6 +6,10 @@ **↳ BlockNumber** +# Implements + +* `Codec` + # Constructors @@ -18,7 +22,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U64.ts:9](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/U64.ts#L9)* +*Defined in [U64.ts:9](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/U64.ts#L9)* **Parameters:** @@ -38,27 +42,14 @@ ___ **● raw**: *`BN`* -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* +*Inherited from [UInt](_codec_uint_.uint.md).[raw](_codec_uint_.uint.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/UInt.ts:23](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L23)* ___ # Accessors - - -## bitLength - -getbitLength(): [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) - -*Inherited from [UInt](_codec_uint_.uint.md).[bitLength](_codec_uint_.uint.md#bitlength)* - -*Defined in [codec/UInt.ts:50](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L50)* - -**Returns:** [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) - -___ ## encodedLength @@ -67,9 +58,7 @@ getencodedLength(): `number` *Inherited from [UInt](_codec_uint_.uint.md).[encodedLength](_codec_uint_.uint.md#encodedlength)* -*Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* - -*Defined in [codec/UInt.ts:54](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L54)* +*Defined in [codec/UInt.ts:55](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L55)* **Returns:** `number` @@ -77,21 +66,167 @@ ___ # Methods + + +## abs + +▸ **abs**(): `BN` + +*Inherited from BN.abs* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:254* + +*__description__*: absolute value + +**Returns:** `BN` + +___ ## add -▸ **add**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **add**(b: *`BN`*): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)* +*Inherited from BN.add* -*Defined in [codec/UInt.ts:86](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L86)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:264* + +*__description__*: addition **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | + +**Returns:** `BN` + +___ + + +## addn + +▸ **addn**(b: *`number`*): `BN` + +*Inherited from BN.addn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:274* + +*__description__*: addition + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## and + +▸ **and**(b: *`BN`*): `BN` + +*Inherited from BN.and* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:395* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## andln + +▸ **andln**(b: *`number`*): `BN` + +*Inherited from BN.andln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:415* + +*__description__*: and (NOTE: `andln` is going to be replaced with `andn` in future) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## bincn + +▸ **bincn**(b: *`number`*): `BN` + +*Inherited from BN.bincn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:499* + +*__description__*: add `1 << b` to the number + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## bitLength + +▸ **bitLength**(): [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) + +*Inherited from [UInt](_codec_uint_.uint.md).[bitLength](_codec_uint_.uint.md#bitlength)* + +*Overrides BN.bitLength* + +*Defined in [codec/UInt.ts:51](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L51)* + +**Returns:** [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) + +___ + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from BN.byteLength* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:144* + +*__description__*: return number of bytes occupied + +**Returns:** `number` + +___ + + +## clone + +▸ **clone**(): `BN` + +*Inherited from BN.clone* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:89* + +*__description__*: clone number **Returns:** `BN` @@ -100,74 +235,229 @@ ___ ## cmp -▸ **cmp**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `number` +▸ **cmp**(b: *`BN`*): `-1` | `0` | `1` -*Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)* +*Inherited from BN.cmp* -*Defined in [codec/UInt.ts:92](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L92)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:169* + +*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | -**Returns:** `number` +**Returns:** `-1` | `0` | `1` + +___ + + +## cmpn + +▸ **cmpn**(b: *`number`*): `-1` | `0` | `1` + +*Inherited from BN.cmpn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:179* + +*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `-1` | `0` | `1` ___ ## div -▸ **div**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **div**(b: *`BN`*): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)* +*Inherited from BN.div* -*Defined in [codec/UInt.ts:98](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L98)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:339* + +*__description__*: divide **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `BN` +___ + + +## divRound + +▸ **divRound**(b: *`BN`*): `BN` + +*Inherited from BN.divRound* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:370* + +*__description__*: rounded division + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## divn + +▸ **divn**(b: *`number`*): `BN` + +*Inherited from BN.divn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:344* + +*__description__*: divide + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## egcd + +▸ **egcd**(b: *`BN`*): `object` + +*Inherited from BN.egcd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:519* + +*__description__*: Extended GCD results `({ a: ..., b: ..., gcd: ... })` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `object` + ___ ## eq -▸ **eq**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **eq**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[eq](_codec_uint_.uint.md#eq)* +*Inherited from BN.eq* -*Defined in [codec/UInt.ts:104](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L104)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:224* + +*__description__*: a equals b **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` +___ + + +## eqn + +▸ **eqn**(b: *`number`*): `boolean` + +*Inherited from BN.eqn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:229* + +*__description__*: a equals b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## fromTwos + +▸ **fromTwos**(width: *`number`*): `BN` + +*Inherited from BN.fromTwos* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:239* + +*__description__*: convert from two's complement representation, where width is the bit width + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| width | `number` | + +**Returns:** `BN` + +___ + + +## gcd + +▸ **gcd**(b: *`BN`*): `BN` + +*Inherited from BN.gcd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:514* + +*__description__*: GCD + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + ___ ## gt -▸ **gt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **gt**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)* +*Inherited from BN.gt* -*Defined in [codec/UInt.ts:126](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L126)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:204* + +*__description__*: a greater than b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` @@ -176,17 +466,346 @@ ___ ## gte -▸ **gte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **gte**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)* +*Inherited from BN.gte* -*Defined in [codec/UInt.ts:132](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L132)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:214* + +*__description__*: a greater than or equals b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | + +**Returns:** `boolean` + +___ + + +## gten + +▸ **gten**(b: *`number`*): `boolean` + +*Inherited from BN.gten* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:219* + +*__description__*: a greater than or equals b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## gtn + +▸ **gtn**(b: *`number`*): `boolean` + +*Inherited from BN.gtn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:209* + +*__description__*: a greater than b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## iabs + +▸ **iabs**(): `BN` + +*Inherited from BN.iabs* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:259* + +*__description__*: absolute value + +**Returns:** `BN` + +___ + + +## iadd + +▸ **iadd**(b: *`BN`*): `BN` + +*Inherited from BN.iadd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:269* + +*__description__*: addition + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## iaddn + +▸ **iaddn**(b: *`number`*): `BN` + +*Inherited from BN.iaddn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:279* + +*__description__*: addition + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iand + +▸ **iand**(b: *`BN`*): `BN` + +*Inherited from BN.iand* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:400* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## idivn + +▸ **idivn**(b: *`number`*): `BN` + +*Inherited from BN.idivn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:349* + +*__description__*: divide + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## imaskn + +▸ **imaskn**(b: *`number`*): `BN` + +*Inherited from BN.imaskn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495* + +*__description__*: clear bits with indexes higher or equal to `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## imul + +▸ **imul**(b: *`BN`*): `BN` + +*Inherited from BN.imul* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:309* + +*__description__*: multiply + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## imuln + +▸ **imuln**(b: *`number`*): `BN` + +*Inherited from BN.imuln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:319* + +*__description__*: multiply + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## ineg + +▸ **ineg**(): `BN` + +*Inherited from BN.ineg* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:249* + +*__description__*: negate sign + +**Returns:** `BN` + +___ + + +## inotn + +▸ **inotn**(w: *`number`*): `BN` + +*Inherited from BN.inotn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:509* + +*__description__*: not (for the width specified by `w`) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| w | `number` | + +**Returns:** `BN` + +___ + + +## invm + +▸ **invm**(b: *`BN`*): `BN` + +*Inherited from BN.invm* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:524* + +*__description__*: inverse `a` modulo `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ior + +▸ **ior**(b: *`BN`*): `BN` + +*Inherited from BN.ior* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:380* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## isEven + +▸ **isEven**(): `boolean` + +*Inherited from BN.isEven* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:154* + +*__description__*: check if value is even + +**Returns:** `boolean` + +___ + + +## isNeg + +▸ **isNeg**(): `boolean` + +*Inherited from BN.isNeg* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:149* + +*__description__*: true if the number is negative + +**Returns:** `boolean` + +___ + + +## isOdd + +▸ **isOdd**(): `boolean` + +*Inherited from BN.isOdd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:159* + +*__description__*: check if value is odd **Returns:** `boolean` @@ -197,28 +816,257 @@ ___ ▸ **isZero**(): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)* +*Inherited from BN.isZero* -*Defined in [codec/UInt.ts:110](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L110)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:164* + +*__description__*: check if value is zero **Returns:** `boolean` +___ + + +## ishln + +▸ **ishln**(b: *`number`*): `BN` + +*Inherited from BN.ishln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:450* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## ishrn + +▸ **ishrn**(b: *`number`*): `BN` + +*Inherited from BN.ishrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:470* + +*__description__*: shift right (unimplemented [https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086](https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## isqr + +▸ **isqr**(): `BN` + +*Inherited from BN.isqr* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:329* + +*__description__*: square + +**Returns:** `BN` + +___ + + +## isub + +▸ **isub**(b: *`BN`*): `BN` + +*Inherited from BN.isub* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:289* + +*__description__*: subtraction + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## isubn + +▸ **isubn**(b: *`number`*): `BN` + +*Inherited from BN.isubn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:299* + +*__description__*: subtraction + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iuand + +▸ **iuand**(b: *`BN`*): `BN` + +*Inherited from BN.iuand* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:410* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## iuor + +▸ **iuor**(b: *`BN`*): `BN` + +*Inherited from BN.iuor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:390* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## iushln + +▸ **iushln**(b: *`number`*): `BN` + +*Inherited from BN.iushln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:460* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iushrn + +▸ **iushrn**(b: *`number`*): `BN` + +*Inherited from BN.iushrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480* + +*__description__*: shift right + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iuxor + +▸ **iuxor**(b: *`BN`*): `BN` + +*Inherited from BN.iuxor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:435* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ixor + +▸ **ixor**(b: *`BN`*): `BN` + +*Inherited from BN.ixor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:425* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + ___ ## lt -▸ **lt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **lt**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)* +*Inherited from BN.lt* -*Defined in [codec/UInt.ts:114](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L114)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:184* + +*__description__*: a less than b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` @@ -227,36 +1075,324 @@ ___ ## lte -▸ **lte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **lte**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)* +*Inherited from BN.lte* -*Defined in [codec/UInt.ts:120](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L120)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:194* + +*__description__*: a less than or equals b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` +___ + + +## lten + +▸ **lten**(b: *`number`*): `boolean` + +*Inherited from BN.lten* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:199* + +*__description__*: a less than or equals b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## ltn + +▸ **ltn**(b: *`number`*): `boolean` + +*Inherited from BN.ltn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:189* + +*__description__*: a less than b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## maskn + +▸ **maskn**(b: *`number`*): `BN` + +*Inherited from BN.maskn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490* + +*__description__*: clear bits with indexes higher or equal to `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## mod + +▸ **mod**(b: *`BN`*): `BN` + +*Inherited from BN.mod* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:354* + +*__description__*: reduct + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## modn + +▸ **modn**(b: *`number`*): `number` + +*Inherited from BN.modn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:365* + +*__see__*: API consistency [https://github.com/indutny/bn.js/pull/130](https://github.com/indutny/bn.js/pull/130) + +*__description__*: reduct + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `number` + ___ ## mul -▸ **mul**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **mul**(b: *`BN`*): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)* +*Inherited from BN.mul* -*Defined in [codec/UInt.ts:138](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L138)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:304* + +*__description__*: multiply **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | + +**Returns:** `BN` + +___ + + +## muln + +▸ **muln**(b: *`number`*): `BN` + +*Inherited from BN.muln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:314* + +*__description__*: multiply + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## neg + +▸ **neg**(): `BN` + +*Inherited from BN.neg* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:244* + +*__description__*: negate sign + +**Returns:** `BN` + +___ + + +## notn + +▸ **notn**(w: *`number`*): `BN` + +*Inherited from BN.notn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:504* + +*__description__*: not (for the width specified by `w`) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| w | `number` | + +**Returns:** `BN` + +___ + + +## or + +▸ **or**(b: *`BN`*): `BN` + +*Inherited from BN.or* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:375* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## pow + +▸ **pow**(b: *`BN`*): `BN` + +*Inherited from BN.pow* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:334* + +*__description__*: raise `a` to the power of `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## setn + +▸ **setn**(b: *`number`*): `BN` + +*Inherited from BN.setn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:440* + +*__description__*: set specified bit to 1 + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## shln + +▸ **shln**(b: *`number`*): `BN` + +*Inherited from BN.shln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:445* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## shrn + +▸ **shrn**(b: *`number`*): `BN` + +*Inherited from BN.shrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:465* + +*__description__*: shift right + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## sqr + +▸ **sqr**(): `BN` + +*Inherited from BN.sqr* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:324* + +*__description__*: square **Returns:** `BN` @@ -265,20 +1401,125 @@ ___ ## sub -▸ **sub**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **sub**(b: *`BN`*): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)* +*Inherited from BN.sub* -*Defined in [codec/UInt.ts:144](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L144)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:284* + +*__description__*: subtraction **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `BN` +___ + + +## subn + +▸ **subn**(b: *`number`*): `BN` + +*Inherited from BN.subn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:294* + +*__description__*: subtraction + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## testn + +▸ **testn**(b: *`number`*): `boolean` + +*Inherited from BN.testn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485* + +*__description__*: test if specified bit is set + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## toArray + +▸ **toArray**(endian?: *`Endianness`*, length?: * `undefined` | `number`*): `number`[] + +*Inherited from BN.toArray* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:109* + +*__description__*: convert to byte Array, and optionally zero pad to length, throwing if already exceeding + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `number`[] + +___ + + +## toArrayLike + +▸ **toArrayLike**(ArrayType: *`object`*, endian?: *`Endianness`*, length?: * `undefined` | `number`*): `Buffer` + +▸ **toArrayLike**(ArrayType: *`any`[]*, endian?: *`Endianness`*, length?: * `undefined` | `number`*): `any`[] + +*Inherited from BN.toArrayLike* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:114* + +*__description__*: convert to an instance of `type`, which must behave like an Array + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| ArrayType | `object` | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `Buffer` + +*Inherited from BN.toArrayLike* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| ArrayType | `any`[] | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `any`[] + ___ @@ -288,10 +1529,32 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)* -*Defined in [codec/UInt.ts:76](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L76)* +*Defined in [codec/UInt.ts:73](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L73)* **Returns:** `BN` +___ + + +## toBuffer + +▸ **toBuffer**(endian?: *`Endianness`*, length?: * `undefined` | `number`*): `Buffer` + +*Inherited from BN.toBuffer* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:129* + +*__description__*: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `Buffer` + ___ @@ -301,7 +1564,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* -*Defined in [codec/UInt.ts:58](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L58)* +*Defined in [codec/UInt.ts:59](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L59)* **Returns:** `string` @@ -314,9 +1577,9 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toJSON](_codec_uint_.uint.md#tojson)* -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* +*Overrides BN.toJSON* -*Defined in [codec/UInt.ts:62](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L62)* +*Defined in [codec/UInt.ts:63](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L63)* **Returns:** `any` @@ -327,27 +1590,78 @@ ___ ▸ **toNumber**(): `number` -*Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)* +*Inherited from BN.toNumber* -*Defined in [codec/UInt.ts:80](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L80)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:99* + +*__description__*: convert to Javascript Number (limited to 53 bits) **Returns:** `number` +___ + + +## toRed + +▸ **toRed**(reductionContext: *`ReductionContext`*): `RedBN` + +*Inherited from BN.toRed* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:84* + +*__description__*: Convert number to red + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| reductionContext | `ReductionContext` | + +**Returns:** `RedBN` + ___ ## toString -▸ **toString**(): `string` +▸ **toString**(base?: * `number` | "hex"*, length?: * `undefined` | `number`*): `string` -*Inherited from [UInt](_codec_uint_.uint.md).[toString](_codec_uint_.uint.md#tostring)* +*Inherited from BN.toString* -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:94* -*Defined in [codec/UInt.ts:72](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L72)* +*__description__*: convert to base-string and pad with zeroes + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` base | `number` | "hex"| +| `Optional` length | `undefined` | `number`| **Returns:** `string` +___ + + +## toTwos + +▸ **toTwos**(width: *`number`*): `BN` + +*Inherited from BN.toTwos* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:234* + +*__description__*: convert to two's complement representation, where width is bit width + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| width | `number` | + +**Returns:** `BN` + ___ @@ -357,9 +1671,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/UInt.ts:68](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L68)* +*Defined in [codec/UInt.ts:69](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L69)* **Parameters:** @@ -369,16 +1681,199 @@ ___ **Returns:** `Uint8Array` +___ + + +## uand + +▸ **uand**(b: *`BN`*): `BN` + +*Inherited from BN.uand* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:405* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ucmp + +▸ **ucmp**(b: *`BN`*): `-1` | `0` | `1` + +*Inherited from BN.ucmp* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:174* + +*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `-1` | `0` | `1` + +___ + + +## umod + +▸ **umod**(b: *`BN`*): `BN` + +*Inherited from BN.umod* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:359* + +*__description__*: reduct + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## uor + +▸ **uor**(b: *`BN`*): `BN` + +*Inherited from BN.uor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:385* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ushln + +▸ **ushln**(b: *`number`*): `BN` + +*Inherited from BN.ushln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:455* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## ushrn + +▸ **ushrn**(b: *`number`*): `BN` + +*Inherited from BN.ushrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475* + +*__description__*: shift right + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## uxor + +▸ **uxor**(b: *`BN`*): `BN` + +*Inherited from BN.uxor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:430* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## xor + +▸ **xor**(b: *`BN`*): `BN` + +*Inherited from BN.xor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:420* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## zeroBits + +▸ **zeroBits**(): `number` + +*Inherited from BN.zeroBits* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:139* + +*__description__*: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits) + +**Returns:** `number` + ___ ## `` decodeUInt -▸ **decodeUInt**(value: *`AnyNumber`*, bitLength: *[UIntBitLength](../modules/_codec_uint_.md#uintbitlength)*): `BN` +▸ **decodeUInt**(value: *`AnyNumber`*, bitLength: *[UIntBitLength](../modules/_codec_uint_.md#uintbitlength)*): `string` *Inherited from [UInt](_codec_uint_.uint.md).[decodeUInt](_codec_uint_.uint.md#decodeuint)* -*Defined in [codec/UInt.ts:35](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L35)* +*Defined in [codec/UInt.ts:35](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L35)* **Parameters:** @@ -387,7 +1882,114 @@ ___ | value | `AnyNumber` | | bitLength | [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) | +**Returns:** `string` + +___ + + +## `` isBN + +▸ **isBN**(b: *`any`*): `boolean` + +*Inherited from BN.isBN* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:69* + +*__description__*: returns true if the supplied object is a BN.js instance + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `any` | + +**Returns:** `boolean` + +___ + + +## `` max + +▸ **max**(left: *`BN`*, right: *`BN`*): `BN` + +*Inherited from BN.max* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:74* + +*__description__*: returns the maximum of 2 BN instances. + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| left | `BN` | +| right | `BN` | + **Returns:** `BN` ___ + + +## `` min + +▸ **min**(left: *`BN`*, right: *`BN`*): `BN` + +*Inherited from BN.min* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:79* + +*__description__*: returns the minimum of 2 BN instances. + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| left | `BN` | +| right | `BN` | + +**Returns:** `BN` + +___ + + +## `` mont + +▸ **mont**(num: *`BN`*): `ReductionContext` + +*Inherited from BN.mont* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:64* + +*__description__*: create a reduction context with the Montgomery trick. + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| num | `BN` | + +**Returns:** `ReductionContext` + +___ + + +## `` red + +▸ **red**(reductionContext: * `BN` | `IPrimeName`*): `ReductionContext` + +*Inherited from BN.red* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:59* + +*__description__*: create a reduction context + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| reductionContext | `BN` | `IPrimeName`| + +**Returns:** `ReductionContext` + +___ diff --git a/docs/types/classes/_bool_.bool.md b/docs/types/classes/_bool_.bool.md index 0b2c3eae1b..5b626050e1 100644 --- a/docs/types/classes/_bool_.bool.md +++ b/docs/types/classes/_bool_.bool.md @@ -16,7 +16,7 @@ *Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* -*Defined in [Bool.ts:9](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Bool.ts#L9)* +*Defined in [Bool.ts:9](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Bool.ts#L9)* **Parameters:** @@ -38,7 +38,7 @@ ___ *Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Base.ts#L19)* ___ @@ -52,7 +52,7 @@ getencodedLength(): `number` *Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* -*Defined in [Bool.ts:26](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Bool.ts#L26)* +*Defined in [Bool.ts:26](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Bool.ts#L26)* **Returns:** `number` @@ -68,7 +68,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* -*Defined in [Bool.ts:30](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Bool.ts#L30)* +*Defined in [Bool.ts:30](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Bool.ts#L30)* **Returns:** `any` @@ -81,7 +81,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* -*Defined in [Bool.ts:38](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Bool.ts#L38)* +*Defined in [Bool.ts:38](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Bool.ts#L38)* **Returns:** `string` @@ -94,7 +94,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* -*Defined in [Bool.ts:34](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Bool.ts#L34)* +*Defined in [Bool.ts:34](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Bool.ts#L34)* **Parameters:** @@ -111,7 +111,7 @@ ___ ▸ **valueOf**(): `boolean` -*Defined in [Bool.ts:42](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Bool.ts#L42)* +*Defined in [Bool.ts:42](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Bool.ts#L42)* **Returns:** `boolean` @@ -122,7 +122,7 @@ ___ ▸ **decodeBool**(value: *`any`*): `boolean` -*Defined in [Bool.ts:16](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Bool.ts#L16)* +*Defined in [Bool.ts:16](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Bool.ts#L16)* **Parameters:** diff --git a/docs/types/classes/_bytes_.bytes.md b/docs/types/classes/_bytes_.bytes.md index a7efdab260..8fab15a17e 100644 --- a/docs/types/classes/_bytes_.bytes.md +++ b/docs/types/classes/_bytes_.bytes.md @@ -27,7 +27,7 @@ *Overrides [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)* -*Defined in [Bytes.ts:14](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Bytes.ts#L14)* +*Defined in [Bytes.ts:14](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Bytes.ts#L14)* **Parameters:** @@ -125,7 +125,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[raw](_codec_u8a_.u8a.md#raw)* -*Defined in [codec/U8a.ts:15](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L15)* +*Defined in [codec/U8a.ts:15](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L15)* ___ @@ -139,7 +139,7 @@ getencodedLength(): `number` *Overrides [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [Bytes.ts:43](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Bytes.ts#L43)* +*Defined in [Bytes.ts:43](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Bytes.ts#L43)* **Returns:** `number` @@ -679,7 +679,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:39](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L39)* +*Defined in [codec/U8a.ts:39](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L39)* **Parameters:** @@ -699,7 +699,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L43)* **Returns:** `string` @@ -712,7 +712,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:47](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L47)* +*Defined in [codec/U8a.ts:47](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L47)* **Returns:** `any` @@ -742,7 +742,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:55](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L55)* +*Defined in [codec/U8a.ts:55](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L55)* **Returns:** `string` @@ -755,7 +755,7 @@ ___ *Overrides [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [Bytes.ts:47](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Bytes.ts#L47)* +*Defined in [Bytes.ts:47](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Bytes.ts#L47)* **Parameters:** diff --git a/docs/types/classes/_codec_base_.base.md b/docs/types/classes/_codec_base_.base.md index 65282b4b7b..c61af9542f 100644 --- a/docs/types/classes/_codec_base_.base.md +++ b/docs/types/classes/_codec_base_.base.md @@ -6,8 +6,6 @@ **Base** -↳ [UInt](_codec_uint_.uint.md) - ↳ [Address](_address_.address.md) ↳ [Moment](_moment_.moment.md) @@ -40,7 +38,7 @@ ⊕ **new Base**(value?: *`any`*): [Base](_codec_base_.base.md) -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Base.ts#L19)* **Parameters:** @@ -60,7 +58,7 @@ ___ **● raw**: *`T`* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Base.ts#L19)* ___ @@ -72,7 +70,7 @@ ___ getencodedLength(): `number` -*Defined in [codec/Base.ts:25](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Base.ts#L25)* +*Defined in [codec/Base.ts:25](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Base.ts#L25)* **Returns:** `number` @@ -86,7 +84,7 @@ ___ ▸ **toJSON**(): `any` -*Defined in [codec/Base.ts:29](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Base.ts#L29)* +*Defined in [codec/Base.ts:29](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Base.ts#L29)* **Returns:** `any` @@ -97,7 +95,7 @@ ___ ▸ **toString**(): `string` -*Defined in [codec/Base.ts:33](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Base.ts#L33)* +*Defined in [codec/Base.ts:33](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Base.ts#L33)* **Returns:** `string` @@ -108,7 +106,7 @@ ___ ▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` -*Defined in [codec/Base.ts:37](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Base.ts#L37)* +*Defined in [codec/Base.ts:37](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Base.ts#L37)* **Parameters:** diff --git a/docs/types/classes/_codec_compact_.compact.md b/docs/types/classes/_codec_compact_.compact.md index cba91e5cc8..98153c50ba 100644 --- a/docs/types/classes/_codec_compact_.compact.md +++ b/docs/types/classes/_codec_compact_.compact.md @@ -16,7 +16,7 @@ *Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* -*Defined in [codec/Compact.ts:34](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Compact.ts#L34)* +*Defined in [codec/Compact.ts:34](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Compact.ts#L34)* **Parameters:** @@ -40,23 +40,12 @@ ___ *Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Base.ts#L19)* ___ # Accessors - - -## bitLength - -getbitLength(): [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) - -*Defined in [codec/Compact.ts:121](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Compact.ts#L121)* - -**Returns:** [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) - -___ ## encodedLength @@ -65,7 +54,7 @@ getencodedLength(): `number` *Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* -*Defined in [codec/Compact.ts:125](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Compact.ts#L125)* +*Defined in [codec/Compact.ts:125](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Compact.ts#L125)* **Returns:** `number` @@ -73,13 +62,24 @@ ___ # Methods + + +## bitLength + +▸ **bitLength**(): [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) + +*Defined in [codec/Compact.ts:121](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Compact.ts#L121)* + +**Returns:** [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) + +___ ## toBn ▸ **toBn**(): `any` -*Defined in [codec/Compact.ts:129](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Compact.ts#L129)* +*Defined in [codec/Compact.ts:129](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Compact.ts#L129)* **Returns:** `any` @@ -90,7 +90,7 @@ ___ ▸ **toHex**(): `any` -*Defined in [codec/Compact.ts:133](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Compact.ts#L133)* +*Defined in [codec/Compact.ts:133](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Compact.ts#L133)* **Returns:** `any` @@ -103,7 +103,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* -*Defined in [codec/Compact.ts:137](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Compact.ts#L137)* +*Defined in [codec/Compact.ts:137](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Compact.ts#L137)* **Returns:** `any` @@ -114,7 +114,7 @@ ___ ▸ **toNumber**(): `number` -*Defined in [codec/Compact.ts:141](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Compact.ts#L141)* +*Defined in [codec/Compact.ts:141](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Compact.ts#L141)* **Returns:** `number` @@ -127,7 +127,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* -*Defined in [codec/Compact.ts:145](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Compact.ts#L145)* +*Defined in [codec/Compact.ts:145](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Compact.ts#L145)* **Returns:** `string` @@ -140,7 +140,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* -*Defined in [codec/Compact.ts:149](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Compact.ts#L149)* +*Defined in [codec/Compact.ts:149](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Compact.ts#L149)* **Parameters:** @@ -157,7 +157,7 @@ ___ ▸ **addLengthPrefix**(u8a: *`Uint8Array`*, bitLength?: *[UIntBitLength](../modules/_codec_uint_.md#uintbitlength)*): `Uint8Array` -*Defined in [codec/Compact.ts:52](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Compact.ts#L52)* +*Defined in [codec/Compact.ts:52](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Compact.ts#L52)* Prepend a Uint8Array with its compact length. @@ -177,7 +177,7 @@ ___ ▸ **decodeCompact**(Type: *`Constructor`< [UInt](_codec_uint_.uint.md) | [Moment](_moment_.moment.md)>*, value: *`AnyNumber`*): [Moment](_moment_.moment.md) | [UInt](_codec_uint_.uint.md) -*Defined in [codec/Compact.ts:65](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Compact.ts#L65)* +*Defined in [codec/Compact.ts:65](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Compact.ts#L65)* **Parameters:** @@ -195,7 +195,7 @@ ___ ▸ **decodeU8a**(_input: * `Uint8Array` | `string`*, bitLength: *[UIntBitLength](../modules/_codec_uint_.md#uintbitlength)*): [`number`, `BN`] -*Defined in [codec/Compact.ts:83](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Compact.ts#L83)* +*Defined in [codec/Compact.ts:83](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Compact.ts#L83)* **Parameters:** @@ -213,7 +213,7 @@ ___ ▸ **encodeU8a**(_value: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*, bitLength: *[UIntBitLength](../modules/_codec_uint_.md#uintbitlength)*): `Uint8Array` -*Defined in [codec/Compact.ts:100](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Compact.ts#L100)* +*Defined in [codec/Compact.ts:100](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Compact.ts#L100)* **Parameters:** @@ -231,7 +231,7 @@ ___ ▸ **stripLengthPrefix**(u8a: *`Uint8Array`*, bitLength?: *[UIntBitLength](../modules/_codec_uint_.md#uintbitlength)*): `Uint8Array` -*Defined in [codec/Compact.ts:59](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Compact.ts#L59)* +*Defined in [codec/Compact.ts:59](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Compact.ts#L59)* **Parameters:** @@ -249,7 +249,7 @@ ___ ▸ **with**(Type: *`Constructor`< [UInt](_codec_uint_.uint.md) | [Moment](_moment_.moment.md)>*): `Constructor`<[Compact](_codec_compact_.compact.md)> -*Defined in [codec/Compact.ts:39](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Compact.ts#L39)* +*Defined in [codec/Compact.ts:39](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Compact.ts#L39)* **Parameters:** diff --git a/docs/types/classes/_codec_enum_.enum.md b/docs/types/classes/_codec_enum_.enum.md index a73ab105d6..b2b92665e9 100644 --- a/docs/types/classes/_codec_enum_.enum.md +++ b/docs/types/classes/_codec_enum_.enum.md @@ -22,7 +22,7 @@ *Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* -*Defined in [codec/Enum.ts:21](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Enum.ts#L21)* +*Defined in [codec/Enum.ts:21](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Enum.ts#L21)* **Parameters:** @@ -45,7 +45,7 @@ ___ *Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Base.ts#L19)* ___ @@ -59,7 +59,7 @@ getencodedLength(): `number` *Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* -*Defined in [codec/Enum.ts:41](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Enum.ts#L41)* +*Defined in [codec/Enum.ts:41](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Enum.ts#L41)* **Returns:** `number` @@ -75,7 +75,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* -*Defined in [codec/Enum.ts:45](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Enum.ts#L45)* +*Defined in [codec/Enum.ts:45](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Enum.ts#L45)* **Returns:** `any` @@ -86,7 +86,7 @@ ___ ▸ **toNumber**(): `number` -*Defined in [codec/Enum.ts:49](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Enum.ts#L49)* +*Defined in [codec/Enum.ts:49](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Enum.ts#L49)* **Returns:** `number` @@ -99,7 +99,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* -*Defined in [codec/Enum.ts:53](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Enum.ts#L53)* +*Defined in [codec/Enum.ts:53](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Enum.ts#L53)* **Returns:** `string` @@ -112,7 +112,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* -*Defined in [codec/Enum.ts:57](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Enum.ts#L57)* +*Defined in [codec/Enum.ts:57](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Enum.ts#L57)* **Parameters:** @@ -129,7 +129,7 @@ ___ ▸ **decodeEnum**(value?: * [Enum](_codec_enum_.enum.md) | `Uint8Array` | `number`*): `number` -*Defined in [codec/Enum.ts:31](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Enum.ts#L31)* +*Defined in [codec/Enum.ts:31](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Enum.ts#L31)* **Parameters:** diff --git a/docs/types/classes/_codec_enumtype_.enumtype.md b/docs/types/classes/_codec_enumtype_.enumtype.md index 596d2f7863..64c27a4419 100644 --- a/docs/types/classes/_codec_enumtype_.enumtype.md +++ b/docs/types/classes/_codec_enumtype_.enumtype.md @@ -26,7 +26,7 @@ *Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* -*Defined in [codec/EnumType.ts:26](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/EnumType.ts#L26)* +*Defined in [codec/EnumType.ts:26](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/EnumType.ts#L26)* **Parameters:** @@ -50,7 +50,7 @@ ___ *Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Base.ts#L19)* ___ @@ -64,7 +64,7 @@ getencodedLength(): `number` *Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* -*Defined in [codec/EnumType.ts:94](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/EnumType.ts#L94)* +*Defined in [codec/EnumType.ts:94](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/EnumType.ts#L94)* **Returns:** `number` @@ -75,7 +75,7 @@ ___ getisNull(): `boolean` -*Defined in [codec/EnumType.ts:82](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/EnumType.ts#L82)* +*Defined in [codec/EnumType.ts:82](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/EnumType.ts#L82)* **Returns:** `boolean` @@ -86,7 +86,7 @@ ___ gettype(): `string` -*Defined in [codec/EnumType.ts:86](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/EnumType.ts#L86)* +*Defined in [codec/EnumType.ts:86](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/EnumType.ts#L86)* **Returns:** `string` @@ -97,7 +97,7 @@ ___ getvalue(): [Base](_codec_base_.base.md)<`T`> -*Defined in [codec/EnumType.ts:90](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/EnumType.ts#L90)* +*Defined in [codec/EnumType.ts:90](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/EnumType.ts#L90)* **Returns:** [Base](_codec_base_.base.md)<`T`> @@ -111,7 +111,7 @@ ___ ▸ **setValue**(index?: * [EnumType](_codec_enumtype_.enumtype.md)<`T`> | `number`*, value?: *`any`*): `void` -*Defined in [codec/EnumType.ts:98](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/EnumType.ts#L98)* +*Defined in [codec/EnumType.ts:98](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/EnumType.ts#L98)* **Parameters:** @@ -131,7 +131,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* -*Defined in [codec/EnumType.ts:115](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/EnumType.ts#L115)* +*Defined in [codec/EnumType.ts:115](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/EnumType.ts#L115)* **Returns:** `any` @@ -142,7 +142,7 @@ ___ ▸ **toNumber**(): `number` -*Defined in [codec/EnumType.ts:119](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/EnumType.ts#L119)* +*Defined in [codec/EnumType.ts:119](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/EnumType.ts#L119)* **Returns:** `number` @@ -155,7 +155,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* -*Defined in [codec/EnumType.ts:123](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/EnumType.ts#L123)* +*Defined in [codec/EnumType.ts:123](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/EnumType.ts#L123)* **Returns:** `string` @@ -168,7 +168,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* -*Defined in [codec/EnumType.ts:127](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/EnumType.ts#L127)* +*Defined in [codec/EnumType.ts:127](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/EnumType.ts#L127)* **Parameters:** @@ -185,7 +185,7 @@ ___ ▸ **decodeEnumType**<`T`>(def: *`TypesDef`*, value?: *`any`*, index?: * `number` | [EnumType](_codec_enumtype_.enumtype.md)<`T`>*): `object` -*Defined in [codec/EnumType.ts:45](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/EnumType.ts#L45)* +*Defined in [codec/EnumType.ts:45](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/EnumType.ts#L45)* **Type parameters:** diff --git a/docs/types/classes/_codec_option_.option.md b/docs/types/classes/_codec_option_.option.md index 7b713edf05..4a6a4ec050 100644 --- a/docs/types/classes/_codec_option_.option.md +++ b/docs/types/classes/_codec_option_.option.md @@ -18,7 +18,7 @@ *Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* -*Defined in [codec/Option.ts:16](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Option.ts#L16)* +*Defined in [codec/Option.ts:16](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Option.ts#L16)* **Parameters:** @@ -41,7 +41,7 @@ ___ *Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Base.ts#L19)* ___ @@ -55,7 +55,7 @@ getencodedLength(): `number` *Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* -*Defined in [codec/Option.ts:60](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Option.ts#L60)* +*Defined in [codec/Option.ts:60](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Option.ts#L60)* **Returns:** `number` @@ -66,7 +66,7 @@ ___ getisEmpty(): `boolean` -*Defined in [codec/Option.ts:50](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Option.ts#L50)* +*Defined in [codec/Option.ts:50](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Option.ts#L50)* **Returns:** `boolean` @@ -77,7 +77,7 @@ ___ getvalue(): [Base](_codec_base_.base.md)<`T`> | `undefined` -*Defined in [codec/Option.ts:54](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Option.ts#L54)* +*Defined in [codec/Option.ts:54](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Option.ts#L54)* **Returns:** [Base](_codec_base_.base.md)<`T`> | `undefined` @@ -93,7 +93,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* -*Defined in [codec/Option.ts:68](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Option.ts#L68)* +*Defined in [codec/Option.ts:68](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Option.ts#L68)* **Returns:** `any` @@ -106,7 +106,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* -*Defined in [codec/Option.ts:89](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Option.ts#L89)* +*Defined in [codec/Option.ts:89](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Option.ts#L89)* **Returns:** `string` @@ -119,7 +119,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* -*Defined in [codec/Option.ts:74](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Option.ts#L74)* +*Defined in [codec/Option.ts:74](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Option.ts#L74)* **Parameters:** @@ -136,7 +136,7 @@ ___ ▸ **decodeOption**<`O`>(Type: *`Constructor`<[Base](_codec_base_.base.md)<`O`>>*, value?: *`any`*): [Base](_codec_base_.base.md) -*Defined in [codec/Option.ts:26](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Option.ts#L26)* +*Defined in [codec/Option.ts:26](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Option.ts#L26)* **Type parameters:** @@ -157,7 +157,7 @@ ___ ▸ **with**<`O`>(Type: *`Constructor`<[Base](_codec_base_.base.md)<`O`>>*): `Constructor`<[Option](_codec_option_.option.md)<`O`>> -*Defined in [codec/Option.ts:42](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Option.ts#L42)* +*Defined in [codec/Option.ts:42](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Option.ts#L42)* **Type parameters:** diff --git a/docs/types/classes/_codec_set_.set.md b/docs/types/classes/_codec_set_.set.md index 922309631d..c1b8021d2c 100644 --- a/docs/types/classes/_codec_set_.set.md +++ b/docs/types/classes/_codec_set_.set.md @@ -16,7 +16,7 @@ *Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* -*Defined in [codec/Set.ts:18](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Set.ts#L18)* +*Defined in [codec/Set.ts:18](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Set.ts#L18)* **Parameters:** @@ -39,7 +39,7 @@ ___ *Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Base.ts#L19)* ___ @@ -53,7 +53,7 @@ getencodedLength(): `number` *Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* -*Defined in [codec/Set.ts:65](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Set.ts#L65)* +*Defined in [codec/Set.ts:65](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Set.ts#L65)* **Returns:** `number` @@ -64,7 +64,7 @@ ___ getisEmpty(): `boolean` -*Defined in [codec/Set.ts:69](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Set.ts#L69)* +*Defined in [codec/Set.ts:69](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Set.ts#L69)* **Returns:** `boolean` @@ -75,7 +75,7 @@ ___ getvalueEncoded(): `number` -*Defined in [codec/Set.ts:77](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Set.ts#L77)* +*Defined in [codec/Set.ts:77](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Set.ts#L77)* **Returns:** `number` @@ -86,7 +86,7 @@ ___ getvalues(): `Array`<`string`> -*Defined in [codec/Set.ts:73](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Set.ts#L73)* +*Defined in [codec/Set.ts:73](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Set.ts#L73)* **Returns:** `Array`<`string`> @@ -102,7 +102,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* -*Defined in [codec/Set.ts:81](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Set.ts#L81)* +*Defined in [codec/Set.ts:81](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Set.ts#L81)* **Returns:** `any` @@ -115,7 +115,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* -*Defined in [codec/Set.ts:89](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Set.ts#L89)* +*Defined in [codec/Set.ts:89](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Set.ts#L89)* **Returns:** `string` @@ -128,7 +128,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* -*Defined in [codec/Set.ts:85](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Set.ts#L85)* +*Defined in [codec/Set.ts:85](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Set.ts#L85)* **Parameters:** @@ -145,7 +145,7 @@ ___ ▸ **decodeSet**(setValues: *`SetValues`*, value?: * `Array`<`string`> | `Uint8Array` | `number`*): `Array`<`string`> -*Defined in [codec/Set.ts:28](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Set.ts#L28)* +*Defined in [codec/Set.ts:28](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Set.ts#L28)* **Parameters:** @@ -163,7 +163,7 @@ ___ ▸ **encodeSet**(setValues: *`SetValues`*, value: *`Array`<`string`>*): `number` -*Defined in [codec/Set.ts:59](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Set.ts#L59)* +*Defined in [codec/Set.ts:59](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Set.ts#L59)* **Parameters:** diff --git a/docs/types/classes/_codec_struct_.struct.md b/docs/types/classes/_codec_struct_.struct.md index 61222d2e55..ac6edc7713 100644 --- a/docs/types/classes/_codec_struct_.struct.md +++ b/docs/types/classes/_codec_struct_.struct.md @@ -85,7 +85,7 @@ ⊕ **new Struct**(Types: *`S`*, value?: * `V` | `Array`<`any`>*, jsonMap?: *`Map`<`keyof S`, `string`>*): [Struct](_codec_struct_.struct.md) -*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L27)* +*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L27)* **Parameters:** @@ -118,7 +118,7 @@ ___ **● raw**: *`Map`<`keyof S`, [Base](_codec_base_.base.md)>* -*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L25)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L25)* ___ @@ -150,7 +150,7 @@ ___ getType(): `E` -*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L123)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -161,7 +161,7 @@ ___ getencodedLength(): `number` -*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L127)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -276,7 +276,7 @@ ___ ▸ **getAtIndex**(index: *`number`*): [Base](_codec_base_.base.md) -*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L133)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -347,7 +347,7 @@ ___ ▸ **toArray**(): `Array`<[Base](_codec_base_.base.md)> -*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L137)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -358,7 +358,7 @@ ___ ▸ **toHex**(): `string` -*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L141)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -369,7 +369,7 @@ ___ ▸ **toJSON**(): `any` -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L145)* **Returns:** `any` @@ -380,7 +380,7 @@ ___ ▸ **toString**(): `string` -*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L156)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -391,7 +391,7 @@ ___ ▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -423,7 +423,7 @@ ___ ▸ **with**<`S`>(Types: *`S`*): `Constructor`<[Struct](_codec_struct_.struct.md)<`S`>> -*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L113)* +*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/types/classes/_codec_tuple_.tuple.md b/docs/types/classes/_codec_tuple_.tuple.md index 6fa23e77cc..19fee38644 100644 --- a/docs/types/classes/_codec_tuple_.tuple.md +++ b/docs/types/classes/_codec_tuple_.tuple.md @@ -33,7 +33,7 @@ *Inherited from [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L27)* +*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L27)* **Parameters:** @@ -68,7 +68,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L25)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L25)* ___ @@ -93,7 +93,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L123)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -106,7 +106,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L127)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -223,7 +223,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L133)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -296,7 +296,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L137)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -309,7 +309,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L141)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -322,7 +322,7 @@ ___ *Overrides [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Tuple.ts:28](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Tuple.ts#L28)* +*Defined in [codec/Tuple.ts:28](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Tuple.ts#L28)* **Returns:** `any` @@ -335,7 +335,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L156)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -348,7 +348,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -382,7 +382,7 @@ ___ *Overrides [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Tuple.ts:18](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Tuple.ts#L18)* +*Defined in [codec/Tuple.ts:18](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Tuple.ts#L18)* **Type parameters:** diff --git a/docs/types/classes/_codec_u8a_.u8a.md b/docs/types/classes/_codec_u8a_.u8a.md index ebb0949872..e467b6efb6 100644 --- a/docs/types/classes/_codec_u8a_.u8a.md +++ b/docs/types/classes/_codec_u8a_.u8a.md @@ -29,7 +29,7 @@ ⊕ **new U8a**(value: *`AnyU8a`*): [U8a](_codec_u8a_.u8a.md) -*Defined in [codec/U8a.ts:15](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L15)* +*Defined in [codec/U8a.ts:15](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L15)* **Parameters:** @@ -125,7 +125,7 @@ ___ **● raw**: *`Uint8Array`* -*Defined in [codec/U8a.ts:15](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L15)* +*Defined in [codec/U8a.ts:15](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L15)* ___ @@ -146,7 +146,7 @@ ___ getencodedLength(): `number` -*Defined in [codec/U8a.ts:33](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L33)* +*Defined in [codec/U8a.ts:33](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L33)* **Returns:** `number` @@ -684,7 +684,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:39](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L39)* +*Defined in [codec/U8a.ts:39](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L39)* **Parameters:** @@ -702,7 +702,7 @@ ___ ▸ **toHex**(): `string` -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L43)* **Returns:** `string` @@ -713,7 +713,7 @@ ___ ▸ **toJSON**(): `any` -*Defined in [codec/U8a.ts:47](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L47)* +*Defined in [codec/U8a.ts:47](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L47)* **Returns:** `any` @@ -741,7 +741,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:55](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L55)* +*Defined in [codec/U8a.ts:55](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L55)* **Returns:** `string` @@ -752,7 +752,7 @@ ___ ▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` -*Defined in [codec/U8a.ts:51](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L51)* +*Defined in [codec/U8a.ts:51](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L51)* **Parameters:** diff --git a/docs/types/classes/_codec_u8afixed_.u8afixed.md b/docs/types/classes/_codec_u8afixed_.u8afixed.md index b2106f3a9f..fbaf26deaf 100644 --- a/docs/types/classes/_codec_u8afixed_.u8afixed.md +++ b/docs/types/classes/_codec_u8afixed_.u8afixed.md @@ -29,7 +29,7 @@ *Overrides [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)* -*Defined in [codec/U8aFixed.ts:15](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8aFixed.ts#L15)* +*Defined in [codec/U8aFixed.ts:15](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8aFixed.ts#L15)* **Parameters:** @@ -128,23 +128,12 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[raw](_codec_u8a_.u8a.md#raw)* -*Defined in [codec/U8a.ts:15](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L15)* +*Defined in [codec/U8a.ts:15](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L15)* ___ # Accessors - - -## bitLength - -getbitLength(): `number` - -*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8aFixed.ts#L32)* - -**Returns:** `number` - -___ ## encodedLength @@ -153,7 +142,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:33](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L33)* +*Defined in [codec/U8a.ts:33](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L33)* **Returns:** `number` @@ -173,6 +162,17 @@ ___ **Returns:** `IterableIterator`<`number`> +___ + + +## bitLength + +▸ **bitLength**(): `number` + +*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8aFixed.ts#L32)* + +**Returns:** `number` + ___ @@ -693,7 +693,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:39](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L39)* +*Defined in [codec/U8a.ts:39](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L39)* **Parameters:** @@ -713,7 +713,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L43)* **Returns:** `string` @@ -726,7 +726,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:47](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L47)* +*Defined in [codec/U8a.ts:47](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L47)* **Returns:** `any` @@ -756,7 +756,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:55](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L55)* +*Defined in [codec/U8a.ts:55](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L55)* **Returns:** `string` @@ -769,7 +769,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:51](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L51)* +*Defined in [codec/U8a.ts:51](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L51)* **Parameters:** diff --git a/docs/types/classes/_codec_uint_.uint.md b/docs/types/classes/_codec_uint_.uint.md index 5f6c743be9..adfde35e2b 100644 --- a/docs/types/classes/_codec_uint_.uint.md +++ b/docs/types/classes/_codec_uint_.uint.md @@ -2,7 +2,7 @@ # Hierarchy - [Base](_codec_base_.base.md)<`BN`> + `BN` **↳ UInt** @@ -18,6 +18,10 @@ ↳ [U256](_u256_.u256.md) +# Implements + +* `Codec` + # Constructors @@ -26,9 +30,9 @@ ⊕ **new UInt**(value?: *`AnyNumber`*, bitLength?: *[UIntBitLength](../modules/_codec_uint_.md#uintbitlength)*, isHexJson?: *`boolean`*): [UInt](_codec_uint_.uint.md) -*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* +*Overrides BN.__constructor* -*Defined in [codec/UInt.ts:24](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L24)* +*Defined in [codec/UInt.ts:23](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L23)* **Parameters:** @@ -50,34 +54,19 @@ ___ **● raw**: *`BN`* -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/UInt.ts:23](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L23)* ___ # Accessors - - -## bitLength - -getbitLength(): [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) - -*Defined in [codec/UInt.ts:50](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L50)* - -**Returns:** [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) - -___ ## encodedLength getencodedLength(): `number` -*Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* - -*Defined in [codec/UInt.ts:54](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L54)* +*Defined in [codec/UInt.ts:55](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L55)* **Returns:** `number` @@ -85,19 +74,165 @@ ___ # Methods + + +## abs + +▸ **abs**(): `BN` + +*Inherited from BN.abs* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:254* + +*__description__*: absolute value + +**Returns:** `BN` + +___ ## add -▸ **add**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **add**(b: *`BN`*): `BN` -*Defined in [codec/UInt.ts:86](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L86)* +*Inherited from BN.add* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:264* + +*__description__*: addition **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | + +**Returns:** `BN` + +___ + + +## addn + +▸ **addn**(b: *`number`*): `BN` + +*Inherited from BN.addn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:274* + +*__description__*: addition + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## and + +▸ **and**(b: *`BN`*): `BN` + +*Inherited from BN.and* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:395* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## andln + +▸ **andln**(b: *`number`*): `BN` + +*Inherited from BN.andln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:415* + +*__description__*: and (NOTE: `andln` is going to be replaced with `andn` in future) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## bincn + +▸ **bincn**(b: *`number`*): `BN` + +*Inherited from BN.bincn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:499* + +*__description__*: add `1 << b` to the number + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## bitLength + +▸ **bitLength**(): [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) + +*Overrides BN.bitLength* + +*Defined in [codec/UInt.ts:51](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L51)* + +**Returns:** [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) + +___ + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from BN.byteLength* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:144* + +*__description__*: return number of bytes occupied + +**Returns:** `number` + +___ + + +## clone + +▸ **clone**(): `BN` + +*Inherited from BN.clone* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:89* + +*__description__*: clone number **Returns:** `BN` @@ -106,66 +241,229 @@ ___ ## cmp -▸ **cmp**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `number` +▸ **cmp**(b: *`BN`*): `-1` | `0` | `1` -*Defined in [codec/UInt.ts:92](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L92)* +*Inherited from BN.cmp* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:169* + +*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | -**Returns:** `number` +**Returns:** `-1` | `0` | `1` + +___ + + +## cmpn + +▸ **cmpn**(b: *`number`*): `-1` | `0` | `1` + +*Inherited from BN.cmpn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:179* + +*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `-1` | `0` | `1` ___ ## div -▸ **div**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **div**(b: *`BN`*): `BN` -*Defined in [codec/UInt.ts:98](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L98)* +*Inherited from BN.div* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:339* + +*__description__*: divide **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `BN` +___ + + +## divRound + +▸ **divRound**(b: *`BN`*): `BN` + +*Inherited from BN.divRound* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:370* + +*__description__*: rounded division + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## divn + +▸ **divn**(b: *`number`*): `BN` + +*Inherited from BN.divn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:344* + +*__description__*: divide + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## egcd + +▸ **egcd**(b: *`BN`*): `object` + +*Inherited from BN.egcd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:519* + +*__description__*: Extended GCD results `({ a: ..., b: ..., gcd: ... })` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `object` + ___ ## eq -▸ **eq**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **eq**(b: *`BN`*): `boolean` -*Defined in [codec/UInt.ts:104](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L104)* +*Inherited from BN.eq* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:224* + +*__description__*: a equals b **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` +___ + + +## eqn + +▸ **eqn**(b: *`number`*): `boolean` + +*Inherited from BN.eqn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:229* + +*__description__*: a equals b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## fromTwos + +▸ **fromTwos**(width: *`number`*): `BN` + +*Inherited from BN.fromTwos* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:239* + +*__description__*: convert from two's complement representation, where width is the bit width + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| width | `number` | + +**Returns:** `BN` + +___ + + +## gcd + +▸ **gcd**(b: *`BN`*): `BN` + +*Inherited from BN.gcd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:514* + +*__description__*: GCD + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + ___ ## gt -▸ **gt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **gt**(b: *`BN`*): `boolean` -*Defined in [codec/UInt.ts:126](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L126)* +*Inherited from BN.gt* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:204* + +*__description__*: a greater than b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` @@ -174,15 +472,346 @@ ___ ## gte -▸ **gte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **gte**(b: *`BN`*): `boolean` -*Defined in [codec/UInt.ts:132](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L132)* +*Inherited from BN.gte* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:214* + +*__description__*: a greater than or equals b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | + +**Returns:** `boolean` + +___ + + +## gten + +▸ **gten**(b: *`number`*): `boolean` + +*Inherited from BN.gten* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:219* + +*__description__*: a greater than or equals b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## gtn + +▸ **gtn**(b: *`number`*): `boolean` + +*Inherited from BN.gtn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:209* + +*__description__*: a greater than b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## iabs + +▸ **iabs**(): `BN` + +*Inherited from BN.iabs* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:259* + +*__description__*: absolute value + +**Returns:** `BN` + +___ + + +## iadd + +▸ **iadd**(b: *`BN`*): `BN` + +*Inherited from BN.iadd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:269* + +*__description__*: addition + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## iaddn + +▸ **iaddn**(b: *`number`*): `BN` + +*Inherited from BN.iaddn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:279* + +*__description__*: addition + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iand + +▸ **iand**(b: *`BN`*): `BN` + +*Inherited from BN.iand* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:400* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## idivn + +▸ **idivn**(b: *`number`*): `BN` + +*Inherited from BN.idivn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:349* + +*__description__*: divide + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## imaskn + +▸ **imaskn**(b: *`number`*): `BN` + +*Inherited from BN.imaskn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495* + +*__description__*: clear bits with indexes higher or equal to `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## imul + +▸ **imul**(b: *`BN`*): `BN` + +*Inherited from BN.imul* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:309* + +*__description__*: multiply + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## imuln + +▸ **imuln**(b: *`number`*): `BN` + +*Inherited from BN.imuln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:319* + +*__description__*: multiply + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## ineg + +▸ **ineg**(): `BN` + +*Inherited from BN.ineg* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:249* + +*__description__*: negate sign + +**Returns:** `BN` + +___ + + +## inotn + +▸ **inotn**(w: *`number`*): `BN` + +*Inherited from BN.inotn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:509* + +*__description__*: not (for the width specified by `w`) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| w | `number` | + +**Returns:** `BN` + +___ + + +## invm + +▸ **invm**(b: *`BN`*): `BN` + +*Inherited from BN.invm* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:524* + +*__description__*: inverse `a` modulo `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ior + +▸ **ior**(b: *`BN`*): `BN` + +*Inherited from BN.ior* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:380* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## isEven + +▸ **isEven**(): `boolean` + +*Inherited from BN.isEven* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:154* + +*__description__*: check if value is even + +**Returns:** `boolean` + +___ + + +## isNeg + +▸ **isNeg**(): `boolean` + +*Inherited from BN.isNeg* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:149* + +*__description__*: true if the number is negative + +**Returns:** `boolean` + +___ + + +## isOdd + +▸ **isOdd**(): `boolean` + +*Inherited from BN.isOdd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:159* + +*__description__*: check if value is odd **Returns:** `boolean` @@ -193,24 +822,257 @@ ___ ▸ **isZero**(): `boolean` -*Defined in [codec/UInt.ts:110](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L110)* +*Inherited from BN.isZero* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:164* + +*__description__*: check if value is zero **Returns:** `boolean` +___ + + +## ishln + +▸ **ishln**(b: *`number`*): `BN` + +*Inherited from BN.ishln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:450* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## ishrn + +▸ **ishrn**(b: *`number`*): `BN` + +*Inherited from BN.ishrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:470* + +*__description__*: shift right (unimplemented [https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086](https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## isqr + +▸ **isqr**(): `BN` + +*Inherited from BN.isqr* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:329* + +*__description__*: square + +**Returns:** `BN` + +___ + + +## isub + +▸ **isub**(b: *`BN`*): `BN` + +*Inherited from BN.isub* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:289* + +*__description__*: subtraction + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## isubn + +▸ **isubn**(b: *`number`*): `BN` + +*Inherited from BN.isubn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:299* + +*__description__*: subtraction + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iuand + +▸ **iuand**(b: *`BN`*): `BN` + +*Inherited from BN.iuand* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:410* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## iuor + +▸ **iuor**(b: *`BN`*): `BN` + +*Inherited from BN.iuor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:390* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## iushln + +▸ **iushln**(b: *`number`*): `BN` + +*Inherited from BN.iushln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:460* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iushrn + +▸ **iushrn**(b: *`number`*): `BN` + +*Inherited from BN.iushrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480* + +*__description__*: shift right + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iuxor + +▸ **iuxor**(b: *`BN`*): `BN` + +*Inherited from BN.iuxor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:435* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ixor + +▸ **ixor**(b: *`BN`*): `BN` + +*Inherited from BN.ixor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:425* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + ___ ## lt -▸ **lt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **lt**(b: *`BN`*): `boolean` -*Defined in [codec/UInt.ts:114](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L114)* +*Inherited from BN.lt* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:184* + +*__description__*: a less than b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` @@ -219,32 +1081,324 @@ ___ ## lte -▸ **lte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **lte**(b: *`BN`*): `boolean` -*Defined in [codec/UInt.ts:120](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L120)* +*Inherited from BN.lte* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:194* + +*__description__*: a less than or equals b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` +___ + + +## lten + +▸ **lten**(b: *`number`*): `boolean` + +*Inherited from BN.lten* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:199* + +*__description__*: a less than or equals b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## ltn + +▸ **ltn**(b: *`number`*): `boolean` + +*Inherited from BN.ltn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:189* + +*__description__*: a less than b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## maskn + +▸ **maskn**(b: *`number`*): `BN` + +*Inherited from BN.maskn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490* + +*__description__*: clear bits with indexes higher or equal to `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## mod + +▸ **mod**(b: *`BN`*): `BN` + +*Inherited from BN.mod* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:354* + +*__description__*: reduct + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## modn + +▸ **modn**(b: *`number`*): `number` + +*Inherited from BN.modn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:365* + +*__see__*: API consistency [https://github.com/indutny/bn.js/pull/130](https://github.com/indutny/bn.js/pull/130) + +*__description__*: reduct + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `number` + ___ ## mul -▸ **mul**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **mul**(b: *`BN`*): `BN` -*Defined in [codec/UInt.ts:138](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L138)* +*Inherited from BN.mul* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:304* + +*__description__*: multiply **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | + +**Returns:** `BN` + +___ + + +## muln + +▸ **muln**(b: *`number`*): `BN` + +*Inherited from BN.muln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:314* + +*__description__*: multiply + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## neg + +▸ **neg**(): `BN` + +*Inherited from BN.neg* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:244* + +*__description__*: negate sign + +**Returns:** `BN` + +___ + + +## notn + +▸ **notn**(w: *`number`*): `BN` + +*Inherited from BN.notn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:504* + +*__description__*: not (for the width specified by `w`) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| w | `number` | + +**Returns:** `BN` + +___ + + +## or + +▸ **or**(b: *`BN`*): `BN` + +*Inherited from BN.or* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:375* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## pow + +▸ **pow**(b: *`BN`*): `BN` + +*Inherited from BN.pow* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:334* + +*__description__*: raise `a` to the power of `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## setn + +▸ **setn**(b: *`number`*): `BN` + +*Inherited from BN.setn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:440* + +*__description__*: set specified bit to 1 + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## shln + +▸ **shln**(b: *`number`*): `BN` + +*Inherited from BN.shln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:445* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## shrn + +▸ **shrn**(b: *`number`*): `BN` + +*Inherited from BN.shrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:465* + +*__description__*: shift right + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## sqr + +▸ **sqr**(): `BN` + +*Inherited from BN.sqr* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:324* + +*__description__*: square **Returns:** `BN` @@ -253,18 +1407,125 @@ ___ ## sub -▸ **sub**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **sub**(b: *`BN`*): `BN` -*Defined in [codec/UInt.ts:144](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L144)* +*Inherited from BN.sub* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:284* + +*__description__*: subtraction **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `BN` +___ + + +## subn + +▸ **subn**(b: *`number`*): `BN` + +*Inherited from BN.subn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:294* + +*__description__*: subtraction + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## testn + +▸ **testn**(b: *`number`*): `boolean` + +*Inherited from BN.testn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485* + +*__description__*: test if specified bit is set + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## toArray + +▸ **toArray**(endian?: *`Endianness`*, length?: * `undefined` | `number`*): `number`[] + +*Inherited from BN.toArray* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:109* + +*__description__*: convert to byte Array, and optionally zero pad to length, throwing if already exceeding + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `number`[] + +___ + + +## toArrayLike + +▸ **toArrayLike**(ArrayType: *`object`*, endian?: *`Endianness`*, length?: * `undefined` | `number`*): `Buffer` + +▸ **toArrayLike**(ArrayType: *`any`[]*, endian?: *`Endianness`*, length?: * `undefined` | `number`*): `any`[] + +*Inherited from BN.toArrayLike* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:114* + +*__description__*: convert to an instance of `type`, which must behave like an Array + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| ArrayType | `object` | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `Buffer` + +*Inherited from BN.toArrayLike* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| ArrayType | `any`[] | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `any`[] + ___ @@ -272,10 +1533,32 @@ ___ ▸ **toBn**(): `BN` -*Defined in [codec/UInt.ts:76](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L76)* +*Defined in [codec/UInt.ts:73](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L73)* **Returns:** `BN` +___ + + +## toBuffer + +▸ **toBuffer**(endian?: *`Endianness`*, length?: * `undefined` | `number`*): `Buffer` + +*Inherited from BN.toBuffer* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:129* + +*__description__*: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `Buffer` + ___ @@ -283,7 +1566,7 @@ ___ ▸ **toHex**(): `string` -*Defined in [codec/UInt.ts:58](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L58)* +*Defined in [codec/UInt.ts:59](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L59)* **Returns:** `string` @@ -294,9 +1577,9 @@ ___ ▸ **toJSON**(): `any` -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* +*Overrides BN.toJSON* -*Defined in [codec/UInt.ts:62](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L62)* +*Defined in [codec/UInt.ts:63](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L63)* **Returns:** `any` @@ -307,23 +1590,78 @@ ___ ▸ **toNumber**(): `number` -*Defined in [codec/UInt.ts:80](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L80)* +*Inherited from BN.toNumber* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:99* + +*__description__*: convert to Javascript Number (limited to 53 bits) **Returns:** `number` +___ + + +## toRed + +▸ **toRed**(reductionContext: *`ReductionContext`*): `RedBN` + +*Inherited from BN.toRed* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:84* + +*__description__*: Convert number to red + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| reductionContext | `ReductionContext` | + +**Returns:** `RedBN` + ___ ## toString -▸ **toString**(): `string` +▸ **toString**(base?: * `number` | "hex"*, length?: * `undefined` | `number`*): `string` -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* +*Inherited from BN.toString* -*Defined in [codec/UInt.ts:72](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L72)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:94* + +*__description__*: convert to base-string and pad with zeroes + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` base | `number` | "hex"| +| `Optional` length | `undefined` | `number`| **Returns:** `string` +___ + + +## toTwos + +▸ **toTwos**(width: *`number`*): `BN` + +*Inherited from BN.toTwos* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:234* + +*__description__*: convert to two's complement representation, where width is bit width + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| width | `number` | + +**Returns:** `BN` + ___ @@ -331,9 +1669,7 @@ ___ ▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/UInt.ts:68](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L68)* +*Defined in [codec/UInt.ts:69](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L69)* **Parameters:** @@ -343,14 +1679,197 @@ ___ **Returns:** `Uint8Array` +___ + + +## uand + +▸ **uand**(b: *`BN`*): `BN` + +*Inherited from BN.uand* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:405* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ucmp + +▸ **ucmp**(b: *`BN`*): `-1` | `0` | `1` + +*Inherited from BN.ucmp* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:174* + +*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `-1` | `0` | `1` + +___ + + +## umod + +▸ **umod**(b: *`BN`*): `BN` + +*Inherited from BN.umod* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:359* + +*__description__*: reduct + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## uor + +▸ **uor**(b: *`BN`*): `BN` + +*Inherited from BN.uor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:385* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ushln + +▸ **ushln**(b: *`number`*): `BN` + +*Inherited from BN.ushln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:455* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## ushrn + +▸ **ushrn**(b: *`number`*): `BN` + +*Inherited from BN.ushrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475* + +*__description__*: shift right + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## uxor + +▸ **uxor**(b: *`BN`*): `BN` + +*Inherited from BN.uxor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:430* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## xor + +▸ **xor**(b: *`BN`*): `BN` + +*Inherited from BN.xor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:420* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## zeroBits + +▸ **zeroBits**(): `number` + +*Inherited from BN.zeroBits* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:139* + +*__description__*: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits) + +**Returns:** `number` + ___ ## `` decodeUInt -▸ **decodeUInt**(value: *`AnyNumber`*, bitLength: *[UIntBitLength](../modules/_codec_uint_.md#uintbitlength)*): `BN` +▸ **decodeUInt**(value: *`AnyNumber`*, bitLength: *[UIntBitLength](../modules/_codec_uint_.md#uintbitlength)*): `string` -*Defined in [codec/UInt.ts:35](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L35)* +*Defined in [codec/UInt.ts:35](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L35)* **Parameters:** @@ -359,7 +1878,114 @@ ___ | value | `AnyNumber` | | bitLength | [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) | +**Returns:** `string` + +___ + + +## `` isBN + +▸ **isBN**(b: *`any`*): `boolean` + +*Inherited from BN.isBN* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:69* + +*__description__*: returns true if the supplied object is a BN.js instance + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `any` | + +**Returns:** `boolean` + +___ + + +## `` max + +▸ **max**(left: *`BN`*, right: *`BN`*): `BN` + +*Inherited from BN.max* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:74* + +*__description__*: returns the maximum of 2 BN instances. + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| left | `BN` | +| right | `BN` | + **Returns:** `BN` ___ + + +## `` min + +▸ **min**(left: *`BN`*, right: *`BN`*): `BN` + +*Inherited from BN.min* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:79* + +*__description__*: returns the minimum of 2 BN instances. + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| left | `BN` | +| right | `BN` | + +**Returns:** `BN` + +___ + + +## `` mont + +▸ **mont**(num: *`BN`*): `ReductionContext` + +*Inherited from BN.mont* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:64* + +*__description__*: create a reduction context with the Montgomery trick. + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| num | `BN` | + +**Returns:** `ReductionContext` + +___ + + +## `` red + +▸ **red**(reductionContext: * `BN` | `IPrimeName`*): `ReductionContext` + +*Inherited from BN.red* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:59* + +*__description__*: create a reduction context + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| reductionContext | `BN` | `IPrimeName`| + +**Returns:** `ReductionContext` + +___ diff --git a/docs/types/classes/_codec_vector_.vector.md b/docs/types/classes/_codec_vector_.vector.md index 1a3317ec2f..43f8490f7c 100644 --- a/docs/types/classes/_codec_vector_.vector.md +++ b/docs/types/classes/_codec_vector_.vector.md @@ -22,7 +22,7 @@ *Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* -*Defined in [codec/Vector.ts:19](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Vector.ts#L19)* +*Defined in [codec/Vector.ts:19](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Vector.ts#L19)* **Parameters:** @@ -45,7 +45,7 @@ ___ *Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Base.ts#L19)* ___ @@ -57,7 +57,7 @@ ___ getType(): `string` -*Defined in [codec/Vector.ts:65](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Vector.ts#L65)* +*Defined in [codec/Vector.ts:65](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Vector.ts#L65)* **Returns:** `string` @@ -70,7 +70,7 @@ getencodedLength(): `number` *Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* -*Defined in [codec/Vector.ts:73](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Vector.ts#L73)* +*Defined in [codec/Vector.ts:73](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Vector.ts#L73)* **Returns:** `number` @@ -81,7 +81,7 @@ ___ getlength(): `number` -*Defined in [codec/Vector.ts:69](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Vector.ts#L69)* +*Defined in [codec/Vector.ts:69](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Vector.ts#L69)* **Returns:** `number` @@ -95,7 +95,7 @@ ___ ▸ **filter**(fn: *`function`*): `Array`<`T`> -*Defined in [codec/Vector.ts:79](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Vector.ts#L79)* +*Defined in [codec/Vector.ts:79](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Vector.ts#L79)* **Parameters:** @@ -112,7 +112,7 @@ ___ ▸ **find**(fn: *`function`*): `T` | `undefined` -*Defined in [codec/Vector.ts:83](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Vector.ts#L83)* +*Defined in [codec/Vector.ts:83](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Vector.ts#L83)* **Parameters:** @@ -129,7 +129,7 @@ ___ ▸ **forEach**(fn: *`function`*): `any` -*Defined in [codec/Vector.ts:87](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Vector.ts#L87)* +*Defined in [codec/Vector.ts:87](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Vector.ts#L87)* **Parameters:** @@ -146,7 +146,7 @@ ___ ▸ **get**(index: *`number`*): `T` -*Defined in [codec/Vector.ts:91](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Vector.ts#L91)* +*Defined in [codec/Vector.ts:91](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Vector.ts#L91)* **Parameters:** @@ -163,7 +163,7 @@ ___ ▸ **map**<`O`>(fn: *`function`*): `Array`<`O`> -*Defined in [codec/Vector.ts:95](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Vector.ts#L95)* +*Defined in [codec/Vector.ts:95](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Vector.ts#L95)* **Type parameters:** @@ -183,7 +183,7 @@ ___ ▸ **push**(item: *`T`*): `void` -*Defined in [codec/Vector.ts:99](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Vector.ts#L99)* +*Defined in [codec/Vector.ts:99](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Vector.ts#L99)* **Parameters:** @@ -200,7 +200,7 @@ ___ ▸ **reduce**<`O`>(fn: *`function`*, initial: *`O`*): `O` -*Defined in [codec/Vector.ts:103](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Vector.ts#L103)* +*Defined in [codec/Vector.ts:103](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Vector.ts#L103)* **Type parameters:** @@ -223,7 +223,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* -*Defined in [codec/Vector.ts:107](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Vector.ts#L107)* +*Defined in [codec/Vector.ts:107](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Vector.ts#L107)* **Returns:** `any` @@ -236,7 +236,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* -*Defined in [codec/Vector.ts:126](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Vector.ts#L126)* +*Defined in [codec/Vector.ts:126](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Vector.ts#L126)* **Returns:** `string` @@ -249,7 +249,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* -*Defined in [codec/Vector.ts:113](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Vector.ts#L113)* +*Defined in [codec/Vector.ts:113](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Vector.ts#L113)* **Parameters:** @@ -266,7 +266,7 @@ ___ ▸ **decodeVector**<`T`>(Type: *`Constructor`<`T`>*, value: * [Vector](_codec_vector_.vector.md)<`any`> | `Uint8Array` | `string` | `Array`<`any`>*): `Array`<`T`> -*Defined in [codec/Vector.ts:29](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Vector.ts#L29)* +*Defined in [codec/Vector.ts:29](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Vector.ts#L29)* **Type parameters:** @@ -287,7 +287,7 @@ ___ ▸ **with**<`O`>(Type: *`Constructor`<`O`>*): `Constructor`<[Vector](_codec_vector_.vector.md)<`O`>> -*Defined in [codec/Vector.ts:57](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Vector.ts#L57)* +*Defined in [codec/Vector.ts:57](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Vector.ts#L57)* **Type parameters:** diff --git a/docs/types/classes/_data_.data.md b/docs/types/classes/_data_.data.md index 32cb6832b1..1d842b193d 100644 --- a/docs/types/classes/_data_.data.md +++ b/docs/types/classes/_data_.data.md @@ -23,7 +23,7 @@ *Inherited from [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)* -*Defined in [codec/U8a.ts:15](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L15)* +*Defined in [codec/U8a.ts:15](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L15)* **Parameters:** @@ -121,7 +121,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[raw](_codec_u8a_.u8a.md#raw)* -*Defined in [codec/U8a.ts:15](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L15)* +*Defined in [codec/U8a.ts:15](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L15)* ___ @@ -135,7 +135,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:33](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L33)* +*Defined in [codec/U8a.ts:33](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L33)* **Returns:** `number` @@ -675,7 +675,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:39](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L39)* +*Defined in [codec/U8a.ts:39](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L39)* **Parameters:** @@ -695,7 +695,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L43)* **Returns:** `string` @@ -708,7 +708,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:47](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L47)* +*Defined in [codec/U8a.ts:47](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L47)* **Returns:** `any` @@ -738,7 +738,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:55](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L55)* +*Defined in [codec/U8a.ts:55](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L55)* **Returns:** `string` @@ -751,7 +751,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:51](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L51)* +*Defined in [codec/U8a.ts:51](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L51)* **Parameters:** diff --git a/docs/types/classes/_digest_.digest.md b/docs/types/classes/_digest_.digest.md index dc325ea52f..eedb81eb89 100644 --- a/docs/types/classes/_digest_.digest.md +++ b/docs/types/classes/_digest_.digest.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Digest.ts:53](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Digest.ts#L53)* +*Defined in [Digest.ts:53](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Digest.ts#L53)* **Parameters:** @@ -58,7 +58,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L25)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L25)* ___ @@ -83,7 +83,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L123)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -96,7 +96,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L127)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -107,7 +107,7 @@ ___ getlogs(): [Vector](_codec_vector_.vector.md)<[DigestItem](_digest_.digestitem.md)> -*Defined in [Digest.ts:60](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Digest.ts#L60)* +*Defined in [Digest.ts:60](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Digest.ts#L60)* **Returns:** [Vector](_codec_vector_.vector.md)<[DigestItem](_digest_.digestitem.md)> @@ -224,7 +224,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L133)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -297,7 +297,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L137)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -310,7 +310,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L141)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -323,7 +323,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L145)* **Returns:** `any` @@ -336,7 +336,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L156)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -349,7 +349,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -383,7 +383,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L113)* +*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/types/classes/_digest_.digestitem.md b/docs/types/classes/_digest_.digestitem.md index ad9661bae3..845541b4a8 100644 --- a/docs/types/classes/_digest_.digestitem.md +++ b/docs/types/classes/_digest_.digestitem.md @@ -16,7 +16,7 @@ *Overrides [EnumType](_codec_enumtype_.enumtype.md).[constructor](_codec_enumtype_.enumtype.md#constructor)* -*Defined in [Digest.ts:42](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Digest.ts#L42)* +*Defined in [Digest.ts:42](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Digest.ts#L42)* **Parameters:** @@ -38,7 +38,7 @@ ___ *Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Base.ts#L19)* ___ @@ -54,7 +54,7 @@ getencodedLength(): `number` *Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* -*Defined in [codec/EnumType.ts:94](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/EnumType.ts#L94)* +*Defined in [codec/EnumType.ts:94](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/EnumType.ts#L94)* **Returns:** `number` @@ -67,7 +67,7 @@ getisNull(): `boolean` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNull](_codec_enumtype_.enumtype.md#isnull)* -*Defined in [codec/EnumType.ts:82](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/EnumType.ts#L82)* +*Defined in [codec/EnumType.ts:82](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/EnumType.ts#L82)* **Returns:** `boolean` @@ -80,7 +80,7 @@ gettype(): `string` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[type](_codec_enumtype_.enumtype.md#type)* -*Defined in [codec/EnumType.ts:86](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/EnumType.ts#L86)* +*Defined in [codec/EnumType.ts:86](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/EnumType.ts#L86)* **Returns:** `string` @@ -93,7 +93,7 @@ getvalue(): [Base](_codec_base_.base.md)< `AuthoritiesChange` | `ChangesTri *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[value](_codec_enumtype_.enumtype.md#value)* -*Defined in [codec/EnumType.ts:90](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/EnumType.ts#L90)* +*Defined in [codec/EnumType.ts:90](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/EnumType.ts#L90)* **Returns:** [Base](_codec_base_.base.md)< `AuthoritiesChange` | `ChangesTrieRoot` | `Other` | `Seal`> @@ -109,7 +109,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[setValue](_codec_enumtype_.enumtype.md#setvalue)* -*Defined in [codec/EnumType.ts:98](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/EnumType.ts#L98)* +*Defined in [codec/EnumType.ts:98](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/EnumType.ts#L98)* **Parameters:** @@ -131,7 +131,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* -*Defined in [codec/EnumType.ts:115](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/EnumType.ts#L115)* +*Defined in [codec/EnumType.ts:115](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/EnumType.ts#L115)* **Returns:** `any` @@ -144,7 +144,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toNumber](_codec_enumtype_.enumtype.md#tonumber)* -*Defined in [codec/EnumType.ts:119](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/EnumType.ts#L119)* +*Defined in [codec/EnumType.ts:119](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/EnumType.ts#L119)* **Returns:** `number` @@ -159,7 +159,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* -*Defined in [codec/EnumType.ts:123](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/EnumType.ts#L123)* +*Defined in [codec/EnumType.ts:123](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/EnumType.ts#L123)* **Returns:** `string` @@ -174,7 +174,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* -*Defined in [codec/EnumType.ts:127](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/EnumType.ts#L127)* +*Defined in [codec/EnumType.ts:127](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/EnumType.ts#L127)* **Parameters:** @@ -193,7 +193,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[decodeEnumType](_codec_enumtype_.enumtype.md#decodeenumtype)* -*Defined in [codec/EnumType.ts:45](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/EnumType.ts#L45)* +*Defined in [codec/EnumType.ts:45](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/EnumType.ts#L45)* **Type parameters:** diff --git a/docs/types/classes/_event_.event.md b/docs/types/classes/_event_.event.md index 21642cd722..f13acd135a 100644 --- a/docs/types/classes/_event_.event.md +++ b/docs/types/classes/_event_.event.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Event.ts:56](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Event.ts#L56)* +*Defined in [Event.ts:56](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Event.ts#L56)* **Parameters:** @@ -58,7 +58,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L25)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L25)* ___ @@ -83,7 +83,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L123)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -94,7 +94,7 @@ ___ getdata(): `EventData` -*Defined in [Event.ts:110](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Event.ts#L110)* +*Defined in [Event.ts:110](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Event.ts#L110)* **Returns:** `EventData` @@ -107,7 +107,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L127)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -118,7 +118,7 @@ ___ getindex(): `EventIndex` -*Defined in [Event.ts:114](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Event.ts#L114)* +*Defined in [Event.ts:114](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Event.ts#L114)* **Returns:** `EventIndex` @@ -129,7 +129,7 @@ ___ getmeta(): [EventMetadata](_metadata_.eventmetadata.md) -*Defined in [Event.ts:118](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Event.ts#L118)* +*Defined in [Event.ts:118](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Event.ts#L118)* **Returns:** [EventMetadata](_metadata_.eventmetadata.md) @@ -140,7 +140,7 @@ ___ getmethod(): `string` -*Defined in [Event.ts:122](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Event.ts#L122)* +*Defined in [Event.ts:122](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Event.ts#L122)* **Returns:** `string` @@ -151,7 +151,7 @@ ___ getsection(): `string` -*Defined in [Event.ts:126](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Event.ts#L126)* +*Defined in [Event.ts:126](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Event.ts#L126)* **Returns:** `string` @@ -162,7 +162,7 @@ ___ gettypeDef(): `Array`<[TypeDef](../modules/_codec_createtype_.md#typedef)> -*Defined in [Event.ts:130](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Event.ts#L130)* +*Defined in [Event.ts:130](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Event.ts#L130)* **Returns:** `Array`<[TypeDef](../modules/_codec_createtype_.md#typedef)> @@ -279,7 +279,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L133)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -352,7 +352,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L137)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -365,7 +365,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L141)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -378,7 +378,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L145)* **Returns:** `any` @@ -391,7 +391,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L156)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -404,7 +404,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -436,7 +436,7 @@ ___ ▸ **decodeEvent**(value: *`Uint8Array`*): `object` -*Defined in [Event.ts:68](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Event.ts#L68)* +*Defined in [Event.ts:68](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Event.ts#L68)* **Parameters:** @@ -453,7 +453,7 @@ ___ ▸ **injectMetadata**(metadata: *`Metadata`*): `void` -*Defined in [Event.ts:87](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Event.ts#L87)* +*Defined in [Event.ts:87](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Event.ts#L87)* **Parameters:** @@ -472,7 +472,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L113)* +*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/types/classes/_eventrecord_.eventrecord.md b/docs/types/classes/_eventrecord_.eventrecord.md index b2d956c48b..506027a646 100644 --- a/docs/types/classes/_eventrecord_.eventrecord.md +++ b/docs/types/classes/_eventrecord_.eventrecord.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [EventRecord.ts:26](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/EventRecord.ts#L26)* +*Defined in [EventRecord.ts:26](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/EventRecord.ts#L26)* **Parameters:** @@ -58,7 +58,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L25)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L25)* ___ @@ -83,7 +83,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L123)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -96,7 +96,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L127)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -107,7 +107,7 @@ ___ getevent(): [Event](_event_.event.md) -*Defined in [EventRecord.ts:34](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/EventRecord.ts#L34)* +*Defined in [EventRecord.ts:34](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/EventRecord.ts#L34)* **Returns:** [Event](_event_.event.md) @@ -118,7 +118,7 @@ ___ getphase(): `Phase` -*Defined in [EventRecord.ts:38](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/EventRecord.ts#L38)* +*Defined in [EventRecord.ts:38](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/EventRecord.ts#L38)* **Returns:** `Phase` @@ -235,7 +235,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L133)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -308,7 +308,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L137)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -321,7 +321,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L141)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -334,7 +334,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L145)* **Returns:** `any` @@ -347,7 +347,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L156)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -360,7 +360,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -394,7 +394,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L113)* +*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/types/classes/_extrinsic_.extrinsic.md b/docs/types/classes/_extrinsic_.extrinsic.md index 294ef6197a..4aca17eb28 100644 --- a/docs/types/classes/_extrinsic_.extrinsic.md +++ b/docs/types/classes/_extrinsic_.extrinsic.md @@ -34,7 +34,7 @@ Can be: *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Extrinsic.ts:34](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Extrinsic.ts#L34)* +*Defined in [Extrinsic.ts:34](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Extrinsic.ts#L34)* **Parameters:** @@ -67,7 +67,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L25)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L25)* ___ @@ -92,7 +92,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L123)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -103,7 +103,7 @@ ___ getargs(): `Array`<[Base](_codec_base_.base.md)> -*Defined in [Extrinsic.ts:70](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Extrinsic.ts#L70)* +*Defined in [Extrinsic.ts:70](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Extrinsic.ts#L70)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -114,7 +114,7 @@ ___ getcallIndex(): `Uint8Array` -*Defined in [Extrinsic.ts:75](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Extrinsic.ts#L75)* +*Defined in [Extrinsic.ts:75](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Extrinsic.ts#L75)* **Returns:** `Uint8Array` @@ -125,7 +125,7 @@ ___ getdata(): `Uint8Array` -*Defined in [Extrinsic.ts:79](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Extrinsic.ts#L79)* +*Defined in [Extrinsic.ts:79](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Extrinsic.ts#L79)* **Returns:** `Uint8Array` @@ -138,7 +138,7 @@ getencodedLength(): `number` *Overrides [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [Extrinsic.ts:110](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Extrinsic.ts#L110)* +*Defined in [Extrinsic.ts:110](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Extrinsic.ts#L110)* **Returns:** `number` @@ -149,7 +149,7 @@ ___ gethash(): [Hash](_hash_.hash.md) -*Defined in [Extrinsic.ts:84](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Extrinsic.ts#L84)* +*Defined in [Extrinsic.ts:84](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Extrinsic.ts#L84)* **Returns:** [Hash](_hash_.hash.md) @@ -160,7 +160,7 @@ ___ getisSigned(): `boolean` -*Defined in [Extrinsic.ts:90](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Extrinsic.ts#L90)* +*Defined in [Extrinsic.ts:90](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Extrinsic.ts#L90)* **Returns:** `boolean` @@ -171,7 +171,7 @@ ___ getlength(): `number` -*Defined in [Extrinsic.ts:94](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Extrinsic.ts#L94)* +*Defined in [Extrinsic.ts:94](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Extrinsic.ts#L94)* **Returns:** `number` @@ -182,7 +182,7 @@ ___ getmeta(): [FunctionMetadata](_metadata_.functionmetadata.md) -*Defined in [Extrinsic.ts:98](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Extrinsic.ts#L98)* +*Defined in [Extrinsic.ts:98](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Extrinsic.ts#L98)* **Returns:** [FunctionMetadata](_metadata_.functionmetadata.md) @@ -193,7 +193,7 @@ ___ getmethod(): [Method](_method_.method.md) -*Defined in [Extrinsic.ts:102](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Extrinsic.ts#L102)* +*Defined in [Extrinsic.ts:102](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Extrinsic.ts#L102)* **Returns:** [Method](_method_.method.md) @@ -204,7 +204,7 @@ ___ getsignature(): [ExtrinsicSignature](_extrinsicsignature_.extrinsicsignature.md) -*Defined in [Extrinsic.ts:106](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Extrinsic.ts#L106)* +*Defined in [Extrinsic.ts:106](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Extrinsic.ts#L106)* **Returns:** [ExtrinsicSignature](_extrinsicsignature_.extrinsicsignature.md) @@ -321,7 +321,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L133)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -392,7 +392,7 @@ ___ ▸ **sign**(signerPair: *`KeyringPair`*, nonce: *`AnyNumber`*, blockHash: *`AnyU8a`*): [Extrinsic](_extrinsic_.extrinsic.md) -*Defined in [Extrinsic.ts:116](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Extrinsic.ts#L116)* +*Defined in [Extrinsic.ts:116](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Extrinsic.ts#L116)* **Parameters:** @@ -413,7 +413,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L137)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -426,7 +426,7 @@ ___ *Overrides [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [Extrinsic.ts:133](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Extrinsic.ts#L133)* +*Defined in [Extrinsic.ts:133](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Extrinsic.ts#L133)* **Returns:** `string` @@ -439,7 +439,7 @@ ___ *Overrides [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [Extrinsic.ts:137](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Extrinsic.ts#L137)* +*Defined in [Extrinsic.ts:137](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Extrinsic.ts#L137)* **Returns:** `any` @@ -452,7 +452,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L156)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -465,7 +465,7 @@ ___ *Overrides [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [Extrinsic.ts:122](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Extrinsic.ts#L122)* +*Defined in [Extrinsic.ts:122](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Extrinsic.ts#L122)* **Parameters:** @@ -497,7 +497,7 @@ ___ ▸ **decodeExtrinsic**(value?: * `ExtrinsicValue` | `AnyU8a`*): `any` | `Uint8Array` -*Defined in [Extrinsic.ts:42](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Extrinsic.ts#L42)* +*Defined in [Extrinsic.ts:42](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Extrinsic.ts#L42)* **Parameters:** @@ -516,7 +516,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L113)* +*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/types/classes/_extrinsicera_.extrinsicera.md b/docs/types/classes/_extrinsicera_.extrinsicera.md index 4765631ff4..58e7da3957 100644 --- a/docs/types/classes/_extrinsicera_.extrinsicera.md +++ b/docs/types/classes/_extrinsicera_.extrinsicera.md @@ -23,7 +23,7 @@ *Overrides [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)* -*Defined in [ExtrinsicEra.ts:11](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/ExtrinsicEra.ts#L11)* +*Defined in [ExtrinsicEra.ts:11](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/ExtrinsicEra.ts#L11)* **Parameters:** @@ -121,7 +121,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[raw](_codec_u8a_.u8a.md#raw)* -*Defined in [codec/U8a.ts:15](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L15)* +*Defined in [codec/U8a.ts:15](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L15)* ___ @@ -135,7 +135,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:33](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L33)* +*Defined in [codec/U8a.ts:33](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L33)* **Returns:** `number` @@ -675,7 +675,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:39](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L39)* +*Defined in [codec/U8a.ts:39](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L39)* **Parameters:** @@ -695,7 +695,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L43)* **Returns:** `string` @@ -708,7 +708,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:47](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L47)* +*Defined in [codec/U8a.ts:47](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L47)* **Returns:** `any` @@ -738,7 +738,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:55](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L55)* +*Defined in [codec/U8a.ts:55](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L55)* **Returns:** `string` @@ -751,7 +751,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:51](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L51)* +*Defined in [codec/U8a.ts:51](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L51)* **Parameters:** @@ -783,7 +783,7 @@ ___ ▸ **decodeExtrinsicEra**(value?: *`AnyU8a`*): `Uint8Array` -*Defined in [ExtrinsicEra.ts:18](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/ExtrinsicEra.ts#L18)* +*Defined in [ExtrinsicEra.ts:18](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/ExtrinsicEra.ts#L18)* **Parameters:** diff --git a/docs/types/classes/_extrinsics_.extrinsics.md b/docs/types/classes/_extrinsics_.extrinsics.md index ee2ec83b57..a07ae9593e 100644 --- a/docs/types/classes/_extrinsics_.extrinsics.md +++ b/docs/types/classes/_extrinsics_.extrinsics.md @@ -22,7 +22,7 @@ *Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* -*Defined in [codec/Vector.ts:19](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Vector.ts#L19)* +*Defined in [codec/Vector.ts:19](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Vector.ts#L19)* **Parameters:** @@ -45,7 +45,7 @@ ___ *Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Base.ts#L19)* ___ @@ -59,7 +59,7 @@ getType(): `string` *Inherited from [Vector](_codec_vector_.vector.md).[Type](_codec_vector_.vector.md#type)* -*Defined in [codec/Vector.ts:65](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Vector.ts#L65)* +*Defined in [codec/Vector.ts:65](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Vector.ts#L65)* **Returns:** `string` @@ -74,7 +74,7 @@ getencodedLength(): `number` *Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* -*Defined in [codec/Vector.ts:73](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Vector.ts#L73)* +*Defined in [codec/Vector.ts:73](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Vector.ts#L73)* **Returns:** `number` @@ -87,7 +87,7 @@ getlength(): `number` *Inherited from [Vector](_codec_vector_.vector.md).[length](_codec_vector_.vector.md#length)* -*Defined in [codec/Vector.ts:69](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Vector.ts#L69)* +*Defined in [codec/Vector.ts:69](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Vector.ts#L69)* **Returns:** `number` @@ -103,7 +103,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[filter](_codec_vector_.vector.md#filter)* -*Defined in [codec/Vector.ts:79](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Vector.ts#L79)* +*Defined in [codec/Vector.ts:79](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Vector.ts#L79)* **Parameters:** @@ -122,7 +122,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[find](_codec_vector_.vector.md#find)* -*Defined in [codec/Vector.ts:83](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Vector.ts#L83)* +*Defined in [codec/Vector.ts:83](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Vector.ts#L83)* **Parameters:** @@ -141,7 +141,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[forEach](_codec_vector_.vector.md#foreach)* -*Defined in [codec/Vector.ts:87](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Vector.ts#L87)* +*Defined in [codec/Vector.ts:87](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Vector.ts#L87)* **Parameters:** @@ -160,7 +160,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[get](_codec_vector_.vector.md#get)* -*Defined in [codec/Vector.ts:91](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Vector.ts#L91)* +*Defined in [codec/Vector.ts:91](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Vector.ts#L91)* **Parameters:** @@ -179,7 +179,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[map](_codec_vector_.vector.md#map)* -*Defined in [codec/Vector.ts:95](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Vector.ts#L95)* +*Defined in [codec/Vector.ts:95](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Vector.ts#L95)* **Type parameters:** @@ -201,7 +201,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[push](_codec_vector_.vector.md#push)* -*Defined in [codec/Vector.ts:99](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Vector.ts#L99)* +*Defined in [codec/Vector.ts:99](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Vector.ts#L99)* **Parameters:** @@ -220,7 +220,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[reduce](_codec_vector_.vector.md#reduce)* -*Defined in [codec/Vector.ts:103](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Vector.ts#L103)* +*Defined in [codec/Vector.ts:103](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Vector.ts#L103)* **Type parameters:** @@ -245,7 +245,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* -*Defined in [codec/Vector.ts:107](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Vector.ts#L107)* +*Defined in [codec/Vector.ts:107](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Vector.ts#L107)* **Returns:** `any` @@ -260,7 +260,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* -*Defined in [codec/Vector.ts:126](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Vector.ts#L126)* +*Defined in [codec/Vector.ts:126](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Vector.ts#L126)* **Returns:** `string` @@ -275,7 +275,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* -*Defined in [codec/Vector.ts:113](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Vector.ts#L113)* +*Defined in [codec/Vector.ts:113](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Vector.ts#L113)* **Parameters:** @@ -294,7 +294,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[decodeVector](_codec_vector_.vector.md#decodevector)* -*Defined in [codec/Vector.ts:29](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Vector.ts#L29)* +*Defined in [codec/Vector.ts:29](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Vector.ts#L29)* **Type parameters:** @@ -317,7 +317,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[with](_codec_vector_.vector.md#with)* -*Defined in [codec/Vector.ts:57](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Vector.ts#L57)* +*Defined in [codec/Vector.ts:57](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Vector.ts#L57)* **Type parameters:** diff --git a/docs/types/classes/_extrinsicsignature_.extrinsicsignature.md b/docs/types/classes/_extrinsicsignature_.extrinsicsignature.md index fb50d6b6a3..eb42de3197 100644 --- a/docs/types/classes/_extrinsicsignature_.extrinsicsignature.md +++ b/docs/types/classes/_extrinsicsignature_.extrinsicsignature.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [ExtrinsicSignature.ts:36](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/ExtrinsicSignature.ts#L36)* +*Defined in [ExtrinsicSignature.ts:36](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/ExtrinsicSignature.ts#L36)* **Parameters:** @@ -58,7 +58,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L25)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L25)* ___ @@ -83,7 +83,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L123)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -96,7 +96,7 @@ getencodedLength(): `number` *Overrides [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [ExtrinsicSignature.ts:64](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/ExtrinsicSignature.ts#L64)* +*Defined in [ExtrinsicSignature.ts:64](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/ExtrinsicSignature.ts#L64)* **Returns:** `number` @@ -107,7 +107,7 @@ ___ getera(): [ExtrinsicEra](_extrinsicera_.extrinsicera.md) -*Defined in [ExtrinsicSignature.ts:77](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/ExtrinsicSignature.ts#L77)* +*Defined in [ExtrinsicSignature.ts:77](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/ExtrinsicSignature.ts#L77)* **Returns:** [ExtrinsicEra](_extrinsicera_.extrinsicera.md) @@ -118,7 +118,7 @@ ___ getisSigned(): `boolean` -*Defined in [ExtrinsicSignature.ts:73](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/ExtrinsicSignature.ts#L73)* +*Defined in [ExtrinsicSignature.ts:73](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/ExtrinsicSignature.ts#L73)* **Returns:** `boolean` @@ -129,7 +129,7 @@ ___ getnonce(): `Nonce` -*Defined in [ExtrinsicSignature.ts:81](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/ExtrinsicSignature.ts#L81)* +*Defined in [ExtrinsicSignature.ts:81](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/ExtrinsicSignature.ts#L81)* **Returns:** `Nonce` @@ -140,7 +140,7 @@ ___ getsignature(): [Signature](_signature_.signature.md) -*Defined in [ExtrinsicSignature.ts:85](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/ExtrinsicSignature.ts#L85)* +*Defined in [ExtrinsicSignature.ts:85](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/ExtrinsicSignature.ts#L85)* **Returns:** [Signature](_signature_.signature.md) @@ -151,7 +151,7 @@ ___ getsigner(): [Address](_address_.address.md) -*Defined in [ExtrinsicSignature.ts:89](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/ExtrinsicSignature.ts#L89)* +*Defined in [ExtrinsicSignature.ts:89](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/ExtrinsicSignature.ts#L89)* **Returns:** [Address](_address_.address.md) @@ -162,7 +162,7 @@ ___ getversion(): `number` -*Defined in [ExtrinsicSignature.ts:93](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/ExtrinsicSignature.ts#L93)* +*Defined in [ExtrinsicSignature.ts:93](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/ExtrinsicSignature.ts#L93)* **Returns:** `number` @@ -191,7 +191,7 @@ ___ ▸ **addSignature**(method: *[Method](_method_.method.md)*, signerPair: *`KeyringPair`*, nonce: *`AnyNumber`*, blockHash: *`AnyU8a`*, era?: *`Uint8Array`*): [ExtrinsicSignature](_extrinsicsignature_.extrinsicsignature.md) -*Defined in [ExtrinsicSignature.ts:105](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/ExtrinsicSignature.ts#L105)* +*Defined in [ExtrinsicSignature.ts:105](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/ExtrinsicSignature.ts#L105)* **Parameters:** @@ -300,7 +300,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L133)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -373,7 +373,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L137)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -386,7 +386,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L141)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -399,7 +399,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L145)* **Returns:** `any` @@ -412,7 +412,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L156)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -425,7 +425,7 @@ ___ *Overrides [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [ExtrinsicSignature.ts:124](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/ExtrinsicSignature.ts#L124)* +*Defined in [ExtrinsicSignature.ts:124](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/ExtrinsicSignature.ts#L124)* **Parameters:** @@ -457,7 +457,7 @@ ___ ▸ **decodeExtrinsicSignature**(value: * [ExtrinsicSignature](_extrinsicsignature_.extrinsicsignature.md) | `ExtrinsicSignatureValue` | `AnyU8a` | `undefined`*): `any` | `Uint8Array` -*Defined in [ExtrinsicSignature.ts:46](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/ExtrinsicSignature.ts#L46)* +*Defined in [ExtrinsicSignature.ts:46](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/ExtrinsicSignature.ts#L46)* **Parameters:** @@ -476,7 +476,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L113)* +*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/types/classes/_extrinsicstatus_.broadcast.md b/docs/types/classes/_extrinsicstatus_.broadcast.md index d01a2bd01c..b963a01651 100644 --- a/docs/types/classes/_extrinsicstatus_.broadcast.md +++ b/docs/types/classes/_extrinsicstatus_.broadcast.md @@ -20,7 +20,7 @@ *Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* -*Defined in [codec/Vector.ts:19](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Vector.ts#L19)* +*Defined in [codec/Vector.ts:19](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Vector.ts#L19)* **Parameters:** @@ -43,7 +43,7 @@ ___ *Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Base.ts#L19)* ___ @@ -57,7 +57,7 @@ getType(): `string` *Inherited from [Vector](_codec_vector_.vector.md).[Type](_codec_vector_.vector.md#type)* -*Defined in [codec/Vector.ts:65](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Vector.ts#L65)* +*Defined in [codec/Vector.ts:65](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Vector.ts#L65)* **Returns:** `string` @@ -72,7 +72,7 @@ getencodedLength(): `number` *Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* -*Defined in [codec/Vector.ts:73](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Vector.ts#L73)* +*Defined in [codec/Vector.ts:73](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Vector.ts#L73)* **Returns:** `number` @@ -85,7 +85,7 @@ getlength(): `number` *Inherited from [Vector](_codec_vector_.vector.md).[length](_codec_vector_.vector.md#length)* -*Defined in [codec/Vector.ts:69](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Vector.ts#L69)* +*Defined in [codec/Vector.ts:69](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Vector.ts#L69)* **Returns:** `number` @@ -101,7 +101,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[filter](_codec_vector_.vector.md#filter)* -*Defined in [codec/Vector.ts:79](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Vector.ts#L79)* +*Defined in [codec/Vector.ts:79](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Vector.ts#L79)* **Parameters:** @@ -120,7 +120,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[find](_codec_vector_.vector.md#find)* -*Defined in [codec/Vector.ts:83](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Vector.ts#L83)* +*Defined in [codec/Vector.ts:83](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Vector.ts#L83)* **Parameters:** @@ -139,7 +139,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[forEach](_codec_vector_.vector.md#foreach)* -*Defined in [codec/Vector.ts:87](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Vector.ts#L87)* +*Defined in [codec/Vector.ts:87](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Vector.ts#L87)* **Parameters:** @@ -158,7 +158,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[get](_codec_vector_.vector.md#get)* -*Defined in [codec/Vector.ts:91](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Vector.ts#L91)* +*Defined in [codec/Vector.ts:91](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Vector.ts#L91)* **Parameters:** @@ -177,7 +177,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[map](_codec_vector_.vector.md#map)* -*Defined in [codec/Vector.ts:95](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Vector.ts#L95)* +*Defined in [codec/Vector.ts:95](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Vector.ts#L95)* **Type parameters:** @@ -199,7 +199,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[push](_codec_vector_.vector.md#push)* -*Defined in [codec/Vector.ts:99](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Vector.ts#L99)* +*Defined in [codec/Vector.ts:99](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Vector.ts#L99)* **Parameters:** @@ -218,7 +218,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[reduce](_codec_vector_.vector.md#reduce)* -*Defined in [codec/Vector.ts:103](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Vector.ts#L103)* +*Defined in [codec/Vector.ts:103](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Vector.ts#L103)* **Type parameters:** @@ -243,7 +243,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* -*Defined in [codec/Vector.ts:107](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Vector.ts#L107)* +*Defined in [codec/Vector.ts:107](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Vector.ts#L107)* **Returns:** `any` @@ -258,7 +258,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* -*Defined in [codec/Vector.ts:126](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Vector.ts#L126)* +*Defined in [codec/Vector.ts:126](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Vector.ts#L126)* **Returns:** `string` @@ -273,7 +273,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* -*Defined in [codec/Vector.ts:113](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Vector.ts#L113)* +*Defined in [codec/Vector.ts:113](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Vector.ts#L113)* **Parameters:** @@ -292,7 +292,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[decodeVector](_codec_vector_.vector.md#decodevector)* -*Defined in [codec/Vector.ts:29](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Vector.ts#L29)* +*Defined in [codec/Vector.ts:29](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Vector.ts#L29)* **Type parameters:** @@ -315,7 +315,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[with](_codec_vector_.vector.md#with)* -*Defined in [codec/Vector.ts:57](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Vector.ts#L57)* +*Defined in [codec/Vector.ts:57](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Vector.ts#L57)* **Type parameters:** diff --git a/docs/types/classes/_extrinsicstatus_.dropped.md b/docs/types/classes/_extrinsicstatus_.dropped.md index 6f41060d67..0afac48017 100644 --- a/docs/types/classes/_extrinsicstatus_.dropped.md +++ b/docs/types/classes/_extrinsicstatus_.dropped.md @@ -18,7 +18,7 @@ *Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* -*Defined in [Null.ts:8](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Null.ts#L8)* +*Defined in [Null.ts:8](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Null.ts#L8)* **Returns:** [Dropped](_extrinsicstatus_.dropped.md) @@ -34,7 +34,7 @@ ___ *Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Base.ts#L19)* ___ @@ -50,7 +50,7 @@ getencodedLength(): `number` *Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* -*Defined in [Null.ts:13](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Null.ts#L13)* +*Defined in [Null.ts:13](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Null.ts#L13)* **Returns:** `number` @@ -68,7 +68,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* -*Defined in [Null.ts:17](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Null.ts#L17)* +*Defined in [Null.ts:17](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Null.ts#L17)* **Returns:** `any` @@ -83,7 +83,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* -*Defined in [Null.ts:25](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Null.ts#L25)* +*Defined in [Null.ts:25](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Null.ts#L25)* **Returns:** `string` @@ -98,7 +98,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* -*Defined in [Null.ts:21](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Null.ts#L21)* +*Defined in [Null.ts:21](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Null.ts#L21)* **Parameters:** diff --git a/docs/types/classes/_extrinsicstatus_.extrinsicstatus.md b/docs/types/classes/_extrinsicstatus_.extrinsicstatus.md index 53eba707a9..ea717df157 100644 --- a/docs/types/classes/_extrinsicstatus_.extrinsicstatus.md +++ b/docs/types/classes/_extrinsicstatus_.extrinsicstatus.md @@ -16,7 +16,7 @@ *Overrides [EnumType](_codec_enumtype_.enumtype.md).[constructor](_codec_enumtype_.enumtype.md#constructor)* -*Defined in [ExtrinsicStatus.ts:23](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/ExtrinsicStatus.ts#L23)* +*Defined in [ExtrinsicStatus.ts:23](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/ExtrinsicStatus.ts#L23)* **Parameters:** @@ -39,7 +39,7 @@ ___ *Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Base.ts#L19)* ___ @@ -55,7 +55,7 @@ getencodedLength(): `number` *Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* -*Defined in [codec/EnumType.ts:94](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/EnumType.ts#L94)* +*Defined in [codec/EnumType.ts:94](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/EnumType.ts#L94)* **Returns:** `number` @@ -68,7 +68,7 @@ getisNull(): `boolean` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNull](_codec_enumtype_.enumtype.md#isnull)* -*Defined in [codec/EnumType.ts:82](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/EnumType.ts#L82)* +*Defined in [codec/EnumType.ts:82](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/EnumType.ts#L82)* **Returns:** `boolean` @@ -81,7 +81,7 @@ gettype(): `string` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[type](_codec_enumtype_.enumtype.md#type)* -*Defined in [codec/EnumType.ts:86](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/EnumType.ts#L86)* +*Defined in [codec/EnumType.ts:86](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/EnumType.ts#L86)* **Returns:** `string` @@ -94,7 +94,7 @@ getvalue(): [Base](_codec_base_.base.md)< [Finalised](_extrinsicstatus_.finalise *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[value](_codec_enumtype_.enumtype.md#value)* -*Defined in [codec/EnumType.ts:90](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/EnumType.ts#L90)* +*Defined in [codec/EnumType.ts:90](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/EnumType.ts#L90)* **Returns:** [Base](_codec_base_.base.md)< [Finalised](_extrinsicstatus_.finalised.md) | [Usurped](_extrinsicstatus_.usurped.md) | [Broadcast](_extrinsicstatus_.broadcast.md) | [Dropped](_extrinsicstatus_.dropped.md)> @@ -110,7 +110,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[setValue](_codec_enumtype_.enumtype.md#setvalue)* -*Defined in [codec/EnumType.ts:98](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/EnumType.ts#L98)* +*Defined in [codec/EnumType.ts:98](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/EnumType.ts#L98)* **Parameters:** @@ -132,7 +132,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* -*Defined in [codec/EnumType.ts:115](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/EnumType.ts#L115)* +*Defined in [codec/EnumType.ts:115](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/EnumType.ts#L115)* **Returns:** `any` @@ -145,7 +145,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toNumber](_codec_enumtype_.enumtype.md#tonumber)* -*Defined in [codec/EnumType.ts:119](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/EnumType.ts#L119)* +*Defined in [codec/EnumType.ts:119](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/EnumType.ts#L119)* **Returns:** `number` @@ -160,7 +160,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* -*Defined in [codec/EnumType.ts:123](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/EnumType.ts#L123)* +*Defined in [codec/EnumType.ts:123](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/EnumType.ts#L123)* **Returns:** `string` @@ -175,7 +175,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* -*Defined in [codec/EnumType.ts:127](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/EnumType.ts#L127)* +*Defined in [codec/EnumType.ts:127](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/EnumType.ts#L127)* **Parameters:** @@ -194,7 +194,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[decodeEnumType](_codec_enumtype_.enumtype.md#decodeenumtype)* -*Defined in [codec/EnumType.ts:45](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/EnumType.ts#L45)* +*Defined in [codec/EnumType.ts:45](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/EnumType.ts#L45)* **Type parameters:** diff --git a/docs/types/classes/_extrinsicstatus_.finalised.md b/docs/types/classes/_extrinsicstatus_.finalised.md index d9c3ab0ca2..900b4e3668 100644 --- a/docs/types/classes/_extrinsicstatus_.finalised.md +++ b/docs/types/classes/_extrinsicstatus_.finalised.md @@ -25,7 +25,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [H256.ts:11](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/H256.ts#L11)* +*Defined in [H256.ts:11](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/H256.ts#L11)* **Parameters:** @@ -123,25 +123,12 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[raw](_codec_u8a_.u8a.md#raw)* -*Defined in [codec/U8a.ts:15](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L15)* +*Defined in [codec/U8a.ts:15](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L15)* ___ # Accessors - - -## bitLength - -getbitLength(): `number` - -*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* - -*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8aFixed.ts#L32)* - -**Returns:** `number` - -___ ## encodedLength @@ -150,7 +137,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:33](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L33)* +*Defined in [codec/U8a.ts:33](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L33)* **Returns:** `number` @@ -170,6 +157,19 @@ ___ **Returns:** `IterableIterator`<`number`> +___ + + +## bitLength + +▸ **bitLength**(): `number` + +*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* + +*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8aFixed.ts#L32)* + +**Returns:** `number` + ___ @@ -690,7 +690,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:39](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L39)* +*Defined in [codec/U8a.ts:39](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L39)* **Parameters:** @@ -710,7 +710,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L43)* **Returns:** `string` @@ -723,7 +723,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:47](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L47)* +*Defined in [codec/U8a.ts:47](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L47)* **Returns:** `any` @@ -753,7 +753,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:55](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L55)* +*Defined in [codec/U8a.ts:55](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L55)* **Returns:** `string` @@ -766,7 +766,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:51](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L51)* +*Defined in [codec/U8a.ts:51](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L51)* **Parameters:** diff --git a/docs/types/classes/_extrinsicstatus_.usurped.md b/docs/types/classes/_extrinsicstatus_.usurped.md index cbf33bbfa8..29f27535b6 100644 --- a/docs/types/classes/_extrinsicstatus_.usurped.md +++ b/docs/types/classes/_extrinsicstatus_.usurped.md @@ -25,7 +25,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [H256.ts:11](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/H256.ts#L11)* +*Defined in [H256.ts:11](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/H256.ts#L11)* **Parameters:** @@ -123,25 +123,12 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[raw](_codec_u8a_.u8a.md#raw)* -*Defined in [codec/U8a.ts:15](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L15)* +*Defined in [codec/U8a.ts:15](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L15)* ___ # Accessors - - -## bitLength - -getbitLength(): `number` - -*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* - -*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8aFixed.ts#L32)* - -**Returns:** `number` - -___ ## encodedLength @@ -150,7 +137,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:33](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L33)* +*Defined in [codec/U8a.ts:33](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L33)* **Returns:** `number` @@ -170,6 +157,19 @@ ___ **Returns:** `IterableIterator`<`number`> +___ + + +## bitLength + +▸ **bitLength**(): `number` + +*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* + +*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8aFixed.ts#L32)* + +**Returns:** `number` + ___ @@ -690,7 +690,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:39](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L39)* +*Defined in [codec/U8a.ts:39](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L39)* **Parameters:** @@ -710,7 +710,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L43)* **Returns:** `string` @@ -723,7 +723,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:47](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L47)* +*Defined in [codec/U8a.ts:47](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L47)* **Returns:** `any` @@ -753,7 +753,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:55](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L55)* +*Defined in [codec/U8a.ts:55](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L55)* **Returns:** `string` @@ -766,7 +766,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:51](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L51)* +*Defined in [codec/U8a.ts:51](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L51)* **Parameters:** diff --git a/docs/types/classes/_gas_.gas.md b/docs/types/classes/_gas_.gas.md index 2b98b4dc6b..9322a62f64 100644 --- a/docs/types/classes/_gas_.gas.md +++ b/docs/types/classes/_gas_.gas.md @@ -6,6 +6,10 @@ **↳ Gas** +# Implements + +* `Codec` + # Constructors @@ -18,7 +22,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U64.ts:9](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/U64.ts#L9)* +*Defined in [U64.ts:9](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/U64.ts#L9)* **Parameters:** @@ -38,27 +42,14 @@ ___ **● raw**: *`BN`* -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* +*Inherited from [UInt](_codec_uint_.uint.md).[raw](_codec_uint_.uint.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/UInt.ts:23](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L23)* ___ # Accessors - - -## bitLength - -getbitLength(): [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) - -*Inherited from [UInt](_codec_uint_.uint.md).[bitLength](_codec_uint_.uint.md#bitlength)* - -*Defined in [codec/UInt.ts:50](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L50)* - -**Returns:** [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) - -___ ## encodedLength @@ -67,9 +58,7 @@ getencodedLength(): `number` *Inherited from [UInt](_codec_uint_.uint.md).[encodedLength](_codec_uint_.uint.md#encodedlength)* -*Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* - -*Defined in [codec/UInt.ts:54](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L54)* +*Defined in [codec/UInt.ts:55](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L55)* **Returns:** `number` @@ -77,21 +66,167 @@ ___ # Methods + + +## abs + +▸ **abs**(): `BN` + +*Inherited from BN.abs* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:254* + +*__description__*: absolute value + +**Returns:** `BN` + +___ ## add -▸ **add**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **add**(b: *`BN`*): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)* +*Inherited from BN.add* -*Defined in [codec/UInt.ts:86](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L86)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:264* + +*__description__*: addition **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | + +**Returns:** `BN` + +___ + + +## addn + +▸ **addn**(b: *`number`*): `BN` + +*Inherited from BN.addn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:274* + +*__description__*: addition + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## and + +▸ **and**(b: *`BN`*): `BN` + +*Inherited from BN.and* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:395* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## andln + +▸ **andln**(b: *`number`*): `BN` + +*Inherited from BN.andln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:415* + +*__description__*: and (NOTE: `andln` is going to be replaced with `andn` in future) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## bincn + +▸ **bincn**(b: *`number`*): `BN` + +*Inherited from BN.bincn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:499* + +*__description__*: add `1 << b` to the number + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## bitLength + +▸ **bitLength**(): [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) + +*Inherited from [UInt](_codec_uint_.uint.md).[bitLength](_codec_uint_.uint.md#bitlength)* + +*Overrides BN.bitLength* + +*Defined in [codec/UInt.ts:51](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L51)* + +**Returns:** [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) + +___ + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from BN.byteLength* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:144* + +*__description__*: return number of bytes occupied + +**Returns:** `number` + +___ + + +## clone + +▸ **clone**(): `BN` + +*Inherited from BN.clone* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:89* + +*__description__*: clone number **Returns:** `BN` @@ -100,74 +235,229 @@ ___ ## cmp -▸ **cmp**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `number` +▸ **cmp**(b: *`BN`*): `-1` | `0` | `1` -*Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)* +*Inherited from BN.cmp* -*Defined in [codec/UInt.ts:92](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L92)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:169* + +*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | -**Returns:** `number` +**Returns:** `-1` | `0` | `1` + +___ + + +## cmpn + +▸ **cmpn**(b: *`number`*): `-1` | `0` | `1` + +*Inherited from BN.cmpn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:179* + +*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `-1` | `0` | `1` ___ ## div -▸ **div**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **div**(b: *`BN`*): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)* +*Inherited from BN.div* -*Defined in [codec/UInt.ts:98](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L98)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:339* + +*__description__*: divide **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `BN` +___ + + +## divRound + +▸ **divRound**(b: *`BN`*): `BN` + +*Inherited from BN.divRound* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:370* + +*__description__*: rounded division + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## divn + +▸ **divn**(b: *`number`*): `BN` + +*Inherited from BN.divn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:344* + +*__description__*: divide + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## egcd + +▸ **egcd**(b: *`BN`*): `object` + +*Inherited from BN.egcd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:519* + +*__description__*: Extended GCD results `({ a: ..., b: ..., gcd: ... })` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `object` + ___ ## eq -▸ **eq**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **eq**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[eq](_codec_uint_.uint.md#eq)* +*Inherited from BN.eq* -*Defined in [codec/UInt.ts:104](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L104)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:224* + +*__description__*: a equals b **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` +___ + + +## eqn + +▸ **eqn**(b: *`number`*): `boolean` + +*Inherited from BN.eqn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:229* + +*__description__*: a equals b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## fromTwos + +▸ **fromTwos**(width: *`number`*): `BN` + +*Inherited from BN.fromTwos* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:239* + +*__description__*: convert from two's complement representation, where width is the bit width + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| width | `number` | + +**Returns:** `BN` + +___ + + +## gcd + +▸ **gcd**(b: *`BN`*): `BN` + +*Inherited from BN.gcd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:514* + +*__description__*: GCD + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + ___ ## gt -▸ **gt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **gt**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)* +*Inherited from BN.gt* -*Defined in [codec/UInt.ts:126](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L126)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:204* + +*__description__*: a greater than b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` @@ -176,17 +466,346 @@ ___ ## gte -▸ **gte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **gte**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)* +*Inherited from BN.gte* -*Defined in [codec/UInt.ts:132](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L132)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:214* + +*__description__*: a greater than or equals b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | + +**Returns:** `boolean` + +___ + + +## gten + +▸ **gten**(b: *`number`*): `boolean` + +*Inherited from BN.gten* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:219* + +*__description__*: a greater than or equals b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## gtn + +▸ **gtn**(b: *`number`*): `boolean` + +*Inherited from BN.gtn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:209* + +*__description__*: a greater than b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## iabs + +▸ **iabs**(): `BN` + +*Inherited from BN.iabs* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:259* + +*__description__*: absolute value + +**Returns:** `BN` + +___ + + +## iadd + +▸ **iadd**(b: *`BN`*): `BN` + +*Inherited from BN.iadd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:269* + +*__description__*: addition + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## iaddn + +▸ **iaddn**(b: *`number`*): `BN` + +*Inherited from BN.iaddn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:279* + +*__description__*: addition + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iand + +▸ **iand**(b: *`BN`*): `BN` + +*Inherited from BN.iand* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:400* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## idivn + +▸ **idivn**(b: *`number`*): `BN` + +*Inherited from BN.idivn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:349* + +*__description__*: divide + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## imaskn + +▸ **imaskn**(b: *`number`*): `BN` + +*Inherited from BN.imaskn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495* + +*__description__*: clear bits with indexes higher or equal to `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## imul + +▸ **imul**(b: *`BN`*): `BN` + +*Inherited from BN.imul* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:309* + +*__description__*: multiply + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## imuln + +▸ **imuln**(b: *`number`*): `BN` + +*Inherited from BN.imuln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:319* + +*__description__*: multiply + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## ineg + +▸ **ineg**(): `BN` + +*Inherited from BN.ineg* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:249* + +*__description__*: negate sign + +**Returns:** `BN` + +___ + + +## inotn + +▸ **inotn**(w: *`number`*): `BN` + +*Inherited from BN.inotn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:509* + +*__description__*: not (for the width specified by `w`) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| w | `number` | + +**Returns:** `BN` + +___ + + +## invm + +▸ **invm**(b: *`BN`*): `BN` + +*Inherited from BN.invm* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:524* + +*__description__*: inverse `a` modulo `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ior + +▸ **ior**(b: *`BN`*): `BN` + +*Inherited from BN.ior* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:380* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## isEven + +▸ **isEven**(): `boolean` + +*Inherited from BN.isEven* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:154* + +*__description__*: check if value is even + +**Returns:** `boolean` + +___ + + +## isNeg + +▸ **isNeg**(): `boolean` + +*Inherited from BN.isNeg* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:149* + +*__description__*: true if the number is negative + +**Returns:** `boolean` + +___ + + +## isOdd + +▸ **isOdd**(): `boolean` + +*Inherited from BN.isOdd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:159* + +*__description__*: check if value is odd **Returns:** `boolean` @@ -197,28 +816,257 @@ ___ ▸ **isZero**(): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)* +*Inherited from BN.isZero* -*Defined in [codec/UInt.ts:110](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L110)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:164* + +*__description__*: check if value is zero **Returns:** `boolean` +___ + + +## ishln + +▸ **ishln**(b: *`number`*): `BN` + +*Inherited from BN.ishln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:450* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## ishrn + +▸ **ishrn**(b: *`number`*): `BN` + +*Inherited from BN.ishrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:470* + +*__description__*: shift right (unimplemented [https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086](https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## isqr + +▸ **isqr**(): `BN` + +*Inherited from BN.isqr* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:329* + +*__description__*: square + +**Returns:** `BN` + +___ + + +## isub + +▸ **isub**(b: *`BN`*): `BN` + +*Inherited from BN.isub* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:289* + +*__description__*: subtraction + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## isubn + +▸ **isubn**(b: *`number`*): `BN` + +*Inherited from BN.isubn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:299* + +*__description__*: subtraction + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iuand + +▸ **iuand**(b: *`BN`*): `BN` + +*Inherited from BN.iuand* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:410* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## iuor + +▸ **iuor**(b: *`BN`*): `BN` + +*Inherited from BN.iuor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:390* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## iushln + +▸ **iushln**(b: *`number`*): `BN` + +*Inherited from BN.iushln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:460* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iushrn + +▸ **iushrn**(b: *`number`*): `BN` + +*Inherited from BN.iushrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480* + +*__description__*: shift right + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iuxor + +▸ **iuxor**(b: *`BN`*): `BN` + +*Inherited from BN.iuxor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:435* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ixor + +▸ **ixor**(b: *`BN`*): `BN` + +*Inherited from BN.ixor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:425* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + ___ ## lt -▸ **lt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **lt**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)* +*Inherited from BN.lt* -*Defined in [codec/UInt.ts:114](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L114)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:184* + +*__description__*: a less than b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` @@ -227,36 +1075,324 @@ ___ ## lte -▸ **lte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **lte**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)* +*Inherited from BN.lte* -*Defined in [codec/UInt.ts:120](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L120)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:194* + +*__description__*: a less than or equals b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` +___ + + +## lten + +▸ **lten**(b: *`number`*): `boolean` + +*Inherited from BN.lten* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:199* + +*__description__*: a less than or equals b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## ltn + +▸ **ltn**(b: *`number`*): `boolean` + +*Inherited from BN.ltn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:189* + +*__description__*: a less than b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## maskn + +▸ **maskn**(b: *`number`*): `BN` + +*Inherited from BN.maskn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490* + +*__description__*: clear bits with indexes higher or equal to `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## mod + +▸ **mod**(b: *`BN`*): `BN` + +*Inherited from BN.mod* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:354* + +*__description__*: reduct + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## modn + +▸ **modn**(b: *`number`*): `number` + +*Inherited from BN.modn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:365* + +*__see__*: API consistency [https://github.com/indutny/bn.js/pull/130](https://github.com/indutny/bn.js/pull/130) + +*__description__*: reduct + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `number` + ___ ## mul -▸ **mul**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **mul**(b: *`BN`*): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)* +*Inherited from BN.mul* -*Defined in [codec/UInt.ts:138](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L138)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:304* + +*__description__*: multiply **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | + +**Returns:** `BN` + +___ + + +## muln + +▸ **muln**(b: *`number`*): `BN` + +*Inherited from BN.muln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:314* + +*__description__*: multiply + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## neg + +▸ **neg**(): `BN` + +*Inherited from BN.neg* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:244* + +*__description__*: negate sign + +**Returns:** `BN` + +___ + + +## notn + +▸ **notn**(w: *`number`*): `BN` + +*Inherited from BN.notn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:504* + +*__description__*: not (for the width specified by `w`) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| w | `number` | + +**Returns:** `BN` + +___ + + +## or + +▸ **or**(b: *`BN`*): `BN` + +*Inherited from BN.or* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:375* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## pow + +▸ **pow**(b: *`BN`*): `BN` + +*Inherited from BN.pow* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:334* + +*__description__*: raise `a` to the power of `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## setn + +▸ **setn**(b: *`number`*): `BN` + +*Inherited from BN.setn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:440* + +*__description__*: set specified bit to 1 + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## shln + +▸ **shln**(b: *`number`*): `BN` + +*Inherited from BN.shln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:445* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## shrn + +▸ **shrn**(b: *`number`*): `BN` + +*Inherited from BN.shrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:465* + +*__description__*: shift right + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## sqr + +▸ **sqr**(): `BN` + +*Inherited from BN.sqr* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:324* + +*__description__*: square **Returns:** `BN` @@ -265,20 +1401,125 @@ ___ ## sub -▸ **sub**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **sub**(b: *`BN`*): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)* +*Inherited from BN.sub* -*Defined in [codec/UInt.ts:144](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L144)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:284* + +*__description__*: subtraction **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `BN` +___ + + +## subn + +▸ **subn**(b: *`number`*): `BN` + +*Inherited from BN.subn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:294* + +*__description__*: subtraction + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## testn + +▸ **testn**(b: *`number`*): `boolean` + +*Inherited from BN.testn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485* + +*__description__*: test if specified bit is set + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## toArray + +▸ **toArray**(endian?: *`Endianness`*, length?: * `undefined` | `number`*): `number`[] + +*Inherited from BN.toArray* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:109* + +*__description__*: convert to byte Array, and optionally zero pad to length, throwing if already exceeding + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `number`[] + +___ + + +## toArrayLike + +▸ **toArrayLike**(ArrayType: *`object`*, endian?: *`Endianness`*, length?: * `undefined` | `number`*): `Buffer` + +▸ **toArrayLike**(ArrayType: *`any`[]*, endian?: *`Endianness`*, length?: * `undefined` | `number`*): `any`[] + +*Inherited from BN.toArrayLike* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:114* + +*__description__*: convert to an instance of `type`, which must behave like an Array + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| ArrayType | `object` | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `Buffer` + +*Inherited from BN.toArrayLike* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| ArrayType | `any`[] | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `any`[] + ___ @@ -288,10 +1529,32 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)* -*Defined in [codec/UInt.ts:76](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L76)* +*Defined in [codec/UInt.ts:73](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L73)* **Returns:** `BN` +___ + + +## toBuffer + +▸ **toBuffer**(endian?: *`Endianness`*, length?: * `undefined` | `number`*): `Buffer` + +*Inherited from BN.toBuffer* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:129* + +*__description__*: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `Buffer` + ___ @@ -301,7 +1564,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* -*Defined in [codec/UInt.ts:58](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L58)* +*Defined in [codec/UInt.ts:59](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L59)* **Returns:** `string` @@ -314,9 +1577,9 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toJSON](_codec_uint_.uint.md#tojson)* -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* +*Overrides BN.toJSON* -*Defined in [codec/UInt.ts:62](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L62)* +*Defined in [codec/UInt.ts:63](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L63)* **Returns:** `any` @@ -327,27 +1590,78 @@ ___ ▸ **toNumber**(): `number` -*Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)* +*Inherited from BN.toNumber* -*Defined in [codec/UInt.ts:80](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L80)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:99* + +*__description__*: convert to Javascript Number (limited to 53 bits) **Returns:** `number` +___ + + +## toRed + +▸ **toRed**(reductionContext: *`ReductionContext`*): `RedBN` + +*Inherited from BN.toRed* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:84* + +*__description__*: Convert number to red + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| reductionContext | `ReductionContext` | + +**Returns:** `RedBN` + ___ ## toString -▸ **toString**(): `string` +▸ **toString**(base?: * `number` | "hex"*, length?: * `undefined` | `number`*): `string` -*Inherited from [UInt](_codec_uint_.uint.md).[toString](_codec_uint_.uint.md#tostring)* +*Inherited from BN.toString* -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:94* -*Defined in [codec/UInt.ts:72](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L72)* +*__description__*: convert to base-string and pad with zeroes + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` base | `number` | "hex"| +| `Optional` length | `undefined` | `number`| **Returns:** `string` +___ + + +## toTwos + +▸ **toTwos**(width: *`number`*): `BN` + +*Inherited from BN.toTwos* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:234* + +*__description__*: convert to two's complement representation, where width is bit width + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| width | `number` | + +**Returns:** `BN` + ___ @@ -357,9 +1671,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/UInt.ts:68](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L68)* +*Defined in [codec/UInt.ts:69](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L69)* **Parameters:** @@ -369,16 +1681,199 @@ ___ **Returns:** `Uint8Array` +___ + + +## uand + +▸ **uand**(b: *`BN`*): `BN` + +*Inherited from BN.uand* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:405* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ucmp + +▸ **ucmp**(b: *`BN`*): `-1` | `0` | `1` + +*Inherited from BN.ucmp* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:174* + +*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `-1` | `0` | `1` + +___ + + +## umod + +▸ **umod**(b: *`BN`*): `BN` + +*Inherited from BN.umod* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:359* + +*__description__*: reduct + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## uor + +▸ **uor**(b: *`BN`*): `BN` + +*Inherited from BN.uor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:385* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ushln + +▸ **ushln**(b: *`number`*): `BN` + +*Inherited from BN.ushln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:455* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## ushrn + +▸ **ushrn**(b: *`number`*): `BN` + +*Inherited from BN.ushrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475* + +*__description__*: shift right + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## uxor + +▸ **uxor**(b: *`BN`*): `BN` + +*Inherited from BN.uxor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:430* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## xor + +▸ **xor**(b: *`BN`*): `BN` + +*Inherited from BN.xor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:420* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## zeroBits + +▸ **zeroBits**(): `number` + +*Inherited from BN.zeroBits* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:139* + +*__description__*: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits) + +**Returns:** `number` + ___ ## `` decodeUInt -▸ **decodeUInt**(value: *`AnyNumber`*, bitLength: *[UIntBitLength](../modules/_codec_uint_.md#uintbitlength)*): `BN` +▸ **decodeUInt**(value: *`AnyNumber`*, bitLength: *[UIntBitLength](../modules/_codec_uint_.md#uintbitlength)*): `string` *Inherited from [UInt](_codec_uint_.uint.md).[decodeUInt](_codec_uint_.uint.md#decodeuint)* -*Defined in [codec/UInt.ts:35](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L35)* +*Defined in [codec/UInt.ts:35](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L35)* **Parameters:** @@ -387,7 +1882,114 @@ ___ | value | `AnyNumber` | | bitLength | [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) | +**Returns:** `string` + +___ + + +## `` isBN + +▸ **isBN**(b: *`any`*): `boolean` + +*Inherited from BN.isBN* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:69* + +*__description__*: returns true if the supplied object is a BN.js instance + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `any` | + +**Returns:** `boolean` + +___ + + +## `` max + +▸ **max**(left: *`BN`*, right: *`BN`*): `BN` + +*Inherited from BN.max* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:74* + +*__description__*: returns the maximum of 2 BN instances. + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| left | `BN` | +| right | `BN` | + **Returns:** `BN` ___ + + +## `` min + +▸ **min**(left: *`BN`*, right: *`BN`*): `BN` + +*Inherited from BN.min* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:79* + +*__description__*: returns the minimum of 2 BN instances. + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| left | `BN` | +| right | `BN` | + +**Returns:** `BN` + +___ + + +## `` mont + +▸ **mont**(num: *`BN`*): `ReductionContext` + +*Inherited from BN.mont* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:64* + +*__description__*: create a reduction context with the Montgomery trick. + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| num | `BN` | + +**Returns:** `ReductionContext` + +___ + + +## `` red + +▸ **red**(reductionContext: * `BN` | `IPrimeName`*): `ReductionContext` + +*Inherited from BN.red* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:59* + +*__description__*: create a reduction context + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| reductionContext | `BN` | `IPrimeName`| + +**Returns:** `ReductionContext` + +___ diff --git a/docs/types/classes/_h256_.h256.md b/docs/types/classes/_h256_.h256.md index 5344ee0b17..7ad4921d75 100644 --- a/docs/types/classes/_h256_.h256.md +++ b/docs/types/classes/_h256_.h256.md @@ -25,7 +25,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [H256.ts:11](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/H256.ts#L11)* +*Defined in [H256.ts:11](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/H256.ts#L11)* **Parameters:** @@ -123,25 +123,12 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[raw](_codec_u8a_.u8a.md#raw)* -*Defined in [codec/U8a.ts:15](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L15)* +*Defined in [codec/U8a.ts:15](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L15)* ___ # Accessors - - -## bitLength - -getbitLength(): `number` - -*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* - -*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8aFixed.ts#L32)* - -**Returns:** `number` - -___ ## encodedLength @@ -150,7 +137,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:33](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L33)* +*Defined in [codec/U8a.ts:33](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L33)* **Returns:** `number` @@ -170,6 +157,19 @@ ___ **Returns:** `IterableIterator`<`number`> +___ + + +## bitLength + +▸ **bitLength**(): `number` + +*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* + +*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8aFixed.ts#L32)* + +**Returns:** `number` + ___ @@ -690,7 +690,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:39](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L39)* +*Defined in [codec/U8a.ts:39](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L39)* **Parameters:** @@ -710,7 +710,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L43)* **Returns:** `string` @@ -723,7 +723,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:47](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L47)* +*Defined in [codec/U8a.ts:47](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L47)* **Returns:** `any` @@ -753,7 +753,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:55](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L55)* +*Defined in [codec/U8a.ts:55](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L55)* **Returns:** `string` @@ -766,7 +766,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:51](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L51)* +*Defined in [codec/U8a.ts:51](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L51)* **Parameters:** diff --git a/docs/types/classes/_h512_.h512.md b/docs/types/classes/_h512_.h512.md index 71a4b46dbd..b249d469cb 100644 --- a/docs/types/classes/_h512_.h512.md +++ b/docs/types/classes/_h512_.h512.md @@ -25,7 +25,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [H512.ts:10](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/H512.ts#L10)* +*Defined in [H512.ts:10](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/H512.ts#L10)* **Parameters:** @@ -123,25 +123,12 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[raw](_codec_u8a_.u8a.md#raw)* -*Defined in [codec/U8a.ts:15](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L15)* +*Defined in [codec/U8a.ts:15](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L15)* ___ # Accessors - - -## bitLength - -getbitLength(): `number` - -*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* - -*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8aFixed.ts#L32)* - -**Returns:** `number` - -___ ## encodedLength @@ -150,7 +137,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:33](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L33)* +*Defined in [codec/U8a.ts:33](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L33)* **Returns:** `number` @@ -170,6 +157,19 @@ ___ **Returns:** `IterableIterator`<`number`> +___ + + +## bitLength + +▸ **bitLength**(): `number` + +*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* + +*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8aFixed.ts#L32)* + +**Returns:** `number` + ___ @@ -690,7 +690,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:39](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L39)* +*Defined in [codec/U8a.ts:39](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L39)* **Parameters:** @@ -710,7 +710,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L43)* **Returns:** `string` @@ -723,7 +723,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:47](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L47)* +*Defined in [codec/U8a.ts:47](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L47)* **Returns:** `any` @@ -753,7 +753,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:55](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L55)* +*Defined in [codec/U8a.ts:55](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L55)* **Returns:** `string` @@ -766,7 +766,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:51](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L51)* +*Defined in [codec/U8a.ts:51](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L51)* **Parameters:** diff --git a/docs/types/classes/_hash_.hash.md b/docs/types/classes/_hash_.hash.md index 8f637937d3..a6144aa787 100644 --- a/docs/types/classes/_hash_.hash.md +++ b/docs/types/classes/_hash_.hash.md @@ -29,7 +29,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [H256.ts:11](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/H256.ts#L11)* +*Defined in [H256.ts:11](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/H256.ts#L11)* **Parameters:** @@ -127,25 +127,12 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[raw](_codec_u8a_.u8a.md#raw)* -*Defined in [codec/U8a.ts:15](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L15)* +*Defined in [codec/U8a.ts:15](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L15)* ___ # Accessors - - -## bitLength - -getbitLength(): `number` - -*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* - -*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8aFixed.ts#L32)* - -**Returns:** `number` - -___ ## encodedLength @@ -154,7 +141,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:33](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L33)* +*Defined in [codec/U8a.ts:33](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L33)* **Returns:** `number` @@ -174,6 +161,19 @@ ___ **Returns:** `IterableIterator`<`number`> +___ + + +## bitLength + +▸ **bitLength**(): `number` + +*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* + +*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8aFixed.ts#L32)* + +**Returns:** `number` + ___ @@ -694,7 +694,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:39](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L39)* +*Defined in [codec/U8a.ts:39](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L39)* **Parameters:** @@ -714,7 +714,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L43)* **Returns:** `string` @@ -727,7 +727,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:47](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L47)* +*Defined in [codec/U8a.ts:47](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L47)* **Returns:** `any` @@ -757,7 +757,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:55](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L55)* +*Defined in [codec/U8a.ts:55](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L55)* **Returns:** `string` @@ -770,7 +770,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:51](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L51)* +*Defined in [codec/U8a.ts:51](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L51)* **Parameters:** diff --git a/docs/types/classes/_header_.header.md b/docs/types/classes/_header_.header.md index 44a46714a9..faad8b305e 100644 --- a/docs/types/classes/_header_.header.md +++ b/docs/types/classes/_header_.header.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Header.ts:26](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Header.ts#L26)* +*Defined in [Header.ts:26](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Header.ts#L26)* **Parameters:** @@ -58,7 +58,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L25)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L25)* ___ @@ -83,7 +83,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L123)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -94,7 +94,7 @@ ___ getblockNumber(): [BlockNumber](_blocknumber_.blocknumber.md) -*Defined in [Header.ts:37](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Header.ts#L37)* +*Defined in [Header.ts:37](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Header.ts#L37)* **Returns:** [BlockNumber](_blocknumber_.blocknumber.md) @@ -105,7 +105,7 @@ ___ getdigest(): [Digest](_digest_.digest.md) -*Defined in [Header.ts:41](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Header.ts#L41)* +*Defined in [Header.ts:41](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Header.ts#L41)* **Returns:** [Digest](_digest_.digest.md) @@ -118,7 +118,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L127)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -129,7 +129,7 @@ ___ getextrinsicsRoot(): [Hash](_hash_.hash.md) -*Defined in [Header.ts:45](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Header.ts#L45)* +*Defined in [Header.ts:45](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Header.ts#L45)* **Returns:** [Hash](_hash_.hash.md) @@ -140,7 +140,7 @@ ___ gethash(): [Hash](_hash_.hash.md) -*Defined in [Header.ts:50](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Header.ts#L50)* +*Defined in [Header.ts:50](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Header.ts#L50)* **Returns:** [Hash](_hash_.hash.md) @@ -151,7 +151,7 @@ ___ getparentHash(): [Hash](_hash_.hash.md) -*Defined in [Header.ts:56](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Header.ts#L56)* +*Defined in [Header.ts:56](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Header.ts#L56)* **Returns:** [Hash](_hash_.hash.md) @@ -162,7 +162,7 @@ ___ getstateRoot(): [Hash](_hash_.hash.md) -*Defined in [Header.ts:60](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Header.ts#L60)* +*Defined in [Header.ts:60](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Header.ts#L60)* **Returns:** [Hash](_hash_.hash.md) @@ -279,7 +279,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L133)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -352,7 +352,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L137)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -365,7 +365,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L141)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -378,7 +378,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L145)* **Returns:** `any` @@ -391,7 +391,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L156)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -404,7 +404,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -438,7 +438,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L113)* +*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/types/classes/_keyvalue_.keyvalue.md b/docs/types/classes/_keyvalue_.keyvalue.md index e890278797..0a7f873ed4 100644 --- a/docs/types/classes/_keyvalue_.keyvalue.md +++ b/docs/types/classes/_keyvalue_.keyvalue.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [KeyValue.ts:23](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/KeyValue.ts#L23)* +*Defined in [KeyValue.ts:23](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/KeyValue.ts#L23)* **Parameters:** @@ -58,7 +58,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L25)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L25)* ___ @@ -83,7 +83,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L123)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -96,7 +96,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L127)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -107,7 +107,7 @@ ___ getkey(): [StorageKey](_storagekey_.storagekey.md) -*Defined in [KeyValue.ts:31](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/KeyValue.ts#L31)* +*Defined in [KeyValue.ts:31](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/KeyValue.ts#L31)* **Returns:** [StorageKey](_storagekey_.storagekey.md) @@ -118,7 +118,7 @@ ___ getvalue(): [StorageData](_storagedata_.storagedata.md) -*Defined in [KeyValue.ts:35](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/KeyValue.ts#L35)* +*Defined in [KeyValue.ts:35](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/KeyValue.ts#L35)* **Returns:** [StorageData](_storagedata_.storagedata.md) @@ -235,7 +235,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L133)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -308,7 +308,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L137)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -321,7 +321,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L141)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -334,7 +334,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L145)* **Returns:** `any` @@ -347,7 +347,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L156)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -360,7 +360,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -394,7 +394,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L113)* +*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/types/classes/_keyvalue_.keyvalueoption.md b/docs/types/classes/_keyvalue_.keyvalueoption.md index f35cd2e676..7748a10ad1 100644 --- a/docs/types/classes/_keyvalue_.keyvalueoption.md +++ b/docs/types/classes/_keyvalue_.keyvalueoption.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [KeyValue.ts:48](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/KeyValue.ts#L48)* +*Defined in [KeyValue.ts:48](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/KeyValue.ts#L48)* **Parameters:** @@ -58,7 +58,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L25)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L25)* ___ @@ -83,7 +83,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L123)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -96,7 +96,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L127)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -107,7 +107,7 @@ ___ getkey(): [StorageKey](_storagekey_.storagekey.md) -*Defined in [KeyValue.ts:56](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/KeyValue.ts#L56)* +*Defined in [KeyValue.ts:56](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/KeyValue.ts#L56)* **Returns:** [StorageKey](_storagekey_.storagekey.md) @@ -118,7 +118,7 @@ ___ getvalue(): [Option](_codec_option_.option.md)<[StorageData](_storagedata_.storagedata.md)> -*Defined in [KeyValue.ts:60](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/KeyValue.ts#L60)* +*Defined in [KeyValue.ts:60](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/KeyValue.ts#L60)* **Returns:** [Option](_codec_option_.option.md)<[StorageData](_storagedata_.storagedata.md)> @@ -235,7 +235,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L133)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -308,7 +308,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L137)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -321,7 +321,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L141)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -336,7 +336,7 @@ ___ *Overrides [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Tuple.ts:28](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Tuple.ts#L28)* +*Defined in [codec/Tuple.ts:28](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Tuple.ts#L28)* **Returns:** `any` @@ -349,7 +349,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L156)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -362,7 +362,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -398,7 +398,7 @@ ___ *Overrides [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Tuple.ts:18](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Tuple.ts#L18)* +*Defined in [codec/Tuple.ts:18](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Tuple.ts#L18)* **Type parameters:** diff --git a/docs/types/classes/_metadata_.callmetadata.md b/docs/types/classes/_metadata_.callmetadata.md index 204026c8ca..d0b752f905 100644 --- a/docs/types/classes/_metadata_.callmetadata.md +++ b/docs/types/classes/_metadata_.callmetadata.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata.ts:164](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Metadata.ts#L164)* +*Defined in [Metadata.ts:164](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Metadata.ts#L164)* **Parameters:** @@ -58,7 +58,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L25)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L25)* ___ @@ -83,7 +83,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L123)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -96,7 +96,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L127)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -107,7 +107,7 @@ ___ getfunctions(): [Vector](_codec_vector_.vector.md)<[FunctionMetadata](_metadata_.functionmetadata.md)> -*Defined in [Metadata.ts:172](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Metadata.ts#L172)* +*Defined in [Metadata.ts:172](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Metadata.ts#L172)* **Returns:** [Vector](_codec_vector_.vector.md)<[FunctionMetadata](_metadata_.functionmetadata.md)> @@ -118,7 +118,7 @@ ___ getname(): [Text](_text_.text.md) -*Defined in [Metadata.ts:176](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Metadata.ts#L176)* +*Defined in [Metadata.ts:176](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Metadata.ts#L176)* **Returns:** [Text](_text_.text.md) @@ -235,7 +235,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L133)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -308,7 +308,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L137)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -321,7 +321,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L141)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -334,7 +334,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L145)* **Returns:** `any` @@ -347,7 +347,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L156)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -360,7 +360,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -394,7 +394,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L113)* +*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/types/classes/_metadata_.eventmetadata.md b/docs/types/classes/_metadata_.eventmetadata.md index e1fa78e3d9..3cd78a341a 100644 --- a/docs/types/classes/_metadata_.eventmetadata.md +++ b/docs/types/classes/_metadata_.eventmetadata.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata.ts:64](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Metadata.ts#L64)* +*Defined in [Metadata.ts:64](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Metadata.ts#L64)* **Parameters:** @@ -58,7 +58,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L25)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L25)* ___ @@ -83,7 +83,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L123)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -94,7 +94,7 @@ ___ getarguments(): [Vector](_codec_vector_.vector.md)<[Type](_type_.type.md)> -*Defined in [Metadata.ts:73](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Metadata.ts#L73)* +*Defined in [Metadata.ts:73](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Metadata.ts#L73)* **Returns:** [Vector](_codec_vector_.vector.md)<[Type](_type_.type.md)> @@ -105,7 +105,7 @@ ___ getdocumentation(): [Vector](_codec_vector_.vector.md)<[Text](_text_.text.md)> -*Defined in [Metadata.ts:77](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Metadata.ts#L77)* +*Defined in [Metadata.ts:77](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Metadata.ts#L77)* **Returns:** [Vector](_codec_vector_.vector.md)<[Text](_text_.text.md)> @@ -118,7 +118,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L127)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -129,7 +129,7 @@ ___ getname(): [Text](_text_.text.md) -*Defined in [Metadata.ts:81](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Metadata.ts#L81)* +*Defined in [Metadata.ts:81](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Metadata.ts#L81)* **Returns:** [Text](_text_.text.md) @@ -246,7 +246,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L133)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -319,7 +319,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L137)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -332,7 +332,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L141)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -345,7 +345,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L145)* **Returns:** `any` @@ -358,7 +358,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L156)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -371,7 +371,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -405,7 +405,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L113)* +*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/types/classes/_metadata_.functionargumentmetadata.md b/docs/types/classes/_metadata_.functionargumentmetadata.md index 9d7272af3a..008bc9826a 100644 --- a/docs/types/classes/_metadata_.functionargumentmetadata.md +++ b/docs/types/classes/_metadata_.functionargumentmetadata.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata.ts:120](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Metadata.ts#L120)* +*Defined in [Metadata.ts:120](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Metadata.ts#L120)* **Parameters:** @@ -58,7 +58,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L25)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L25)* ___ @@ -83,7 +83,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L123)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -96,7 +96,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L127)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -107,7 +107,7 @@ ___ getname(): [Text](_text_.text.md) -*Defined in [Metadata.ts:128](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Metadata.ts#L128)* +*Defined in [Metadata.ts:128](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Metadata.ts#L128)* **Returns:** [Text](_text_.text.md) @@ -118,7 +118,7 @@ ___ gettype(): [Type](_type_.type.md) -*Defined in [Metadata.ts:132](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Metadata.ts#L132)* +*Defined in [Metadata.ts:132](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Metadata.ts#L132)* **Returns:** [Type](_type_.type.md) @@ -235,7 +235,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L133)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -308,7 +308,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L137)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -321,7 +321,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L141)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -334,7 +334,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L145)* **Returns:** `any` @@ -347,7 +347,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L156)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -360,7 +360,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -394,7 +394,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L113)* +*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/types/classes/_metadata_.functionmetadata.md b/docs/types/classes/_metadata_.functionmetadata.md index e87a8e7f2e..7aafe85cf0 100644 --- a/docs/types/classes/_metadata_.functionmetadata.md +++ b/docs/types/classes/_metadata_.functionmetadata.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata.ts:137](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Metadata.ts#L137)* +*Defined in [Metadata.ts:137](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Metadata.ts#L137)* **Parameters:** @@ -58,7 +58,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L25)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L25)* ___ @@ -83,7 +83,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L123)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -94,7 +94,7 @@ ___ getarguments(): [Vector](_codec_vector_.vector.md)<[FunctionArgumentMetadata](_metadata_.functionargumentmetadata.md)> -*Defined in [Metadata.ts:147](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Metadata.ts#L147)* +*Defined in [Metadata.ts:147](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Metadata.ts#L147)* **Returns:** [Vector](_codec_vector_.vector.md)<[FunctionArgumentMetadata](_metadata_.functionargumentmetadata.md)> @@ -105,7 +105,7 @@ ___ getdocumentation(): [Vector](_codec_vector_.vector.md)<[Text](_text_.text.md)> -*Defined in [Metadata.ts:151](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Metadata.ts#L151)* +*Defined in [Metadata.ts:151](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Metadata.ts#L151)* **Returns:** [Vector](_codec_vector_.vector.md)<[Text](_text_.text.md)> @@ -118,7 +118,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L127)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -129,7 +129,7 @@ ___ getid(): [U16](_u16_.u16.md) -*Defined in [Metadata.ts:155](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Metadata.ts#L155)* +*Defined in [Metadata.ts:155](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Metadata.ts#L155)* **Returns:** [U16](_u16_.u16.md) @@ -140,7 +140,7 @@ ___ getname(): [Text](_text_.text.md) -*Defined in [Metadata.ts:159](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Metadata.ts#L159)* +*Defined in [Metadata.ts:159](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Metadata.ts#L159)* **Returns:** [Text](_text_.text.md) @@ -257,7 +257,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L133)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -330,7 +330,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L137)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -343,7 +343,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L141)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -356,7 +356,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L145)* **Returns:** `any` @@ -369,7 +369,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L156)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -382,7 +382,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -416,7 +416,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L113)* +*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/types/classes/_metadata_.modulemetadata.md b/docs/types/classes/_metadata_.modulemetadata.md index f77e575cc1..ef2b6dbe9d 100644 --- a/docs/types/classes/_metadata_.modulemetadata.md +++ b/docs/types/classes/_metadata_.modulemetadata.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata.ts:181](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Metadata.ts#L181)* +*Defined in [Metadata.ts:181](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Metadata.ts#L181)* **Parameters:** @@ -58,7 +58,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L25)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L25)* ___ @@ -83,7 +83,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L123)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -94,7 +94,7 @@ ___ getcall(): [CallMetadata](_metadata_.callmetadata.md) -*Defined in [Metadata.ts:189](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Metadata.ts#L189)* +*Defined in [Metadata.ts:189](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Metadata.ts#L189)* **Returns:** [CallMetadata](_metadata_.callmetadata.md) @@ -107,7 +107,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L127)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -118,7 +118,7 @@ ___ getname(): [Text](_text_.text.md) -*Defined in [Metadata.ts:193](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Metadata.ts#L193)* +*Defined in [Metadata.ts:193](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Metadata.ts#L193)* **Returns:** [Text](_text_.text.md) @@ -235,7 +235,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L133)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -308,7 +308,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L137)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -321,7 +321,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L141)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -334,7 +334,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L145)* **Returns:** `any` @@ -347,7 +347,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L156)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -360,7 +360,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -394,7 +394,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L113)* +*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/types/classes/_metadata_.outerdispatchcall.md b/docs/types/classes/_metadata_.outerdispatchcall.md index 6588d4efef..ac2e519405 100644 --- a/docs/types/classes/_metadata_.outerdispatchcall.md +++ b/docs/types/classes/_metadata_.outerdispatchcall.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata.ts:25](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Metadata.ts#L25)* +*Defined in [Metadata.ts:25](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Metadata.ts#L25)* **Parameters:** @@ -58,7 +58,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L25)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L25)* ___ @@ -83,7 +83,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L123)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -96,7 +96,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L127)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -107,7 +107,7 @@ ___ getindex(): [U16](_u16_.u16.md) -*Defined in [Metadata.ts:34](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Metadata.ts#L34)* +*Defined in [Metadata.ts:34](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Metadata.ts#L34)* **Returns:** [U16](_u16_.u16.md) @@ -118,7 +118,7 @@ ___ getname(): [Text](_text_.text.md) -*Defined in [Metadata.ts:38](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Metadata.ts#L38)* +*Defined in [Metadata.ts:38](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Metadata.ts#L38)* **Returns:** [Text](_text_.text.md) @@ -129,7 +129,7 @@ ___ getprefix(): [Text](_text_.text.md) -*Defined in [Metadata.ts:42](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Metadata.ts#L42)* +*Defined in [Metadata.ts:42](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Metadata.ts#L42)* **Returns:** [Text](_text_.text.md) @@ -246,7 +246,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L133)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -319,7 +319,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L137)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -332,7 +332,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L141)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -345,7 +345,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L145)* **Returns:** `any` @@ -358,7 +358,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L156)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -371,7 +371,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -405,7 +405,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L113)* +*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/types/classes/_metadata_.outerdispatchmetadata.md b/docs/types/classes/_metadata_.outerdispatchmetadata.md index 8ac489d0c3..5f84f29c0d 100644 --- a/docs/types/classes/_metadata_.outerdispatchmetadata.md +++ b/docs/types/classes/_metadata_.outerdispatchmetadata.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata.ts:47](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Metadata.ts#L47)* +*Defined in [Metadata.ts:47](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Metadata.ts#L47)* **Parameters:** @@ -58,7 +58,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L25)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L25)* ___ @@ -83,7 +83,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L123)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -94,7 +94,7 @@ ___ getcalls(): [Vector](_codec_vector_.vector.md)<[OuterDispatchCall](_metadata_.outerdispatchcall.md)> -*Defined in [Metadata.ts:55](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Metadata.ts#L55)* +*Defined in [Metadata.ts:55](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Metadata.ts#L55)* **Returns:** [Vector](_codec_vector_.vector.md)<[OuterDispatchCall](_metadata_.outerdispatchcall.md)> @@ -107,7 +107,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L127)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -118,7 +118,7 @@ ___ getname(): [Text](_text_.text.md) -*Defined in [Metadata.ts:59](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Metadata.ts#L59)* +*Defined in [Metadata.ts:59](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Metadata.ts#L59)* **Returns:** [Text](_text_.text.md) @@ -235,7 +235,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L133)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -308,7 +308,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L137)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -321,7 +321,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L141)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -334,7 +334,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L145)* **Returns:** `any` @@ -347,7 +347,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L156)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -360,7 +360,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -394,7 +394,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L113)* +*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/types/classes/_metadata_.outereventmetadata.md b/docs/types/classes/_metadata_.outereventmetadata.md index af74f13ae2..f34d3a455f 100644 --- a/docs/types/classes/_metadata_.outereventmetadata.md +++ b/docs/types/classes/_metadata_.outereventmetadata.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata.ts:103](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Metadata.ts#L103)* +*Defined in [Metadata.ts:103](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Metadata.ts#L103)* **Parameters:** @@ -58,7 +58,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L25)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L25)* ___ @@ -83,7 +83,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L123)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -96,7 +96,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L127)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -107,7 +107,7 @@ ___ getevents(): [Vector](_codec_vector_.vector.md)<[OuterEventMetadataEvent](_metadata_.outereventmetadataevent.md)> -*Defined in [Metadata.ts:111](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Metadata.ts#L111)* +*Defined in [Metadata.ts:111](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Metadata.ts#L111)* **Returns:** [Vector](_codec_vector_.vector.md)<[OuterEventMetadataEvent](_metadata_.outereventmetadataevent.md)> @@ -118,7 +118,7 @@ ___ getname(): [Text](_text_.text.md) -*Defined in [Metadata.ts:115](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Metadata.ts#L115)* +*Defined in [Metadata.ts:115](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Metadata.ts#L115)* **Returns:** [Text](_text_.text.md) @@ -235,7 +235,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L133)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -308,7 +308,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L137)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -321,7 +321,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L141)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -334,7 +334,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L145)* **Returns:** `any` @@ -347,7 +347,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L156)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -360,7 +360,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -394,7 +394,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L113)* +*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/types/classes/_metadata_.outereventmetadataevent.md b/docs/types/classes/_metadata_.outereventmetadataevent.md index 101b7c3949..a6d7609fbf 100644 --- a/docs/types/classes/_metadata_.outereventmetadataevent.md +++ b/docs/types/classes/_metadata_.outereventmetadataevent.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata.ts:86](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Metadata.ts#L86)* +*Defined in [Metadata.ts:86](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Metadata.ts#L86)* **Parameters:** @@ -58,7 +58,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L25)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L25)* ___ @@ -83,7 +83,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L123)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -96,7 +96,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L127)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -107,7 +107,7 @@ ___ getevents(): [Vector](_codec_vector_.vector.md)<[EventMetadata](_metadata_.eventmetadata.md)> -*Defined in [Metadata.ts:94](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Metadata.ts#L94)* +*Defined in [Metadata.ts:94](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Metadata.ts#L94)* **Returns:** [Vector](_codec_vector_.vector.md)<[EventMetadata](_metadata_.eventmetadata.md)> @@ -118,7 +118,7 @@ ___ getname(): [Text](_text_.text.md) -*Defined in [Metadata.ts:98](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Metadata.ts#L98)* +*Defined in [Metadata.ts:98](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Metadata.ts#L98)* **Returns:** [Text](_text_.text.md) @@ -235,7 +235,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L133)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -308,7 +308,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L137)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -321,7 +321,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L141)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -336,7 +336,7 @@ ___ *Overrides [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Tuple.ts:28](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Tuple.ts#L28)* +*Defined in [codec/Tuple.ts:28](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Tuple.ts#L28)* **Returns:** `any` @@ -349,7 +349,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L156)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -362,7 +362,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -398,7 +398,7 @@ ___ *Overrides [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Tuple.ts:18](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Tuple.ts#L18)* +*Defined in [codec/Tuple.ts:18](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Tuple.ts#L18)* **Type parameters:** diff --git a/docs/types/classes/_metadata_.runtimemetadata.md b/docs/types/classes/_metadata_.runtimemetadata.md index 0e40a76a33..8ff9668d1d 100644 --- a/docs/types/classes/_metadata_.runtimemetadata.md +++ b/docs/types/classes/_metadata_.runtimemetadata.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata.ts:325](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Metadata.ts#L325)* +*Defined in [Metadata.ts:325](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Metadata.ts#L325)* **Parameters:** @@ -58,7 +58,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L25)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L25)* ___ @@ -83,7 +83,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L123)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -94,7 +94,7 @@ ___ getcalls(): [Vector](_codec_vector_.vector.md)<[OuterDispatchCall](_metadata_.outerdispatchcall.md)> -*Defined in [Metadata.ts:364](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Metadata.ts#L364)* +*Defined in [Metadata.ts:364](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Metadata.ts#L364)* **Returns:** [Vector](_codec_vector_.vector.md)<[OuterDispatchCall](_metadata_.outerdispatchcall.md)> @@ -107,7 +107,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L127)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -118,7 +118,7 @@ ___ getevents(): [Vector](_codec_vector_.vector.md)<[OuterEventMetadataEvent](_metadata_.outereventmetadataevent.md)> -*Defined in [Metadata.ts:368](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Metadata.ts#L368)* +*Defined in [Metadata.ts:368](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Metadata.ts#L368)* **Returns:** [Vector](_codec_vector_.vector.md)<[OuterEventMetadataEvent](_metadata_.outereventmetadataevent.md)> @@ -129,7 +129,7 @@ ___ getmodules(): [Vector](_codec_vector_.vector.md)<[RuntimeModuleMetadata](_metadata_.runtimemodulemetadata.md)> -*Defined in [Metadata.ts:372](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Metadata.ts#L372)* +*Defined in [Metadata.ts:372](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Metadata.ts#L372)* **Returns:** [Vector](_codec_vector_.vector.md)<[RuntimeModuleMetadata](_metadata_.runtimemodulemetadata.md)> @@ -246,7 +246,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L133)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -263,7 +263,7 @@ ___ ▸ **getUniqTypes**(): `Array`<`string`> -*Defined in [Metadata.ts:377](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Metadata.ts#L377)* +*Defined in [Metadata.ts:377](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Metadata.ts#L377)* **Returns:** `Array`<`string`> @@ -330,7 +330,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L137)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -343,7 +343,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L141)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -356,7 +356,7 @@ ___ *Overrides [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [Metadata.ts:360](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Metadata.ts#L360)* +*Defined in [Metadata.ts:360](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Metadata.ts#L360)* **Returns:** `any` @@ -369,7 +369,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L156)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -382,7 +382,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -414,7 +414,7 @@ ___ ▸ **decodeMetadata**(value: * `string` | `Uint8Array` | `any`*): `any` | `Uint8Array` -*Defined in [Metadata.ts:334](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Metadata.ts#L334)* +*Defined in [Metadata.ts:334](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Metadata.ts#L334)* **Parameters:** @@ -433,7 +433,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L113)* +*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/types/classes/_metadata_.runtimemodulemetadata.md b/docs/types/classes/_metadata_.runtimemodulemetadata.md index 88249dcd1c..5ecb3bc8c6 100644 --- a/docs/types/classes/_metadata_.runtimemodulemetadata.md +++ b/docs/types/classes/_metadata_.runtimemodulemetadata.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata.ts:299](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Metadata.ts#L299)* +*Defined in [Metadata.ts:299](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Metadata.ts#L299)* **Parameters:** @@ -58,7 +58,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L25)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L25)* ___ @@ -83,7 +83,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L123)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -96,7 +96,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L127)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -107,7 +107,7 @@ ___ getmodule(): [ModuleMetadata](_metadata_.modulemetadata.md) -*Defined in [Metadata.ts:308](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Metadata.ts#L308)* +*Defined in [Metadata.ts:308](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Metadata.ts#L308)* **Returns:** [ModuleMetadata](_metadata_.modulemetadata.md) @@ -118,7 +118,7 @@ ___ getprefix(): [Text](_text_.text.md) -*Defined in [Metadata.ts:312](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Metadata.ts#L312)* +*Defined in [Metadata.ts:312](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Metadata.ts#L312)* **Returns:** [Text](_text_.text.md) @@ -129,7 +129,7 @@ ___ getstorage(): [StorageMetadata](_metadata_.storagemetadata.md) | `undefined` -*Defined in [Metadata.ts:316](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Metadata.ts#L316)* +*Defined in [Metadata.ts:316](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Metadata.ts#L316)* **Returns:** [StorageMetadata](_metadata_.storagemetadata.md) | `undefined` @@ -246,7 +246,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L133)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -319,7 +319,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L137)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -332,7 +332,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L141)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -345,7 +345,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L145)* **Returns:** `any` @@ -358,7 +358,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L156)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -371,7 +371,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -405,7 +405,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L113)* +*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/types/classes/_metadata_.storagefunctionmetadata.md b/docs/types/classes/_metadata_.storagefunctionmetadata.md index 1435e2cdf0..a43b75c9cc 100644 --- a/docs/types/classes/_metadata_.storagefunctionmetadata.md +++ b/docs/types/classes/_metadata_.storagefunctionmetadata.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata.ts:255](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Metadata.ts#L255)* +*Defined in [Metadata.ts:255](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Metadata.ts#L255)* **Parameters:** @@ -58,7 +58,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L25)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L25)* ___ @@ -83,7 +83,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L123)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -94,7 +94,7 @@ ___ getdocumentation(): [Vector](_codec_vector_.vector.md)<[Text](_text_.text.md)> -*Defined in [Metadata.ts:265](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Metadata.ts#L265)* +*Defined in [Metadata.ts:265](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Metadata.ts#L265)* **Returns:** [Vector](_codec_vector_.vector.md)<[Text](_text_.text.md)> @@ -107,7 +107,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L127)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -118,7 +118,7 @@ ___ getmodifier(): [StorageFunctionModifier](_metadata_.storagefunctionmodifier.md) -*Defined in [Metadata.ts:273](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Metadata.ts#L273)* +*Defined in [Metadata.ts:273](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Metadata.ts#L273)* **Returns:** [StorageFunctionModifier](_metadata_.storagefunctionmodifier.md) @@ -129,7 +129,7 @@ ___ getname(): [Text](_text_.text.md) -*Defined in [Metadata.ts:269](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Metadata.ts#L269)* +*Defined in [Metadata.ts:269](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Metadata.ts#L269)* **Returns:** [Text](_text_.text.md) @@ -140,7 +140,7 @@ ___ gettype(): [StorageFunctionType](_metadata_.storagefunctiontype.md) -*Defined in [Metadata.ts:277](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Metadata.ts#L277)* +*Defined in [Metadata.ts:277](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Metadata.ts#L277)* **Returns:** [StorageFunctionType](_metadata_.storagefunctiontype.md) @@ -257,7 +257,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L133)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -330,7 +330,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L137)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -343,7 +343,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L141)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -356,7 +356,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L145)* **Returns:** `any` @@ -369,7 +369,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L156)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -382,7 +382,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -416,7 +416,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L113)* +*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/types/classes/_metadata_.storagefunctionmodifier.md b/docs/types/classes/_metadata_.storagefunctionmodifier.md index b5958a14bb..a21f9aefa2 100644 --- a/docs/types/classes/_metadata_.storagefunctionmodifier.md +++ b/docs/types/classes/_metadata_.storagefunctionmodifier.md @@ -16,7 +16,7 @@ *Overrides [Enum](_codec_enum_.enum.md).[constructor](_codec_enum_.enum.md#constructor)* -*Defined in [Metadata.ts:198](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Metadata.ts#L198)* +*Defined in [Metadata.ts:198](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Metadata.ts#L198)* **Parameters:** @@ -38,7 +38,7 @@ ___ *Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Base.ts#L19)* ___ @@ -54,7 +54,7 @@ getencodedLength(): `number` *Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* -*Defined in [codec/Enum.ts:41](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Enum.ts#L41)* +*Defined in [codec/Enum.ts:41](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Enum.ts#L41)* **Returns:** `number` @@ -72,7 +72,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* -*Defined in [codec/Enum.ts:45](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Enum.ts#L45)* +*Defined in [codec/Enum.ts:45](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Enum.ts#L45)* **Returns:** `any` @@ -85,7 +85,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[toNumber](_codec_enum_.enum.md#tonumber)* -*Defined in [codec/Enum.ts:49](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Enum.ts#L49)* +*Defined in [codec/Enum.ts:49](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Enum.ts#L49)* **Returns:** `number` @@ -100,7 +100,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* -*Defined in [codec/Enum.ts:53](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Enum.ts#L53)* +*Defined in [codec/Enum.ts:53](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Enum.ts#L53)* **Returns:** `string` @@ -115,7 +115,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* -*Defined in [codec/Enum.ts:57](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Enum.ts#L57)* +*Defined in [codec/Enum.ts:57](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Enum.ts#L57)* **Parameters:** @@ -134,7 +134,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[decodeEnum](_codec_enum_.enum.md#decodeenum)* -*Defined in [codec/Enum.ts:31](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Enum.ts#L31)* +*Defined in [codec/Enum.ts:31](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Enum.ts#L31)* **Parameters:** diff --git a/docs/types/classes/_metadata_.storagefunctiontype.md b/docs/types/classes/_metadata_.storagefunctiontype.md index 3511d7c88a..b835d87273 100644 --- a/docs/types/classes/_metadata_.storagefunctiontype.md +++ b/docs/types/classes/_metadata_.storagefunctiontype.md @@ -16,7 +16,7 @@ *Overrides [EnumType](_codec_enumtype_.enumtype.md).[constructor](_codec_enumtype_.enumtype.md#constructor)* -*Defined in [Metadata.ts:221](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Metadata.ts#L221)* +*Defined in [Metadata.ts:221](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Metadata.ts#L221)* **Parameters:** @@ -39,7 +39,7 @@ ___ *Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Base.ts#L19)* ___ @@ -51,7 +51,7 @@ ___ getasMap(): [StorageFunctionType$Map](_metadata_.storagefunctiontype_map.md) -*Defined in [Metadata.ts:233](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Metadata.ts#L233)* +*Defined in [Metadata.ts:233](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Metadata.ts#L233)* **Returns:** [StorageFunctionType$Map](_metadata_.storagefunctiontype_map.md) @@ -62,7 +62,7 @@ ___ getasType(): [Type](_type_.type.md) -*Defined in [Metadata.ts:237](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Metadata.ts#L237)* +*Defined in [Metadata.ts:237](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Metadata.ts#L237)* **Returns:** [Type](_type_.type.md) @@ -77,7 +77,7 @@ getencodedLength(): `number` *Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* -*Defined in [codec/EnumType.ts:94](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/EnumType.ts#L94)* +*Defined in [codec/EnumType.ts:94](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/EnumType.ts#L94)* **Returns:** `number` @@ -88,7 +88,7 @@ ___ getisMap(): `boolean` -*Defined in [Metadata.ts:229](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Metadata.ts#L229)* +*Defined in [Metadata.ts:229](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Metadata.ts#L229)* **Returns:** `boolean` @@ -101,7 +101,7 @@ getisNull(): `boolean` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNull](_codec_enumtype_.enumtype.md#isnull)* -*Defined in [codec/EnumType.ts:82](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/EnumType.ts#L82)* +*Defined in [codec/EnumType.ts:82](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/EnumType.ts#L82)* **Returns:** `boolean` @@ -114,7 +114,7 @@ gettype(): `string` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[type](_codec_enumtype_.enumtype.md#type)* -*Defined in [codec/EnumType.ts:86](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/EnumType.ts#L86)* +*Defined in [codec/EnumType.ts:86](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/EnumType.ts#L86)* **Returns:** `string` @@ -127,7 +127,7 @@ getvalue(): [Base](_codec_base_.base.md)< [Type](_type_.type.md) | [Storage *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[value](_codec_enumtype_.enumtype.md#value)* -*Defined in [codec/EnumType.ts:90](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/EnumType.ts#L90)* +*Defined in [codec/EnumType.ts:90](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/EnumType.ts#L90)* **Returns:** [Base](_codec_base_.base.md)< [Type](_type_.type.md) | [StorageFunctionType$Map](_metadata_.storagefunctiontype_map.md)> @@ -143,7 +143,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[setValue](_codec_enumtype_.enumtype.md#setvalue)* -*Defined in [codec/EnumType.ts:98](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/EnumType.ts#L98)* +*Defined in [codec/EnumType.ts:98](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/EnumType.ts#L98)* **Parameters:** @@ -165,7 +165,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* -*Defined in [codec/EnumType.ts:115](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/EnumType.ts#L115)* +*Defined in [codec/EnumType.ts:115](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/EnumType.ts#L115)* **Returns:** `any` @@ -178,7 +178,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toNumber](_codec_enumtype_.enumtype.md#tonumber)* -*Defined in [codec/EnumType.ts:119](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/EnumType.ts#L119)* +*Defined in [codec/EnumType.ts:119](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/EnumType.ts#L119)* **Returns:** `number` @@ -191,7 +191,7 @@ ___ *Overrides [EnumType](_codec_enumtype_.enumtype.md).[toString](_codec_enumtype_.enumtype.md#tostring)* -*Defined in [Metadata.ts:241](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Metadata.ts#L241)* +*Defined in [Metadata.ts:241](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Metadata.ts#L241)* **Returns:** `string` @@ -206,7 +206,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* -*Defined in [codec/EnumType.ts:127](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/EnumType.ts#L127)* +*Defined in [codec/EnumType.ts:127](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/EnumType.ts#L127)* **Parameters:** @@ -225,7 +225,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[decodeEnumType](_codec_enumtype_.enumtype.md#decodeenumtype)* -*Defined in [codec/EnumType.ts:45](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/EnumType.ts#L45)* +*Defined in [codec/EnumType.ts:45](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/EnumType.ts#L45)* **Type parameters:** diff --git a/docs/types/classes/_metadata_.storagefunctiontype_map.md b/docs/types/classes/_metadata_.storagefunctiontype_map.md index a3e06eebe6..5bf1b043e8 100644 --- a/docs/types/classes/_metadata_.storagefunctiontype_map.md +++ b/docs/types/classes/_metadata_.storagefunctiontype_map.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata.ts:204](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Metadata.ts#L204)* +*Defined in [Metadata.ts:204](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Metadata.ts#L204)* **Parameters:** @@ -58,7 +58,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L25)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L25)* ___ @@ -83,7 +83,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L123)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -96,7 +96,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L127)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -107,7 +107,7 @@ ___ getkey(): [Type](_type_.type.md) -*Defined in [Metadata.ts:212](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Metadata.ts#L212)* +*Defined in [Metadata.ts:212](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Metadata.ts#L212)* **Returns:** [Type](_type_.type.md) @@ -118,7 +118,7 @@ ___ getvalue(): [Type](_type_.type.md) -*Defined in [Metadata.ts:216](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Metadata.ts#L216)* +*Defined in [Metadata.ts:216](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Metadata.ts#L216)* **Returns:** [Type](_type_.type.md) @@ -235,7 +235,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L133)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -308,7 +308,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L137)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -321,7 +321,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L141)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -334,7 +334,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L145)* **Returns:** `any` @@ -347,7 +347,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L156)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -360,7 +360,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -394,7 +394,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L113)* +*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/types/classes/_metadata_.storagemetadata.md b/docs/types/classes/_metadata_.storagemetadata.md index 62c4b1852e..a3e6822e6f 100644 --- a/docs/types/classes/_metadata_.storagemetadata.md +++ b/docs/types/classes/_metadata_.storagemetadata.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata.ts:282](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Metadata.ts#L282)* +*Defined in [Metadata.ts:282](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Metadata.ts#L282)* **Parameters:** @@ -58,7 +58,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L25)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L25)* ___ @@ -83,7 +83,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L123)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -96,7 +96,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L127)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -107,7 +107,7 @@ ___ getfunctions(): [Vector](_codec_vector_.vector.md)<[StorageFunctionMetadata](_metadata_.storagefunctionmetadata.md)> -*Defined in [Metadata.ts:290](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Metadata.ts#L290)* +*Defined in [Metadata.ts:290](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Metadata.ts#L290)* **Returns:** [Vector](_codec_vector_.vector.md)<[StorageFunctionMetadata](_metadata_.storagefunctionmetadata.md)> @@ -118,7 +118,7 @@ ___ getprefix(): [Text](_text_.text.md) -*Defined in [Metadata.ts:294](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Metadata.ts#L294)* +*Defined in [Metadata.ts:294](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Metadata.ts#L294)* **Returns:** [Text](_text_.text.md) @@ -235,7 +235,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L133)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -308,7 +308,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L137)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -321,7 +321,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L141)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -334,7 +334,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L145)* **Returns:** `any` @@ -347,7 +347,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L156)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -360,7 +360,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -394,7 +394,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L113)* +*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/types/classes/_method_.method.md b/docs/types/classes/_method_.method.md index f4c9754831..c32c1e3c11 100644 --- a/docs/types/classes/_method_.method.md +++ b/docs/types/classes/_method_.method.md @@ -29,7 +29,7 @@ Extrinsic function descriptor, as defined in [https://github.com/paritytech/wiki *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Method.ts:47](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Method.ts#L47)* +*Defined in [Method.ts:47](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Method.ts#L47)* **Parameters:** @@ -63,7 +63,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L25)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L25)* ___ @@ -88,7 +88,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L123)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -99,7 +99,7 @@ ___ getargs(): `Array`<[Base](_codec_base_.base.md)> -*Defined in [Method.ts:169](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Method.ts#L169)* +*Defined in [Method.ts:169](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Method.ts#L169)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -110,7 +110,7 @@ ___ getargsDef(): `ArgsDef` -*Defined in [Method.ts:174](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Method.ts#L174)* +*Defined in [Method.ts:174](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Method.ts#L174)* **Returns:** `ArgsDef` @@ -121,7 +121,7 @@ ___ getcallIndex(): `Uint8Array` -*Defined in [Method.ts:178](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Method.ts#L178)* +*Defined in [Method.ts:178](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Method.ts#L178)* **Returns:** `Uint8Array` @@ -132,7 +132,7 @@ ___ getdata(): `Uint8Array` -*Defined in [Method.ts:182](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Method.ts#L182)* +*Defined in [Method.ts:182](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Method.ts#L182)* **Returns:** `Uint8Array` @@ -145,7 +145,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L127)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -156,7 +156,7 @@ ___ getmeta(): [FunctionMetadata](_metadata_.functionmetadata.md) -*Defined in [Method.ts:186](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Method.ts#L186)* +*Defined in [Method.ts:186](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Method.ts#L186)* **Returns:** [FunctionMetadata](_metadata_.functionmetadata.md) @@ -273,7 +273,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L133)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -346,7 +346,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L137)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -359,7 +359,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L141)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -372,7 +372,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L145)* **Returns:** `any` @@ -385,7 +385,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L156)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -398,7 +398,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -430,7 +430,7 @@ ___ ▸ **filterOrigin**(meta?: *[FunctionMetadata](_metadata_.functionmetadata.md)*): `Array`<[FunctionArgumentMetadata](_metadata_.functionargumentmetadata.md)> -*Defined in [Method.ts:120](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Method.ts#L120)* +*Defined in [Method.ts:120](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Method.ts#L120)* **Parameters:** @@ -447,7 +447,7 @@ ___ ▸ **findFunction**(callIndex: *`Uint8Array`*): `ExtrinsicFunction` -*Defined in [Method.ts:136](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Method.ts#L136)* +*Defined in [Method.ts:136](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Method.ts#L136)* **Parameters:** @@ -464,7 +464,7 @@ ___ ▸ **injectExtrinsics**(extrinsics: *`Extrinsics`*): `void` -*Defined in [Method.ts:161](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Method.ts#L161)* +*Defined in [Method.ts:161](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Method.ts#L161)* **Parameters:** @@ -483,7 +483,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L113)* +*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/types/classes/_misbehaviorreport_.bftatreport.md b/docs/types/classes/_misbehaviorreport_.bftatreport.md index 639e6a2b7d..58a68040d8 100644 --- a/docs/types/classes/_misbehaviorreport_.bftatreport.md +++ b/docs/types/classes/_misbehaviorreport_.bftatreport.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [MisbehaviorReport.ts:28](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/MisbehaviorReport.ts#L28)* +*Defined in [MisbehaviorReport.ts:28](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/MisbehaviorReport.ts#L28)* **Parameters:** @@ -62,7 +62,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L25)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L25)* ___ @@ -87,7 +87,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L123)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -98,7 +98,7 @@ ___ geta(): [BftHashSignature](_bft_.bfthashsignature.md) -*Defined in [MisbehaviorReport.ts:37](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/MisbehaviorReport.ts#L37)* +*Defined in [MisbehaviorReport.ts:37](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/MisbehaviorReport.ts#L37)* **Returns:** [BftHashSignature](_bft_.bfthashsignature.md) @@ -109,7 +109,7 @@ ___ getb(): [BftHashSignature](_bft_.bfthashsignature.md) -*Defined in [MisbehaviorReport.ts:41](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/MisbehaviorReport.ts#L41)* +*Defined in [MisbehaviorReport.ts:41](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/MisbehaviorReport.ts#L41)* **Returns:** [BftHashSignature](_bft_.bfthashsignature.md) @@ -122,7 +122,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L127)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -133,7 +133,7 @@ ___ getround(): [U32](_u32_.u32.md) -*Defined in [MisbehaviorReport.ts:45](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/MisbehaviorReport.ts#L45)* +*Defined in [MisbehaviorReport.ts:45](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/MisbehaviorReport.ts#L45)* **Returns:** [U32](_u32_.u32.md) @@ -250,7 +250,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L133)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -323,7 +323,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L137)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -336,7 +336,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L141)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -349,7 +349,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L145)* **Returns:** `any` @@ -362,7 +362,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L156)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -375,7 +375,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -409,7 +409,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L113)* +*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/types/classes/_misbehaviorreport_.bftdoublecommit.md b/docs/types/classes/_misbehaviorreport_.bftdoublecommit.md index 8a98a28034..c165ce54c3 100644 --- a/docs/types/classes/_misbehaviorreport_.bftdoublecommit.md +++ b/docs/types/classes/_misbehaviorreport_.bftdoublecommit.md @@ -27,7 +27,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [MisbehaviorReport.ts:28](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/MisbehaviorReport.ts#L28)* +*Defined in [MisbehaviorReport.ts:28](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/MisbehaviorReport.ts#L28)* **Parameters:** @@ -60,7 +60,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L25)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L25)* ___ @@ -85,7 +85,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L123)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -98,7 +98,7 @@ geta(): [BftHashSignature](_bft_.bfthashsignature.md) *Inherited from [BftAtReport](_misbehaviorreport_.bftatreport.md).[a](_misbehaviorreport_.bftatreport.md#a)* -*Defined in [MisbehaviorReport.ts:37](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/MisbehaviorReport.ts#L37)* +*Defined in [MisbehaviorReport.ts:37](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/MisbehaviorReport.ts#L37)* **Returns:** [BftHashSignature](_bft_.bfthashsignature.md) @@ -111,7 +111,7 @@ getb(): [BftHashSignature](_bft_.bfthashsignature.md) *Inherited from [BftAtReport](_misbehaviorreport_.bftatreport.md).[b](_misbehaviorreport_.bftatreport.md#b)* -*Defined in [MisbehaviorReport.ts:41](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/MisbehaviorReport.ts#L41)* +*Defined in [MisbehaviorReport.ts:41](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/MisbehaviorReport.ts#L41)* **Returns:** [BftHashSignature](_bft_.bfthashsignature.md) @@ -124,7 +124,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L127)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -137,7 +137,7 @@ getround(): [U32](_u32_.u32.md) *Inherited from [BftAtReport](_misbehaviorreport_.bftatreport.md).[round](_misbehaviorreport_.bftatreport.md#round)* -*Defined in [MisbehaviorReport.ts:45](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/MisbehaviorReport.ts#L45)* +*Defined in [MisbehaviorReport.ts:45](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/MisbehaviorReport.ts#L45)* **Returns:** [U32](_u32_.u32.md) @@ -254,7 +254,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L133)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -327,7 +327,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L137)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -340,7 +340,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L141)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -353,7 +353,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L145)* **Returns:** `any` @@ -366,7 +366,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L156)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -379,7 +379,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -413,7 +413,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L113)* +*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/types/classes/_misbehaviorreport_.bftdoubleprepare.md b/docs/types/classes/_misbehaviorreport_.bftdoubleprepare.md index 070dc065c1..d7c749197b 100644 --- a/docs/types/classes/_misbehaviorreport_.bftdoubleprepare.md +++ b/docs/types/classes/_misbehaviorreport_.bftdoubleprepare.md @@ -27,7 +27,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [MisbehaviorReport.ts:28](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/MisbehaviorReport.ts#L28)* +*Defined in [MisbehaviorReport.ts:28](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/MisbehaviorReport.ts#L28)* **Parameters:** @@ -60,7 +60,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L25)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L25)* ___ @@ -85,7 +85,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L123)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -98,7 +98,7 @@ geta(): [BftHashSignature](_bft_.bfthashsignature.md) *Inherited from [BftAtReport](_misbehaviorreport_.bftatreport.md).[a](_misbehaviorreport_.bftatreport.md#a)* -*Defined in [MisbehaviorReport.ts:37](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/MisbehaviorReport.ts#L37)* +*Defined in [MisbehaviorReport.ts:37](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/MisbehaviorReport.ts#L37)* **Returns:** [BftHashSignature](_bft_.bfthashsignature.md) @@ -111,7 +111,7 @@ getb(): [BftHashSignature](_bft_.bfthashsignature.md) *Inherited from [BftAtReport](_misbehaviorreport_.bftatreport.md).[b](_misbehaviorreport_.bftatreport.md#b)* -*Defined in [MisbehaviorReport.ts:41](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/MisbehaviorReport.ts#L41)* +*Defined in [MisbehaviorReport.ts:41](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/MisbehaviorReport.ts#L41)* **Returns:** [BftHashSignature](_bft_.bfthashsignature.md) @@ -124,7 +124,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L127)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -137,7 +137,7 @@ getround(): [U32](_u32_.u32.md) *Inherited from [BftAtReport](_misbehaviorreport_.bftatreport.md).[round](_misbehaviorreport_.bftatreport.md#round)* -*Defined in [MisbehaviorReport.ts:45](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/MisbehaviorReport.ts#L45)* +*Defined in [MisbehaviorReport.ts:45](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/MisbehaviorReport.ts#L45)* **Returns:** [U32](_u32_.u32.md) @@ -254,7 +254,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L133)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -327,7 +327,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L137)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -340,7 +340,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L141)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -353,7 +353,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L145)* **Returns:** `any` @@ -366,7 +366,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L156)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -379,7 +379,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -413,7 +413,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L113)* +*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/types/classes/_misbehaviorreport_.misbehaviorkind.md b/docs/types/classes/_misbehaviorreport_.misbehaviorkind.md index eeecd45f5b..1b7dc32686 100644 --- a/docs/types/classes/_misbehaviorreport_.misbehaviorkind.md +++ b/docs/types/classes/_misbehaviorreport_.misbehaviorkind.md @@ -16,7 +16,7 @@ *Overrides [EnumType](_codec_enumtype_.enumtype.md).[constructor](_codec_enumtype_.enumtype.md#constructor)* -*Defined in [MisbehaviorReport.ts:58](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/MisbehaviorReport.ts#L58)* +*Defined in [MisbehaviorReport.ts:58](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/MisbehaviorReport.ts#L58)* **Parameters:** @@ -39,7 +39,7 @@ ___ *Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Base.ts#L19)* ___ @@ -55,7 +55,7 @@ getencodedLength(): `number` *Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* -*Defined in [codec/EnumType.ts:94](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/EnumType.ts#L94)* +*Defined in [codec/EnumType.ts:94](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/EnumType.ts#L94)* **Returns:** `number` @@ -68,7 +68,7 @@ getisNull(): `boolean` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNull](_codec_enumtype_.enumtype.md#isnull)* -*Defined in [codec/EnumType.ts:82](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/EnumType.ts#L82)* +*Defined in [codec/EnumType.ts:82](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/EnumType.ts#L82)* **Returns:** `boolean` @@ -81,7 +81,7 @@ gettype(): `string` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[type](_codec_enumtype_.enumtype.md#type)* -*Defined in [codec/EnumType.ts:86](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/EnumType.ts#L86)* +*Defined in [codec/EnumType.ts:86](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/EnumType.ts#L86)* **Returns:** `string` @@ -94,7 +94,7 @@ getvalue(): [Base](_codec_base_.base.md)< [BftDoublePrepare](_misbehaviorreport_ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[value](_codec_enumtype_.enumtype.md#value)* -*Defined in [codec/EnumType.ts:90](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/EnumType.ts#L90)* +*Defined in [codec/EnumType.ts:90](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/EnumType.ts#L90)* **Returns:** [Base](_codec_base_.base.md)< [BftDoublePrepare](_misbehaviorreport_.bftdoubleprepare.md) | [BftDoubleCommit](_misbehaviorreport_.bftdoublecommit.md)> @@ -110,7 +110,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[setValue](_codec_enumtype_.enumtype.md#setvalue)* -*Defined in [codec/EnumType.ts:98](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/EnumType.ts#L98)* +*Defined in [codec/EnumType.ts:98](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/EnumType.ts#L98)* **Parameters:** @@ -132,7 +132,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* -*Defined in [codec/EnumType.ts:115](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/EnumType.ts#L115)* +*Defined in [codec/EnumType.ts:115](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/EnumType.ts#L115)* **Returns:** `any` @@ -145,7 +145,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toNumber](_codec_enumtype_.enumtype.md#tonumber)* -*Defined in [codec/EnumType.ts:119](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/EnumType.ts#L119)* +*Defined in [codec/EnumType.ts:119](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/EnumType.ts#L119)* **Returns:** `number` @@ -160,7 +160,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* -*Defined in [codec/EnumType.ts:123](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/EnumType.ts#L123)* +*Defined in [codec/EnumType.ts:123](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/EnumType.ts#L123)* **Returns:** `string` @@ -175,7 +175,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* -*Defined in [codec/EnumType.ts:127](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/EnumType.ts#L127)* +*Defined in [codec/EnumType.ts:127](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/EnumType.ts#L127)* **Parameters:** @@ -194,7 +194,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[decodeEnumType](_codec_enumtype_.enumtype.md#decodeenumtype)* -*Defined in [codec/EnumType.ts:45](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/EnumType.ts#L45)* +*Defined in [codec/EnumType.ts:45](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/EnumType.ts#L45)* **Type parameters:** diff --git a/docs/types/classes/_misbehaviorreport_.misbehaviorreport.md b/docs/types/classes/_misbehaviorreport_.misbehaviorreport.md index f8062a430b..eb473b3e43 100644 --- a/docs/types/classes/_misbehaviorreport_.misbehaviorreport.md +++ b/docs/types/classes/_misbehaviorreport_.misbehaviorreport.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [MisbehaviorReport.ts:75](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/MisbehaviorReport.ts#L75)* +*Defined in [MisbehaviorReport.ts:75](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/MisbehaviorReport.ts#L75)* **Parameters:** @@ -58,7 +58,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L25)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L25)* ___ @@ -83,7 +83,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L123)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -96,7 +96,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L127)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -107,7 +107,7 @@ ___ getmisbehavior(): [MisbehaviorKind](_misbehaviorreport_.misbehaviorkind.md) -*Defined in [MisbehaviorReport.ts:85](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/MisbehaviorReport.ts#L85)* +*Defined in [MisbehaviorReport.ts:85](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/MisbehaviorReport.ts#L85)* **Returns:** [MisbehaviorKind](_misbehaviorreport_.misbehaviorkind.md) @@ -118,7 +118,7 @@ ___ getparentHash(): [Hash](_hash_.hash.md) -*Defined in [MisbehaviorReport.ts:89](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/MisbehaviorReport.ts#L89)* +*Defined in [MisbehaviorReport.ts:89](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/MisbehaviorReport.ts#L89)* **Returns:** [Hash](_hash_.hash.md) @@ -129,7 +129,7 @@ ___ getparentNumber(): [BlockNumber](_blocknumber_.blocknumber.md) -*Defined in [MisbehaviorReport.ts:93](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/MisbehaviorReport.ts#L93)* +*Defined in [MisbehaviorReport.ts:93](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/MisbehaviorReport.ts#L93)* **Returns:** [BlockNumber](_blocknumber_.blocknumber.md) @@ -140,7 +140,7 @@ ___ gettarget(): [AuthorityId](_authorityid_.authorityid.md) -*Defined in [MisbehaviorReport.ts:97](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/MisbehaviorReport.ts#L97)* +*Defined in [MisbehaviorReport.ts:97](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/MisbehaviorReport.ts#L97)* **Returns:** [AuthorityId](_authorityid_.authorityid.md) @@ -257,7 +257,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L133)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -330,7 +330,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L137)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -343,7 +343,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L141)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -356,7 +356,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L145)* **Returns:** `any` @@ -369,7 +369,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L156)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -382,7 +382,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -416,7 +416,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L113)* +*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/types/classes/_moment_.moment.md b/docs/types/classes/_moment_.moment.md index 1c5a4a2bfc..6c9b70357e 100644 --- a/docs/types/classes/_moment_.moment.md +++ b/docs/types/classes/_moment_.moment.md @@ -16,7 +16,7 @@ *Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* -*Defined in [Moment.ts:18](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Moment.ts#L18)* +*Defined in [Moment.ts:18](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Moment.ts#L18)* **Parameters:** @@ -38,23 +38,12 @@ ___ *Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Base.ts#L19)* ___ # Accessors - - -## bitLength - -getbitLength(): [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) - -*Defined in [Moment.ts:43](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Moment.ts#L43)* - -**Returns:** [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) - -___ ## encodedLength @@ -63,7 +52,7 @@ getencodedLength(): `number` *Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* -*Defined in [Moment.ts:47](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Moment.ts#L47)* +*Defined in [Moment.ts:45](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Moment.ts#L45)* **Returns:** `number` @@ -71,13 +60,24 @@ ___ # Methods + + +## bitLength + +▸ **bitLength**(): [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) + +*Defined in [Moment.ts:41](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Moment.ts#L41)* + +**Returns:** [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) + +___ ## getTime ▸ **getTime**(): `number` -*Defined in [Moment.ts:51](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Moment.ts#L51)* +*Defined in [Moment.ts:49](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Moment.ts#L49)* **Returns:** `number` @@ -88,7 +88,7 @@ ___ ▸ **toBn**(): `BN` -*Defined in [Moment.ts:71](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Moment.ts#L71)* +*Defined in [Moment.ts:69](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Moment.ts#L69)* **Returns:** `BN` @@ -99,7 +99,7 @@ ___ ▸ **toHex**(): `string` -*Defined in [Moment.ts:55](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Moment.ts#L55)* +*Defined in [Moment.ts:53](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Moment.ts#L53)* **Returns:** `string` @@ -112,7 +112,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* -*Defined in [Moment.ts:59](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Moment.ts#L59)* +*Defined in [Moment.ts:57](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Moment.ts#L57)* **Returns:** `any` @@ -123,7 +123,7 @@ ___ ▸ **toNumber**(): `number` -*Defined in [Moment.ts:75](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Moment.ts#L75)* +*Defined in [Moment.ts:73](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Moment.ts#L73)* **Returns:** `number` @@ -136,7 +136,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* -*Defined in [Moment.ts:67](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Moment.ts#L67)* +*Defined in [Moment.ts:65](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Moment.ts#L65)* **Returns:** `string` @@ -149,7 +149,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* -*Defined in [Moment.ts:63](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Moment.ts#L63)* +*Defined in [Moment.ts:61](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Moment.ts#L61)* **Parameters:** @@ -166,7 +166,7 @@ ___ ▸ **decodeMoment**(value: * [Moment](_moment_.moment.md) | `Date` | `AnyNumber`*): `Date` -*Defined in [Moment.ts:25](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Moment.ts#L25)* +*Defined in [Moment.ts:25](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Moment.ts#L25)* **Parameters:** diff --git a/docs/types/classes/_newaccountoutcome_.newaccountoutcome.md b/docs/types/classes/_newaccountoutcome_.newaccountoutcome.md index 8403627f4c..fe9a095079 100644 --- a/docs/types/classes/_newaccountoutcome_.newaccountoutcome.md +++ b/docs/types/classes/_newaccountoutcome_.newaccountoutcome.md @@ -16,7 +16,7 @@ *Overrides [Enum](_codec_enum_.enum.md).[constructor](_codec_enum_.enum.md#constructor)* -*Defined in [NewAccountOutcome.ts:9](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/NewAccountOutcome.ts#L9)* +*Defined in [NewAccountOutcome.ts:9](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/NewAccountOutcome.ts#L9)* **Parameters:** @@ -38,7 +38,7 @@ ___ *Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Base.ts#L19)* ___ @@ -54,7 +54,7 @@ getencodedLength(): `number` *Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* -*Defined in [codec/Enum.ts:41](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Enum.ts#L41)* +*Defined in [codec/Enum.ts:41](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Enum.ts#L41)* **Returns:** `number` @@ -72,7 +72,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* -*Defined in [codec/Enum.ts:45](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Enum.ts#L45)* +*Defined in [codec/Enum.ts:45](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Enum.ts#L45)* **Returns:** `any` @@ -85,7 +85,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[toNumber](_codec_enum_.enum.md#tonumber)* -*Defined in [codec/Enum.ts:49](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Enum.ts#L49)* +*Defined in [codec/Enum.ts:49](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Enum.ts#L49)* **Returns:** `number` @@ -100,7 +100,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* -*Defined in [codec/Enum.ts:53](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Enum.ts#L53)* +*Defined in [codec/Enum.ts:53](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Enum.ts#L53)* **Returns:** `string` @@ -115,7 +115,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* -*Defined in [codec/Enum.ts:57](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Enum.ts#L57)* +*Defined in [codec/Enum.ts:57](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Enum.ts#L57)* **Parameters:** @@ -134,7 +134,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[decodeEnum](_codec_enum_.enum.md#decodeenum)* -*Defined in [codec/Enum.ts:31](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Enum.ts#L31)* +*Defined in [codec/Enum.ts:31](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Enum.ts#L31)* **Parameters:** diff --git a/docs/types/classes/_nonce_.index.md b/docs/types/classes/_nonce_.index.md index 3ce2b8b936..7bbb787e15 100644 --- a/docs/types/classes/_nonce_.index.md +++ b/docs/types/classes/_nonce_.index.md @@ -6,6 +6,10 @@ **↳ Index** +# Implements + +* `Codec` + # Constructors @@ -18,7 +22,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U64.ts:9](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/U64.ts#L9)* +*Defined in [U64.ts:9](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/U64.ts#L9)* **Parameters:** @@ -38,27 +42,14 @@ ___ **● raw**: *`BN`* -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* +*Inherited from [UInt](_codec_uint_.uint.md).[raw](_codec_uint_.uint.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/UInt.ts:23](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L23)* ___ # Accessors - - -## bitLength - -getbitLength(): [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) - -*Inherited from [UInt](_codec_uint_.uint.md).[bitLength](_codec_uint_.uint.md#bitlength)* - -*Defined in [codec/UInt.ts:50](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L50)* - -**Returns:** [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) - -___ ## encodedLength @@ -67,9 +58,7 @@ getencodedLength(): `number` *Inherited from [UInt](_codec_uint_.uint.md).[encodedLength](_codec_uint_.uint.md#encodedlength)* -*Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* - -*Defined in [codec/UInt.ts:54](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L54)* +*Defined in [codec/UInt.ts:55](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L55)* **Returns:** `number` @@ -77,21 +66,167 @@ ___ # Methods + + +## abs + +▸ **abs**(): `BN` + +*Inherited from BN.abs* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:254* + +*__description__*: absolute value + +**Returns:** `BN` + +___ ## add -▸ **add**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **add**(b: *`BN`*): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)* +*Inherited from BN.add* -*Defined in [codec/UInt.ts:86](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L86)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:264* + +*__description__*: addition **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | + +**Returns:** `BN` + +___ + + +## addn + +▸ **addn**(b: *`number`*): `BN` + +*Inherited from BN.addn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:274* + +*__description__*: addition + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## and + +▸ **and**(b: *`BN`*): `BN` + +*Inherited from BN.and* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:395* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## andln + +▸ **andln**(b: *`number`*): `BN` + +*Inherited from BN.andln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:415* + +*__description__*: and (NOTE: `andln` is going to be replaced with `andn` in future) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## bincn + +▸ **bincn**(b: *`number`*): `BN` + +*Inherited from BN.bincn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:499* + +*__description__*: add `1 << b` to the number + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## bitLength + +▸ **bitLength**(): [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) + +*Inherited from [UInt](_codec_uint_.uint.md).[bitLength](_codec_uint_.uint.md#bitlength)* + +*Overrides BN.bitLength* + +*Defined in [codec/UInt.ts:51](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L51)* + +**Returns:** [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) + +___ + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from BN.byteLength* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:144* + +*__description__*: return number of bytes occupied + +**Returns:** `number` + +___ + + +## clone + +▸ **clone**(): `BN` + +*Inherited from BN.clone* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:89* + +*__description__*: clone number **Returns:** `BN` @@ -100,74 +235,229 @@ ___ ## cmp -▸ **cmp**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `number` +▸ **cmp**(b: *`BN`*): `-1` | `0` | `1` -*Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)* +*Inherited from BN.cmp* -*Defined in [codec/UInt.ts:92](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L92)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:169* + +*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | -**Returns:** `number` +**Returns:** `-1` | `0` | `1` + +___ + + +## cmpn + +▸ **cmpn**(b: *`number`*): `-1` | `0` | `1` + +*Inherited from BN.cmpn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:179* + +*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `-1` | `0` | `1` ___ ## div -▸ **div**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **div**(b: *`BN`*): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)* +*Inherited from BN.div* -*Defined in [codec/UInt.ts:98](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L98)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:339* + +*__description__*: divide **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `BN` +___ + + +## divRound + +▸ **divRound**(b: *`BN`*): `BN` + +*Inherited from BN.divRound* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:370* + +*__description__*: rounded division + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## divn + +▸ **divn**(b: *`number`*): `BN` + +*Inherited from BN.divn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:344* + +*__description__*: divide + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## egcd + +▸ **egcd**(b: *`BN`*): `object` + +*Inherited from BN.egcd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:519* + +*__description__*: Extended GCD results `({ a: ..., b: ..., gcd: ... })` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `object` + ___ ## eq -▸ **eq**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **eq**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[eq](_codec_uint_.uint.md#eq)* +*Inherited from BN.eq* -*Defined in [codec/UInt.ts:104](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L104)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:224* + +*__description__*: a equals b **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` +___ + + +## eqn + +▸ **eqn**(b: *`number`*): `boolean` + +*Inherited from BN.eqn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:229* + +*__description__*: a equals b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## fromTwos + +▸ **fromTwos**(width: *`number`*): `BN` + +*Inherited from BN.fromTwos* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:239* + +*__description__*: convert from two's complement representation, where width is the bit width + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| width | `number` | + +**Returns:** `BN` + +___ + + +## gcd + +▸ **gcd**(b: *`BN`*): `BN` + +*Inherited from BN.gcd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:514* + +*__description__*: GCD + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + ___ ## gt -▸ **gt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **gt**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)* +*Inherited from BN.gt* -*Defined in [codec/UInt.ts:126](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L126)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:204* + +*__description__*: a greater than b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` @@ -176,17 +466,346 @@ ___ ## gte -▸ **gte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **gte**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)* +*Inherited from BN.gte* -*Defined in [codec/UInt.ts:132](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L132)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:214* + +*__description__*: a greater than or equals b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | + +**Returns:** `boolean` + +___ + + +## gten + +▸ **gten**(b: *`number`*): `boolean` + +*Inherited from BN.gten* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:219* + +*__description__*: a greater than or equals b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## gtn + +▸ **gtn**(b: *`number`*): `boolean` + +*Inherited from BN.gtn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:209* + +*__description__*: a greater than b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## iabs + +▸ **iabs**(): `BN` + +*Inherited from BN.iabs* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:259* + +*__description__*: absolute value + +**Returns:** `BN` + +___ + + +## iadd + +▸ **iadd**(b: *`BN`*): `BN` + +*Inherited from BN.iadd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:269* + +*__description__*: addition + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## iaddn + +▸ **iaddn**(b: *`number`*): `BN` + +*Inherited from BN.iaddn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:279* + +*__description__*: addition + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iand + +▸ **iand**(b: *`BN`*): `BN` + +*Inherited from BN.iand* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:400* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## idivn + +▸ **idivn**(b: *`number`*): `BN` + +*Inherited from BN.idivn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:349* + +*__description__*: divide + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## imaskn + +▸ **imaskn**(b: *`number`*): `BN` + +*Inherited from BN.imaskn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495* + +*__description__*: clear bits with indexes higher or equal to `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## imul + +▸ **imul**(b: *`BN`*): `BN` + +*Inherited from BN.imul* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:309* + +*__description__*: multiply + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## imuln + +▸ **imuln**(b: *`number`*): `BN` + +*Inherited from BN.imuln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:319* + +*__description__*: multiply + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## ineg + +▸ **ineg**(): `BN` + +*Inherited from BN.ineg* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:249* + +*__description__*: negate sign + +**Returns:** `BN` + +___ + + +## inotn + +▸ **inotn**(w: *`number`*): `BN` + +*Inherited from BN.inotn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:509* + +*__description__*: not (for the width specified by `w`) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| w | `number` | + +**Returns:** `BN` + +___ + + +## invm + +▸ **invm**(b: *`BN`*): `BN` + +*Inherited from BN.invm* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:524* + +*__description__*: inverse `a` modulo `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ior + +▸ **ior**(b: *`BN`*): `BN` + +*Inherited from BN.ior* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:380* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## isEven + +▸ **isEven**(): `boolean` + +*Inherited from BN.isEven* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:154* + +*__description__*: check if value is even + +**Returns:** `boolean` + +___ + + +## isNeg + +▸ **isNeg**(): `boolean` + +*Inherited from BN.isNeg* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:149* + +*__description__*: true if the number is negative + +**Returns:** `boolean` + +___ + + +## isOdd + +▸ **isOdd**(): `boolean` + +*Inherited from BN.isOdd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:159* + +*__description__*: check if value is odd **Returns:** `boolean` @@ -197,28 +816,257 @@ ___ ▸ **isZero**(): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)* +*Inherited from BN.isZero* -*Defined in [codec/UInt.ts:110](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L110)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:164* + +*__description__*: check if value is zero **Returns:** `boolean` +___ + + +## ishln + +▸ **ishln**(b: *`number`*): `BN` + +*Inherited from BN.ishln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:450* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## ishrn + +▸ **ishrn**(b: *`number`*): `BN` + +*Inherited from BN.ishrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:470* + +*__description__*: shift right (unimplemented [https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086](https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## isqr + +▸ **isqr**(): `BN` + +*Inherited from BN.isqr* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:329* + +*__description__*: square + +**Returns:** `BN` + +___ + + +## isub + +▸ **isub**(b: *`BN`*): `BN` + +*Inherited from BN.isub* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:289* + +*__description__*: subtraction + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## isubn + +▸ **isubn**(b: *`number`*): `BN` + +*Inherited from BN.isubn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:299* + +*__description__*: subtraction + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iuand + +▸ **iuand**(b: *`BN`*): `BN` + +*Inherited from BN.iuand* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:410* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## iuor + +▸ **iuor**(b: *`BN`*): `BN` + +*Inherited from BN.iuor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:390* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## iushln + +▸ **iushln**(b: *`number`*): `BN` + +*Inherited from BN.iushln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:460* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iushrn + +▸ **iushrn**(b: *`number`*): `BN` + +*Inherited from BN.iushrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480* + +*__description__*: shift right + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iuxor + +▸ **iuxor**(b: *`BN`*): `BN` + +*Inherited from BN.iuxor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:435* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ixor + +▸ **ixor**(b: *`BN`*): `BN` + +*Inherited from BN.ixor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:425* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + ___ ## lt -▸ **lt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **lt**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)* +*Inherited from BN.lt* -*Defined in [codec/UInt.ts:114](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L114)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:184* + +*__description__*: a less than b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` @@ -227,36 +1075,324 @@ ___ ## lte -▸ **lte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **lte**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)* +*Inherited from BN.lte* -*Defined in [codec/UInt.ts:120](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L120)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:194* + +*__description__*: a less than or equals b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` +___ + + +## lten + +▸ **lten**(b: *`number`*): `boolean` + +*Inherited from BN.lten* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:199* + +*__description__*: a less than or equals b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## ltn + +▸ **ltn**(b: *`number`*): `boolean` + +*Inherited from BN.ltn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:189* + +*__description__*: a less than b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## maskn + +▸ **maskn**(b: *`number`*): `BN` + +*Inherited from BN.maskn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490* + +*__description__*: clear bits with indexes higher or equal to `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## mod + +▸ **mod**(b: *`BN`*): `BN` + +*Inherited from BN.mod* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:354* + +*__description__*: reduct + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## modn + +▸ **modn**(b: *`number`*): `number` + +*Inherited from BN.modn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:365* + +*__see__*: API consistency [https://github.com/indutny/bn.js/pull/130](https://github.com/indutny/bn.js/pull/130) + +*__description__*: reduct + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `number` + ___ ## mul -▸ **mul**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **mul**(b: *`BN`*): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)* +*Inherited from BN.mul* -*Defined in [codec/UInt.ts:138](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L138)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:304* + +*__description__*: multiply **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | + +**Returns:** `BN` + +___ + + +## muln + +▸ **muln**(b: *`number`*): `BN` + +*Inherited from BN.muln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:314* + +*__description__*: multiply + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## neg + +▸ **neg**(): `BN` + +*Inherited from BN.neg* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:244* + +*__description__*: negate sign + +**Returns:** `BN` + +___ + + +## notn + +▸ **notn**(w: *`number`*): `BN` + +*Inherited from BN.notn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:504* + +*__description__*: not (for the width specified by `w`) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| w | `number` | + +**Returns:** `BN` + +___ + + +## or + +▸ **or**(b: *`BN`*): `BN` + +*Inherited from BN.or* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:375* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## pow + +▸ **pow**(b: *`BN`*): `BN` + +*Inherited from BN.pow* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:334* + +*__description__*: raise `a` to the power of `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## setn + +▸ **setn**(b: *`number`*): `BN` + +*Inherited from BN.setn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:440* + +*__description__*: set specified bit to 1 + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## shln + +▸ **shln**(b: *`number`*): `BN` + +*Inherited from BN.shln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:445* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## shrn + +▸ **shrn**(b: *`number`*): `BN` + +*Inherited from BN.shrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:465* + +*__description__*: shift right + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## sqr + +▸ **sqr**(): `BN` + +*Inherited from BN.sqr* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:324* + +*__description__*: square **Returns:** `BN` @@ -265,20 +1401,125 @@ ___ ## sub -▸ **sub**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **sub**(b: *`BN`*): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)* +*Inherited from BN.sub* -*Defined in [codec/UInt.ts:144](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L144)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:284* + +*__description__*: subtraction **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `BN` +___ + + +## subn + +▸ **subn**(b: *`number`*): `BN` + +*Inherited from BN.subn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:294* + +*__description__*: subtraction + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## testn + +▸ **testn**(b: *`number`*): `boolean` + +*Inherited from BN.testn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485* + +*__description__*: test if specified bit is set + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## toArray + +▸ **toArray**(endian?: *`Endianness`*, length?: * `undefined` | `number`*): `number`[] + +*Inherited from BN.toArray* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:109* + +*__description__*: convert to byte Array, and optionally zero pad to length, throwing if already exceeding + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `number`[] + +___ + + +## toArrayLike + +▸ **toArrayLike**(ArrayType: *`object`*, endian?: *`Endianness`*, length?: * `undefined` | `number`*): `Buffer` + +▸ **toArrayLike**(ArrayType: *`any`[]*, endian?: *`Endianness`*, length?: * `undefined` | `number`*): `any`[] + +*Inherited from BN.toArrayLike* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:114* + +*__description__*: convert to an instance of `type`, which must behave like an Array + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| ArrayType | `object` | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `Buffer` + +*Inherited from BN.toArrayLike* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| ArrayType | `any`[] | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `any`[] + ___ @@ -288,10 +1529,32 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)* -*Defined in [codec/UInt.ts:76](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L76)* +*Defined in [codec/UInt.ts:73](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L73)* **Returns:** `BN` +___ + + +## toBuffer + +▸ **toBuffer**(endian?: *`Endianness`*, length?: * `undefined` | `number`*): `Buffer` + +*Inherited from BN.toBuffer* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:129* + +*__description__*: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `Buffer` + ___ @@ -301,7 +1564,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* -*Defined in [codec/UInt.ts:58](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L58)* +*Defined in [codec/UInt.ts:59](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L59)* **Returns:** `string` @@ -314,9 +1577,9 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toJSON](_codec_uint_.uint.md#tojson)* -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* +*Overrides BN.toJSON* -*Defined in [codec/UInt.ts:62](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L62)* +*Defined in [codec/UInt.ts:63](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L63)* **Returns:** `any` @@ -327,27 +1590,78 @@ ___ ▸ **toNumber**(): `number` -*Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)* +*Inherited from BN.toNumber* -*Defined in [codec/UInt.ts:80](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L80)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:99* + +*__description__*: convert to Javascript Number (limited to 53 bits) **Returns:** `number` +___ + + +## toRed + +▸ **toRed**(reductionContext: *`ReductionContext`*): `RedBN` + +*Inherited from BN.toRed* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:84* + +*__description__*: Convert number to red + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| reductionContext | `ReductionContext` | + +**Returns:** `RedBN` + ___ ## toString -▸ **toString**(): `string` +▸ **toString**(base?: * `number` | "hex"*, length?: * `undefined` | `number`*): `string` -*Inherited from [UInt](_codec_uint_.uint.md).[toString](_codec_uint_.uint.md#tostring)* +*Inherited from BN.toString* -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:94* -*Defined in [codec/UInt.ts:72](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L72)* +*__description__*: convert to base-string and pad with zeroes + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` base | `number` | "hex"| +| `Optional` length | `undefined` | `number`| **Returns:** `string` +___ + + +## toTwos + +▸ **toTwos**(width: *`number`*): `BN` + +*Inherited from BN.toTwos* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:234* + +*__description__*: convert to two's complement representation, where width is bit width + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| width | `number` | + +**Returns:** `BN` + ___ @@ -357,9 +1671,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/UInt.ts:68](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L68)* +*Defined in [codec/UInt.ts:69](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L69)* **Parameters:** @@ -369,16 +1681,199 @@ ___ **Returns:** `Uint8Array` +___ + + +## uand + +▸ **uand**(b: *`BN`*): `BN` + +*Inherited from BN.uand* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:405* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ucmp + +▸ **ucmp**(b: *`BN`*): `-1` | `0` | `1` + +*Inherited from BN.ucmp* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:174* + +*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `-1` | `0` | `1` + +___ + + +## umod + +▸ **umod**(b: *`BN`*): `BN` + +*Inherited from BN.umod* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:359* + +*__description__*: reduct + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## uor + +▸ **uor**(b: *`BN`*): `BN` + +*Inherited from BN.uor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:385* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ushln + +▸ **ushln**(b: *`number`*): `BN` + +*Inherited from BN.ushln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:455* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## ushrn + +▸ **ushrn**(b: *`number`*): `BN` + +*Inherited from BN.ushrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475* + +*__description__*: shift right + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## uxor + +▸ **uxor**(b: *`BN`*): `BN` + +*Inherited from BN.uxor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:430* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## xor + +▸ **xor**(b: *`BN`*): `BN` + +*Inherited from BN.xor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:420* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## zeroBits + +▸ **zeroBits**(): `number` + +*Inherited from BN.zeroBits* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:139* + +*__description__*: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits) + +**Returns:** `number` + ___ ## `` decodeUInt -▸ **decodeUInt**(value: *`AnyNumber`*, bitLength: *[UIntBitLength](../modules/_codec_uint_.md#uintbitlength)*): `BN` +▸ **decodeUInt**(value: *`AnyNumber`*, bitLength: *[UIntBitLength](../modules/_codec_uint_.md#uintbitlength)*): `string` *Inherited from [UInt](_codec_uint_.uint.md).[decodeUInt](_codec_uint_.uint.md#decodeuint)* -*Defined in [codec/UInt.ts:35](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L35)* +*Defined in [codec/UInt.ts:35](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L35)* **Parameters:** @@ -387,7 +1882,114 @@ ___ | value | `AnyNumber` | | bitLength | [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) | +**Returns:** `string` + +___ + + +## `` isBN + +▸ **isBN**(b: *`any`*): `boolean` + +*Inherited from BN.isBN* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:69* + +*__description__*: returns true if the supplied object is a BN.js instance + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `any` | + +**Returns:** `boolean` + +___ + + +## `` max + +▸ **max**(left: *`BN`*, right: *`BN`*): `BN` + +*Inherited from BN.max* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:74* + +*__description__*: returns the maximum of 2 BN instances. + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| left | `BN` | +| right | `BN` | + **Returns:** `BN` ___ + + +## `` min + +▸ **min**(left: *`BN`*, right: *`BN`*): `BN` + +*Inherited from BN.min* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:79* + +*__description__*: returns the minimum of 2 BN instances. + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| left | `BN` | +| right | `BN` | + +**Returns:** `BN` + +___ + + +## `` mont + +▸ **mont**(num: *`BN`*): `ReductionContext` + +*Inherited from BN.mont* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:64* + +*__description__*: create a reduction context with the Montgomery trick. + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| num | `BN` | + +**Returns:** `ReductionContext` + +___ + + +## `` red + +▸ **red**(reductionContext: * `BN` | `IPrimeName`*): `ReductionContext` + +*Inherited from BN.red* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:59* + +*__description__*: create a reduction context + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| reductionContext | `BN` | `IPrimeName`| + +**Returns:** `ReductionContext` + +___ diff --git a/docs/types/classes/_null_.null.md b/docs/types/classes/_null_.null.md index adc936dcf3..658902fa11 100644 --- a/docs/types/classes/_null_.null.md +++ b/docs/types/classes/_null_.null.md @@ -18,7 +18,7 @@ *Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* -*Defined in [Null.ts:8](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Null.ts#L8)* +*Defined in [Null.ts:8](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Null.ts#L8)* **Returns:** [Null](_null_.null.md) @@ -34,7 +34,7 @@ ___ *Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Base.ts#L19)* ___ @@ -48,7 +48,7 @@ getencodedLength(): `number` *Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* -*Defined in [Null.ts:13](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Null.ts#L13)* +*Defined in [Null.ts:13](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Null.ts#L13)* **Returns:** `number` @@ -64,7 +64,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* -*Defined in [Null.ts:17](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Null.ts#L17)* +*Defined in [Null.ts:17](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Null.ts#L17)* **Returns:** `any` @@ -77,7 +77,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* -*Defined in [Null.ts:25](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Null.ts#L25)* +*Defined in [Null.ts:25](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Null.ts#L25)* **Returns:** `string` @@ -90,7 +90,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* -*Defined in [Null.ts:21](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Null.ts#L21)* +*Defined in [Null.ts:21](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Null.ts#L21)* **Parameters:** diff --git a/docs/types/classes/_origin_.origin.md b/docs/types/classes/_origin_.origin.md index 2e898839cf..b4c7635e84 100644 --- a/docs/types/classes/_origin_.origin.md +++ b/docs/types/classes/_origin_.origin.md @@ -18,7 +18,7 @@ *Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* -*Defined in [Origin.ts:8](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Origin.ts#L8)* +*Defined in [Origin.ts:8](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Origin.ts#L8)* **Returns:** [Origin](_origin_.origin.md) @@ -34,7 +34,7 @@ ___ *Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Base.ts#L19)* ___ @@ -48,7 +48,7 @@ getencodedLength(): `number` *Inherited from [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* -*Defined in [codec/Base.ts:25](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Base.ts#L25)* +*Defined in [codec/Base.ts:25](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Base.ts#L25)* **Returns:** `number` @@ -64,7 +64,7 @@ ___ *Inherited from [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* -*Defined in [codec/Base.ts:29](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Base.ts#L29)* +*Defined in [codec/Base.ts:29](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Base.ts#L29)* **Returns:** `any` @@ -77,7 +77,7 @@ ___ *Inherited from [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* -*Defined in [codec/Base.ts:33](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Base.ts#L33)* +*Defined in [codec/Base.ts:33](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Base.ts#L33)* **Returns:** `string` @@ -90,7 +90,7 @@ ___ *Inherited from [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* -*Defined in [codec/Base.ts:37](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Base.ts#L37)* +*Defined in [codec/Base.ts:37](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Base.ts#L37)* **Parameters:** diff --git a/docs/types/classes/_parachainid_.parachainid.md b/docs/types/classes/_parachainid_.parachainid.md index a952fa79f2..dd372470e8 100644 --- a/docs/types/classes/_parachainid_.parachainid.md +++ b/docs/types/classes/_parachainid_.parachainid.md @@ -6,6 +6,10 @@ **↳ ParachainId** +# Implements + +* `Codec` + # Constructors @@ -18,7 +22,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U64.ts:9](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/U64.ts#L9)* +*Defined in [U64.ts:9](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/U64.ts#L9)* **Parameters:** @@ -38,27 +42,14 @@ ___ **● raw**: *`BN`* -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* +*Inherited from [UInt](_codec_uint_.uint.md).[raw](_codec_uint_.uint.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/UInt.ts:23](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L23)* ___ # Accessors - - -## bitLength - -getbitLength(): [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) - -*Inherited from [UInt](_codec_uint_.uint.md).[bitLength](_codec_uint_.uint.md#bitlength)* - -*Defined in [codec/UInt.ts:50](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L50)* - -**Returns:** [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) - -___ ## encodedLength @@ -67,9 +58,7 @@ getencodedLength(): `number` *Inherited from [UInt](_codec_uint_.uint.md).[encodedLength](_codec_uint_.uint.md#encodedlength)* -*Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* - -*Defined in [codec/UInt.ts:54](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L54)* +*Defined in [codec/UInt.ts:55](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L55)* **Returns:** `number` @@ -77,21 +66,167 @@ ___ # Methods + + +## abs + +▸ **abs**(): `BN` + +*Inherited from BN.abs* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:254* + +*__description__*: absolute value + +**Returns:** `BN` + +___ ## add -▸ **add**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **add**(b: *`BN`*): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)* +*Inherited from BN.add* -*Defined in [codec/UInt.ts:86](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L86)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:264* + +*__description__*: addition **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | + +**Returns:** `BN` + +___ + + +## addn + +▸ **addn**(b: *`number`*): `BN` + +*Inherited from BN.addn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:274* + +*__description__*: addition + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## and + +▸ **and**(b: *`BN`*): `BN` + +*Inherited from BN.and* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:395* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## andln + +▸ **andln**(b: *`number`*): `BN` + +*Inherited from BN.andln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:415* + +*__description__*: and (NOTE: `andln` is going to be replaced with `andn` in future) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## bincn + +▸ **bincn**(b: *`number`*): `BN` + +*Inherited from BN.bincn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:499* + +*__description__*: add `1 << b` to the number + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## bitLength + +▸ **bitLength**(): [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) + +*Inherited from [UInt](_codec_uint_.uint.md).[bitLength](_codec_uint_.uint.md#bitlength)* + +*Overrides BN.bitLength* + +*Defined in [codec/UInt.ts:51](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L51)* + +**Returns:** [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) + +___ + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from BN.byteLength* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:144* + +*__description__*: return number of bytes occupied + +**Returns:** `number` + +___ + + +## clone + +▸ **clone**(): `BN` + +*Inherited from BN.clone* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:89* + +*__description__*: clone number **Returns:** `BN` @@ -100,74 +235,229 @@ ___ ## cmp -▸ **cmp**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `number` +▸ **cmp**(b: *`BN`*): `-1` | `0` | `1` -*Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)* +*Inherited from BN.cmp* -*Defined in [codec/UInt.ts:92](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L92)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:169* + +*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | -**Returns:** `number` +**Returns:** `-1` | `0` | `1` + +___ + + +## cmpn + +▸ **cmpn**(b: *`number`*): `-1` | `0` | `1` + +*Inherited from BN.cmpn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:179* + +*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `-1` | `0` | `1` ___ ## div -▸ **div**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **div**(b: *`BN`*): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)* +*Inherited from BN.div* -*Defined in [codec/UInt.ts:98](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L98)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:339* + +*__description__*: divide **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `BN` +___ + + +## divRound + +▸ **divRound**(b: *`BN`*): `BN` + +*Inherited from BN.divRound* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:370* + +*__description__*: rounded division + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## divn + +▸ **divn**(b: *`number`*): `BN` + +*Inherited from BN.divn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:344* + +*__description__*: divide + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## egcd + +▸ **egcd**(b: *`BN`*): `object` + +*Inherited from BN.egcd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:519* + +*__description__*: Extended GCD results `({ a: ..., b: ..., gcd: ... })` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `object` + ___ ## eq -▸ **eq**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **eq**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[eq](_codec_uint_.uint.md#eq)* +*Inherited from BN.eq* -*Defined in [codec/UInt.ts:104](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L104)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:224* + +*__description__*: a equals b **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` +___ + + +## eqn + +▸ **eqn**(b: *`number`*): `boolean` + +*Inherited from BN.eqn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:229* + +*__description__*: a equals b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## fromTwos + +▸ **fromTwos**(width: *`number`*): `BN` + +*Inherited from BN.fromTwos* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:239* + +*__description__*: convert from two's complement representation, where width is the bit width + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| width | `number` | + +**Returns:** `BN` + +___ + + +## gcd + +▸ **gcd**(b: *`BN`*): `BN` + +*Inherited from BN.gcd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:514* + +*__description__*: GCD + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + ___ ## gt -▸ **gt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **gt**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)* +*Inherited from BN.gt* -*Defined in [codec/UInt.ts:126](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L126)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:204* + +*__description__*: a greater than b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` @@ -176,17 +466,346 @@ ___ ## gte -▸ **gte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **gte**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)* +*Inherited from BN.gte* -*Defined in [codec/UInt.ts:132](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L132)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:214* + +*__description__*: a greater than or equals b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | + +**Returns:** `boolean` + +___ + + +## gten + +▸ **gten**(b: *`number`*): `boolean` + +*Inherited from BN.gten* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:219* + +*__description__*: a greater than or equals b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## gtn + +▸ **gtn**(b: *`number`*): `boolean` + +*Inherited from BN.gtn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:209* + +*__description__*: a greater than b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## iabs + +▸ **iabs**(): `BN` + +*Inherited from BN.iabs* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:259* + +*__description__*: absolute value + +**Returns:** `BN` + +___ + + +## iadd + +▸ **iadd**(b: *`BN`*): `BN` + +*Inherited from BN.iadd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:269* + +*__description__*: addition + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## iaddn + +▸ **iaddn**(b: *`number`*): `BN` + +*Inherited from BN.iaddn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:279* + +*__description__*: addition + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iand + +▸ **iand**(b: *`BN`*): `BN` + +*Inherited from BN.iand* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:400* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## idivn + +▸ **idivn**(b: *`number`*): `BN` + +*Inherited from BN.idivn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:349* + +*__description__*: divide + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## imaskn + +▸ **imaskn**(b: *`number`*): `BN` + +*Inherited from BN.imaskn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495* + +*__description__*: clear bits with indexes higher or equal to `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## imul + +▸ **imul**(b: *`BN`*): `BN` + +*Inherited from BN.imul* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:309* + +*__description__*: multiply + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## imuln + +▸ **imuln**(b: *`number`*): `BN` + +*Inherited from BN.imuln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:319* + +*__description__*: multiply + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## ineg + +▸ **ineg**(): `BN` + +*Inherited from BN.ineg* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:249* + +*__description__*: negate sign + +**Returns:** `BN` + +___ + + +## inotn + +▸ **inotn**(w: *`number`*): `BN` + +*Inherited from BN.inotn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:509* + +*__description__*: not (for the width specified by `w`) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| w | `number` | + +**Returns:** `BN` + +___ + + +## invm + +▸ **invm**(b: *`BN`*): `BN` + +*Inherited from BN.invm* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:524* + +*__description__*: inverse `a` modulo `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ior + +▸ **ior**(b: *`BN`*): `BN` + +*Inherited from BN.ior* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:380* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## isEven + +▸ **isEven**(): `boolean` + +*Inherited from BN.isEven* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:154* + +*__description__*: check if value is even + +**Returns:** `boolean` + +___ + + +## isNeg + +▸ **isNeg**(): `boolean` + +*Inherited from BN.isNeg* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:149* + +*__description__*: true if the number is negative + +**Returns:** `boolean` + +___ + + +## isOdd + +▸ **isOdd**(): `boolean` + +*Inherited from BN.isOdd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:159* + +*__description__*: check if value is odd **Returns:** `boolean` @@ -197,28 +816,257 @@ ___ ▸ **isZero**(): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)* +*Inherited from BN.isZero* -*Defined in [codec/UInt.ts:110](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L110)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:164* + +*__description__*: check if value is zero **Returns:** `boolean` +___ + + +## ishln + +▸ **ishln**(b: *`number`*): `BN` + +*Inherited from BN.ishln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:450* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## ishrn + +▸ **ishrn**(b: *`number`*): `BN` + +*Inherited from BN.ishrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:470* + +*__description__*: shift right (unimplemented [https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086](https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## isqr + +▸ **isqr**(): `BN` + +*Inherited from BN.isqr* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:329* + +*__description__*: square + +**Returns:** `BN` + +___ + + +## isub + +▸ **isub**(b: *`BN`*): `BN` + +*Inherited from BN.isub* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:289* + +*__description__*: subtraction + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## isubn + +▸ **isubn**(b: *`number`*): `BN` + +*Inherited from BN.isubn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:299* + +*__description__*: subtraction + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iuand + +▸ **iuand**(b: *`BN`*): `BN` + +*Inherited from BN.iuand* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:410* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## iuor + +▸ **iuor**(b: *`BN`*): `BN` + +*Inherited from BN.iuor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:390* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## iushln + +▸ **iushln**(b: *`number`*): `BN` + +*Inherited from BN.iushln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:460* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iushrn + +▸ **iushrn**(b: *`number`*): `BN` + +*Inherited from BN.iushrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480* + +*__description__*: shift right + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iuxor + +▸ **iuxor**(b: *`BN`*): `BN` + +*Inherited from BN.iuxor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:435* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ixor + +▸ **ixor**(b: *`BN`*): `BN` + +*Inherited from BN.ixor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:425* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + ___ ## lt -▸ **lt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **lt**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)* +*Inherited from BN.lt* -*Defined in [codec/UInt.ts:114](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L114)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:184* + +*__description__*: a less than b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` @@ -227,36 +1075,324 @@ ___ ## lte -▸ **lte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **lte**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)* +*Inherited from BN.lte* -*Defined in [codec/UInt.ts:120](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L120)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:194* + +*__description__*: a less than or equals b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` +___ + + +## lten + +▸ **lten**(b: *`number`*): `boolean` + +*Inherited from BN.lten* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:199* + +*__description__*: a less than or equals b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## ltn + +▸ **ltn**(b: *`number`*): `boolean` + +*Inherited from BN.ltn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:189* + +*__description__*: a less than b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## maskn + +▸ **maskn**(b: *`number`*): `BN` + +*Inherited from BN.maskn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490* + +*__description__*: clear bits with indexes higher or equal to `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## mod + +▸ **mod**(b: *`BN`*): `BN` + +*Inherited from BN.mod* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:354* + +*__description__*: reduct + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## modn + +▸ **modn**(b: *`number`*): `number` + +*Inherited from BN.modn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:365* + +*__see__*: API consistency [https://github.com/indutny/bn.js/pull/130](https://github.com/indutny/bn.js/pull/130) + +*__description__*: reduct + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `number` + ___ ## mul -▸ **mul**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **mul**(b: *`BN`*): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)* +*Inherited from BN.mul* -*Defined in [codec/UInt.ts:138](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L138)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:304* + +*__description__*: multiply **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | + +**Returns:** `BN` + +___ + + +## muln + +▸ **muln**(b: *`number`*): `BN` + +*Inherited from BN.muln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:314* + +*__description__*: multiply + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## neg + +▸ **neg**(): `BN` + +*Inherited from BN.neg* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:244* + +*__description__*: negate sign + +**Returns:** `BN` + +___ + + +## notn + +▸ **notn**(w: *`number`*): `BN` + +*Inherited from BN.notn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:504* + +*__description__*: not (for the width specified by `w`) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| w | `number` | + +**Returns:** `BN` + +___ + + +## or + +▸ **or**(b: *`BN`*): `BN` + +*Inherited from BN.or* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:375* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## pow + +▸ **pow**(b: *`BN`*): `BN` + +*Inherited from BN.pow* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:334* + +*__description__*: raise `a` to the power of `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## setn + +▸ **setn**(b: *`number`*): `BN` + +*Inherited from BN.setn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:440* + +*__description__*: set specified bit to 1 + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## shln + +▸ **shln**(b: *`number`*): `BN` + +*Inherited from BN.shln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:445* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## shrn + +▸ **shrn**(b: *`number`*): `BN` + +*Inherited from BN.shrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:465* + +*__description__*: shift right + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## sqr + +▸ **sqr**(): `BN` + +*Inherited from BN.sqr* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:324* + +*__description__*: square **Returns:** `BN` @@ -265,20 +1401,125 @@ ___ ## sub -▸ **sub**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **sub**(b: *`BN`*): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)* +*Inherited from BN.sub* -*Defined in [codec/UInt.ts:144](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L144)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:284* + +*__description__*: subtraction **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `BN` +___ + + +## subn + +▸ **subn**(b: *`number`*): `BN` + +*Inherited from BN.subn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:294* + +*__description__*: subtraction + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## testn + +▸ **testn**(b: *`number`*): `boolean` + +*Inherited from BN.testn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485* + +*__description__*: test if specified bit is set + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## toArray + +▸ **toArray**(endian?: *`Endianness`*, length?: * `undefined` | `number`*): `number`[] + +*Inherited from BN.toArray* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:109* + +*__description__*: convert to byte Array, and optionally zero pad to length, throwing if already exceeding + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `number`[] + +___ + + +## toArrayLike + +▸ **toArrayLike**(ArrayType: *`object`*, endian?: *`Endianness`*, length?: * `undefined` | `number`*): `Buffer` + +▸ **toArrayLike**(ArrayType: *`any`[]*, endian?: *`Endianness`*, length?: * `undefined` | `number`*): `any`[] + +*Inherited from BN.toArrayLike* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:114* + +*__description__*: convert to an instance of `type`, which must behave like an Array + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| ArrayType | `object` | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `Buffer` + +*Inherited from BN.toArrayLike* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| ArrayType | `any`[] | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `any`[] + ___ @@ -288,10 +1529,32 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)* -*Defined in [codec/UInt.ts:76](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L76)* +*Defined in [codec/UInt.ts:73](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L73)* **Returns:** `BN` +___ + + +## toBuffer + +▸ **toBuffer**(endian?: *`Endianness`*, length?: * `undefined` | `number`*): `Buffer` + +*Inherited from BN.toBuffer* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:129* + +*__description__*: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `Buffer` + ___ @@ -301,7 +1564,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* -*Defined in [codec/UInt.ts:58](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L58)* +*Defined in [codec/UInt.ts:59](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L59)* **Returns:** `string` @@ -314,9 +1577,9 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toJSON](_codec_uint_.uint.md#tojson)* -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* +*Overrides BN.toJSON* -*Defined in [codec/UInt.ts:62](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L62)* +*Defined in [codec/UInt.ts:63](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L63)* **Returns:** `any` @@ -327,27 +1590,78 @@ ___ ▸ **toNumber**(): `number` -*Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)* +*Inherited from BN.toNumber* -*Defined in [codec/UInt.ts:80](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L80)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:99* + +*__description__*: convert to Javascript Number (limited to 53 bits) **Returns:** `number` +___ + + +## toRed + +▸ **toRed**(reductionContext: *`ReductionContext`*): `RedBN` + +*Inherited from BN.toRed* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:84* + +*__description__*: Convert number to red + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| reductionContext | `ReductionContext` | + +**Returns:** `RedBN` + ___ ## toString -▸ **toString**(): `string` +▸ **toString**(base?: * `number` | "hex"*, length?: * `undefined` | `number`*): `string` -*Inherited from [UInt](_codec_uint_.uint.md).[toString](_codec_uint_.uint.md#tostring)* +*Inherited from BN.toString* -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:94* -*Defined in [codec/UInt.ts:72](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L72)* +*__description__*: convert to base-string and pad with zeroes + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` base | `number` | "hex"| +| `Optional` length | `undefined` | `number`| **Returns:** `string` +___ + + +## toTwos + +▸ **toTwos**(width: *`number`*): `BN` + +*Inherited from BN.toTwos* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:234* + +*__description__*: convert to two's complement representation, where width is bit width + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| width | `number` | + +**Returns:** `BN` + ___ @@ -357,9 +1671,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/UInt.ts:68](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L68)* +*Defined in [codec/UInt.ts:69](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L69)* **Parameters:** @@ -369,16 +1681,199 @@ ___ **Returns:** `Uint8Array` +___ + + +## uand + +▸ **uand**(b: *`BN`*): `BN` + +*Inherited from BN.uand* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:405* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ucmp + +▸ **ucmp**(b: *`BN`*): `-1` | `0` | `1` + +*Inherited from BN.ucmp* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:174* + +*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `-1` | `0` | `1` + +___ + + +## umod + +▸ **umod**(b: *`BN`*): `BN` + +*Inherited from BN.umod* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:359* + +*__description__*: reduct + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## uor + +▸ **uor**(b: *`BN`*): `BN` + +*Inherited from BN.uor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:385* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ushln + +▸ **ushln**(b: *`number`*): `BN` + +*Inherited from BN.ushln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:455* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## ushrn + +▸ **ushrn**(b: *`number`*): `BN` + +*Inherited from BN.ushrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475* + +*__description__*: shift right + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## uxor + +▸ **uxor**(b: *`BN`*): `BN` + +*Inherited from BN.uxor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:430* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## xor + +▸ **xor**(b: *`BN`*): `BN` + +*Inherited from BN.xor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:420* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## zeroBits + +▸ **zeroBits**(): `number` + +*Inherited from BN.zeroBits* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:139* + +*__description__*: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits) + +**Returns:** `number` + ___ ## `` decodeUInt -▸ **decodeUInt**(value: *`AnyNumber`*, bitLength: *[UIntBitLength](../modules/_codec_uint_.md#uintbitlength)*): `BN` +▸ **decodeUInt**(value: *`AnyNumber`*, bitLength: *[UIntBitLength](../modules/_codec_uint_.md#uintbitlength)*): `string` *Inherited from [UInt](_codec_uint_.uint.md).[decodeUInt](_codec_uint_.uint.md#decodeuint)* -*Defined in [codec/UInt.ts:35](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L35)* +*Defined in [codec/UInt.ts:35](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L35)* **Parameters:** @@ -387,7 +1882,114 @@ ___ | value | `AnyNumber` | | bitLength | [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) | +**Returns:** `string` + +___ + + +## `` isBN + +▸ **isBN**(b: *`any`*): `boolean` + +*Inherited from BN.isBN* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:69* + +*__description__*: returns true if the supplied object is a BN.js instance + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `any` | + +**Returns:** `boolean` + +___ + + +## `` max + +▸ **max**(left: *`BN`*, right: *`BN`*): `BN` + +*Inherited from BN.max* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:74* + +*__description__*: returns the maximum of 2 BN instances. + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| left | `BN` | +| right | `BN` | + **Returns:** `BN` ___ + + +## `` min + +▸ **min**(left: *`BN`*, right: *`BN`*): `BN` + +*Inherited from BN.min* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:79* + +*__description__*: returns the minimum of 2 BN instances. + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| left | `BN` | +| right | `BN` | + +**Returns:** `BN` + +___ + + +## `` mont + +▸ **mont**(num: *`BN`*): `ReductionContext` + +*Inherited from BN.mont* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:64* + +*__description__*: create a reduction context with the Montgomery trick. + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| num | `BN` | + +**Returns:** `ReductionContext` + +___ + + +## `` red + +▸ **red**(reductionContext: * `BN` | `IPrimeName`*): `ReductionContext` + +*Inherited from BN.red* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:59* + +*__description__*: create a reduction context + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| reductionContext | `BN` | `IPrimeName`| + +**Returns:** `ReductionContext` + +___ diff --git a/docs/types/classes/_pendingextrinsics_.pendingextrinsics.md b/docs/types/classes/_pendingextrinsics_.pendingextrinsics.md index 4d440275d3..a64f49adef 100644 --- a/docs/types/classes/_pendingextrinsics_.pendingextrinsics.md +++ b/docs/types/classes/_pendingextrinsics_.pendingextrinsics.md @@ -20,7 +20,7 @@ *Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* -*Defined in [codec/Vector.ts:19](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Vector.ts#L19)* +*Defined in [codec/Vector.ts:19](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Vector.ts#L19)* **Parameters:** @@ -43,7 +43,7 @@ ___ *Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Base.ts#L19)* ___ @@ -57,7 +57,7 @@ getType(): `string` *Inherited from [Vector](_codec_vector_.vector.md).[Type](_codec_vector_.vector.md#type)* -*Defined in [codec/Vector.ts:65](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Vector.ts#L65)* +*Defined in [codec/Vector.ts:65](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Vector.ts#L65)* **Returns:** `string` @@ -72,7 +72,7 @@ getencodedLength(): `number` *Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* -*Defined in [codec/Vector.ts:73](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Vector.ts#L73)* +*Defined in [codec/Vector.ts:73](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Vector.ts#L73)* **Returns:** `number` @@ -85,7 +85,7 @@ getlength(): `number` *Inherited from [Vector](_codec_vector_.vector.md).[length](_codec_vector_.vector.md#length)* -*Defined in [codec/Vector.ts:69](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Vector.ts#L69)* +*Defined in [codec/Vector.ts:69](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Vector.ts#L69)* **Returns:** `number` @@ -101,7 +101,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[filter](_codec_vector_.vector.md#filter)* -*Defined in [codec/Vector.ts:79](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Vector.ts#L79)* +*Defined in [codec/Vector.ts:79](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Vector.ts#L79)* **Parameters:** @@ -120,7 +120,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[find](_codec_vector_.vector.md#find)* -*Defined in [codec/Vector.ts:83](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Vector.ts#L83)* +*Defined in [codec/Vector.ts:83](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Vector.ts#L83)* **Parameters:** @@ -139,7 +139,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[forEach](_codec_vector_.vector.md#foreach)* -*Defined in [codec/Vector.ts:87](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Vector.ts#L87)* +*Defined in [codec/Vector.ts:87](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Vector.ts#L87)* **Parameters:** @@ -158,7 +158,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[get](_codec_vector_.vector.md#get)* -*Defined in [codec/Vector.ts:91](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Vector.ts#L91)* +*Defined in [codec/Vector.ts:91](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Vector.ts#L91)* **Parameters:** @@ -177,7 +177,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[map](_codec_vector_.vector.md#map)* -*Defined in [codec/Vector.ts:95](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Vector.ts#L95)* +*Defined in [codec/Vector.ts:95](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Vector.ts#L95)* **Type parameters:** @@ -199,7 +199,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[push](_codec_vector_.vector.md#push)* -*Defined in [codec/Vector.ts:99](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Vector.ts#L99)* +*Defined in [codec/Vector.ts:99](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Vector.ts#L99)* **Parameters:** @@ -218,7 +218,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[reduce](_codec_vector_.vector.md#reduce)* -*Defined in [codec/Vector.ts:103](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Vector.ts#L103)* +*Defined in [codec/Vector.ts:103](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Vector.ts#L103)* **Type parameters:** @@ -243,7 +243,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* -*Defined in [codec/Vector.ts:107](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Vector.ts#L107)* +*Defined in [codec/Vector.ts:107](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Vector.ts#L107)* **Returns:** `any` @@ -258,7 +258,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* -*Defined in [codec/Vector.ts:126](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Vector.ts#L126)* +*Defined in [codec/Vector.ts:126](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Vector.ts#L126)* **Returns:** `string` @@ -273,7 +273,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* -*Defined in [codec/Vector.ts:113](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Vector.ts#L113)* +*Defined in [codec/Vector.ts:113](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Vector.ts#L113)* **Parameters:** @@ -292,7 +292,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[decodeVector](_codec_vector_.vector.md#decodevector)* -*Defined in [codec/Vector.ts:29](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Vector.ts#L29)* +*Defined in [codec/Vector.ts:29](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Vector.ts#L29)* **Type parameters:** @@ -315,7 +315,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[with](_codec_vector_.vector.md#with)* -*Defined in [codec/Vector.ts:57](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Vector.ts#L57)* +*Defined in [codec/Vector.ts:57](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Vector.ts#L57)* **Type parameters:** diff --git a/docs/types/classes/_perbill_.perbill.md b/docs/types/classes/_perbill_.perbill.md index ee66f09ce9..0cebdfc23e 100644 --- a/docs/types/classes/_perbill_.perbill.md +++ b/docs/types/classes/_perbill_.perbill.md @@ -6,6 +6,10 @@ **↳ Perbill** +# Implements + +* `Codec` + # Constructors @@ -18,7 +22,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U32.ts:9](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/U32.ts#L9)* +*Defined in [U32.ts:9](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/U32.ts#L9)* **Parameters:** @@ -38,27 +42,14 @@ ___ **● raw**: *`BN`* -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* +*Inherited from [UInt](_codec_uint_.uint.md).[raw](_codec_uint_.uint.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/UInt.ts:23](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L23)* ___ # Accessors - - -## bitLength - -getbitLength(): [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) - -*Inherited from [UInt](_codec_uint_.uint.md).[bitLength](_codec_uint_.uint.md#bitlength)* - -*Defined in [codec/UInt.ts:50](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L50)* - -**Returns:** [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) - -___ ## encodedLength @@ -67,9 +58,7 @@ getencodedLength(): `number` *Inherited from [UInt](_codec_uint_.uint.md).[encodedLength](_codec_uint_.uint.md#encodedlength)* -*Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* - -*Defined in [codec/UInt.ts:54](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L54)* +*Defined in [codec/UInt.ts:55](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L55)* **Returns:** `number` @@ -77,21 +66,167 @@ ___ # Methods + + +## abs + +▸ **abs**(): `BN` + +*Inherited from BN.abs* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:254* + +*__description__*: absolute value + +**Returns:** `BN` + +___ ## add -▸ **add**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **add**(b: *`BN`*): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)* +*Inherited from BN.add* -*Defined in [codec/UInt.ts:86](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L86)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:264* + +*__description__*: addition **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | + +**Returns:** `BN` + +___ + + +## addn + +▸ **addn**(b: *`number`*): `BN` + +*Inherited from BN.addn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:274* + +*__description__*: addition + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## and + +▸ **and**(b: *`BN`*): `BN` + +*Inherited from BN.and* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:395* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## andln + +▸ **andln**(b: *`number`*): `BN` + +*Inherited from BN.andln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:415* + +*__description__*: and (NOTE: `andln` is going to be replaced with `andn` in future) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## bincn + +▸ **bincn**(b: *`number`*): `BN` + +*Inherited from BN.bincn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:499* + +*__description__*: add `1 << b` to the number + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## bitLength + +▸ **bitLength**(): [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) + +*Inherited from [UInt](_codec_uint_.uint.md).[bitLength](_codec_uint_.uint.md#bitlength)* + +*Overrides BN.bitLength* + +*Defined in [codec/UInt.ts:51](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L51)* + +**Returns:** [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) + +___ + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from BN.byteLength* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:144* + +*__description__*: return number of bytes occupied + +**Returns:** `number` + +___ + + +## clone + +▸ **clone**(): `BN` + +*Inherited from BN.clone* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:89* + +*__description__*: clone number **Returns:** `BN` @@ -100,74 +235,229 @@ ___ ## cmp -▸ **cmp**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `number` +▸ **cmp**(b: *`BN`*): `-1` | `0` | `1` -*Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)* +*Inherited from BN.cmp* -*Defined in [codec/UInt.ts:92](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L92)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:169* + +*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | -**Returns:** `number` +**Returns:** `-1` | `0` | `1` + +___ + + +## cmpn + +▸ **cmpn**(b: *`number`*): `-1` | `0` | `1` + +*Inherited from BN.cmpn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:179* + +*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `-1` | `0` | `1` ___ ## div -▸ **div**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **div**(b: *`BN`*): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)* +*Inherited from BN.div* -*Defined in [codec/UInt.ts:98](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L98)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:339* + +*__description__*: divide **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `BN` +___ + + +## divRound + +▸ **divRound**(b: *`BN`*): `BN` + +*Inherited from BN.divRound* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:370* + +*__description__*: rounded division + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## divn + +▸ **divn**(b: *`number`*): `BN` + +*Inherited from BN.divn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:344* + +*__description__*: divide + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## egcd + +▸ **egcd**(b: *`BN`*): `object` + +*Inherited from BN.egcd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:519* + +*__description__*: Extended GCD results `({ a: ..., b: ..., gcd: ... })` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `object` + ___ ## eq -▸ **eq**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **eq**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[eq](_codec_uint_.uint.md#eq)* +*Inherited from BN.eq* -*Defined in [codec/UInt.ts:104](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L104)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:224* + +*__description__*: a equals b **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` +___ + + +## eqn + +▸ **eqn**(b: *`number`*): `boolean` + +*Inherited from BN.eqn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:229* + +*__description__*: a equals b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## fromTwos + +▸ **fromTwos**(width: *`number`*): `BN` + +*Inherited from BN.fromTwos* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:239* + +*__description__*: convert from two's complement representation, where width is the bit width + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| width | `number` | + +**Returns:** `BN` + +___ + + +## gcd + +▸ **gcd**(b: *`BN`*): `BN` + +*Inherited from BN.gcd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:514* + +*__description__*: GCD + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + ___ ## gt -▸ **gt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **gt**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)* +*Inherited from BN.gt* -*Defined in [codec/UInt.ts:126](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L126)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:204* + +*__description__*: a greater than b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` @@ -176,17 +466,346 @@ ___ ## gte -▸ **gte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **gte**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)* +*Inherited from BN.gte* -*Defined in [codec/UInt.ts:132](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L132)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:214* + +*__description__*: a greater than or equals b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | + +**Returns:** `boolean` + +___ + + +## gten + +▸ **gten**(b: *`number`*): `boolean` + +*Inherited from BN.gten* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:219* + +*__description__*: a greater than or equals b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## gtn + +▸ **gtn**(b: *`number`*): `boolean` + +*Inherited from BN.gtn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:209* + +*__description__*: a greater than b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## iabs + +▸ **iabs**(): `BN` + +*Inherited from BN.iabs* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:259* + +*__description__*: absolute value + +**Returns:** `BN` + +___ + + +## iadd + +▸ **iadd**(b: *`BN`*): `BN` + +*Inherited from BN.iadd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:269* + +*__description__*: addition + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## iaddn + +▸ **iaddn**(b: *`number`*): `BN` + +*Inherited from BN.iaddn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:279* + +*__description__*: addition + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iand + +▸ **iand**(b: *`BN`*): `BN` + +*Inherited from BN.iand* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:400* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## idivn + +▸ **idivn**(b: *`number`*): `BN` + +*Inherited from BN.idivn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:349* + +*__description__*: divide + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## imaskn + +▸ **imaskn**(b: *`number`*): `BN` + +*Inherited from BN.imaskn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495* + +*__description__*: clear bits with indexes higher or equal to `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## imul + +▸ **imul**(b: *`BN`*): `BN` + +*Inherited from BN.imul* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:309* + +*__description__*: multiply + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## imuln + +▸ **imuln**(b: *`number`*): `BN` + +*Inherited from BN.imuln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:319* + +*__description__*: multiply + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## ineg + +▸ **ineg**(): `BN` + +*Inherited from BN.ineg* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:249* + +*__description__*: negate sign + +**Returns:** `BN` + +___ + + +## inotn + +▸ **inotn**(w: *`number`*): `BN` + +*Inherited from BN.inotn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:509* + +*__description__*: not (for the width specified by `w`) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| w | `number` | + +**Returns:** `BN` + +___ + + +## invm + +▸ **invm**(b: *`BN`*): `BN` + +*Inherited from BN.invm* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:524* + +*__description__*: inverse `a` modulo `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ior + +▸ **ior**(b: *`BN`*): `BN` + +*Inherited from BN.ior* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:380* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## isEven + +▸ **isEven**(): `boolean` + +*Inherited from BN.isEven* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:154* + +*__description__*: check if value is even + +**Returns:** `boolean` + +___ + + +## isNeg + +▸ **isNeg**(): `boolean` + +*Inherited from BN.isNeg* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:149* + +*__description__*: true if the number is negative + +**Returns:** `boolean` + +___ + + +## isOdd + +▸ **isOdd**(): `boolean` + +*Inherited from BN.isOdd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:159* + +*__description__*: check if value is odd **Returns:** `boolean` @@ -197,28 +816,257 @@ ___ ▸ **isZero**(): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)* +*Inherited from BN.isZero* -*Defined in [codec/UInt.ts:110](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L110)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:164* + +*__description__*: check if value is zero **Returns:** `boolean` +___ + + +## ishln + +▸ **ishln**(b: *`number`*): `BN` + +*Inherited from BN.ishln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:450* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## ishrn + +▸ **ishrn**(b: *`number`*): `BN` + +*Inherited from BN.ishrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:470* + +*__description__*: shift right (unimplemented [https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086](https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## isqr + +▸ **isqr**(): `BN` + +*Inherited from BN.isqr* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:329* + +*__description__*: square + +**Returns:** `BN` + +___ + + +## isub + +▸ **isub**(b: *`BN`*): `BN` + +*Inherited from BN.isub* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:289* + +*__description__*: subtraction + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## isubn + +▸ **isubn**(b: *`number`*): `BN` + +*Inherited from BN.isubn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:299* + +*__description__*: subtraction + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iuand + +▸ **iuand**(b: *`BN`*): `BN` + +*Inherited from BN.iuand* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:410* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## iuor + +▸ **iuor**(b: *`BN`*): `BN` + +*Inherited from BN.iuor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:390* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## iushln + +▸ **iushln**(b: *`number`*): `BN` + +*Inherited from BN.iushln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:460* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iushrn + +▸ **iushrn**(b: *`number`*): `BN` + +*Inherited from BN.iushrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480* + +*__description__*: shift right + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iuxor + +▸ **iuxor**(b: *`BN`*): `BN` + +*Inherited from BN.iuxor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:435* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ixor + +▸ **ixor**(b: *`BN`*): `BN` + +*Inherited from BN.ixor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:425* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + ___ ## lt -▸ **lt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **lt**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)* +*Inherited from BN.lt* -*Defined in [codec/UInt.ts:114](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L114)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:184* + +*__description__*: a less than b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` @@ -227,36 +1075,324 @@ ___ ## lte -▸ **lte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **lte**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)* +*Inherited from BN.lte* -*Defined in [codec/UInt.ts:120](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L120)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:194* + +*__description__*: a less than or equals b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` +___ + + +## lten + +▸ **lten**(b: *`number`*): `boolean` + +*Inherited from BN.lten* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:199* + +*__description__*: a less than or equals b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## ltn + +▸ **ltn**(b: *`number`*): `boolean` + +*Inherited from BN.ltn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:189* + +*__description__*: a less than b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## maskn + +▸ **maskn**(b: *`number`*): `BN` + +*Inherited from BN.maskn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490* + +*__description__*: clear bits with indexes higher or equal to `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## mod + +▸ **mod**(b: *`BN`*): `BN` + +*Inherited from BN.mod* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:354* + +*__description__*: reduct + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## modn + +▸ **modn**(b: *`number`*): `number` + +*Inherited from BN.modn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:365* + +*__see__*: API consistency [https://github.com/indutny/bn.js/pull/130](https://github.com/indutny/bn.js/pull/130) + +*__description__*: reduct + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `number` + ___ ## mul -▸ **mul**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **mul**(b: *`BN`*): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)* +*Inherited from BN.mul* -*Defined in [codec/UInt.ts:138](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L138)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:304* + +*__description__*: multiply **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | + +**Returns:** `BN` + +___ + + +## muln + +▸ **muln**(b: *`number`*): `BN` + +*Inherited from BN.muln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:314* + +*__description__*: multiply + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## neg + +▸ **neg**(): `BN` + +*Inherited from BN.neg* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:244* + +*__description__*: negate sign + +**Returns:** `BN` + +___ + + +## notn + +▸ **notn**(w: *`number`*): `BN` + +*Inherited from BN.notn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:504* + +*__description__*: not (for the width specified by `w`) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| w | `number` | + +**Returns:** `BN` + +___ + + +## or + +▸ **or**(b: *`BN`*): `BN` + +*Inherited from BN.or* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:375* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## pow + +▸ **pow**(b: *`BN`*): `BN` + +*Inherited from BN.pow* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:334* + +*__description__*: raise `a` to the power of `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## setn + +▸ **setn**(b: *`number`*): `BN` + +*Inherited from BN.setn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:440* + +*__description__*: set specified bit to 1 + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## shln + +▸ **shln**(b: *`number`*): `BN` + +*Inherited from BN.shln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:445* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## shrn + +▸ **shrn**(b: *`number`*): `BN` + +*Inherited from BN.shrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:465* + +*__description__*: shift right + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## sqr + +▸ **sqr**(): `BN` + +*Inherited from BN.sqr* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:324* + +*__description__*: square **Returns:** `BN` @@ -265,20 +1401,125 @@ ___ ## sub -▸ **sub**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **sub**(b: *`BN`*): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)* +*Inherited from BN.sub* -*Defined in [codec/UInt.ts:144](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L144)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:284* + +*__description__*: subtraction **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `BN` +___ + + +## subn + +▸ **subn**(b: *`number`*): `BN` + +*Inherited from BN.subn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:294* + +*__description__*: subtraction + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## testn + +▸ **testn**(b: *`number`*): `boolean` + +*Inherited from BN.testn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485* + +*__description__*: test if specified bit is set + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## toArray + +▸ **toArray**(endian?: *`Endianness`*, length?: * `undefined` | `number`*): `number`[] + +*Inherited from BN.toArray* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:109* + +*__description__*: convert to byte Array, and optionally zero pad to length, throwing if already exceeding + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `number`[] + +___ + + +## toArrayLike + +▸ **toArrayLike**(ArrayType: *`object`*, endian?: *`Endianness`*, length?: * `undefined` | `number`*): `Buffer` + +▸ **toArrayLike**(ArrayType: *`any`[]*, endian?: *`Endianness`*, length?: * `undefined` | `number`*): `any`[] + +*Inherited from BN.toArrayLike* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:114* + +*__description__*: convert to an instance of `type`, which must behave like an Array + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| ArrayType | `object` | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `Buffer` + +*Inherited from BN.toArrayLike* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| ArrayType | `any`[] | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `any`[] + ___ @@ -288,10 +1529,32 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)* -*Defined in [codec/UInt.ts:76](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L76)* +*Defined in [codec/UInt.ts:73](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L73)* **Returns:** `BN` +___ + + +## toBuffer + +▸ **toBuffer**(endian?: *`Endianness`*, length?: * `undefined` | `number`*): `Buffer` + +*Inherited from BN.toBuffer* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:129* + +*__description__*: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `Buffer` + ___ @@ -301,7 +1564,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* -*Defined in [codec/UInt.ts:58](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L58)* +*Defined in [codec/UInt.ts:59](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L59)* **Returns:** `string` @@ -314,9 +1577,9 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toJSON](_codec_uint_.uint.md#tojson)* -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* +*Overrides BN.toJSON* -*Defined in [codec/UInt.ts:62](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L62)* +*Defined in [codec/UInt.ts:63](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L63)* **Returns:** `any` @@ -327,27 +1590,78 @@ ___ ▸ **toNumber**(): `number` -*Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)* +*Inherited from BN.toNumber* -*Defined in [codec/UInt.ts:80](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L80)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:99* + +*__description__*: convert to Javascript Number (limited to 53 bits) **Returns:** `number` +___ + + +## toRed + +▸ **toRed**(reductionContext: *`ReductionContext`*): `RedBN` + +*Inherited from BN.toRed* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:84* + +*__description__*: Convert number to red + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| reductionContext | `ReductionContext` | + +**Returns:** `RedBN` + ___ ## toString -▸ **toString**(): `string` +▸ **toString**(base?: * `number` | "hex"*, length?: * `undefined` | `number`*): `string` -*Inherited from [UInt](_codec_uint_.uint.md).[toString](_codec_uint_.uint.md#tostring)* +*Inherited from BN.toString* -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:94* -*Defined in [codec/UInt.ts:72](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L72)* +*__description__*: convert to base-string and pad with zeroes + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` base | `number` | "hex"| +| `Optional` length | `undefined` | `number`| **Returns:** `string` +___ + + +## toTwos + +▸ **toTwos**(width: *`number`*): `BN` + +*Inherited from BN.toTwos* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:234* + +*__description__*: convert to two's complement representation, where width is bit width + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| width | `number` | + +**Returns:** `BN` + ___ @@ -357,9 +1671,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/UInt.ts:68](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L68)* +*Defined in [codec/UInt.ts:69](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L69)* **Parameters:** @@ -369,16 +1681,199 @@ ___ **Returns:** `Uint8Array` +___ + + +## uand + +▸ **uand**(b: *`BN`*): `BN` + +*Inherited from BN.uand* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:405* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ucmp + +▸ **ucmp**(b: *`BN`*): `-1` | `0` | `1` + +*Inherited from BN.ucmp* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:174* + +*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `-1` | `0` | `1` + +___ + + +## umod + +▸ **umod**(b: *`BN`*): `BN` + +*Inherited from BN.umod* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:359* + +*__description__*: reduct + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## uor + +▸ **uor**(b: *`BN`*): `BN` + +*Inherited from BN.uor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:385* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ushln + +▸ **ushln**(b: *`number`*): `BN` + +*Inherited from BN.ushln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:455* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## ushrn + +▸ **ushrn**(b: *`number`*): `BN` + +*Inherited from BN.ushrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475* + +*__description__*: shift right + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## uxor + +▸ **uxor**(b: *`BN`*): `BN` + +*Inherited from BN.uxor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:430* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## xor + +▸ **xor**(b: *`BN`*): `BN` + +*Inherited from BN.xor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:420* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## zeroBits + +▸ **zeroBits**(): `number` + +*Inherited from BN.zeroBits* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:139* + +*__description__*: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits) + +**Returns:** `number` + ___ ## `` decodeUInt -▸ **decodeUInt**(value: *`AnyNumber`*, bitLength: *[UIntBitLength](../modules/_codec_uint_.md#uintbitlength)*): `BN` +▸ **decodeUInt**(value: *`AnyNumber`*, bitLength: *[UIntBitLength](../modules/_codec_uint_.md#uintbitlength)*): `string` *Inherited from [UInt](_codec_uint_.uint.md).[decodeUInt](_codec_uint_.uint.md#decodeuint)* -*Defined in [codec/UInt.ts:35](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L35)* +*Defined in [codec/UInt.ts:35](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L35)* **Parameters:** @@ -387,7 +1882,114 @@ ___ | value | `AnyNumber` | | bitLength | [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) | +**Returns:** `string` + +___ + + +## `` isBN + +▸ **isBN**(b: *`any`*): `boolean` + +*Inherited from BN.isBN* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:69* + +*__description__*: returns true if the supplied object is a BN.js instance + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `any` | + +**Returns:** `boolean` + +___ + + +## `` max + +▸ **max**(left: *`BN`*, right: *`BN`*): `BN` + +*Inherited from BN.max* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:74* + +*__description__*: returns the maximum of 2 BN instances. + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| left | `BN` | +| right | `BN` | + **Returns:** `BN` ___ + + +## `` min + +▸ **min**(left: *`BN`*, right: *`BN`*): `BN` + +*Inherited from BN.min* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:79* + +*__description__*: returns the minimum of 2 BN instances. + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| left | `BN` | +| right | `BN` | + +**Returns:** `BN` + +___ + + +## `` mont + +▸ **mont**(num: *`BN`*): `ReductionContext` + +*Inherited from BN.mont* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:64* + +*__description__*: create a reduction context with the Montgomery trick. + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| num | `BN` | + +**Returns:** `ReductionContext` + +___ + + +## `` red + +▸ **red**(reductionContext: * `BN` | `IPrimeName`*): `ReductionContext` + +*Inherited from BN.red* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:59* + +*__description__*: create a reduction context + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| reductionContext | `BN` | `IPrimeName`| + +**Returns:** `ReductionContext` + +___ diff --git a/docs/types/classes/_permill_.permill.md b/docs/types/classes/_permill_.permill.md index b759119d9a..7622e37504 100644 --- a/docs/types/classes/_permill_.permill.md +++ b/docs/types/classes/_permill_.permill.md @@ -6,6 +6,10 @@ **↳ Permill** +# Implements + +* `Codec` + # Constructors @@ -18,7 +22,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U32.ts:9](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/U32.ts#L9)* +*Defined in [U32.ts:9](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/U32.ts#L9)* **Parameters:** @@ -38,27 +42,14 @@ ___ **● raw**: *`BN`* -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* +*Inherited from [UInt](_codec_uint_.uint.md).[raw](_codec_uint_.uint.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/UInt.ts:23](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L23)* ___ # Accessors - - -## bitLength - -getbitLength(): [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) - -*Inherited from [UInt](_codec_uint_.uint.md).[bitLength](_codec_uint_.uint.md#bitlength)* - -*Defined in [codec/UInt.ts:50](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L50)* - -**Returns:** [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) - -___ ## encodedLength @@ -67,9 +58,7 @@ getencodedLength(): `number` *Inherited from [UInt](_codec_uint_.uint.md).[encodedLength](_codec_uint_.uint.md#encodedlength)* -*Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* - -*Defined in [codec/UInt.ts:54](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L54)* +*Defined in [codec/UInt.ts:55](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L55)* **Returns:** `number` @@ -77,21 +66,167 @@ ___ # Methods + + +## abs + +▸ **abs**(): `BN` + +*Inherited from BN.abs* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:254* + +*__description__*: absolute value + +**Returns:** `BN` + +___ ## add -▸ **add**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **add**(b: *`BN`*): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)* +*Inherited from BN.add* -*Defined in [codec/UInt.ts:86](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L86)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:264* + +*__description__*: addition **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | + +**Returns:** `BN` + +___ + + +## addn + +▸ **addn**(b: *`number`*): `BN` + +*Inherited from BN.addn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:274* + +*__description__*: addition + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## and + +▸ **and**(b: *`BN`*): `BN` + +*Inherited from BN.and* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:395* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## andln + +▸ **andln**(b: *`number`*): `BN` + +*Inherited from BN.andln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:415* + +*__description__*: and (NOTE: `andln` is going to be replaced with `andn` in future) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## bincn + +▸ **bincn**(b: *`number`*): `BN` + +*Inherited from BN.bincn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:499* + +*__description__*: add `1 << b` to the number + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## bitLength + +▸ **bitLength**(): [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) + +*Inherited from [UInt](_codec_uint_.uint.md).[bitLength](_codec_uint_.uint.md#bitlength)* + +*Overrides BN.bitLength* + +*Defined in [codec/UInt.ts:51](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L51)* + +**Returns:** [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) + +___ + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from BN.byteLength* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:144* + +*__description__*: return number of bytes occupied + +**Returns:** `number` + +___ + + +## clone + +▸ **clone**(): `BN` + +*Inherited from BN.clone* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:89* + +*__description__*: clone number **Returns:** `BN` @@ -100,74 +235,229 @@ ___ ## cmp -▸ **cmp**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `number` +▸ **cmp**(b: *`BN`*): `-1` | `0` | `1` -*Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)* +*Inherited from BN.cmp* -*Defined in [codec/UInt.ts:92](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L92)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:169* + +*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | -**Returns:** `number` +**Returns:** `-1` | `0` | `1` + +___ + + +## cmpn + +▸ **cmpn**(b: *`number`*): `-1` | `0` | `1` + +*Inherited from BN.cmpn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:179* + +*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `-1` | `0` | `1` ___ ## div -▸ **div**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **div**(b: *`BN`*): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)* +*Inherited from BN.div* -*Defined in [codec/UInt.ts:98](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L98)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:339* + +*__description__*: divide **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `BN` +___ + + +## divRound + +▸ **divRound**(b: *`BN`*): `BN` + +*Inherited from BN.divRound* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:370* + +*__description__*: rounded division + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## divn + +▸ **divn**(b: *`number`*): `BN` + +*Inherited from BN.divn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:344* + +*__description__*: divide + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## egcd + +▸ **egcd**(b: *`BN`*): `object` + +*Inherited from BN.egcd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:519* + +*__description__*: Extended GCD results `({ a: ..., b: ..., gcd: ... })` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `object` + ___ ## eq -▸ **eq**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **eq**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[eq](_codec_uint_.uint.md#eq)* +*Inherited from BN.eq* -*Defined in [codec/UInt.ts:104](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L104)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:224* + +*__description__*: a equals b **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` +___ + + +## eqn + +▸ **eqn**(b: *`number`*): `boolean` + +*Inherited from BN.eqn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:229* + +*__description__*: a equals b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## fromTwos + +▸ **fromTwos**(width: *`number`*): `BN` + +*Inherited from BN.fromTwos* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:239* + +*__description__*: convert from two's complement representation, where width is the bit width + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| width | `number` | + +**Returns:** `BN` + +___ + + +## gcd + +▸ **gcd**(b: *`BN`*): `BN` + +*Inherited from BN.gcd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:514* + +*__description__*: GCD + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + ___ ## gt -▸ **gt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **gt**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)* +*Inherited from BN.gt* -*Defined in [codec/UInt.ts:126](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L126)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:204* + +*__description__*: a greater than b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` @@ -176,17 +466,346 @@ ___ ## gte -▸ **gte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **gte**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)* +*Inherited from BN.gte* -*Defined in [codec/UInt.ts:132](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L132)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:214* + +*__description__*: a greater than or equals b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | + +**Returns:** `boolean` + +___ + + +## gten + +▸ **gten**(b: *`number`*): `boolean` + +*Inherited from BN.gten* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:219* + +*__description__*: a greater than or equals b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## gtn + +▸ **gtn**(b: *`number`*): `boolean` + +*Inherited from BN.gtn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:209* + +*__description__*: a greater than b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## iabs + +▸ **iabs**(): `BN` + +*Inherited from BN.iabs* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:259* + +*__description__*: absolute value + +**Returns:** `BN` + +___ + + +## iadd + +▸ **iadd**(b: *`BN`*): `BN` + +*Inherited from BN.iadd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:269* + +*__description__*: addition + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## iaddn + +▸ **iaddn**(b: *`number`*): `BN` + +*Inherited from BN.iaddn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:279* + +*__description__*: addition + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iand + +▸ **iand**(b: *`BN`*): `BN` + +*Inherited from BN.iand* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:400* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## idivn + +▸ **idivn**(b: *`number`*): `BN` + +*Inherited from BN.idivn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:349* + +*__description__*: divide + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## imaskn + +▸ **imaskn**(b: *`number`*): `BN` + +*Inherited from BN.imaskn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495* + +*__description__*: clear bits with indexes higher or equal to `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## imul + +▸ **imul**(b: *`BN`*): `BN` + +*Inherited from BN.imul* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:309* + +*__description__*: multiply + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## imuln + +▸ **imuln**(b: *`number`*): `BN` + +*Inherited from BN.imuln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:319* + +*__description__*: multiply + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## ineg + +▸ **ineg**(): `BN` + +*Inherited from BN.ineg* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:249* + +*__description__*: negate sign + +**Returns:** `BN` + +___ + + +## inotn + +▸ **inotn**(w: *`number`*): `BN` + +*Inherited from BN.inotn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:509* + +*__description__*: not (for the width specified by `w`) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| w | `number` | + +**Returns:** `BN` + +___ + + +## invm + +▸ **invm**(b: *`BN`*): `BN` + +*Inherited from BN.invm* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:524* + +*__description__*: inverse `a` modulo `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ior + +▸ **ior**(b: *`BN`*): `BN` + +*Inherited from BN.ior* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:380* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## isEven + +▸ **isEven**(): `boolean` + +*Inherited from BN.isEven* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:154* + +*__description__*: check if value is even + +**Returns:** `boolean` + +___ + + +## isNeg + +▸ **isNeg**(): `boolean` + +*Inherited from BN.isNeg* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:149* + +*__description__*: true if the number is negative + +**Returns:** `boolean` + +___ + + +## isOdd + +▸ **isOdd**(): `boolean` + +*Inherited from BN.isOdd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:159* + +*__description__*: check if value is odd **Returns:** `boolean` @@ -197,28 +816,257 @@ ___ ▸ **isZero**(): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)* +*Inherited from BN.isZero* -*Defined in [codec/UInt.ts:110](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L110)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:164* + +*__description__*: check if value is zero **Returns:** `boolean` +___ + + +## ishln + +▸ **ishln**(b: *`number`*): `BN` + +*Inherited from BN.ishln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:450* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## ishrn + +▸ **ishrn**(b: *`number`*): `BN` + +*Inherited from BN.ishrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:470* + +*__description__*: shift right (unimplemented [https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086](https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## isqr + +▸ **isqr**(): `BN` + +*Inherited from BN.isqr* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:329* + +*__description__*: square + +**Returns:** `BN` + +___ + + +## isub + +▸ **isub**(b: *`BN`*): `BN` + +*Inherited from BN.isub* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:289* + +*__description__*: subtraction + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## isubn + +▸ **isubn**(b: *`number`*): `BN` + +*Inherited from BN.isubn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:299* + +*__description__*: subtraction + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iuand + +▸ **iuand**(b: *`BN`*): `BN` + +*Inherited from BN.iuand* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:410* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## iuor + +▸ **iuor**(b: *`BN`*): `BN` + +*Inherited from BN.iuor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:390* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## iushln + +▸ **iushln**(b: *`number`*): `BN` + +*Inherited from BN.iushln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:460* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iushrn + +▸ **iushrn**(b: *`number`*): `BN` + +*Inherited from BN.iushrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480* + +*__description__*: shift right + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iuxor + +▸ **iuxor**(b: *`BN`*): `BN` + +*Inherited from BN.iuxor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:435* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ixor + +▸ **ixor**(b: *`BN`*): `BN` + +*Inherited from BN.ixor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:425* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + ___ ## lt -▸ **lt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **lt**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)* +*Inherited from BN.lt* -*Defined in [codec/UInt.ts:114](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L114)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:184* + +*__description__*: a less than b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` @@ -227,36 +1075,324 @@ ___ ## lte -▸ **lte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **lte**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)* +*Inherited from BN.lte* -*Defined in [codec/UInt.ts:120](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L120)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:194* + +*__description__*: a less than or equals b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` +___ + + +## lten + +▸ **lten**(b: *`number`*): `boolean` + +*Inherited from BN.lten* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:199* + +*__description__*: a less than or equals b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## ltn + +▸ **ltn**(b: *`number`*): `boolean` + +*Inherited from BN.ltn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:189* + +*__description__*: a less than b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## maskn + +▸ **maskn**(b: *`number`*): `BN` + +*Inherited from BN.maskn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490* + +*__description__*: clear bits with indexes higher or equal to `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## mod + +▸ **mod**(b: *`BN`*): `BN` + +*Inherited from BN.mod* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:354* + +*__description__*: reduct + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## modn + +▸ **modn**(b: *`number`*): `number` + +*Inherited from BN.modn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:365* + +*__see__*: API consistency [https://github.com/indutny/bn.js/pull/130](https://github.com/indutny/bn.js/pull/130) + +*__description__*: reduct + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `number` + ___ ## mul -▸ **mul**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **mul**(b: *`BN`*): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)* +*Inherited from BN.mul* -*Defined in [codec/UInt.ts:138](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L138)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:304* + +*__description__*: multiply **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | + +**Returns:** `BN` + +___ + + +## muln + +▸ **muln**(b: *`number`*): `BN` + +*Inherited from BN.muln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:314* + +*__description__*: multiply + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## neg + +▸ **neg**(): `BN` + +*Inherited from BN.neg* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:244* + +*__description__*: negate sign + +**Returns:** `BN` + +___ + + +## notn + +▸ **notn**(w: *`number`*): `BN` + +*Inherited from BN.notn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:504* + +*__description__*: not (for the width specified by `w`) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| w | `number` | + +**Returns:** `BN` + +___ + + +## or + +▸ **or**(b: *`BN`*): `BN` + +*Inherited from BN.or* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:375* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## pow + +▸ **pow**(b: *`BN`*): `BN` + +*Inherited from BN.pow* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:334* + +*__description__*: raise `a` to the power of `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## setn + +▸ **setn**(b: *`number`*): `BN` + +*Inherited from BN.setn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:440* + +*__description__*: set specified bit to 1 + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## shln + +▸ **shln**(b: *`number`*): `BN` + +*Inherited from BN.shln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:445* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## shrn + +▸ **shrn**(b: *`number`*): `BN` + +*Inherited from BN.shrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:465* + +*__description__*: shift right + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## sqr + +▸ **sqr**(): `BN` + +*Inherited from BN.sqr* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:324* + +*__description__*: square **Returns:** `BN` @@ -265,20 +1401,125 @@ ___ ## sub -▸ **sub**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **sub**(b: *`BN`*): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)* +*Inherited from BN.sub* -*Defined in [codec/UInt.ts:144](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L144)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:284* + +*__description__*: subtraction **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `BN` +___ + + +## subn + +▸ **subn**(b: *`number`*): `BN` + +*Inherited from BN.subn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:294* + +*__description__*: subtraction + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## testn + +▸ **testn**(b: *`number`*): `boolean` + +*Inherited from BN.testn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485* + +*__description__*: test if specified bit is set + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## toArray + +▸ **toArray**(endian?: *`Endianness`*, length?: * `undefined` | `number`*): `number`[] + +*Inherited from BN.toArray* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:109* + +*__description__*: convert to byte Array, and optionally zero pad to length, throwing if already exceeding + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `number`[] + +___ + + +## toArrayLike + +▸ **toArrayLike**(ArrayType: *`object`*, endian?: *`Endianness`*, length?: * `undefined` | `number`*): `Buffer` + +▸ **toArrayLike**(ArrayType: *`any`[]*, endian?: *`Endianness`*, length?: * `undefined` | `number`*): `any`[] + +*Inherited from BN.toArrayLike* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:114* + +*__description__*: convert to an instance of `type`, which must behave like an Array + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| ArrayType | `object` | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `Buffer` + +*Inherited from BN.toArrayLike* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| ArrayType | `any`[] | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `any`[] + ___ @@ -288,10 +1529,32 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)* -*Defined in [codec/UInt.ts:76](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L76)* +*Defined in [codec/UInt.ts:73](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L73)* **Returns:** `BN` +___ + + +## toBuffer + +▸ **toBuffer**(endian?: *`Endianness`*, length?: * `undefined` | `number`*): `Buffer` + +*Inherited from BN.toBuffer* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:129* + +*__description__*: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `Buffer` + ___ @@ -301,7 +1564,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* -*Defined in [codec/UInt.ts:58](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L58)* +*Defined in [codec/UInt.ts:59](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L59)* **Returns:** `string` @@ -314,9 +1577,9 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toJSON](_codec_uint_.uint.md#tojson)* -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* +*Overrides BN.toJSON* -*Defined in [codec/UInt.ts:62](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L62)* +*Defined in [codec/UInt.ts:63](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L63)* **Returns:** `any` @@ -327,27 +1590,78 @@ ___ ▸ **toNumber**(): `number` -*Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)* +*Inherited from BN.toNumber* -*Defined in [codec/UInt.ts:80](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L80)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:99* + +*__description__*: convert to Javascript Number (limited to 53 bits) **Returns:** `number` +___ + + +## toRed + +▸ **toRed**(reductionContext: *`ReductionContext`*): `RedBN` + +*Inherited from BN.toRed* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:84* + +*__description__*: Convert number to red + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| reductionContext | `ReductionContext` | + +**Returns:** `RedBN` + ___ ## toString -▸ **toString**(): `string` +▸ **toString**(base?: * `number` | "hex"*, length?: * `undefined` | `number`*): `string` -*Inherited from [UInt](_codec_uint_.uint.md).[toString](_codec_uint_.uint.md#tostring)* +*Inherited from BN.toString* -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:94* -*Defined in [codec/UInt.ts:72](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L72)* +*__description__*: convert to base-string and pad with zeroes + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` base | `number` | "hex"| +| `Optional` length | `undefined` | `number`| **Returns:** `string` +___ + + +## toTwos + +▸ **toTwos**(width: *`number`*): `BN` + +*Inherited from BN.toTwos* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:234* + +*__description__*: convert to two's complement representation, where width is bit width + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| width | `number` | + +**Returns:** `BN` + ___ @@ -357,9 +1671,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/UInt.ts:68](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L68)* +*Defined in [codec/UInt.ts:69](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L69)* **Parameters:** @@ -369,16 +1681,199 @@ ___ **Returns:** `Uint8Array` +___ + + +## uand + +▸ **uand**(b: *`BN`*): `BN` + +*Inherited from BN.uand* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:405* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ucmp + +▸ **ucmp**(b: *`BN`*): `-1` | `0` | `1` + +*Inherited from BN.ucmp* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:174* + +*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `-1` | `0` | `1` + +___ + + +## umod + +▸ **umod**(b: *`BN`*): `BN` + +*Inherited from BN.umod* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:359* + +*__description__*: reduct + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## uor + +▸ **uor**(b: *`BN`*): `BN` + +*Inherited from BN.uor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:385* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ushln + +▸ **ushln**(b: *`number`*): `BN` + +*Inherited from BN.ushln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:455* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## ushrn + +▸ **ushrn**(b: *`number`*): `BN` + +*Inherited from BN.ushrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475* + +*__description__*: shift right + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## uxor + +▸ **uxor**(b: *`BN`*): `BN` + +*Inherited from BN.uxor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:430* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## xor + +▸ **xor**(b: *`BN`*): `BN` + +*Inherited from BN.xor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:420* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## zeroBits + +▸ **zeroBits**(): `number` + +*Inherited from BN.zeroBits* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:139* + +*__description__*: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits) + +**Returns:** `number` + ___ ## `` decodeUInt -▸ **decodeUInt**(value: *`AnyNumber`*, bitLength: *[UIntBitLength](../modules/_codec_uint_.md#uintbitlength)*): `BN` +▸ **decodeUInt**(value: *`AnyNumber`*, bitLength: *[UIntBitLength](../modules/_codec_uint_.md#uintbitlength)*): `string` *Inherited from [UInt](_codec_uint_.uint.md).[decodeUInt](_codec_uint_.uint.md#decodeuint)* -*Defined in [codec/UInt.ts:35](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L35)* +*Defined in [codec/UInt.ts:35](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L35)* **Parameters:** @@ -387,7 +1882,114 @@ ___ | value | `AnyNumber` | | bitLength | [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) | +**Returns:** `string` + +___ + + +## `` isBN + +▸ **isBN**(b: *`any`*): `boolean` + +*Inherited from BN.isBN* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:69* + +*__description__*: returns true if the supplied object is a BN.js instance + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `any` | + +**Returns:** `boolean` + +___ + + +## `` max + +▸ **max**(left: *`BN`*, right: *`BN`*): `BN` + +*Inherited from BN.max* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:74* + +*__description__*: returns the maximum of 2 BN instances. + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| left | `BN` | +| right | `BN` | + **Returns:** `BN` ___ + + +## `` min + +▸ **min**(left: *`BN`*, right: *`BN`*): `BN` + +*Inherited from BN.min* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:79* + +*__description__*: returns the minimum of 2 BN instances. + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| left | `BN` | +| right | `BN` | + +**Returns:** `BN` + +___ + + +## `` mont + +▸ **mont**(num: *`BN`*): `ReductionContext` + +*Inherited from BN.mont* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:64* + +*__description__*: create a reduction context with the Montgomery trick. + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| num | `BN` | + +**Returns:** `ReductionContext` + +___ + + +## `` red + +▸ **red**(reductionContext: * `BN` | `IPrimeName`*): `ReductionContext` + +*Inherited from BN.red* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:59* + +*__description__*: create a reduction context + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| reductionContext | `BN` | `IPrimeName`| + +**Returns:** `ReductionContext` + +___ diff --git a/docs/types/classes/_propindex_.propindex.md b/docs/types/classes/_propindex_.propindex.md index 7fb8f9f118..9af0d146c1 100644 --- a/docs/types/classes/_propindex_.propindex.md +++ b/docs/types/classes/_propindex_.propindex.md @@ -6,6 +6,10 @@ **↳ PropIndex** +# Implements + +* `Codec` + # Constructors @@ -18,7 +22,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U32.ts:9](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/U32.ts#L9)* +*Defined in [U32.ts:9](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/U32.ts#L9)* **Parameters:** @@ -38,27 +42,14 @@ ___ **● raw**: *`BN`* -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* +*Inherited from [UInt](_codec_uint_.uint.md).[raw](_codec_uint_.uint.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/UInt.ts:23](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L23)* ___ # Accessors - - -## bitLength - -getbitLength(): [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) - -*Inherited from [UInt](_codec_uint_.uint.md).[bitLength](_codec_uint_.uint.md#bitlength)* - -*Defined in [codec/UInt.ts:50](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L50)* - -**Returns:** [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) - -___ ## encodedLength @@ -67,9 +58,7 @@ getencodedLength(): `number` *Inherited from [UInt](_codec_uint_.uint.md).[encodedLength](_codec_uint_.uint.md#encodedlength)* -*Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* - -*Defined in [codec/UInt.ts:54](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L54)* +*Defined in [codec/UInt.ts:55](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L55)* **Returns:** `number` @@ -77,21 +66,167 @@ ___ # Methods + + +## abs + +▸ **abs**(): `BN` + +*Inherited from BN.abs* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:254* + +*__description__*: absolute value + +**Returns:** `BN` + +___ ## add -▸ **add**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **add**(b: *`BN`*): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)* +*Inherited from BN.add* -*Defined in [codec/UInt.ts:86](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L86)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:264* + +*__description__*: addition **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | + +**Returns:** `BN` + +___ + + +## addn + +▸ **addn**(b: *`number`*): `BN` + +*Inherited from BN.addn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:274* + +*__description__*: addition + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## and + +▸ **and**(b: *`BN`*): `BN` + +*Inherited from BN.and* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:395* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## andln + +▸ **andln**(b: *`number`*): `BN` + +*Inherited from BN.andln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:415* + +*__description__*: and (NOTE: `andln` is going to be replaced with `andn` in future) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## bincn + +▸ **bincn**(b: *`number`*): `BN` + +*Inherited from BN.bincn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:499* + +*__description__*: add `1 << b` to the number + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## bitLength + +▸ **bitLength**(): [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) + +*Inherited from [UInt](_codec_uint_.uint.md).[bitLength](_codec_uint_.uint.md#bitlength)* + +*Overrides BN.bitLength* + +*Defined in [codec/UInt.ts:51](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L51)* + +**Returns:** [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) + +___ + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from BN.byteLength* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:144* + +*__description__*: return number of bytes occupied + +**Returns:** `number` + +___ + + +## clone + +▸ **clone**(): `BN` + +*Inherited from BN.clone* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:89* + +*__description__*: clone number **Returns:** `BN` @@ -100,74 +235,229 @@ ___ ## cmp -▸ **cmp**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `number` +▸ **cmp**(b: *`BN`*): `-1` | `0` | `1` -*Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)* +*Inherited from BN.cmp* -*Defined in [codec/UInt.ts:92](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L92)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:169* + +*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | -**Returns:** `number` +**Returns:** `-1` | `0` | `1` + +___ + + +## cmpn + +▸ **cmpn**(b: *`number`*): `-1` | `0` | `1` + +*Inherited from BN.cmpn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:179* + +*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `-1` | `0` | `1` ___ ## div -▸ **div**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **div**(b: *`BN`*): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)* +*Inherited from BN.div* -*Defined in [codec/UInt.ts:98](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L98)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:339* + +*__description__*: divide **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `BN` +___ + + +## divRound + +▸ **divRound**(b: *`BN`*): `BN` + +*Inherited from BN.divRound* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:370* + +*__description__*: rounded division + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## divn + +▸ **divn**(b: *`number`*): `BN` + +*Inherited from BN.divn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:344* + +*__description__*: divide + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## egcd + +▸ **egcd**(b: *`BN`*): `object` + +*Inherited from BN.egcd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:519* + +*__description__*: Extended GCD results `({ a: ..., b: ..., gcd: ... })` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `object` + ___ ## eq -▸ **eq**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **eq**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[eq](_codec_uint_.uint.md#eq)* +*Inherited from BN.eq* -*Defined in [codec/UInt.ts:104](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L104)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:224* + +*__description__*: a equals b **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` +___ + + +## eqn + +▸ **eqn**(b: *`number`*): `boolean` + +*Inherited from BN.eqn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:229* + +*__description__*: a equals b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## fromTwos + +▸ **fromTwos**(width: *`number`*): `BN` + +*Inherited from BN.fromTwos* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:239* + +*__description__*: convert from two's complement representation, where width is the bit width + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| width | `number` | + +**Returns:** `BN` + +___ + + +## gcd + +▸ **gcd**(b: *`BN`*): `BN` + +*Inherited from BN.gcd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:514* + +*__description__*: GCD + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + ___ ## gt -▸ **gt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **gt**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)* +*Inherited from BN.gt* -*Defined in [codec/UInt.ts:126](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L126)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:204* + +*__description__*: a greater than b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` @@ -176,17 +466,346 @@ ___ ## gte -▸ **gte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **gte**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)* +*Inherited from BN.gte* -*Defined in [codec/UInt.ts:132](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L132)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:214* + +*__description__*: a greater than or equals b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | + +**Returns:** `boolean` + +___ + + +## gten + +▸ **gten**(b: *`number`*): `boolean` + +*Inherited from BN.gten* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:219* + +*__description__*: a greater than or equals b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## gtn + +▸ **gtn**(b: *`number`*): `boolean` + +*Inherited from BN.gtn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:209* + +*__description__*: a greater than b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## iabs + +▸ **iabs**(): `BN` + +*Inherited from BN.iabs* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:259* + +*__description__*: absolute value + +**Returns:** `BN` + +___ + + +## iadd + +▸ **iadd**(b: *`BN`*): `BN` + +*Inherited from BN.iadd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:269* + +*__description__*: addition + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## iaddn + +▸ **iaddn**(b: *`number`*): `BN` + +*Inherited from BN.iaddn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:279* + +*__description__*: addition + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iand + +▸ **iand**(b: *`BN`*): `BN` + +*Inherited from BN.iand* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:400* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## idivn + +▸ **idivn**(b: *`number`*): `BN` + +*Inherited from BN.idivn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:349* + +*__description__*: divide + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## imaskn + +▸ **imaskn**(b: *`number`*): `BN` + +*Inherited from BN.imaskn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495* + +*__description__*: clear bits with indexes higher or equal to `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## imul + +▸ **imul**(b: *`BN`*): `BN` + +*Inherited from BN.imul* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:309* + +*__description__*: multiply + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## imuln + +▸ **imuln**(b: *`number`*): `BN` + +*Inherited from BN.imuln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:319* + +*__description__*: multiply + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## ineg + +▸ **ineg**(): `BN` + +*Inherited from BN.ineg* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:249* + +*__description__*: negate sign + +**Returns:** `BN` + +___ + + +## inotn + +▸ **inotn**(w: *`number`*): `BN` + +*Inherited from BN.inotn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:509* + +*__description__*: not (for the width specified by `w`) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| w | `number` | + +**Returns:** `BN` + +___ + + +## invm + +▸ **invm**(b: *`BN`*): `BN` + +*Inherited from BN.invm* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:524* + +*__description__*: inverse `a` modulo `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ior + +▸ **ior**(b: *`BN`*): `BN` + +*Inherited from BN.ior* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:380* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## isEven + +▸ **isEven**(): `boolean` + +*Inherited from BN.isEven* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:154* + +*__description__*: check if value is even + +**Returns:** `boolean` + +___ + + +## isNeg + +▸ **isNeg**(): `boolean` + +*Inherited from BN.isNeg* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:149* + +*__description__*: true if the number is negative + +**Returns:** `boolean` + +___ + + +## isOdd + +▸ **isOdd**(): `boolean` + +*Inherited from BN.isOdd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:159* + +*__description__*: check if value is odd **Returns:** `boolean` @@ -197,28 +816,257 @@ ___ ▸ **isZero**(): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)* +*Inherited from BN.isZero* -*Defined in [codec/UInt.ts:110](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L110)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:164* + +*__description__*: check if value is zero **Returns:** `boolean` +___ + + +## ishln + +▸ **ishln**(b: *`number`*): `BN` + +*Inherited from BN.ishln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:450* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## ishrn + +▸ **ishrn**(b: *`number`*): `BN` + +*Inherited from BN.ishrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:470* + +*__description__*: shift right (unimplemented [https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086](https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## isqr + +▸ **isqr**(): `BN` + +*Inherited from BN.isqr* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:329* + +*__description__*: square + +**Returns:** `BN` + +___ + + +## isub + +▸ **isub**(b: *`BN`*): `BN` + +*Inherited from BN.isub* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:289* + +*__description__*: subtraction + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## isubn + +▸ **isubn**(b: *`number`*): `BN` + +*Inherited from BN.isubn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:299* + +*__description__*: subtraction + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iuand + +▸ **iuand**(b: *`BN`*): `BN` + +*Inherited from BN.iuand* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:410* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## iuor + +▸ **iuor**(b: *`BN`*): `BN` + +*Inherited from BN.iuor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:390* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## iushln + +▸ **iushln**(b: *`number`*): `BN` + +*Inherited from BN.iushln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:460* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iushrn + +▸ **iushrn**(b: *`number`*): `BN` + +*Inherited from BN.iushrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480* + +*__description__*: shift right + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iuxor + +▸ **iuxor**(b: *`BN`*): `BN` + +*Inherited from BN.iuxor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:435* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ixor + +▸ **ixor**(b: *`BN`*): `BN` + +*Inherited from BN.ixor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:425* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + ___ ## lt -▸ **lt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **lt**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)* +*Inherited from BN.lt* -*Defined in [codec/UInt.ts:114](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L114)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:184* + +*__description__*: a less than b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` @@ -227,36 +1075,324 @@ ___ ## lte -▸ **lte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **lte**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)* +*Inherited from BN.lte* -*Defined in [codec/UInt.ts:120](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L120)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:194* + +*__description__*: a less than or equals b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` +___ + + +## lten + +▸ **lten**(b: *`number`*): `boolean` + +*Inherited from BN.lten* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:199* + +*__description__*: a less than or equals b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## ltn + +▸ **ltn**(b: *`number`*): `boolean` + +*Inherited from BN.ltn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:189* + +*__description__*: a less than b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## maskn + +▸ **maskn**(b: *`number`*): `BN` + +*Inherited from BN.maskn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490* + +*__description__*: clear bits with indexes higher or equal to `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## mod + +▸ **mod**(b: *`BN`*): `BN` + +*Inherited from BN.mod* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:354* + +*__description__*: reduct + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## modn + +▸ **modn**(b: *`number`*): `number` + +*Inherited from BN.modn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:365* + +*__see__*: API consistency [https://github.com/indutny/bn.js/pull/130](https://github.com/indutny/bn.js/pull/130) + +*__description__*: reduct + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `number` + ___ ## mul -▸ **mul**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **mul**(b: *`BN`*): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)* +*Inherited from BN.mul* -*Defined in [codec/UInt.ts:138](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L138)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:304* + +*__description__*: multiply **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | + +**Returns:** `BN` + +___ + + +## muln + +▸ **muln**(b: *`number`*): `BN` + +*Inherited from BN.muln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:314* + +*__description__*: multiply + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## neg + +▸ **neg**(): `BN` + +*Inherited from BN.neg* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:244* + +*__description__*: negate sign + +**Returns:** `BN` + +___ + + +## notn + +▸ **notn**(w: *`number`*): `BN` + +*Inherited from BN.notn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:504* + +*__description__*: not (for the width specified by `w`) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| w | `number` | + +**Returns:** `BN` + +___ + + +## or + +▸ **or**(b: *`BN`*): `BN` + +*Inherited from BN.or* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:375* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## pow + +▸ **pow**(b: *`BN`*): `BN` + +*Inherited from BN.pow* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:334* + +*__description__*: raise `a` to the power of `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## setn + +▸ **setn**(b: *`number`*): `BN` + +*Inherited from BN.setn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:440* + +*__description__*: set specified bit to 1 + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## shln + +▸ **shln**(b: *`number`*): `BN` + +*Inherited from BN.shln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:445* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## shrn + +▸ **shrn**(b: *`number`*): `BN` + +*Inherited from BN.shrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:465* + +*__description__*: shift right + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## sqr + +▸ **sqr**(): `BN` + +*Inherited from BN.sqr* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:324* + +*__description__*: square **Returns:** `BN` @@ -265,20 +1401,125 @@ ___ ## sub -▸ **sub**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **sub**(b: *`BN`*): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)* +*Inherited from BN.sub* -*Defined in [codec/UInt.ts:144](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L144)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:284* + +*__description__*: subtraction **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `BN` +___ + + +## subn + +▸ **subn**(b: *`number`*): `BN` + +*Inherited from BN.subn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:294* + +*__description__*: subtraction + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## testn + +▸ **testn**(b: *`number`*): `boolean` + +*Inherited from BN.testn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485* + +*__description__*: test if specified bit is set + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## toArray + +▸ **toArray**(endian?: *`Endianness`*, length?: * `undefined` | `number`*): `number`[] + +*Inherited from BN.toArray* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:109* + +*__description__*: convert to byte Array, and optionally zero pad to length, throwing if already exceeding + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `number`[] + +___ + + +## toArrayLike + +▸ **toArrayLike**(ArrayType: *`object`*, endian?: *`Endianness`*, length?: * `undefined` | `number`*): `Buffer` + +▸ **toArrayLike**(ArrayType: *`any`[]*, endian?: *`Endianness`*, length?: * `undefined` | `number`*): `any`[] + +*Inherited from BN.toArrayLike* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:114* + +*__description__*: convert to an instance of `type`, which must behave like an Array + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| ArrayType | `object` | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `Buffer` + +*Inherited from BN.toArrayLike* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| ArrayType | `any`[] | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `any`[] + ___ @@ -288,10 +1529,32 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)* -*Defined in [codec/UInt.ts:76](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L76)* +*Defined in [codec/UInt.ts:73](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L73)* **Returns:** `BN` +___ + + +## toBuffer + +▸ **toBuffer**(endian?: *`Endianness`*, length?: * `undefined` | `number`*): `Buffer` + +*Inherited from BN.toBuffer* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:129* + +*__description__*: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `Buffer` + ___ @@ -301,7 +1564,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* -*Defined in [codec/UInt.ts:58](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L58)* +*Defined in [codec/UInt.ts:59](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L59)* **Returns:** `string` @@ -314,9 +1577,9 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toJSON](_codec_uint_.uint.md#tojson)* -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* +*Overrides BN.toJSON* -*Defined in [codec/UInt.ts:62](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L62)* +*Defined in [codec/UInt.ts:63](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L63)* **Returns:** `any` @@ -327,27 +1590,78 @@ ___ ▸ **toNumber**(): `number` -*Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)* +*Inherited from BN.toNumber* -*Defined in [codec/UInt.ts:80](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L80)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:99* + +*__description__*: convert to Javascript Number (limited to 53 bits) **Returns:** `number` +___ + + +## toRed + +▸ **toRed**(reductionContext: *`ReductionContext`*): `RedBN` + +*Inherited from BN.toRed* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:84* + +*__description__*: Convert number to red + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| reductionContext | `ReductionContext` | + +**Returns:** `RedBN` + ___ ## toString -▸ **toString**(): `string` +▸ **toString**(base?: * `number` | "hex"*, length?: * `undefined` | `number`*): `string` -*Inherited from [UInt](_codec_uint_.uint.md).[toString](_codec_uint_.uint.md#tostring)* +*Inherited from BN.toString* -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:94* -*Defined in [codec/UInt.ts:72](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L72)* +*__description__*: convert to base-string and pad with zeroes + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` base | `number` | "hex"| +| `Optional` length | `undefined` | `number`| **Returns:** `string` +___ + + +## toTwos + +▸ **toTwos**(width: *`number`*): `BN` + +*Inherited from BN.toTwos* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:234* + +*__description__*: convert to two's complement representation, where width is bit width + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| width | `number` | + +**Returns:** `BN` + ___ @@ -357,9 +1671,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/UInt.ts:68](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L68)* +*Defined in [codec/UInt.ts:69](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L69)* **Parameters:** @@ -369,16 +1681,199 @@ ___ **Returns:** `Uint8Array` +___ + + +## uand + +▸ **uand**(b: *`BN`*): `BN` + +*Inherited from BN.uand* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:405* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ucmp + +▸ **ucmp**(b: *`BN`*): `-1` | `0` | `1` + +*Inherited from BN.ucmp* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:174* + +*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `-1` | `0` | `1` + +___ + + +## umod + +▸ **umod**(b: *`BN`*): `BN` + +*Inherited from BN.umod* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:359* + +*__description__*: reduct + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## uor + +▸ **uor**(b: *`BN`*): `BN` + +*Inherited from BN.uor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:385* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ushln + +▸ **ushln**(b: *`number`*): `BN` + +*Inherited from BN.ushln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:455* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## ushrn + +▸ **ushrn**(b: *`number`*): `BN` + +*Inherited from BN.ushrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475* + +*__description__*: shift right + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## uxor + +▸ **uxor**(b: *`BN`*): `BN` + +*Inherited from BN.uxor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:430* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## xor + +▸ **xor**(b: *`BN`*): `BN` + +*Inherited from BN.xor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:420* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## zeroBits + +▸ **zeroBits**(): `number` + +*Inherited from BN.zeroBits* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:139* + +*__description__*: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits) + +**Returns:** `number` + ___ ## `` decodeUInt -▸ **decodeUInt**(value: *`AnyNumber`*, bitLength: *[UIntBitLength](../modules/_codec_uint_.md#uintbitlength)*): `BN` +▸ **decodeUInt**(value: *`AnyNumber`*, bitLength: *[UIntBitLength](../modules/_codec_uint_.md#uintbitlength)*): `string` *Inherited from [UInt](_codec_uint_.uint.md).[decodeUInt](_codec_uint_.uint.md#decodeuint)* -*Defined in [codec/UInt.ts:35](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L35)* +*Defined in [codec/UInt.ts:35](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L35)* **Parameters:** @@ -387,7 +1882,114 @@ ___ | value | `AnyNumber` | | bitLength | [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) | +**Returns:** `string` + +___ + + +## `` isBN + +▸ **isBN**(b: *`any`*): `boolean` + +*Inherited from BN.isBN* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:69* + +*__description__*: returns true if the supplied object is a BN.js instance + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `any` | + +**Returns:** `boolean` + +___ + + +## `` max + +▸ **max**(left: *`BN`*, right: *`BN`*): `BN` + +*Inherited from BN.max* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:74* + +*__description__*: returns the maximum of 2 BN instances. + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| left | `BN` | +| right | `BN` | + **Returns:** `BN` ___ + + +## `` min + +▸ **min**(left: *`BN`*, right: *`BN`*): `BN` + +*Inherited from BN.min* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:79* + +*__description__*: returns the minimum of 2 BN instances. + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| left | `BN` | +| right | `BN` | + +**Returns:** `BN` + +___ + + +## `` mont + +▸ **mont**(num: *`BN`*): `ReductionContext` + +*Inherited from BN.mont* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:64* + +*__description__*: create a reduction context with the Montgomery trick. + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| num | `BN` | + +**Returns:** `ReductionContext` + +___ + + +## `` red + +▸ **red**(reductionContext: * `BN` | `IPrimeName`*): `ReductionContext` + +*Inherited from BN.red* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:59* + +*__description__*: create a reduction context + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| reductionContext | `BN` | `IPrimeName`| + +**Returns:** `ReductionContext` + +___ diff --git a/docs/types/classes/_proposal_.proposal.md b/docs/types/classes/_proposal_.proposal.md index fde8276cfa..dc173d0083 100644 --- a/docs/types/classes/_proposal_.proposal.md +++ b/docs/types/classes/_proposal_.proposal.md @@ -27,7 +27,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Method.ts:47](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Method.ts#L47)* +*Defined in [Method.ts:47](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Method.ts#L47)* **Parameters:** @@ -61,7 +61,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L25)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L25)* ___ @@ -86,7 +86,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L123)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -99,7 +99,7 @@ getargs(): `Array`<[Base](_codec_base_.base.md)> *Inherited from [Method](_method_.method.md).[args](_method_.method.md#args)* -*Defined in [Method.ts:169](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Method.ts#L169)* +*Defined in [Method.ts:169](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Method.ts#L169)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -112,7 +112,7 @@ getargsDef(): `ArgsDef` *Inherited from [Method](_method_.method.md).[argsDef](_method_.method.md#argsdef)* -*Defined in [Method.ts:174](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Method.ts#L174)* +*Defined in [Method.ts:174](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Method.ts#L174)* **Returns:** `ArgsDef` @@ -125,7 +125,7 @@ getcallIndex(): `Uint8Array` *Inherited from [Method](_method_.method.md).[callIndex](_method_.method.md#callindex)* -*Defined in [Method.ts:178](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Method.ts#L178)* +*Defined in [Method.ts:178](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Method.ts#L178)* **Returns:** `Uint8Array` @@ -138,7 +138,7 @@ getdata(): `Uint8Array` *Inherited from [Method](_method_.method.md).[data](_method_.method.md#data)* -*Defined in [Method.ts:182](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Method.ts#L182)* +*Defined in [Method.ts:182](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Method.ts#L182)* **Returns:** `Uint8Array` @@ -151,7 +151,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L127)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -164,7 +164,7 @@ getmeta(): [FunctionMetadata](_metadata_.functionmetadata.md) *Inherited from [Method](_method_.method.md).[meta](_method_.method.md#meta)* -*Defined in [Method.ts:186](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Method.ts#L186)* +*Defined in [Method.ts:186](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Method.ts#L186)* **Returns:** [FunctionMetadata](_metadata_.functionmetadata.md) @@ -281,7 +281,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L133)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -354,7 +354,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L137)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -367,7 +367,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L141)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -380,7 +380,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L145)* **Returns:** `any` @@ -393,7 +393,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L156)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -406,7 +406,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -440,7 +440,7 @@ ___ *Inherited from [Method](_method_.method.md).[filterOrigin](_method_.method.md#filterorigin)* -*Defined in [Method.ts:120](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Method.ts#L120)* +*Defined in [Method.ts:120](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Method.ts#L120)* **Parameters:** @@ -459,7 +459,7 @@ ___ *Inherited from [Method](_method_.method.md).[findFunction](_method_.method.md#findfunction)* -*Defined in [Method.ts:136](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Method.ts#L136)* +*Defined in [Method.ts:136](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Method.ts#L136)* **Parameters:** @@ -478,7 +478,7 @@ ___ *Inherited from [Method](_method_.method.md).[injectExtrinsics](_method_.method.md#injectextrinsics)* -*Defined in [Method.ts:161](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Method.ts#L161)* +*Defined in [Method.ts:161](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Method.ts#L161)* **Parameters:** @@ -497,7 +497,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L113)* +*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/types/classes/_proposalindex_.proposalindex.md b/docs/types/classes/_proposalindex_.proposalindex.md index 5bf35d1584..aef3d162bd 100644 --- a/docs/types/classes/_proposalindex_.proposalindex.md +++ b/docs/types/classes/_proposalindex_.proposalindex.md @@ -6,6 +6,10 @@ **↳ ProposalIndex** +# Implements + +* `Codec` + # Constructors @@ -18,7 +22,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U32.ts:9](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/U32.ts#L9)* +*Defined in [U32.ts:9](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/U32.ts#L9)* **Parameters:** @@ -38,27 +42,14 @@ ___ **● raw**: *`BN`* -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* +*Inherited from [UInt](_codec_uint_.uint.md).[raw](_codec_uint_.uint.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/UInt.ts:23](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L23)* ___ # Accessors - - -## bitLength - -getbitLength(): [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) - -*Inherited from [UInt](_codec_uint_.uint.md).[bitLength](_codec_uint_.uint.md#bitlength)* - -*Defined in [codec/UInt.ts:50](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L50)* - -**Returns:** [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) - -___ ## encodedLength @@ -67,9 +58,7 @@ getencodedLength(): `number` *Inherited from [UInt](_codec_uint_.uint.md).[encodedLength](_codec_uint_.uint.md#encodedlength)* -*Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* - -*Defined in [codec/UInt.ts:54](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L54)* +*Defined in [codec/UInt.ts:55](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L55)* **Returns:** `number` @@ -77,21 +66,167 @@ ___ # Methods + + +## abs + +▸ **abs**(): `BN` + +*Inherited from BN.abs* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:254* + +*__description__*: absolute value + +**Returns:** `BN` + +___ ## add -▸ **add**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **add**(b: *`BN`*): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)* +*Inherited from BN.add* -*Defined in [codec/UInt.ts:86](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L86)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:264* + +*__description__*: addition **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | + +**Returns:** `BN` + +___ + + +## addn + +▸ **addn**(b: *`number`*): `BN` + +*Inherited from BN.addn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:274* + +*__description__*: addition + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## and + +▸ **and**(b: *`BN`*): `BN` + +*Inherited from BN.and* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:395* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## andln + +▸ **andln**(b: *`number`*): `BN` + +*Inherited from BN.andln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:415* + +*__description__*: and (NOTE: `andln` is going to be replaced with `andn` in future) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## bincn + +▸ **bincn**(b: *`number`*): `BN` + +*Inherited from BN.bincn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:499* + +*__description__*: add `1 << b` to the number + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## bitLength + +▸ **bitLength**(): [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) + +*Inherited from [UInt](_codec_uint_.uint.md).[bitLength](_codec_uint_.uint.md#bitlength)* + +*Overrides BN.bitLength* + +*Defined in [codec/UInt.ts:51](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L51)* + +**Returns:** [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) + +___ + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from BN.byteLength* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:144* + +*__description__*: return number of bytes occupied + +**Returns:** `number` + +___ + + +## clone + +▸ **clone**(): `BN` + +*Inherited from BN.clone* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:89* + +*__description__*: clone number **Returns:** `BN` @@ -100,74 +235,229 @@ ___ ## cmp -▸ **cmp**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `number` +▸ **cmp**(b: *`BN`*): `-1` | `0` | `1` -*Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)* +*Inherited from BN.cmp* -*Defined in [codec/UInt.ts:92](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L92)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:169* + +*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | -**Returns:** `number` +**Returns:** `-1` | `0` | `1` + +___ + + +## cmpn + +▸ **cmpn**(b: *`number`*): `-1` | `0` | `1` + +*Inherited from BN.cmpn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:179* + +*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `-1` | `0` | `1` ___ ## div -▸ **div**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **div**(b: *`BN`*): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)* +*Inherited from BN.div* -*Defined in [codec/UInt.ts:98](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L98)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:339* + +*__description__*: divide **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `BN` +___ + + +## divRound + +▸ **divRound**(b: *`BN`*): `BN` + +*Inherited from BN.divRound* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:370* + +*__description__*: rounded division + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## divn + +▸ **divn**(b: *`number`*): `BN` + +*Inherited from BN.divn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:344* + +*__description__*: divide + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## egcd + +▸ **egcd**(b: *`BN`*): `object` + +*Inherited from BN.egcd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:519* + +*__description__*: Extended GCD results `({ a: ..., b: ..., gcd: ... })` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `object` + ___ ## eq -▸ **eq**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **eq**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[eq](_codec_uint_.uint.md#eq)* +*Inherited from BN.eq* -*Defined in [codec/UInt.ts:104](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L104)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:224* + +*__description__*: a equals b **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` +___ + + +## eqn + +▸ **eqn**(b: *`number`*): `boolean` + +*Inherited from BN.eqn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:229* + +*__description__*: a equals b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## fromTwos + +▸ **fromTwos**(width: *`number`*): `BN` + +*Inherited from BN.fromTwos* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:239* + +*__description__*: convert from two's complement representation, where width is the bit width + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| width | `number` | + +**Returns:** `BN` + +___ + + +## gcd + +▸ **gcd**(b: *`BN`*): `BN` + +*Inherited from BN.gcd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:514* + +*__description__*: GCD + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + ___ ## gt -▸ **gt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **gt**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)* +*Inherited from BN.gt* -*Defined in [codec/UInt.ts:126](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L126)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:204* + +*__description__*: a greater than b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` @@ -176,17 +466,346 @@ ___ ## gte -▸ **gte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **gte**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)* +*Inherited from BN.gte* -*Defined in [codec/UInt.ts:132](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L132)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:214* + +*__description__*: a greater than or equals b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | + +**Returns:** `boolean` + +___ + + +## gten + +▸ **gten**(b: *`number`*): `boolean` + +*Inherited from BN.gten* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:219* + +*__description__*: a greater than or equals b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## gtn + +▸ **gtn**(b: *`number`*): `boolean` + +*Inherited from BN.gtn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:209* + +*__description__*: a greater than b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## iabs + +▸ **iabs**(): `BN` + +*Inherited from BN.iabs* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:259* + +*__description__*: absolute value + +**Returns:** `BN` + +___ + + +## iadd + +▸ **iadd**(b: *`BN`*): `BN` + +*Inherited from BN.iadd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:269* + +*__description__*: addition + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## iaddn + +▸ **iaddn**(b: *`number`*): `BN` + +*Inherited from BN.iaddn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:279* + +*__description__*: addition + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iand + +▸ **iand**(b: *`BN`*): `BN` + +*Inherited from BN.iand* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:400* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## idivn + +▸ **idivn**(b: *`number`*): `BN` + +*Inherited from BN.idivn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:349* + +*__description__*: divide + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## imaskn + +▸ **imaskn**(b: *`number`*): `BN` + +*Inherited from BN.imaskn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495* + +*__description__*: clear bits with indexes higher or equal to `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## imul + +▸ **imul**(b: *`BN`*): `BN` + +*Inherited from BN.imul* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:309* + +*__description__*: multiply + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## imuln + +▸ **imuln**(b: *`number`*): `BN` + +*Inherited from BN.imuln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:319* + +*__description__*: multiply + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## ineg + +▸ **ineg**(): `BN` + +*Inherited from BN.ineg* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:249* + +*__description__*: negate sign + +**Returns:** `BN` + +___ + + +## inotn + +▸ **inotn**(w: *`number`*): `BN` + +*Inherited from BN.inotn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:509* + +*__description__*: not (for the width specified by `w`) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| w | `number` | + +**Returns:** `BN` + +___ + + +## invm + +▸ **invm**(b: *`BN`*): `BN` + +*Inherited from BN.invm* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:524* + +*__description__*: inverse `a` modulo `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ior + +▸ **ior**(b: *`BN`*): `BN` + +*Inherited from BN.ior* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:380* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## isEven + +▸ **isEven**(): `boolean` + +*Inherited from BN.isEven* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:154* + +*__description__*: check if value is even + +**Returns:** `boolean` + +___ + + +## isNeg + +▸ **isNeg**(): `boolean` + +*Inherited from BN.isNeg* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:149* + +*__description__*: true if the number is negative + +**Returns:** `boolean` + +___ + + +## isOdd + +▸ **isOdd**(): `boolean` + +*Inherited from BN.isOdd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:159* + +*__description__*: check if value is odd **Returns:** `boolean` @@ -197,28 +816,257 @@ ___ ▸ **isZero**(): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)* +*Inherited from BN.isZero* -*Defined in [codec/UInt.ts:110](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L110)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:164* + +*__description__*: check if value is zero **Returns:** `boolean` +___ + + +## ishln + +▸ **ishln**(b: *`number`*): `BN` + +*Inherited from BN.ishln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:450* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## ishrn + +▸ **ishrn**(b: *`number`*): `BN` + +*Inherited from BN.ishrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:470* + +*__description__*: shift right (unimplemented [https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086](https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## isqr + +▸ **isqr**(): `BN` + +*Inherited from BN.isqr* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:329* + +*__description__*: square + +**Returns:** `BN` + +___ + + +## isub + +▸ **isub**(b: *`BN`*): `BN` + +*Inherited from BN.isub* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:289* + +*__description__*: subtraction + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## isubn + +▸ **isubn**(b: *`number`*): `BN` + +*Inherited from BN.isubn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:299* + +*__description__*: subtraction + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iuand + +▸ **iuand**(b: *`BN`*): `BN` + +*Inherited from BN.iuand* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:410* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## iuor + +▸ **iuor**(b: *`BN`*): `BN` + +*Inherited from BN.iuor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:390* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## iushln + +▸ **iushln**(b: *`number`*): `BN` + +*Inherited from BN.iushln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:460* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iushrn + +▸ **iushrn**(b: *`number`*): `BN` + +*Inherited from BN.iushrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480* + +*__description__*: shift right + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iuxor + +▸ **iuxor**(b: *`BN`*): `BN` + +*Inherited from BN.iuxor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:435* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ixor + +▸ **ixor**(b: *`BN`*): `BN` + +*Inherited from BN.ixor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:425* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + ___ ## lt -▸ **lt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **lt**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)* +*Inherited from BN.lt* -*Defined in [codec/UInt.ts:114](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L114)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:184* + +*__description__*: a less than b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` @@ -227,36 +1075,324 @@ ___ ## lte -▸ **lte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **lte**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)* +*Inherited from BN.lte* -*Defined in [codec/UInt.ts:120](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L120)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:194* + +*__description__*: a less than or equals b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` +___ + + +## lten + +▸ **lten**(b: *`number`*): `boolean` + +*Inherited from BN.lten* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:199* + +*__description__*: a less than or equals b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## ltn + +▸ **ltn**(b: *`number`*): `boolean` + +*Inherited from BN.ltn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:189* + +*__description__*: a less than b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## maskn + +▸ **maskn**(b: *`number`*): `BN` + +*Inherited from BN.maskn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490* + +*__description__*: clear bits with indexes higher or equal to `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## mod + +▸ **mod**(b: *`BN`*): `BN` + +*Inherited from BN.mod* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:354* + +*__description__*: reduct + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## modn + +▸ **modn**(b: *`number`*): `number` + +*Inherited from BN.modn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:365* + +*__see__*: API consistency [https://github.com/indutny/bn.js/pull/130](https://github.com/indutny/bn.js/pull/130) + +*__description__*: reduct + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `number` + ___ ## mul -▸ **mul**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **mul**(b: *`BN`*): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)* +*Inherited from BN.mul* -*Defined in [codec/UInt.ts:138](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L138)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:304* + +*__description__*: multiply **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | + +**Returns:** `BN` + +___ + + +## muln + +▸ **muln**(b: *`number`*): `BN` + +*Inherited from BN.muln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:314* + +*__description__*: multiply + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## neg + +▸ **neg**(): `BN` + +*Inherited from BN.neg* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:244* + +*__description__*: negate sign + +**Returns:** `BN` + +___ + + +## notn + +▸ **notn**(w: *`number`*): `BN` + +*Inherited from BN.notn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:504* + +*__description__*: not (for the width specified by `w`) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| w | `number` | + +**Returns:** `BN` + +___ + + +## or + +▸ **or**(b: *`BN`*): `BN` + +*Inherited from BN.or* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:375* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## pow + +▸ **pow**(b: *`BN`*): `BN` + +*Inherited from BN.pow* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:334* + +*__description__*: raise `a` to the power of `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## setn + +▸ **setn**(b: *`number`*): `BN` + +*Inherited from BN.setn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:440* + +*__description__*: set specified bit to 1 + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## shln + +▸ **shln**(b: *`number`*): `BN` + +*Inherited from BN.shln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:445* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## shrn + +▸ **shrn**(b: *`number`*): `BN` + +*Inherited from BN.shrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:465* + +*__description__*: shift right + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## sqr + +▸ **sqr**(): `BN` + +*Inherited from BN.sqr* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:324* + +*__description__*: square **Returns:** `BN` @@ -265,20 +1401,125 @@ ___ ## sub -▸ **sub**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **sub**(b: *`BN`*): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)* +*Inherited from BN.sub* -*Defined in [codec/UInt.ts:144](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L144)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:284* + +*__description__*: subtraction **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `BN` +___ + + +## subn + +▸ **subn**(b: *`number`*): `BN` + +*Inherited from BN.subn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:294* + +*__description__*: subtraction + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## testn + +▸ **testn**(b: *`number`*): `boolean` + +*Inherited from BN.testn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485* + +*__description__*: test if specified bit is set + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## toArray + +▸ **toArray**(endian?: *`Endianness`*, length?: * `undefined` | `number`*): `number`[] + +*Inherited from BN.toArray* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:109* + +*__description__*: convert to byte Array, and optionally zero pad to length, throwing if already exceeding + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `number`[] + +___ + + +## toArrayLike + +▸ **toArrayLike**(ArrayType: *`object`*, endian?: *`Endianness`*, length?: * `undefined` | `number`*): `Buffer` + +▸ **toArrayLike**(ArrayType: *`any`[]*, endian?: *`Endianness`*, length?: * `undefined` | `number`*): `any`[] + +*Inherited from BN.toArrayLike* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:114* + +*__description__*: convert to an instance of `type`, which must behave like an Array + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| ArrayType | `object` | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `Buffer` + +*Inherited from BN.toArrayLike* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| ArrayType | `any`[] | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `any`[] + ___ @@ -288,10 +1529,32 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)* -*Defined in [codec/UInt.ts:76](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L76)* +*Defined in [codec/UInt.ts:73](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L73)* **Returns:** `BN` +___ + + +## toBuffer + +▸ **toBuffer**(endian?: *`Endianness`*, length?: * `undefined` | `number`*): `Buffer` + +*Inherited from BN.toBuffer* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:129* + +*__description__*: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `Buffer` + ___ @@ -301,7 +1564,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* -*Defined in [codec/UInt.ts:58](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L58)* +*Defined in [codec/UInt.ts:59](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L59)* **Returns:** `string` @@ -314,9 +1577,9 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toJSON](_codec_uint_.uint.md#tojson)* -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* +*Overrides BN.toJSON* -*Defined in [codec/UInt.ts:62](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L62)* +*Defined in [codec/UInt.ts:63](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L63)* **Returns:** `any` @@ -327,27 +1590,78 @@ ___ ▸ **toNumber**(): `number` -*Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)* +*Inherited from BN.toNumber* -*Defined in [codec/UInt.ts:80](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L80)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:99* + +*__description__*: convert to Javascript Number (limited to 53 bits) **Returns:** `number` +___ + + +## toRed + +▸ **toRed**(reductionContext: *`ReductionContext`*): `RedBN` + +*Inherited from BN.toRed* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:84* + +*__description__*: Convert number to red + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| reductionContext | `ReductionContext` | + +**Returns:** `RedBN` + ___ ## toString -▸ **toString**(): `string` +▸ **toString**(base?: * `number` | "hex"*, length?: * `undefined` | `number`*): `string` -*Inherited from [UInt](_codec_uint_.uint.md).[toString](_codec_uint_.uint.md#tostring)* +*Inherited from BN.toString* -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:94* -*Defined in [codec/UInt.ts:72](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L72)* +*__description__*: convert to base-string and pad with zeroes + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` base | `number` | "hex"| +| `Optional` length | `undefined` | `number`| **Returns:** `string` +___ + + +## toTwos + +▸ **toTwos**(width: *`number`*): `BN` + +*Inherited from BN.toTwos* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:234* + +*__description__*: convert to two's complement representation, where width is bit width + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| width | `number` | + +**Returns:** `BN` + ___ @@ -357,9 +1671,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/UInt.ts:68](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L68)* +*Defined in [codec/UInt.ts:69](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L69)* **Parameters:** @@ -369,16 +1681,199 @@ ___ **Returns:** `Uint8Array` +___ + + +## uand + +▸ **uand**(b: *`BN`*): `BN` + +*Inherited from BN.uand* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:405* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ucmp + +▸ **ucmp**(b: *`BN`*): `-1` | `0` | `1` + +*Inherited from BN.ucmp* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:174* + +*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `-1` | `0` | `1` + +___ + + +## umod + +▸ **umod**(b: *`BN`*): `BN` + +*Inherited from BN.umod* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:359* + +*__description__*: reduct + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## uor + +▸ **uor**(b: *`BN`*): `BN` + +*Inherited from BN.uor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:385* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ushln + +▸ **ushln**(b: *`number`*): `BN` + +*Inherited from BN.ushln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:455* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## ushrn + +▸ **ushrn**(b: *`number`*): `BN` + +*Inherited from BN.ushrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475* + +*__description__*: shift right + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## uxor + +▸ **uxor**(b: *`BN`*): `BN` + +*Inherited from BN.uxor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:430* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## xor + +▸ **xor**(b: *`BN`*): `BN` + +*Inherited from BN.xor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:420* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## zeroBits + +▸ **zeroBits**(): `number` + +*Inherited from BN.zeroBits* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:139* + +*__description__*: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits) + +**Returns:** `number` + ___ ## `` decodeUInt -▸ **decodeUInt**(value: *`AnyNumber`*, bitLength: *[UIntBitLength](../modules/_codec_uint_.md#uintbitlength)*): `BN` +▸ **decodeUInt**(value: *`AnyNumber`*, bitLength: *[UIntBitLength](../modules/_codec_uint_.md#uintbitlength)*): `string` *Inherited from [UInt](_codec_uint_.uint.md).[decodeUInt](_codec_uint_.uint.md#decodeuint)* -*Defined in [codec/UInt.ts:35](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L35)* +*Defined in [codec/UInt.ts:35](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L35)* **Parameters:** @@ -387,7 +1882,114 @@ ___ | value | `AnyNumber` | | bitLength | [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) | +**Returns:** `string` + +___ + + +## `` isBN + +▸ **isBN**(b: *`any`*): `boolean` + +*Inherited from BN.isBN* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:69* + +*__description__*: returns true if the supplied object is a BN.js instance + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `any` | + +**Returns:** `boolean` + +___ + + +## `` max + +▸ **max**(left: *`BN`*, right: *`BN`*): `BN` + +*Inherited from BN.max* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:74* + +*__description__*: returns the maximum of 2 BN instances. + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| left | `BN` | +| right | `BN` | + **Returns:** `BN` ___ + + +## `` min + +▸ **min**(left: *`BN`*, right: *`BN`*): `BN` + +*Inherited from BN.min* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:79* + +*__description__*: returns the minimum of 2 BN instances. + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| left | `BN` | +| right | `BN` | + +**Returns:** `BN` + +___ + + +## `` mont + +▸ **mont**(num: *`BN`*): `ReductionContext` + +*Inherited from BN.mont* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:64* + +*__description__*: create a reduction context with the Montgomery trick. + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| num | `BN` | + +**Returns:** `ReductionContext` + +___ + + +## `` red + +▸ **red**(reductionContext: * `BN` | `IPrimeName`*): `ReductionContext` + +*Inherited from BN.red* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:59* + +*__description__*: create a reduction context + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| reductionContext | `BN` | `IPrimeName`| + +**Returns:** `ReductionContext` + +___ diff --git a/docs/types/classes/_referendumindex_.referendumindex.md b/docs/types/classes/_referendumindex_.referendumindex.md index f43f530102..ff29a3cf68 100644 --- a/docs/types/classes/_referendumindex_.referendumindex.md +++ b/docs/types/classes/_referendumindex_.referendumindex.md @@ -6,6 +6,10 @@ **↳ ReferendumIndex** +# Implements + +* `Codec` + # Constructors @@ -18,7 +22,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U32.ts:9](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/U32.ts#L9)* +*Defined in [U32.ts:9](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/U32.ts#L9)* **Parameters:** @@ -38,27 +42,14 @@ ___ **● raw**: *`BN`* -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* +*Inherited from [UInt](_codec_uint_.uint.md).[raw](_codec_uint_.uint.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/UInt.ts:23](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L23)* ___ # Accessors - - -## bitLength - -getbitLength(): [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) - -*Inherited from [UInt](_codec_uint_.uint.md).[bitLength](_codec_uint_.uint.md#bitlength)* - -*Defined in [codec/UInt.ts:50](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L50)* - -**Returns:** [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) - -___ ## encodedLength @@ -67,9 +58,7 @@ getencodedLength(): `number` *Inherited from [UInt](_codec_uint_.uint.md).[encodedLength](_codec_uint_.uint.md#encodedlength)* -*Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* - -*Defined in [codec/UInt.ts:54](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L54)* +*Defined in [codec/UInt.ts:55](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L55)* **Returns:** `number` @@ -77,21 +66,167 @@ ___ # Methods + + +## abs + +▸ **abs**(): `BN` + +*Inherited from BN.abs* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:254* + +*__description__*: absolute value + +**Returns:** `BN` + +___ ## add -▸ **add**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **add**(b: *`BN`*): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)* +*Inherited from BN.add* -*Defined in [codec/UInt.ts:86](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L86)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:264* + +*__description__*: addition **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | + +**Returns:** `BN` + +___ + + +## addn + +▸ **addn**(b: *`number`*): `BN` + +*Inherited from BN.addn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:274* + +*__description__*: addition + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## and + +▸ **and**(b: *`BN`*): `BN` + +*Inherited from BN.and* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:395* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## andln + +▸ **andln**(b: *`number`*): `BN` + +*Inherited from BN.andln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:415* + +*__description__*: and (NOTE: `andln` is going to be replaced with `andn` in future) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## bincn + +▸ **bincn**(b: *`number`*): `BN` + +*Inherited from BN.bincn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:499* + +*__description__*: add `1 << b` to the number + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## bitLength + +▸ **bitLength**(): [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) + +*Inherited from [UInt](_codec_uint_.uint.md).[bitLength](_codec_uint_.uint.md#bitlength)* + +*Overrides BN.bitLength* + +*Defined in [codec/UInt.ts:51](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L51)* + +**Returns:** [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) + +___ + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from BN.byteLength* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:144* + +*__description__*: return number of bytes occupied + +**Returns:** `number` + +___ + + +## clone + +▸ **clone**(): `BN` + +*Inherited from BN.clone* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:89* + +*__description__*: clone number **Returns:** `BN` @@ -100,74 +235,229 @@ ___ ## cmp -▸ **cmp**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `number` +▸ **cmp**(b: *`BN`*): `-1` | `0` | `1` -*Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)* +*Inherited from BN.cmp* -*Defined in [codec/UInt.ts:92](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L92)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:169* + +*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | -**Returns:** `number` +**Returns:** `-1` | `0` | `1` + +___ + + +## cmpn + +▸ **cmpn**(b: *`number`*): `-1` | `0` | `1` + +*Inherited from BN.cmpn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:179* + +*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `-1` | `0` | `1` ___ ## div -▸ **div**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **div**(b: *`BN`*): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)* +*Inherited from BN.div* -*Defined in [codec/UInt.ts:98](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L98)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:339* + +*__description__*: divide **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `BN` +___ + + +## divRound + +▸ **divRound**(b: *`BN`*): `BN` + +*Inherited from BN.divRound* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:370* + +*__description__*: rounded division + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## divn + +▸ **divn**(b: *`number`*): `BN` + +*Inherited from BN.divn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:344* + +*__description__*: divide + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## egcd + +▸ **egcd**(b: *`BN`*): `object` + +*Inherited from BN.egcd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:519* + +*__description__*: Extended GCD results `({ a: ..., b: ..., gcd: ... })` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `object` + ___ ## eq -▸ **eq**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **eq**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[eq](_codec_uint_.uint.md#eq)* +*Inherited from BN.eq* -*Defined in [codec/UInt.ts:104](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L104)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:224* + +*__description__*: a equals b **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` +___ + + +## eqn + +▸ **eqn**(b: *`number`*): `boolean` + +*Inherited from BN.eqn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:229* + +*__description__*: a equals b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## fromTwos + +▸ **fromTwos**(width: *`number`*): `BN` + +*Inherited from BN.fromTwos* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:239* + +*__description__*: convert from two's complement representation, where width is the bit width + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| width | `number` | + +**Returns:** `BN` + +___ + + +## gcd + +▸ **gcd**(b: *`BN`*): `BN` + +*Inherited from BN.gcd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:514* + +*__description__*: GCD + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + ___ ## gt -▸ **gt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **gt**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)* +*Inherited from BN.gt* -*Defined in [codec/UInt.ts:126](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L126)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:204* + +*__description__*: a greater than b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` @@ -176,17 +466,346 @@ ___ ## gte -▸ **gte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **gte**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)* +*Inherited from BN.gte* -*Defined in [codec/UInt.ts:132](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L132)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:214* + +*__description__*: a greater than or equals b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | + +**Returns:** `boolean` + +___ + + +## gten + +▸ **gten**(b: *`number`*): `boolean` + +*Inherited from BN.gten* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:219* + +*__description__*: a greater than or equals b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## gtn + +▸ **gtn**(b: *`number`*): `boolean` + +*Inherited from BN.gtn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:209* + +*__description__*: a greater than b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## iabs + +▸ **iabs**(): `BN` + +*Inherited from BN.iabs* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:259* + +*__description__*: absolute value + +**Returns:** `BN` + +___ + + +## iadd + +▸ **iadd**(b: *`BN`*): `BN` + +*Inherited from BN.iadd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:269* + +*__description__*: addition + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## iaddn + +▸ **iaddn**(b: *`number`*): `BN` + +*Inherited from BN.iaddn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:279* + +*__description__*: addition + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iand + +▸ **iand**(b: *`BN`*): `BN` + +*Inherited from BN.iand* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:400* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## idivn + +▸ **idivn**(b: *`number`*): `BN` + +*Inherited from BN.idivn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:349* + +*__description__*: divide + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## imaskn + +▸ **imaskn**(b: *`number`*): `BN` + +*Inherited from BN.imaskn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495* + +*__description__*: clear bits with indexes higher or equal to `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## imul + +▸ **imul**(b: *`BN`*): `BN` + +*Inherited from BN.imul* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:309* + +*__description__*: multiply + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## imuln + +▸ **imuln**(b: *`number`*): `BN` + +*Inherited from BN.imuln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:319* + +*__description__*: multiply + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## ineg + +▸ **ineg**(): `BN` + +*Inherited from BN.ineg* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:249* + +*__description__*: negate sign + +**Returns:** `BN` + +___ + + +## inotn + +▸ **inotn**(w: *`number`*): `BN` + +*Inherited from BN.inotn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:509* + +*__description__*: not (for the width specified by `w`) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| w | `number` | + +**Returns:** `BN` + +___ + + +## invm + +▸ **invm**(b: *`BN`*): `BN` + +*Inherited from BN.invm* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:524* + +*__description__*: inverse `a` modulo `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ior + +▸ **ior**(b: *`BN`*): `BN` + +*Inherited from BN.ior* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:380* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## isEven + +▸ **isEven**(): `boolean` + +*Inherited from BN.isEven* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:154* + +*__description__*: check if value is even + +**Returns:** `boolean` + +___ + + +## isNeg + +▸ **isNeg**(): `boolean` + +*Inherited from BN.isNeg* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:149* + +*__description__*: true if the number is negative + +**Returns:** `boolean` + +___ + + +## isOdd + +▸ **isOdd**(): `boolean` + +*Inherited from BN.isOdd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:159* + +*__description__*: check if value is odd **Returns:** `boolean` @@ -197,28 +816,257 @@ ___ ▸ **isZero**(): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)* +*Inherited from BN.isZero* -*Defined in [codec/UInt.ts:110](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L110)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:164* + +*__description__*: check if value is zero **Returns:** `boolean` +___ + + +## ishln + +▸ **ishln**(b: *`number`*): `BN` + +*Inherited from BN.ishln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:450* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## ishrn + +▸ **ishrn**(b: *`number`*): `BN` + +*Inherited from BN.ishrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:470* + +*__description__*: shift right (unimplemented [https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086](https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## isqr + +▸ **isqr**(): `BN` + +*Inherited from BN.isqr* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:329* + +*__description__*: square + +**Returns:** `BN` + +___ + + +## isub + +▸ **isub**(b: *`BN`*): `BN` + +*Inherited from BN.isub* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:289* + +*__description__*: subtraction + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## isubn + +▸ **isubn**(b: *`number`*): `BN` + +*Inherited from BN.isubn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:299* + +*__description__*: subtraction + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iuand + +▸ **iuand**(b: *`BN`*): `BN` + +*Inherited from BN.iuand* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:410* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## iuor + +▸ **iuor**(b: *`BN`*): `BN` + +*Inherited from BN.iuor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:390* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## iushln + +▸ **iushln**(b: *`number`*): `BN` + +*Inherited from BN.iushln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:460* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iushrn + +▸ **iushrn**(b: *`number`*): `BN` + +*Inherited from BN.iushrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480* + +*__description__*: shift right + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iuxor + +▸ **iuxor**(b: *`BN`*): `BN` + +*Inherited from BN.iuxor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:435* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ixor + +▸ **ixor**(b: *`BN`*): `BN` + +*Inherited from BN.ixor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:425* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + ___ ## lt -▸ **lt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **lt**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)* +*Inherited from BN.lt* -*Defined in [codec/UInt.ts:114](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L114)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:184* + +*__description__*: a less than b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` @@ -227,36 +1075,324 @@ ___ ## lte -▸ **lte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **lte**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)* +*Inherited from BN.lte* -*Defined in [codec/UInt.ts:120](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L120)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:194* + +*__description__*: a less than or equals b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` +___ + + +## lten + +▸ **lten**(b: *`number`*): `boolean` + +*Inherited from BN.lten* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:199* + +*__description__*: a less than or equals b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## ltn + +▸ **ltn**(b: *`number`*): `boolean` + +*Inherited from BN.ltn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:189* + +*__description__*: a less than b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## maskn + +▸ **maskn**(b: *`number`*): `BN` + +*Inherited from BN.maskn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490* + +*__description__*: clear bits with indexes higher or equal to `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## mod + +▸ **mod**(b: *`BN`*): `BN` + +*Inherited from BN.mod* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:354* + +*__description__*: reduct + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## modn + +▸ **modn**(b: *`number`*): `number` + +*Inherited from BN.modn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:365* + +*__see__*: API consistency [https://github.com/indutny/bn.js/pull/130](https://github.com/indutny/bn.js/pull/130) + +*__description__*: reduct + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `number` + ___ ## mul -▸ **mul**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **mul**(b: *`BN`*): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)* +*Inherited from BN.mul* -*Defined in [codec/UInt.ts:138](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L138)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:304* + +*__description__*: multiply **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | + +**Returns:** `BN` + +___ + + +## muln + +▸ **muln**(b: *`number`*): `BN` + +*Inherited from BN.muln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:314* + +*__description__*: multiply + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## neg + +▸ **neg**(): `BN` + +*Inherited from BN.neg* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:244* + +*__description__*: negate sign + +**Returns:** `BN` + +___ + + +## notn + +▸ **notn**(w: *`number`*): `BN` + +*Inherited from BN.notn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:504* + +*__description__*: not (for the width specified by `w`) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| w | `number` | + +**Returns:** `BN` + +___ + + +## or + +▸ **or**(b: *`BN`*): `BN` + +*Inherited from BN.or* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:375* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## pow + +▸ **pow**(b: *`BN`*): `BN` + +*Inherited from BN.pow* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:334* + +*__description__*: raise `a` to the power of `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## setn + +▸ **setn**(b: *`number`*): `BN` + +*Inherited from BN.setn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:440* + +*__description__*: set specified bit to 1 + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## shln + +▸ **shln**(b: *`number`*): `BN` + +*Inherited from BN.shln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:445* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## shrn + +▸ **shrn**(b: *`number`*): `BN` + +*Inherited from BN.shrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:465* + +*__description__*: shift right + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## sqr + +▸ **sqr**(): `BN` + +*Inherited from BN.sqr* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:324* + +*__description__*: square **Returns:** `BN` @@ -265,20 +1401,125 @@ ___ ## sub -▸ **sub**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **sub**(b: *`BN`*): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)* +*Inherited from BN.sub* -*Defined in [codec/UInt.ts:144](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L144)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:284* + +*__description__*: subtraction **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `BN` +___ + + +## subn + +▸ **subn**(b: *`number`*): `BN` + +*Inherited from BN.subn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:294* + +*__description__*: subtraction + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## testn + +▸ **testn**(b: *`number`*): `boolean` + +*Inherited from BN.testn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485* + +*__description__*: test if specified bit is set + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## toArray + +▸ **toArray**(endian?: *`Endianness`*, length?: * `undefined` | `number`*): `number`[] + +*Inherited from BN.toArray* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:109* + +*__description__*: convert to byte Array, and optionally zero pad to length, throwing if already exceeding + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `number`[] + +___ + + +## toArrayLike + +▸ **toArrayLike**(ArrayType: *`object`*, endian?: *`Endianness`*, length?: * `undefined` | `number`*): `Buffer` + +▸ **toArrayLike**(ArrayType: *`any`[]*, endian?: *`Endianness`*, length?: * `undefined` | `number`*): `any`[] + +*Inherited from BN.toArrayLike* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:114* + +*__description__*: convert to an instance of `type`, which must behave like an Array + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| ArrayType | `object` | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `Buffer` + +*Inherited from BN.toArrayLike* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| ArrayType | `any`[] | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `any`[] + ___ @@ -288,10 +1529,32 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)* -*Defined in [codec/UInt.ts:76](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L76)* +*Defined in [codec/UInt.ts:73](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L73)* **Returns:** `BN` +___ + + +## toBuffer + +▸ **toBuffer**(endian?: *`Endianness`*, length?: * `undefined` | `number`*): `Buffer` + +*Inherited from BN.toBuffer* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:129* + +*__description__*: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `Buffer` + ___ @@ -301,7 +1564,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* -*Defined in [codec/UInt.ts:58](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L58)* +*Defined in [codec/UInt.ts:59](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L59)* **Returns:** `string` @@ -314,9 +1577,9 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toJSON](_codec_uint_.uint.md#tojson)* -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* +*Overrides BN.toJSON* -*Defined in [codec/UInt.ts:62](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L62)* +*Defined in [codec/UInt.ts:63](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L63)* **Returns:** `any` @@ -327,27 +1590,78 @@ ___ ▸ **toNumber**(): `number` -*Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)* +*Inherited from BN.toNumber* -*Defined in [codec/UInt.ts:80](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L80)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:99* + +*__description__*: convert to Javascript Number (limited to 53 bits) **Returns:** `number` +___ + + +## toRed + +▸ **toRed**(reductionContext: *`ReductionContext`*): `RedBN` + +*Inherited from BN.toRed* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:84* + +*__description__*: Convert number to red + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| reductionContext | `ReductionContext` | + +**Returns:** `RedBN` + ___ ## toString -▸ **toString**(): `string` +▸ **toString**(base?: * `number` | "hex"*, length?: * `undefined` | `number`*): `string` -*Inherited from [UInt](_codec_uint_.uint.md).[toString](_codec_uint_.uint.md#tostring)* +*Inherited from BN.toString* -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:94* -*Defined in [codec/UInt.ts:72](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L72)* +*__description__*: convert to base-string and pad with zeroes + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` base | `number` | "hex"| +| `Optional` length | `undefined` | `number`| **Returns:** `string` +___ + + +## toTwos + +▸ **toTwos**(width: *`number`*): `BN` + +*Inherited from BN.toTwos* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:234* + +*__description__*: convert to two's complement representation, where width is bit width + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| width | `number` | + +**Returns:** `BN` + ___ @@ -357,9 +1671,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/UInt.ts:68](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L68)* +*Defined in [codec/UInt.ts:69](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L69)* **Parameters:** @@ -369,16 +1681,199 @@ ___ **Returns:** `Uint8Array` +___ + + +## uand + +▸ **uand**(b: *`BN`*): `BN` + +*Inherited from BN.uand* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:405* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ucmp + +▸ **ucmp**(b: *`BN`*): `-1` | `0` | `1` + +*Inherited from BN.ucmp* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:174* + +*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `-1` | `0` | `1` + +___ + + +## umod + +▸ **umod**(b: *`BN`*): `BN` + +*Inherited from BN.umod* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:359* + +*__description__*: reduct + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## uor + +▸ **uor**(b: *`BN`*): `BN` + +*Inherited from BN.uor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:385* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ushln + +▸ **ushln**(b: *`number`*): `BN` + +*Inherited from BN.ushln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:455* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## ushrn + +▸ **ushrn**(b: *`number`*): `BN` + +*Inherited from BN.ushrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475* + +*__description__*: shift right + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## uxor + +▸ **uxor**(b: *`BN`*): `BN` + +*Inherited from BN.uxor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:430* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## xor + +▸ **xor**(b: *`BN`*): `BN` + +*Inherited from BN.xor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:420* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## zeroBits + +▸ **zeroBits**(): `number` + +*Inherited from BN.zeroBits* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:139* + +*__description__*: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits) + +**Returns:** `number` + ___ ## `` decodeUInt -▸ **decodeUInt**(value: *`AnyNumber`*, bitLength: *[UIntBitLength](../modules/_codec_uint_.md#uintbitlength)*): `BN` +▸ **decodeUInt**(value: *`AnyNumber`*, bitLength: *[UIntBitLength](../modules/_codec_uint_.md#uintbitlength)*): `string` *Inherited from [UInt](_codec_uint_.uint.md).[decodeUInt](_codec_uint_.uint.md#decodeuint)* -*Defined in [codec/UInt.ts:35](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L35)* +*Defined in [codec/UInt.ts:35](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L35)* **Parameters:** @@ -387,7 +1882,114 @@ ___ | value | `AnyNumber` | | bitLength | [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) | +**Returns:** `string` + +___ + + +## `` isBN + +▸ **isBN**(b: *`any`*): `boolean` + +*Inherited from BN.isBN* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:69* + +*__description__*: returns true if the supplied object is a BN.js instance + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `any` | + +**Returns:** `boolean` + +___ + + +## `` max + +▸ **max**(left: *`BN`*, right: *`BN`*): `BN` + +*Inherited from BN.max* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:74* + +*__description__*: returns the maximum of 2 BN instances. + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| left | `BN` | +| right | `BN` | + **Returns:** `BN` ___ + + +## `` min + +▸ **min**(left: *`BN`*, right: *`BN`*): `BN` + +*Inherited from BN.min* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:79* + +*__description__*: returns the minimum of 2 BN instances. + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| left | `BN` | +| right | `BN` | + +**Returns:** `BN` + +___ + + +## `` mont + +▸ **mont**(num: *`BN`*): `ReductionContext` + +*Inherited from BN.mont* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:64* + +*__description__*: create a reduction context with the Montgomery trick. + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| num | `BN` | + +**Returns:** `ReductionContext` + +___ + + +## `` red + +▸ **red**(reductionContext: * `BN` | `IPrimeName`*): `ReductionContext` + +*Inherited from BN.red* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:59* + +*__description__*: create a reduction context + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| reductionContext | `BN` | `IPrimeName`| + +**Returns:** `ReductionContext` + +___ diff --git a/docs/types/classes/_runtimeversion_.runtimeversion.md b/docs/types/classes/_runtimeversion_.runtimeversion.md index 5548a88664..117197a2fd 100644 --- a/docs/types/classes/_runtimeversion_.runtimeversion.md +++ b/docs/types/classes/_runtimeversion_.runtimeversion.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [RuntimeVersion.ts:52](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/RuntimeVersion.ts#L52)* +*Defined in [RuntimeVersion.ts:52](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/RuntimeVersion.ts#L52)* **Parameters:** @@ -58,7 +58,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L25)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L25)* ___ @@ -83,7 +83,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L123)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -94,7 +94,7 @@ ___ getapis(): [Vector](_codec_vector_.vector.md)<`RuntimeVersionApi`> -*Defined in [RuntimeVersion.ts:70](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/RuntimeVersion.ts#L70)* +*Defined in [RuntimeVersion.ts:70](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/RuntimeVersion.ts#L70)* **Returns:** [Vector](_codec_vector_.vector.md)<`RuntimeVersionApi`> @@ -105,7 +105,7 @@ ___ getauthoringVersion(): [U32](_u32_.u32.md) -*Defined in [RuntimeVersion.ts:74](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/RuntimeVersion.ts#L74)* +*Defined in [RuntimeVersion.ts:74](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/RuntimeVersion.ts#L74)* **Returns:** [U32](_u32_.u32.md) @@ -118,7 +118,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L127)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -129,7 +129,7 @@ ___ getimplName(): [Text](_text_.text.md) -*Defined in [RuntimeVersion.ts:78](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/RuntimeVersion.ts#L78)* +*Defined in [RuntimeVersion.ts:78](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/RuntimeVersion.ts#L78)* **Returns:** [Text](_text_.text.md) @@ -140,7 +140,7 @@ ___ getimplVersion(): [U32](_u32_.u32.md) -*Defined in [RuntimeVersion.ts:82](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/RuntimeVersion.ts#L82)* +*Defined in [RuntimeVersion.ts:82](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/RuntimeVersion.ts#L82)* **Returns:** [U32](_u32_.u32.md) @@ -151,7 +151,7 @@ ___ getspecName(): [Text](_text_.text.md) -*Defined in [RuntimeVersion.ts:86](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/RuntimeVersion.ts#L86)* +*Defined in [RuntimeVersion.ts:86](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/RuntimeVersion.ts#L86)* **Returns:** [Text](_text_.text.md) @@ -162,7 +162,7 @@ ___ getspecVersion(): [U32](_u32_.u32.md) -*Defined in [RuntimeVersion.ts:90](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/RuntimeVersion.ts#L90)* +*Defined in [RuntimeVersion.ts:90](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/RuntimeVersion.ts#L90)* **Returns:** [U32](_u32_.u32.md) @@ -279,7 +279,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L133)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -352,7 +352,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L137)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -365,7 +365,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L141)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -378,7 +378,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L145)* **Returns:** `any` @@ -391,7 +391,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L156)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -404,7 +404,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -438,7 +438,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L113)* +*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/types/classes/_signature_.signature.md b/docs/types/classes/_signature_.signature.md index aa7f7be511..3381bf49ec 100644 --- a/docs/types/classes/_signature_.signature.md +++ b/docs/types/classes/_signature_.signature.md @@ -25,7 +25,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [H512.ts:10](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/H512.ts#L10)* +*Defined in [H512.ts:10](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/H512.ts#L10)* **Parameters:** @@ -123,25 +123,12 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[raw](_codec_u8a_.u8a.md#raw)* -*Defined in [codec/U8a.ts:15](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L15)* +*Defined in [codec/U8a.ts:15](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L15)* ___ # Accessors - - -## bitLength - -getbitLength(): `number` - -*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* - -*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8aFixed.ts#L32)* - -**Returns:** `number` - -___ ## encodedLength @@ -150,7 +137,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:33](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L33)* +*Defined in [codec/U8a.ts:33](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L33)* **Returns:** `number` @@ -170,6 +157,19 @@ ___ **Returns:** `IterableIterator`<`number`> +___ + + +## bitLength + +▸ **bitLength**(): `number` + +*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* + +*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8aFixed.ts#L32)* + +**Returns:** `number` + ___ @@ -690,7 +690,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:39](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L39)* +*Defined in [codec/U8a.ts:39](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L39)* **Parameters:** @@ -710,7 +710,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L43)* **Returns:** `string` @@ -723,7 +723,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:47](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L47)* +*Defined in [codec/U8a.ts:47](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L47)* **Returns:** `any` @@ -753,7 +753,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:55](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L55)* +*Defined in [codec/U8a.ts:55](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L55)* **Returns:** `string` @@ -766,7 +766,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:51](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L51)* +*Defined in [codec/U8a.ts:51](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L51)* **Parameters:** diff --git a/docs/types/classes/_signaturepayload_.signaturepayload.md b/docs/types/classes/_signaturepayload_.signaturepayload.md index 7e2c6c5ce5..35c1b2ab19 100644 --- a/docs/types/classes/_signaturepayload_.signaturepayload.md +++ b/docs/types/classes/_signaturepayload_.signaturepayload.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [SignaturePayload.ts:28](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/SignaturePayload.ts#L28)* +*Defined in [SignaturePayload.ts:28](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/SignaturePayload.ts#L28)* **Parameters:** @@ -58,7 +58,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L25)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L25)* ___ @@ -83,7 +83,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L123)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -94,7 +94,7 @@ ___ getblockHash(): [Hash](_hash_.hash.md) -*Defined in [SignaturePayload.ts:43](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/SignaturePayload.ts#L43)* +*Defined in [SignaturePayload.ts:43](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/SignaturePayload.ts#L43)* **Returns:** [Hash](_hash_.hash.md) @@ -107,7 +107,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L127)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -118,7 +118,7 @@ ___ getera(): [ExtrinsicEra](_extrinsicera_.extrinsicera.md) -*Defined in [SignaturePayload.ts:51](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/SignaturePayload.ts#L51)* +*Defined in [SignaturePayload.ts:51](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/SignaturePayload.ts#L51)* **Returns:** [ExtrinsicEra](_extrinsicera_.extrinsicera.md) @@ -129,7 +129,7 @@ ___ getisSigned(): `boolean` -*Defined in [SignaturePayload.ts:39](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/SignaturePayload.ts#L39)* +*Defined in [SignaturePayload.ts:39](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/SignaturePayload.ts#L39)* **Returns:** `boolean` @@ -140,7 +140,7 @@ ___ getmethod(): [Method](_method_.method.md) -*Defined in [SignaturePayload.ts:47](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/SignaturePayload.ts#L47)* +*Defined in [SignaturePayload.ts:47](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/SignaturePayload.ts#L47)* **Returns:** [Method](_method_.method.md) @@ -151,7 +151,7 @@ ___ getnonce(): `Nonce` -*Defined in [SignaturePayload.ts:55](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/SignaturePayload.ts#L55)* +*Defined in [SignaturePayload.ts:55](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/SignaturePayload.ts#L55)* **Returns:** `Nonce` @@ -162,7 +162,7 @@ ___ getsignature(): `Uint8Array` -*Defined in [SignaturePayload.ts:59](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/SignaturePayload.ts#L59)* +*Defined in [SignaturePayload.ts:59](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/SignaturePayload.ts#L59)* **Returns:** `Uint8Array` @@ -279,7 +279,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L133)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -350,7 +350,7 @@ ___ ▸ **sign**(signerPair: *`KeyringPair`*): `Uint8Array` -*Defined in [SignaturePayload.ts:67](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/SignaturePayload.ts#L67)* +*Defined in [SignaturePayload.ts:67](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/SignaturePayload.ts#L67)* **Parameters:** @@ -369,7 +369,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L137)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -382,7 +382,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L141)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -395,7 +395,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L145)* **Returns:** `any` @@ -408,7 +408,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L156)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -421,7 +421,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -455,7 +455,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L113)* +*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/types/classes/_signedblock_.signedblock.md b/docs/types/classes/_signedblock_.signedblock.md index b2c2d5ace4..f7ba4965c3 100644 --- a/docs/types/classes/_signedblock_.signedblock.md +++ b/docs/types/classes/_signedblock_.signedblock.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [SignedBlock.ts:15](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/SignedBlock.ts#L15)* +*Defined in [SignedBlock.ts:15](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/SignedBlock.ts#L15)* **Parameters:** @@ -58,7 +58,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L25)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L25)* ___ @@ -83,7 +83,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L123)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -94,7 +94,7 @@ ___ getblock(): [Block](_block_.block.md) -*Defined in [SignedBlock.ts:23](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/SignedBlock.ts#L23)* +*Defined in [SignedBlock.ts:23](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/SignedBlock.ts#L23)* **Returns:** [Block](_block_.block.md) @@ -107,7 +107,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L127)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -118,7 +118,7 @@ ___ getjustification(): [Justification](_bft_.justification.md) -*Defined in [SignedBlock.ts:27](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/SignedBlock.ts#L27)* +*Defined in [SignedBlock.ts:27](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/SignedBlock.ts#L27)* **Returns:** [Justification](_bft_.justification.md) @@ -235,7 +235,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L133)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -308,7 +308,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L137)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -321,7 +321,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L141)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -334,7 +334,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L145)* **Returns:** `any` @@ -347,7 +347,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L156)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -360,7 +360,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -394,7 +394,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L113)* +*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/types/classes/_storagechangeset_.storagechangeset.md b/docs/types/classes/_storagechangeset_.storagechangeset.md index 9a4904de62..7b0b52fbf7 100644 --- a/docs/types/classes/_storagechangeset_.storagechangeset.md +++ b/docs/types/classes/_storagechangeset_.storagechangeset.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [StorageChangeSet.ts:20](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/StorageChangeSet.ts#L20)* +*Defined in [StorageChangeSet.ts:20](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/StorageChangeSet.ts#L20)* **Parameters:** @@ -58,7 +58,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L25)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L25)* ___ @@ -83,7 +83,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L123)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -94,7 +94,7 @@ ___ getchanges(): [Vector](_codec_vector_.vector.md)<[KeyValueOption](_keyvalue_.keyvalueoption.md)> -*Defined in [StorageChangeSet.ts:28](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/StorageChangeSet.ts#L28)* +*Defined in [StorageChangeSet.ts:28](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/StorageChangeSet.ts#L28)* **Returns:** [Vector](_codec_vector_.vector.md)<[KeyValueOption](_keyvalue_.keyvalueoption.md)> @@ -107,7 +107,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L127)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -118,7 +118,7 @@ ___ gethash(): [Hash](_hash_.hash.md) -*Defined in [StorageChangeSet.ts:32](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/StorageChangeSet.ts#L32)* +*Defined in [StorageChangeSet.ts:32](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/StorageChangeSet.ts#L32)* **Returns:** [Hash](_hash_.hash.md) @@ -235,7 +235,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L133)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -308,7 +308,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L137)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -321,7 +321,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L141)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -334,7 +334,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L145)* **Returns:** `any` @@ -347,7 +347,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L156)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -360,7 +360,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -394,7 +394,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L113)* +*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/types/classes/_storagedata_.storagedata.md b/docs/types/classes/_storagedata_.storagedata.md index 507ea8353b..94d4f2236f 100644 --- a/docs/types/classes/_storagedata_.storagedata.md +++ b/docs/types/classes/_storagedata_.storagedata.md @@ -25,7 +25,7 @@ *Overrides [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)* -*Defined in [Bytes.ts:14](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Bytes.ts#L14)* +*Defined in [Bytes.ts:14](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Bytes.ts#L14)* **Parameters:** @@ -123,7 +123,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[raw](_codec_u8a_.u8a.md#raw)* -*Defined in [codec/U8a.ts:15](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L15)* +*Defined in [codec/U8a.ts:15](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L15)* ___ @@ -139,7 +139,7 @@ getencodedLength(): `number` *Overrides [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [Bytes.ts:43](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Bytes.ts#L43)* +*Defined in [Bytes.ts:43](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Bytes.ts#L43)* **Returns:** `number` @@ -679,7 +679,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:39](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L39)* +*Defined in [codec/U8a.ts:39](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L39)* **Parameters:** @@ -699,7 +699,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L43)* **Returns:** `string` @@ -712,7 +712,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:47](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L47)* +*Defined in [codec/U8a.ts:47](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L47)* **Returns:** `any` @@ -742,7 +742,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:55](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L55)* +*Defined in [codec/U8a.ts:55](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L55)* **Returns:** `string` @@ -757,7 +757,7 @@ ___ *Overrides [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [Bytes.ts:47](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Bytes.ts#L47)* +*Defined in [Bytes.ts:47](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Bytes.ts#L47)* **Parameters:** diff --git a/docs/types/classes/_storagekey_.storagekey.md b/docs/types/classes/_storagekey_.storagekey.md index 4477948031..3bf47f18fe 100644 --- a/docs/types/classes/_storagekey_.storagekey.md +++ b/docs/types/classes/_storagekey_.storagekey.md @@ -23,7 +23,7 @@ *Overrides [Bytes](_bytes_.bytes.md).[constructor](_bytes_.bytes.md#constructor)* -*Defined in [StorageKey.ts:23](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/StorageKey.ts#L23)* +*Defined in [StorageKey.ts:23](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/StorageKey.ts#L23)* **Parameters:** @@ -121,7 +121,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[raw](_codec_u8a_.u8a.md#raw)* -*Defined in [codec/U8a.ts:15](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L15)* +*Defined in [codec/U8a.ts:15](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L15)* ___ @@ -137,7 +137,7 @@ getencodedLength(): `number` *Overrides [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [Bytes.ts:43](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Bytes.ts#L43)* +*Defined in [Bytes.ts:43](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Bytes.ts#L43)* **Returns:** `number` @@ -148,7 +148,7 @@ ___ getoutputType(): `string` | `null` -*Defined in [StorageKey.ts:59](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/StorageKey.ts#L59)* +*Defined in [StorageKey.ts:59](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/StorageKey.ts#L59)* **Returns:** `string` | `null` @@ -688,7 +688,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:39](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L39)* +*Defined in [codec/U8a.ts:39](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L39)* **Parameters:** @@ -708,7 +708,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L43)* **Returns:** `string` @@ -721,7 +721,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:47](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L47)* +*Defined in [codec/U8a.ts:47](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L47)* **Returns:** `any` @@ -751,7 +751,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:55](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/U8a.ts#L55)* +*Defined in [codec/U8a.ts:55](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/U8a.ts#L55)* **Returns:** `string` @@ -766,7 +766,7 @@ ___ *Overrides [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [Bytes.ts:47](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Bytes.ts#L47)* +*Defined in [Bytes.ts:47](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Bytes.ts#L47)* **Parameters:** @@ -798,7 +798,7 @@ ___ ▸ **decodeStorageKey**(value: * `AnyU8a` | [StorageKey](_storagekey_.storagekey.md) | [StorageFunction](../interfaces/_storagekey_.storagefunction.md) | [[StorageFunction](../interfaces/_storagekey_.storagefunction.md), `any`]*): `Uint8Array` -*Defined in [StorageKey.ts:31](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/StorageKey.ts#L31)* +*Defined in [StorageKey.ts:31](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/StorageKey.ts#L31)* **Parameters:** @@ -815,7 +815,7 @@ ___ ▸ **getType**(value: * [StorageKey](_storagekey_.storagekey.md) | [StorageFunction](../interfaces/_storagekey_.storagefunction.md) | [[StorageFunction](../interfaces/_storagekey_.storagefunction.md), `any`]*): `string` | `null` -*Defined in [StorageKey.ts:45](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/StorageKey.ts#L45)* +*Defined in [StorageKey.ts:45](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/StorageKey.ts#L45)* **Parameters:** diff --git a/docs/types/classes/_text_.text.md b/docs/types/classes/_text_.text.md index 703c67ca5a..d20574042c 100644 --- a/docs/types/classes/_text_.text.md +++ b/docs/types/classes/_text_.text.md @@ -18,7 +18,7 @@ *Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* -*Defined in [Text.ts:19](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Text.ts#L19)* +*Defined in [Text.ts:19](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Text.ts#L19)* **Parameters:** @@ -40,7 +40,7 @@ ___ *Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Base.ts#L19)* ___ @@ -54,7 +54,7 @@ getencodedLength(): `number` *Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* -*Defined in [Text.ts:46](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Text.ts#L46)* +*Defined in [Text.ts:46](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Text.ts#L46)* **Returns:** `number` @@ -65,7 +65,7 @@ ___ getlength(): `number` -*Defined in [Text.ts:42](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Text.ts#L42)* +*Defined in [Text.ts:42](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Text.ts#L42)* **Returns:** `number` @@ -81,7 +81,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* -*Defined in [Text.ts:50](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Text.ts#L50)* +*Defined in [Text.ts:50](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Text.ts#L50)* **Returns:** `any` @@ -94,7 +94,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* -*Defined in [Text.ts:54](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Text.ts#L54)* +*Defined in [Text.ts:54](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Text.ts#L54)* **Returns:** `string` @@ -107,7 +107,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* -*Defined in [Text.ts:58](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Text.ts#L58)* +*Defined in [Text.ts:58](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Text.ts#L58)* **Parameters:** @@ -124,7 +124,7 @@ ___ ▸ **decodeText**(value: * [Text](_text_.text.md) | `string` | `AnyU8a` | `object`*): `string` -*Defined in [Text.ts:26](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Text.ts#L26)* +*Defined in [Text.ts:26](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Text.ts#L26)* **Parameters:** diff --git a/docs/types/classes/_type_.type.md b/docs/types/classes/_type_.type.md index c9a6313890..d599b91e2a 100644 --- a/docs/types/classes/_type_.type.md +++ b/docs/types/classes/_type_.type.md @@ -16,7 +16,7 @@ *Overrides [Text](_text_.text.md).[constructor](_text_.text.md#constructor)* -*Defined in [Type.ts:16](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Type.ts#L16)* +*Defined in [Type.ts:16](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Type.ts#L16)* **Parameters:** @@ -38,7 +38,7 @@ ___ *Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Base.ts#L19)* ___ @@ -54,7 +54,7 @@ getencodedLength(): `number` *Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* -*Defined in [Text.ts:46](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Text.ts#L46)* +*Defined in [Text.ts:46](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Text.ts#L46)* **Returns:** `number` @@ -67,7 +67,7 @@ getlength(): `number` *Overrides [Text](_text_.text.md).[length](_text_.text.md#length)* -*Defined in [Type.ts:27](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Type.ts#L27)* +*Defined in [Type.ts:27](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Type.ts#L27)* **Returns:** `number` @@ -85,7 +85,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* -*Defined in [Text.ts:50](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Text.ts#L50)* +*Defined in [Text.ts:50](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Text.ts#L50)* **Returns:** `any` @@ -100,7 +100,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* -*Defined in [Text.ts:54](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Text.ts#L54)* +*Defined in [Text.ts:54](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Text.ts#L54)* **Returns:** `string` @@ -113,7 +113,7 @@ ___ *Overrides [Text](_text_.text.md).[toU8a](_text_.text.md#tou8a)* -*Defined in [Type.ts:34](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Type.ts#L34)* +*Defined in [Type.ts:34](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Type.ts#L34)* **Parameters:** @@ -132,7 +132,7 @@ ___ *Inherited from [Text](_text_.text.md).[decodeText](_text_.text.md#decodetext)* -*Defined in [Text.ts:26](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Text.ts#L26)* +*Defined in [Text.ts:26](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Text.ts#L26)* **Parameters:** diff --git a/docs/types/classes/_u128_.u128.md b/docs/types/classes/_u128_.u128.md index 3ca8f18f97..c20ab02008 100644 --- a/docs/types/classes/_u128_.u128.md +++ b/docs/types/classes/_u128_.u128.md @@ -8,6 +8,10 @@ ↳ [Balance](_balance_.balance.md) +# Implements + +* `Codec` + # Constructors @@ -18,7 +22,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U128.ts:9](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/U128.ts#L9)* +*Defined in [U128.ts:9](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/U128.ts#L9)* **Parameters:** @@ -38,27 +42,14 @@ ___ **● raw**: *`BN`* -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* +*Inherited from [UInt](_codec_uint_.uint.md).[raw](_codec_uint_.uint.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/UInt.ts:23](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L23)* ___ # Accessors - - -## bitLength - -getbitLength(): [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) - -*Inherited from [UInt](_codec_uint_.uint.md).[bitLength](_codec_uint_.uint.md#bitlength)* - -*Defined in [codec/UInt.ts:50](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L50)* - -**Returns:** [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) - -___ ## encodedLength @@ -67,9 +58,7 @@ getencodedLength(): `number` *Inherited from [UInt](_codec_uint_.uint.md).[encodedLength](_codec_uint_.uint.md#encodedlength)* -*Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* - -*Defined in [codec/UInt.ts:54](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L54)* +*Defined in [codec/UInt.ts:55](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L55)* **Returns:** `number` @@ -77,21 +66,167 @@ ___ # Methods + + +## abs + +▸ **abs**(): `BN` + +*Inherited from BN.abs* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:254* + +*__description__*: absolute value + +**Returns:** `BN` + +___ ## add -▸ **add**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **add**(b: *`BN`*): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)* +*Inherited from BN.add* -*Defined in [codec/UInt.ts:86](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L86)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:264* + +*__description__*: addition **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | + +**Returns:** `BN` + +___ + + +## addn + +▸ **addn**(b: *`number`*): `BN` + +*Inherited from BN.addn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:274* + +*__description__*: addition + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## and + +▸ **and**(b: *`BN`*): `BN` + +*Inherited from BN.and* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:395* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## andln + +▸ **andln**(b: *`number`*): `BN` + +*Inherited from BN.andln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:415* + +*__description__*: and (NOTE: `andln` is going to be replaced with `andn` in future) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## bincn + +▸ **bincn**(b: *`number`*): `BN` + +*Inherited from BN.bincn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:499* + +*__description__*: add `1 << b` to the number + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## bitLength + +▸ **bitLength**(): [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) + +*Inherited from [UInt](_codec_uint_.uint.md).[bitLength](_codec_uint_.uint.md#bitlength)* + +*Overrides BN.bitLength* + +*Defined in [codec/UInt.ts:51](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L51)* + +**Returns:** [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) + +___ + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from BN.byteLength* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:144* + +*__description__*: return number of bytes occupied + +**Returns:** `number` + +___ + + +## clone + +▸ **clone**(): `BN` + +*Inherited from BN.clone* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:89* + +*__description__*: clone number **Returns:** `BN` @@ -100,74 +235,229 @@ ___ ## cmp -▸ **cmp**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `number` +▸ **cmp**(b: *`BN`*): `-1` | `0` | `1` -*Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)* +*Inherited from BN.cmp* -*Defined in [codec/UInt.ts:92](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L92)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:169* + +*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | -**Returns:** `number` +**Returns:** `-1` | `0` | `1` + +___ + + +## cmpn + +▸ **cmpn**(b: *`number`*): `-1` | `0` | `1` + +*Inherited from BN.cmpn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:179* + +*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `-1` | `0` | `1` ___ ## div -▸ **div**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **div**(b: *`BN`*): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)* +*Inherited from BN.div* -*Defined in [codec/UInt.ts:98](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L98)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:339* + +*__description__*: divide **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `BN` +___ + + +## divRound + +▸ **divRound**(b: *`BN`*): `BN` + +*Inherited from BN.divRound* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:370* + +*__description__*: rounded division + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## divn + +▸ **divn**(b: *`number`*): `BN` + +*Inherited from BN.divn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:344* + +*__description__*: divide + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## egcd + +▸ **egcd**(b: *`BN`*): `object` + +*Inherited from BN.egcd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:519* + +*__description__*: Extended GCD results `({ a: ..., b: ..., gcd: ... })` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `object` + ___ ## eq -▸ **eq**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **eq**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[eq](_codec_uint_.uint.md#eq)* +*Inherited from BN.eq* -*Defined in [codec/UInt.ts:104](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L104)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:224* + +*__description__*: a equals b **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` +___ + + +## eqn + +▸ **eqn**(b: *`number`*): `boolean` + +*Inherited from BN.eqn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:229* + +*__description__*: a equals b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## fromTwos + +▸ **fromTwos**(width: *`number`*): `BN` + +*Inherited from BN.fromTwos* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:239* + +*__description__*: convert from two's complement representation, where width is the bit width + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| width | `number` | + +**Returns:** `BN` + +___ + + +## gcd + +▸ **gcd**(b: *`BN`*): `BN` + +*Inherited from BN.gcd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:514* + +*__description__*: GCD + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + ___ ## gt -▸ **gt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **gt**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)* +*Inherited from BN.gt* -*Defined in [codec/UInt.ts:126](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L126)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:204* + +*__description__*: a greater than b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` @@ -176,17 +466,346 @@ ___ ## gte -▸ **gte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **gte**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)* +*Inherited from BN.gte* -*Defined in [codec/UInt.ts:132](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L132)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:214* + +*__description__*: a greater than or equals b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | + +**Returns:** `boolean` + +___ + + +## gten + +▸ **gten**(b: *`number`*): `boolean` + +*Inherited from BN.gten* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:219* + +*__description__*: a greater than or equals b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## gtn + +▸ **gtn**(b: *`number`*): `boolean` + +*Inherited from BN.gtn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:209* + +*__description__*: a greater than b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## iabs + +▸ **iabs**(): `BN` + +*Inherited from BN.iabs* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:259* + +*__description__*: absolute value + +**Returns:** `BN` + +___ + + +## iadd + +▸ **iadd**(b: *`BN`*): `BN` + +*Inherited from BN.iadd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:269* + +*__description__*: addition + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## iaddn + +▸ **iaddn**(b: *`number`*): `BN` + +*Inherited from BN.iaddn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:279* + +*__description__*: addition + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iand + +▸ **iand**(b: *`BN`*): `BN` + +*Inherited from BN.iand* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:400* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## idivn + +▸ **idivn**(b: *`number`*): `BN` + +*Inherited from BN.idivn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:349* + +*__description__*: divide + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## imaskn + +▸ **imaskn**(b: *`number`*): `BN` + +*Inherited from BN.imaskn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495* + +*__description__*: clear bits with indexes higher or equal to `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## imul + +▸ **imul**(b: *`BN`*): `BN` + +*Inherited from BN.imul* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:309* + +*__description__*: multiply + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## imuln + +▸ **imuln**(b: *`number`*): `BN` + +*Inherited from BN.imuln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:319* + +*__description__*: multiply + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## ineg + +▸ **ineg**(): `BN` + +*Inherited from BN.ineg* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:249* + +*__description__*: negate sign + +**Returns:** `BN` + +___ + + +## inotn + +▸ **inotn**(w: *`number`*): `BN` + +*Inherited from BN.inotn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:509* + +*__description__*: not (for the width specified by `w`) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| w | `number` | + +**Returns:** `BN` + +___ + + +## invm + +▸ **invm**(b: *`BN`*): `BN` + +*Inherited from BN.invm* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:524* + +*__description__*: inverse `a` modulo `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ior + +▸ **ior**(b: *`BN`*): `BN` + +*Inherited from BN.ior* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:380* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## isEven + +▸ **isEven**(): `boolean` + +*Inherited from BN.isEven* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:154* + +*__description__*: check if value is even + +**Returns:** `boolean` + +___ + + +## isNeg + +▸ **isNeg**(): `boolean` + +*Inherited from BN.isNeg* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:149* + +*__description__*: true if the number is negative + +**Returns:** `boolean` + +___ + + +## isOdd + +▸ **isOdd**(): `boolean` + +*Inherited from BN.isOdd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:159* + +*__description__*: check if value is odd **Returns:** `boolean` @@ -197,28 +816,257 @@ ___ ▸ **isZero**(): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)* +*Inherited from BN.isZero* -*Defined in [codec/UInt.ts:110](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L110)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:164* + +*__description__*: check if value is zero **Returns:** `boolean` +___ + + +## ishln + +▸ **ishln**(b: *`number`*): `BN` + +*Inherited from BN.ishln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:450* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## ishrn + +▸ **ishrn**(b: *`number`*): `BN` + +*Inherited from BN.ishrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:470* + +*__description__*: shift right (unimplemented [https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086](https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## isqr + +▸ **isqr**(): `BN` + +*Inherited from BN.isqr* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:329* + +*__description__*: square + +**Returns:** `BN` + +___ + + +## isub + +▸ **isub**(b: *`BN`*): `BN` + +*Inherited from BN.isub* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:289* + +*__description__*: subtraction + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## isubn + +▸ **isubn**(b: *`number`*): `BN` + +*Inherited from BN.isubn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:299* + +*__description__*: subtraction + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iuand + +▸ **iuand**(b: *`BN`*): `BN` + +*Inherited from BN.iuand* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:410* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## iuor + +▸ **iuor**(b: *`BN`*): `BN` + +*Inherited from BN.iuor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:390* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## iushln + +▸ **iushln**(b: *`number`*): `BN` + +*Inherited from BN.iushln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:460* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iushrn + +▸ **iushrn**(b: *`number`*): `BN` + +*Inherited from BN.iushrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480* + +*__description__*: shift right + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iuxor + +▸ **iuxor**(b: *`BN`*): `BN` + +*Inherited from BN.iuxor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:435* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ixor + +▸ **ixor**(b: *`BN`*): `BN` + +*Inherited from BN.ixor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:425* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + ___ ## lt -▸ **lt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **lt**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)* +*Inherited from BN.lt* -*Defined in [codec/UInt.ts:114](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L114)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:184* + +*__description__*: a less than b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` @@ -227,36 +1075,324 @@ ___ ## lte -▸ **lte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **lte**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)* +*Inherited from BN.lte* -*Defined in [codec/UInt.ts:120](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L120)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:194* + +*__description__*: a less than or equals b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` +___ + + +## lten + +▸ **lten**(b: *`number`*): `boolean` + +*Inherited from BN.lten* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:199* + +*__description__*: a less than or equals b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## ltn + +▸ **ltn**(b: *`number`*): `boolean` + +*Inherited from BN.ltn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:189* + +*__description__*: a less than b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## maskn + +▸ **maskn**(b: *`number`*): `BN` + +*Inherited from BN.maskn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490* + +*__description__*: clear bits with indexes higher or equal to `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## mod + +▸ **mod**(b: *`BN`*): `BN` + +*Inherited from BN.mod* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:354* + +*__description__*: reduct + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## modn + +▸ **modn**(b: *`number`*): `number` + +*Inherited from BN.modn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:365* + +*__see__*: API consistency [https://github.com/indutny/bn.js/pull/130](https://github.com/indutny/bn.js/pull/130) + +*__description__*: reduct + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `number` + ___ ## mul -▸ **mul**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **mul**(b: *`BN`*): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)* +*Inherited from BN.mul* -*Defined in [codec/UInt.ts:138](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L138)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:304* + +*__description__*: multiply **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | + +**Returns:** `BN` + +___ + + +## muln + +▸ **muln**(b: *`number`*): `BN` + +*Inherited from BN.muln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:314* + +*__description__*: multiply + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## neg + +▸ **neg**(): `BN` + +*Inherited from BN.neg* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:244* + +*__description__*: negate sign + +**Returns:** `BN` + +___ + + +## notn + +▸ **notn**(w: *`number`*): `BN` + +*Inherited from BN.notn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:504* + +*__description__*: not (for the width specified by `w`) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| w | `number` | + +**Returns:** `BN` + +___ + + +## or + +▸ **or**(b: *`BN`*): `BN` + +*Inherited from BN.or* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:375* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## pow + +▸ **pow**(b: *`BN`*): `BN` + +*Inherited from BN.pow* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:334* + +*__description__*: raise `a` to the power of `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## setn + +▸ **setn**(b: *`number`*): `BN` + +*Inherited from BN.setn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:440* + +*__description__*: set specified bit to 1 + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## shln + +▸ **shln**(b: *`number`*): `BN` + +*Inherited from BN.shln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:445* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## shrn + +▸ **shrn**(b: *`number`*): `BN` + +*Inherited from BN.shrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:465* + +*__description__*: shift right + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## sqr + +▸ **sqr**(): `BN` + +*Inherited from BN.sqr* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:324* + +*__description__*: square **Returns:** `BN` @@ -265,20 +1401,125 @@ ___ ## sub -▸ **sub**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **sub**(b: *`BN`*): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)* +*Inherited from BN.sub* -*Defined in [codec/UInt.ts:144](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L144)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:284* + +*__description__*: subtraction **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `BN` +___ + + +## subn + +▸ **subn**(b: *`number`*): `BN` + +*Inherited from BN.subn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:294* + +*__description__*: subtraction + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## testn + +▸ **testn**(b: *`number`*): `boolean` + +*Inherited from BN.testn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485* + +*__description__*: test if specified bit is set + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## toArray + +▸ **toArray**(endian?: *`Endianness`*, length?: * `undefined` | `number`*): `number`[] + +*Inherited from BN.toArray* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:109* + +*__description__*: convert to byte Array, and optionally zero pad to length, throwing if already exceeding + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `number`[] + +___ + + +## toArrayLike + +▸ **toArrayLike**(ArrayType: *`object`*, endian?: *`Endianness`*, length?: * `undefined` | `number`*): `Buffer` + +▸ **toArrayLike**(ArrayType: *`any`[]*, endian?: *`Endianness`*, length?: * `undefined` | `number`*): `any`[] + +*Inherited from BN.toArrayLike* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:114* + +*__description__*: convert to an instance of `type`, which must behave like an Array + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| ArrayType | `object` | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `Buffer` + +*Inherited from BN.toArrayLike* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| ArrayType | `any`[] | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `any`[] + ___ @@ -288,10 +1529,32 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)* -*Defined in [codec/UInt.ts:76](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L76)* +*Defined in [codec/UInt.ts:73](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L73)* **Returns:** `BN` +___ + + +## toBuffer + +▸ **toBuffer**(endian?: *`Endianness`*, length?: * `undefined` | `number`*): `Buffer` + +*Inherited from BN.toBuffer* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:129* + +*__description__*: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `Buffer` + ___ @@ -301,7 +1564,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* -*Defined in [codec/UInt.ts:58](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L58)* +*Defined in [codec/UInt.ts:59](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L59)* **Returns:** `string` @@ -314,9 +1577,9 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toJSON](_codec_uint_.uint.md#tojson)* -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* +*Overrides BN.toJSON* -*Defined in [codec/UInt.ts:62](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L62)* +*Defined in [codec/UInt.ts:63](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L63)* **Returns:** `any` @@ -327,27 +1590,78 @@ ___ ▸ **toNumber**(): `number` -*Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)* +*Inherited from BN.toNumber* -*Defined in [codec/UInt.ts:80](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L80)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:99* + +*__description__*: convert to Javascript Number (limited to 53 bits) **Returns:** `number` +___ + + +## toRed + +▸ **toRed**(reductionContext: *`ReductionContext`*): `RedBN` + +*Inherited from BN.toRed* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:84* + +*__description__*: Convert number to red + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| reductionContext | `ReductionContext` | + +**Returns:** `RedBN` + ___ ## toString -▸ **toString**(): `string` +▸ **toString**(base?: * `number` | "hex"*, length?: * `undefined` | `number`*): `string` -*Inherited from [UInt](_codec_uint_.uint.md).[toString](_codec_uint_.uint.md#tostring)* +*Inherited from BN.toString* -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:94* -*Defined in [codec/UInt.ts:72](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L72)* +*__description__*: convert to base-string and pad with zeroes + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` base | `number` | "hex"| +| `Optional` length | `undefined` | `number`| **Returns:** `string` +___ + + +## toTwos + +▸ **toTwos**(width: *`number`*): `BN` + +*Inherited from BN.toTwos* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:234* + +*__description__*: convert to two's complement representation, where width is bit width + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| width | `number` | + +**Returns:** `BN` + ___ @@ -357,9 +1671,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/UInt.ts:68](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L68)* +*Defined in [codec/UInt.ts:69](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L69)* **Parameters:** @@ -369,16 +1681,199 @@ ___ **Returns:** `Uint8Array` +___ + + +## uand + +▸ **uand**(b: *`BN`*): `BN` + +*Inherited from BN.uand* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:405* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ucmp + +▸ **ucmp**(b: *`BN`*): `-1` | `0` | `1` + +*Inherited from BN.ucmp* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:174* + +*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `-1` | `0` | `1` + +___ + + +## umod + +▸ **umod**(b: *`BN`*): `BN` + +*Inherited from BN.umod* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:359* + +*__description__*: reduct + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## uor + +▸ **uor**(b: *`BN`*): `BN` + +*Inherited from BN.uor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:385* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ushln + +▸ **ushln**(b: *`number`*): `BN` + +*Inherited from BN.ushln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:455* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## ushrn + +▸ **ushrn**(b: *`number`*): `BN` + +*Inherited from BN.ushrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475* + +*__description__*: shift right + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## uxor + +▸ **uxor**(b: *`BN`*): `BN` + +*Inherited from BN.uxor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:430* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## xor + +▸ **xor**(b: *`BN`*): `BN` + +*Inherited from BN.xor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:420* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## zeroBits + +▸ **zeroBits**(): `number` + +*Inherited from BN.zeroBits* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:139* + +*__description__*: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits) + +**Returns:** `number` + ___ ## `` decodeUInt -▸ **decodeUInt**(value: *`AnyNumber`*, bitLength: *[UIntBitLength](../modules/_codec_uint_.md#uintbitlength)*): `BN` +▸ **decodeUInt**(value: *`AnyNumber`*, bitLength: *[UIntBitLength](../modules/_codec_uint_.md#uintbitlength)*): `string` *Inherited from [UInt](_codec_uint_.uint.md).[decodeUInt](_codec_uint_.uint.md#decodeuint)* -*Defined in [codec/UInt.ts:35](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L35)* +*Defined in [codec/UInt.ts:35](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L35)* **Parameters:** @@ -387,7 +1882,114 @@ ___ | value | `AnyNumber` | | bitLength | [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) | +**Returns:** `string` + +___ + + +## `` isBN + +▸ **isBN**(b: *`any`*): `boolean` + +*Inherited from BN.isBN* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:69* + +*__description__*: returns true if the supplied object is a BN.js instance + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `any` | + +**Returns:** `boolean` + +___ + + +## `` max + +▸ **max**(left: *`BN`*, right: *`BN`*): `BN` + +*Inherited from BN.max* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:74* + +*__description__*: returns the maximum of 2 BN instances. + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| left | `BN` | +| right | `BN` | + **Returns:** `BN` ___ + + +## `` min + +▸ **min**(left: *`BN`*, right: *`BN`*): `BN` + +*Inherited from BN.min* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:79* + +*__description__*: returns the minimum of 2 BN instances. + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| left | `BN` | +| right | `BN` | + +**Returns:** `BN` + +___ + + +## `` mont + +▸ **mont**(num: *`BN`*): `ReductionContext` + +*Inherited from BN.mont* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:64* + +*__description__*: create a reduction context with the Montgomery trick. + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| num | `BN` | + +**Returns:** `ReductionContext` + +___ + + +## `` red + +▸ **red**(reductionContext: * `BN` | `IPrimeName`*): `ReductionContext` + +*Inherited from BN.red* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:59* + +*__description__*: create a reduction context + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| reductionContext | `BN` | `IPrimeName`| + +**Returns:** `ReductionContext` + +___ diff --git a/docs/types/classes/_u16_.u16.md b/docs/types/classes/_u16_.u16.md index 443bd1bca6..7cfa42d4d1 100644 --- a/docs/types/classes/_u16_.u16.md +++ b/docs/types/classes/_u16_.u16.md @@ -6,6 +6,10 @@ **↳ U16** +# Implements + +* `Codec` + # Constructors @@ -16,7 +20,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U16.ts:9](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/U16.ts#L9)* +*Defined in [U16.ts:9](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/U16.ts#L9)* **Parameters:** @@ -36,27 +40,14 @@ ___ **● raw**: *`BN`* -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* +*Inherited from [UInt](_codec_uint_.uint.md).[raw](_codec_uint_.uint.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/UInt.ts:23](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L23)* ___ # Accessors - - -## bitLength - -getbitLength(): [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) - -*Inherited from [UInt](_codec_uint_.uint.md).[bitLength](_codec_uint_.uint.md#bitlength)* - -*Defined in [codec/UInt.ts:50](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L50)* - -**Returns:** [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) - -___ ## encodedLength @@ -65,9 +56,7 @@ getencodedLength(): `number` *Inherited from [UInt](_codec_uint_.uint.md).[encodedLength](_codec_uint_.uint.md#encodedlength)* -*Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* - -*Defined in [codec/UInt.ts:54](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L54)* +*Defined in [codec/UInt.ts:55](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L55)* **Returns:** `number` @@ -75,21 +64,167 @@ ___ # Methods + + +## abs + +▸ **abs**(): `BN` + +*Inherited from BN.abs* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:254* + +*__description__*: absolute value + +**Returns:** `BN` + +___ ## add -▸ **add**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **add**(b: *`BN`*): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)* +*Inherited from BN.add* -*Defined in [codec/UInt.ts:86](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L86)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:264* + +*__description__*: addition **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | + +**Returns:** `BN` + +___ + + +## addn + +▸ **addn**(b: *`number`*): `BN` + +*Inherited from BN.addn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:274* + +*__description__*: addition + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## and + +▸ **and**(b: *`BN`*): `BN` + +*Inherited from BN.and* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:395* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## andln + +▸ **andln**(b: *`number`*): `BN` + +*Inherited from BN.andln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:415* + +*__description__*: and (NOTE: `andln` is going to be replaced with `andn` in future) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## bincn + +▸ **bincn**(b: *`number`*): `BN` + +*Inherited from BN.bincn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:499* + +*__description__*: add `1 << b` to the number + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## bitLength + +▸ **bitLength**(): [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) + +*Inherited from [UInt](_codec_uint_.uint.md).[bitLength](_codec_uint_.uint.md#bitlength)* + +*Overrides BN.bitLength* + +*Defined in [codec/UInt.ts:51](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L51)* + +**Returns:** [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) + +___ + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from BN.byteLength* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:144* + +*__description__*: return number of bytes occupied + +**Returns:** `number` + +___ + + +## clone + +▸ **clone**(): `BN` + +*Inherited from BN.clone* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:89* + +*__description__*: clone number **Returns:** `BN` @@ -98,74 +233,229 @@ ___ ## cmp -▸ **cmp**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `number` +▸ **cmp**(b: *`BN`*): `-1` | `0` | `1` -*Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)* +*Inherited from BN.cmp* -*Defined in [codec/UInt.ts:92](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L92)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:169* + +*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | -**Returns:** `number` +**Returns:** `-1` | `0` | `1` + +___ + + +## cmpn + +▸ **cmpn**(b: *`number`*): `-1` | `0` | `1` + +*Inherited from BN.cmpn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:179* + +*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `-1` | `0` | `1` ___ ## div -▸ **div**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **div**(b: *`BN`*): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)* +*Inherited from BN.div* -*Defined in [codec/UInt.ts:98](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L98)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:339* + +*__description__*: divide **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `BN` +___ + + +## divRound + +▸ **divRound**(b: *`BN`*): `BN` + +*Inherited from BN.divRound* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:370* + +*__description__*: rounded division + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## divn + +▸ **divn**(b: *`number`*): `BN` + +*Inherited from BN.divn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:344* + +*__description__*: divide + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## egcd + +▸ **egcd**(b: *`BN`*): `object` + +*Inherited from BN.egcd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:519* + +*__description__*: Extended GCD results `({ a: ..., b: ..., gcd: ... })` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `object` + ___ ## eq -▸ **eq**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **eq**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[eq](_codec_uint_.uint.md#eq)* +*Inherited from BN.eq* -*Defined in [codec/UInt.ts:104](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L104)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:224* + +*__description__*: a equals b **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` +___ + + +## eqn + +▸ **eqn**(b: *`number`*): `boolean` + +*Inherited from BN.eqn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:229* + +*__description__*: a equals b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## fromTwos + +▸ **fromTwos**(width: *`number`*): `BN` + +*Inherited from BN.fromTwos* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:239* + +*__description__*: convert from two's complement representation, where width is the bit width + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| width | `number` | + +**Returns:** `BN` + +___ + + +## gcd + +▸ **gcd**(b: *`BN`*): `BN` + +*Inherited from BN.gcd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:514* + +*__description__*: GCD + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + ___ ## gt -▸ **gt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **gt**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)* +*Inherited from BN.gt* -*Defined in [codec/UInt.ts:126](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L126)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:204* + +*__description__*: a greater than b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` @@ -174,17 +464,346 @@ ___ ## gte -▸ **gte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **gte**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)* +*Inherited from BN.gte* -*Defined in [codec/UInt.ts:132](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L132)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:214* + +*__description__*: a greater than or equals b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | + +**Returns:** `boolean` + +___ + + +## gten + +▸ **gten**(b: *`number`*): `boolean` + +*Inherited from BN.gten* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:219* + +*__description__*: a greater than or equals b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## gtn + +▸ **gtn**(b: *`number`*): `boolean` + +*Inherited from BN.gtn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:209* + +*__description__*: a greater than b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## iabs + +▸ **iabs**(): `BN` + +*Inherited from BN.iabs* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:259* + +*__description__*: absolute value + +**Returns:** `BN` + +___ + + +## iadd + +▸ **iadd**(b: *`BN`*): `BN` + +*Inherited from BN.iadd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:269* + +*__description__*: addition + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## iaddn + +▸ **iaddn**(b: *`number`*): `BN` + +*Inherited from BN.iaddn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:279* + +*__description__*: addition + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iand + +▸ **iand**(b: *`BN`*): `BN` + +*Inherited from BN.iand* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:400* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## idivn + +▸ **idivn**(b: *`number`*): `BN` + +*Inherited from BN.idivn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:349* + +*__description__*: divide + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## imaskn + +▸ **imaskn**(b: *`number`*): `BN` + +*Inherited from BN.imaskn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495* + +*__description__*: clear bits with indexes higher or equal to `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## imul + +▸ **imul**(b: *`BN`*): `BN` + +*Inherited from BN.imul* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:309* + +*__description__*: multiply + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## imuln + +▸ **imuln**(b: *`number`*): `BN` + +*Inherited from BN.imuln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:319* + +*__description__*: multiply + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## ineg + +▸ **ineg**(): `BN` + +*Inherited from BN.ineg* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:249* + +*__description__*: negate sign + +**Returns:** `BN` + +___ + + +## inotn + +▸ **inotn**(w: *`number`*): `BN` + +*Inherited from BN.inotn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:509* + +*__description__*: not (for the width specified by `w`) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| w | `number` | + +**Returns:** `BN` + +___ + + +## invm + +▸ **invm**(b: *`BN`*): `BN` + +*Inherited from BN.invm* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:524* + +*__description__*: inverse `a` modulo `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ior + +▸ **ior**(b: *`BN`*): `BN` + +*Inherited from BN.ior* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:380* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## isEven + +▸ **isEven**(): `boolean` + +*Inherited from BN.isEven* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:154* + +*__description__*: check if value is even + +**Returns:** `boolean` + +___ + + +## isNeg + +▸ **isNeg**(): `boolean` + +*Inherited from BN.isNeg* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:149* + +*__description__*: true if the number is negative + +**Returns:** `boolean` + +___ + + +## isOdd + +▸ **isOdd**(): `boolean` + +*Inherited from BN.isOdd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:159* + +*__description__*: check if value is odd **Returns:** `boolean` @@ -195,28 +814,257 @@ ___ ▸ **isZero**(): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)* +*Inherited from BN.isZero* -*Defined in [codec/UInt.ts:110](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L110)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:164* + +*__description__*: check if value is zero **Returns:** `boolean` +___ + + +## ishln + +▸ **ishln**(b: *`number`*): `BN` + +*Inherited from BN.ishln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:450* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## ishrn + +▸ **ishrn**(b: *`number`*): `BN` + +*Inherited from BN.ishrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:470* + +*__description__*: shift right (unimplemented [https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086](https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## isqr + +▸ **isqr**(): `BN` + +*Inherited from BN.isqr* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:329* + +*__description__*: square + +**Returns:** `BN` + +___ + + +## isub + +▸ **isub**(b: *`BN`*): `BN` + +*Inherited from BN.isub* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:289* + +*__description__*: subtraction + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## isubn + +▸ **isubn**(b: *`number`*): `BN` + +*Inherited from BN.isubn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:299* + +*__description__*: subtraction + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iuand + +▸ **iuand**(b: *`BN`*): `BN` + +*Inherited from BN.iuand* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:410* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## iuor + +▸ **iuor**(b: *`BN`*): `BN` + +*Inherited from BN.iuor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:390* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## iushln + +▸ **iushln**(b: *`number`*): `BN` + +*Inherited from BN.iushln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:460* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iushrn + +▸ **iushrn**(b: *`number`*): `BN` + +*Inherited from BN.iushrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480* + +*__description__*: shift right + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iuxor + +▸ **iuxor**(b: *`BN`*): `BN` + +*Inherited from BN.iuxor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:435* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ixor + +▸ **ixor**(b: *`BN`*): `BN` + +*Inherited from BN.ixor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:425* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + ___ ## lt -▸ **lt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **lt**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)* +*Inherited from BN.lt* -*Defined in [codec/UInt.ts:114](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L114)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:184* + +*__description__*: a less than b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` @@ -225,36 +1073,324 @@ ___ ## lte -▸ **lte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **lte**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)* +*Inherited from BN.lte* -*Defined in [codec/UInt.ts:120](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L120)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:194* + +*__description__*: a less than or equals b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` +___ + + +## lten + +▸ **lten**(b: *`number`*): `boolean` + +*Inherited from BN.lten* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:199* + +*__description__*: a less than or equals b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## ltn + +▸ **ltn**(b: *`number`*): `boolean` + +*Inherited from BN.ltn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:189* + +*__description__*: a less than b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## maskn + +▸ **maskn**(b: *`number`*): `BN` + +*Inherited from BN.maskn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490* + +*__description__*: clear bits with indexes higher or equal to `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## mod + +▸ **mod**(b: *`BN`*): `BN` + +*Inherited from BN.mod* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:354* + +*__description__*: reduct + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## modn + +▸ **modn**(b: *`number`*): `number` + +*Inherited from BN.modn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:365* + +*__see__*: API consistency [https://github.com/indutny/bn.js/pull/130](https://github.com/indutny/bn.js/pull/130) + +*__description__*: reduct + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `number` + ___ ## mul -▸ **mul**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **mul**(b: *`BN`*): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)* +*Inherited from BN.mul* -*Defined in [codec/UInt.ts:138](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L138)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:304* + +*__description__*: multiply **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | + +**Returns:** `BN` + +___ + + +## muln + +▸ **muln**(b: *`number`*): `BN` + +*Inherited from BN.muln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:314* + +*__description__*: multiply + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## neg + +▸ **neg**(): `BN` + +*Inherited from BN.neg* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:244* + +*__description__*: negate sign + +**Returns:** `BN` + +___ + + +## notn + +▸ **notn**(w: *`number`*): `BN` + +*Inherited from BN.notn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:504* + +*__description__*: not (for the width specified by `w`) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| w | `number` | + +**Returns:** `BN` + +___ + + +## or + +▸ **or**(b: *`BN`*): `BN` + +*Inherited from BN.or* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:375* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## pow + +▸ **pow**(b: *`BN`*): `BN` + +*Inherited from BN.pow* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:334* + +*__description__*: raise `a` to the power of `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## setn + +▸ **setn**(b: *`number`*): `BN` + +*Inherited from BN.setn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:440* + +*__description__*: set specified bit to 1 + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## shln + +▸ **shln**(b: *`number`*): `BN` + +*Inherited from BN.shln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:445* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## shrn + +▸ **shrn**(b: *`number`*): `BN` + +*Inherited from BN.shrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:465* + +*__description__*: shift right + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## sqr + +▸ **sqr**(): `BN` + +*Inherited from BN.sqr* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:324* + +*__description__*: square **Returns:** `BN` @@ -263,20 +1399,125 @@ ___ ## sub -▸ **sub**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **sub**(b: *`BN`*): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)* +*Inherited from BN.sub* -*Defined in [codec/UInt.ts:144](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L144)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:284* + +*__description__*: subtraction **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `BN` +___ + + +## subn + +▸ **subn**(b: *`number`*): `BN` + +*Inherited from BN.subn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:294* + +*__description__*: subtraction + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## testn + +▸ **testn**(b: *`number`*): `boolean` + +*Inherited from BN.testn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485* + +*__description__*: test if specified bit is set + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## toArray + +▸ **toArray**(endian?: *`Endianness`*, length?: * `undefined` | `number`*): `number`[] + +*Inherited from BN.toArray* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:109* + +*__description__*: convert to byte Array, and optionally zero pad to length, throwing if already exceeding + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `number`[] + +___ + + +## toArrayLike + +▸ **toArrayLike**(ArrayType: *`object`*, endian?: *`Endianness`*, length?: * `undefined` | `number`*): `Buffer` + +▸ **toArrayLike**(ArrayType: *`any`[]*, endian?: *`Endianness`*, length?: * `undefined` | `number`*): `any`[] + +*Inherited from BN.toArrayLike* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:114* + +*__description__*: convert to an instance of `type`, which must behave like an Array + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| ArrayType | `object` | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `Buffer` + +*Inherited from BN.toArrayLike* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| ArrayType | `any`[] | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `any`[] + ___ @@ -286,10 +1527,32 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)* -*Defined in [codec/UInt.ts:76](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L76)* +*Defined in [codec/UInt.ts:73](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L73)* **Returns:** `BN` +___ + + +## toBuffer + +▸ **toBuffer**(endian?: *`Endianness`*, length?: * `undefined` | `number`*): `Buffer` + +*Inherited from BN.toBuffer* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:129* + +*__description__*: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `Buffer` + ___ @@ -299,7 +1562,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* -*Defined in [codec/UInt.ts:58](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L58)* +*Defined in [codec/UInt.ts:59](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L59)* **Returns:** `string` @@ -312,9 +1575,9 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toJSON](_codec_uint_.uint.md#tojson)* -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* +*Overrides BN.toJSON* -*Defined in [codec/UInt.ts:62](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L62)* +*Defined in [codec/UInt.ts:63](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L63)* **Returns:** `any` @@ -325,27 +1588,78 @@ ___ ▸ **toNumber**(): `number` -*Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)* +*Inherited from BN.toNumber* -*Defined in [codec/UInt.ts:80](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L80)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:99* + +*__description__*: convert to Javascript Number (limited to 53 bits) **Returns:** `number` +___ + + +## toRed + +▸ **toRed**(reductionContext: *`ReductionContext`*): `RedBN` + +*Inherited from BN.toRed* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:84* + +*__description__*: Convert number to red + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| reductionContext | `ReductionContext` | + +**Returns:** `RedBN` + ___ ## toString -▸ **toString**(): `string` +▸ **toString**(base?: * `number` | "hex"*, length?: * `undefined` | `number`*): `string` -*Inherited from [UInt](_codec_uint_.uint.md).[toString](_codec_uint_.uint.md#tostring)* +*Inherited from BN.toString* -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:94* -*Defined in [codec/UInt.ts:72](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L72)* +*__description__*: convert to base-string and pad with zeroes + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` base | `number` | "hex"| +| `Optional` length | `undefined` | `number`| **Returns:** `string` +___ + + +## toTwos + +▸ **toTwos**(width: *`number`*): `BN` + +*Inherited from BN.toTwos* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:234* + +*__description__*: convert to two's complement representation, where width is bit width + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| width | `number` | + +**Returns:** `BN` + ___ @@ -355,9 +1669,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/UInt.ts:68](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L68)* +*Defined in [codec/UInt.ts:69](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L69)* **Parameters:** @@ -367,16 +1679,199 @@ ___ **Returns:** `Uint8Array` +___ + + +## uand + +▸ **uand**(b: *`BN`*): `BN` + +*Inherited from BN.uand* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:405* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ucmp + +▸ **ucmp**(b: *`BN`*): `-1` | `0` | `1` + +*Inherited from BN.ucmp* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:174* + +*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `-1` | `0` | `1` + +___ + + +## umod + +▸ **umod**(b: *`BN`*): `BN` + +*Inherited from BN.umod* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:359* + +*__description__*: reduct + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## uor + +▸ **uor**(b: *`BN`*): `BN` + +*Inherited from BN.uor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:385* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ushln + +▸ **ushln**(b: *`number`*): `BN` + +*Inherited from BN.ushln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:455* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## ushrn + +▸ **ushrn**(b: *`number`*): `BN` + +*Inherited from BN.ushrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475* + +*__description__*: shift right + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## uxor + +▸ **uxor**(b: *`BN`*): `BN` + +*Inherited from BN.uxor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:430* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## xor + +▸ **xor**(b: *`BN`*): `BN` + +*Inherited from BN.xor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:420* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## zeroBits + +▸ **zeroBits**(): `number` + +*Inherited from BN.zeroBits* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:139* + +*__description__*: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits) + +**Returns:** `number` + ___ ## `` decodeUInt -▸ **decodeUInt**(value: *`AnyNumber`*, bitLength: *[UIntBitLength](../modules/_codec_uint_.md#uintbitlength)*): `BN` +▸ **decodeUInt**(value: *`AnyNumber`*, bitLength: *[UIntBitLength](../modules/_codec_uint_.md#uintbitlength)*): `string` *Inherited from [UInt](_codec_uint_.uint.md).[decodeUInt](_codec_uint_.uint.md#decodeuint)* -*Defined in [codec/UInt.ts:35](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L35)* +*Defined in [codec/UInt.ts:35](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L35)* **Parameters:** @@ -385,7 +1880,114 @@ ___ | value | `AnyNumber` | | bitLength | [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) | +**Returns:** `string` + +___ + + +## `` isBN + +▸ **isBN**(b: *`any`*): `boolean` + +*Inherited from BN.isBN* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:69* + +*__description__*: returns true if the supplied object is a BN.js instance + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `any` | + +**Returns:** `boolean` + +___ + + +## `` max + +▸ **max**(left: *`BN`*, right: *`BN`*): `BN` + +*Inherited from BN.max* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:74* + +*__description__*: returns the maximum of 2 BN instances. + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| left | `BN` | +| right | `BN` | + **Returns:** `BN` ___ + + +## `` min + +▸ **min**(left: *`BN`*, right: *`BN`*): `BN` + +*Inherited from BN.min* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:79* + +*__description__*: returns the minimum of 2 BN instances. + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| left | `BN` | +| right | `BN` | + +**Returns:** `BN` + +___ + + +## `` mont + +▸ **mont**(num: *`BN`*): `ReductionContext` + +*Inherited from BN.mont* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:64* + +*__description__*: create a reduction context with the Montgomery trick. + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| num | `BN` | + +**Returns:** `ReductionContext` + +___ + + +## `` red + +▸ **red**(reductionContext: * `BN` | `IPrimeName`*): `ReductionContext` + +*Inherited from BN.red* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:59* + +*__description__*: create a reduction context + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| reductionContext | `BN` | `IPrimeName`| + +**Returns:** `ReductionContext` + +___ diff --git a/docs/types/classes/_u256_.u256.md b/docs/types/classes/_u256_.u256.md index 737eeedfe8..14c5724777 100644 --- a/docs/types/classes/_u256_.u256.md +++ b/docs/types/classes/_u256_.u256.md @@ -6,6 +6,10 @@ **↳ U256** +# Implements + +* `Codec` + # Constructors @@ -16,7 +20,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U256.ts:9](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/U256.ts#L9)* +*Defined in [U256.ts:9](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/U256.ts#L9)* **Parameters:** @@ -36,27 +40,14 @@ ___ **● raw**: *`BN`* -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* +*Inherited from [UInt](_codec_uint_.uint.md).[raw](_codec_uint_.uint.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/UInt.ts:23](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L23)* ___ # Accessors - - -## bitLength - -getbitLength(): [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) - -*Inherited from [UInt](_codec_uint_.uint.md).[bitLength](_codec_uint_.uint.md#bitlength)* - -*Defined in [codec/UInt.ts:50](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L50)* - -**Returns:** [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) - -___ ## encodedLength @@ -65,9 +56,7 @@ getencodedLength(): `number` *Inherited from [UInt](_codec_uint_.uint.md).[encodedLength](_codec_uint_.uint.md#encodedlength)* -*Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* - -*Defined in [codec/UInt.ts:54](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L54)* +*Defined in [codec/UInt.ts:55](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L55)* **Returns:** `number` @@ -75,21 +64,167 @@ ___ # Methods + + +## abs + +▸ **abs**(): `BN` + +*Inherited from BN.abs* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:254* + +*__description__*: absolute value + +**Returns:** `BN` + +___ ## add -▸ **add**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **add**(b: *`BN`*): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)* +*Inherited from BN.add* -*Defined in [codec/UInt.ts:86](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L86)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:264* + +*__description__*: addition **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | + +**Returns:** `BN` + +___ + + +## addn + +▸ **addn**(b: *`number`*): `BN` + +*Inherited from BN.addn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:274* + +*__description__*: addition + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## and + +▸ **and**(b: *`BN`*): `BN` + +*Inherited from BN.and* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:395* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## andln + +▸ **andln**(b: *`number`*): `BN` + +*Inherited from BN.andln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:415* + +*__description__*: and (NOTE: `andln` is going to be replaced with `andn` in future) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## bincn + +▸ **bincn**(b: *`number`*): `BN` + +*Inherited from BN.bincn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:499* + +*__description__*: add `1 << b` to the number + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## bitLength + +▸ **bitLength**(): [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) + +*Inherited from [UInt](_codec_uint_.uint.md).[bitLength](_codec_uint_.uint.md#bitlength)* + +*Overrides BN.bitLength* + +*Defined in [codec/UInt.ts:51](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L51)* + +**Returns:** [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) + +___ + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from BN.byteLength* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:144* + +*__description__*: return number of bytes occupied + +**Returns:** `number` + +___ + + +## clone + +▸ **clone**(): `BN` + +*Inherited from BN.clone* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:89* + +*__description__*: clone number **Returns:** `BN` @@ -98,74 +233,229 @@ ___ ## cmp -▸ **cmp**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `number` +▸ **cmp**(b: *`BN`*): `-1` | `0` | `1` -*Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)* +*Inherited from BN.cmp* -*Defined in [codec/UInt.ts:92](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L92)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:169* + +*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | -**Returns:** `number` +**Returns:** `-1` | `0` | `1` + +___ + + +## cmpn + +▸ **cmpn**(b: *`number`*): `-1` | `0` | `1` + +*Inherited from BN.cmpn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:179* + +*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `-1` | `0` | `1` ___ ## div -▸ **div**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **div**(b: *`BN`*): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)* +*Inherited from BN.div* -*Defined in [codec/UInt.ts:98](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L98)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:339* + +*__description__*: divide **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `BN` +___ + + +## divRound + +▸ **divRound**(b: *`BN`*): `BN` + +*Inherited from BN.divRound* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:370* + +*__description__*: rounded division + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## divn + +▸ **divn**(b: *`number`*): `BN` + +*Inherited from BN.divn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:344* + +*__description__*: divide + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## egcd + +▸ **egcd**(b: *`BN`*): `object` + +*Inherited from BN.egcd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:519* + +*__description__*: Extended GCD results `({ a: ..., b: ..., gcd: ... })` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `object` + ___ ## eq -▸ **eq**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **eq**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[eq](_codec_uint_.uint.md#eq)* +*Inherited from BN.eq* -*Defined in [codec/UInt.ts:104](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L104)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:224* + +*__description__*: a equals b **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` +___ + + +## eqn + +▸ **eqn**(b: *`number`*): `boolean` + +*Inherited from BN.eqn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:229* + +*__description__*: a equals b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## fromTwos + +▸ **fromTwos**(width: *`number`*): `BN` + +*Inherited from BN.fromTwos* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:239* + +*__description__*: convert from two's complement representation, where width is the bit width + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| width | `number` | + +**Returns:** `BN` + +___ + + +## gcd + +▸ **gcd**(b: *`BN`*): `BN` + +*Inherited from BN.gcd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:514* + +*__description__*: GCD + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + ___ ## gt -▸ **gt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **gt**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)* +*Inherited from BN.gt* -*Defined in [codec/UInt.ts:126](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L126)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:204* + +*__description__*: a greater than b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` @@ -174,17 +464,346 @@ ___ ## gte -▸ **gte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **gte**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)* +*Inherited from BN.gte* -*Defined in [codec/UInt.ts:132](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L132)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:214* + +*__description__*: a greater than or equals b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | + +**Returns:** `boolean` + +___ + + +## gten + +▸ **gten**(b: *`number`*): `boolean` + +*Inherited from BN.gten* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:219* + +*__description__*: a greater than or equals b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## gtn + +▸ **gtn**(b: *`number`*): `boolean` + +*Inherited from BN.gtn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:209* + +*__description__*: a greater than b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## iabs + +▸ **iabs**(): `BN` + +*Inherited from BN.iabs* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:259* + +*__description__*: absolute value + +**Returns:** `BN` + +___ + + +## iadd + +▸ **iadd**(b: *`BN`*): `BN` + +*Inherited from BN.iadd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:269* + +*__description__*: addition + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## iaddn + +▸ **iaddn**(b: *`number`*): `BN` + +*Inherited from BN.iaddn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:279* + +*__description__*: addition + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iand + +▸ **iand**(b: *`BN`*): `BN` + +*Inherited from BN.iand* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:400* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## idivn + +▸ **idivn**(b: *`number`*): `BN` + +*Inherited from BN.idivn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:349* + +*__description__*: divide + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## imaskn + +▸ **imaskn**(b: *`number`*): `BN` + +*Inherited from BN.imaskn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495* + +*__description__*: clear bits with indexes higher or equal to `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## imul + +▸ **imul**(b: *`BN`*): `BN` + +*Inherited from BN.imul* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:309* + +*__description__*: multiply + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## imuln + +▸ **imuln**(b: *`number`*): `BN` + +*Inherited from BN.imuln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:319* + +*__description__*: multiply + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## ineg + +▸ **ineg**(): `BN` + +*Inherited from BN.ineg* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:249* + +*__description__*: negate sign + +**Returns:** `BN` + +___ + + +## inotn + +▸ **inotn**(w: *`number`*): `BN` + +*Inherited from BN.inotn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:509* + +*__description__*: not (for the width specified by `w`) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| w | `number` | + +**Returns:** `BN` + +___ + + +## invm + +▸ **invm**(b: *`BN`*): `BN` + +*Inherited from BN.invm* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:524* + +*__description__*: inverse `a` modulo `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ior + +▸ **ior**(b: *`BN`*): `BN` + +*Inherited from BN.ior* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:380* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## isEven + +▸ **isEven**(): `boolean` + +*Inherited from BN.isEven* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:154* + +*__description__*: check if value is even + +**Returns:** `boolean` + +___ + + +## isNeg + +▸ **isNeg**(): `boolean` + +*Inherited from BN.isNeg* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:149* + +*__description__*: true if the number is negative + +**Returns:** `boolean` + +___ + + +## isOdd + +▸ **isOdd**(): `boolean` + +*Inherited from BN.isOdd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:159* + +*__description__*: check if value is odd **Returns:** `boolean` @@ -195,28 +814,257 @@ ___ ▸ **isZero**(): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)* +*Inherited from BN.isZero* -*Defined in [codec/UInt.ts:110](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L110)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:164* + +*__description__*: check if value is zero **Returns:** `boolean` +___ + + +## ishln + +▸ **ishln**(b: *`number`*): `BN` + +*Inherited from BN.ishln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:450* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## ishrn + +▸ **ishrn**(b: *`number`*): `BN` + +*Inherited from BN.ishrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:470* + +*__description__*: shift right (unimplemented [https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086](https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## isqr + +▸ **isqr**(): `BN` + +*Inherited from BN.isqr* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:329* + +*__description__*: square + +**Returns:** `BN` + +___ + + +## isub + +▸ **isub**(b: *`BN`*): `BN` + +*Inherited from BN.isub* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:289* + +*__description__*: subtraction + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## isubn + +▸ **isubn**(b: *`number`*): `BN` + +*Inherited from BN.isubn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:299* + +*__description__*: subtraction + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iuand + +▸ **iuand**(b: *`BN`*): `BN` + +*Inherited from BN.iuand* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:410* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## iuor + +▸ **iuor**(b: *`BN`*): `BN` + +*Inherited from BN.iuor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:390* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## iushln + +▸ **iushln**(b: *`number`*): `BN` + +*Inherited from BN.iushln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:460* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iushrn + +▸ **iushrn**(b: *`number`*): `BN` + +*Inherited from BN.iushrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480* + +*__description__*: shift right + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iuxor + +▸ **iuxor**(b: *`BN`*): `BN` + +*Inherited from BN.iuxor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:435* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ixor + +▸ **ixor**(b: *`BN`*): `BN` + +*Inherited from BN.ixor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:425* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + ___ ## lt -▸ **lt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **lt**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)* +*Inherited from BN.lt* -*Defined in [codec/UInt.ts:114](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L114)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:184* + +*__description__*: a less than b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` @@ -225,36 +1073,324 @@ ___ ## lte -▸ **lte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **lte**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)* +*Inherited from BN.lte* -*Defined in [codec/UInt.ts:120](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L120)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:194* + +*__description__*: a less than or equals b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` +___ + + +## lten + +▸ **lten**(b: *`number`*): `boolean` + +*Inherited from BN.lten* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:199* + +*__description__*: a less than or equals b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## ltn + +▸ **ltn**(b: *`number`*): `boolean` + +*Inherited from BN.ltn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:189* + +*__description__*: a less than b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## maskn + +▸ **maskn**(b: *`number`*): `BN` + +*Inherited from BN.maskn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490* + +*__description__*: clear bits with indexes higher or equal to `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## mod + +▸ **mod**(b: *`BN`*): `BN` + +*Inherited from BN.mod* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:354* + +*__description__*: reduct + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## modn + +▸ **modn**(b: *`number`*): `number` + +*Inherited from BN.modn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:365* + +*__see__*: API consistency [https://github.com/indutny/bn.js/pull/130](https://github.com/indutny/bn.js/pull/130) + +*__description__*: reduct + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `number` + ___ ## mul -▸ **mul**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **mul**(b: *`BN`*): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)* +*Inherited from BN.mul* -*Defined in [codec/UInt.ts:138](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L138)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:304* + +*__description__*: multiply **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | + +**Returns:** `BN` + +___ + + +## muln + +▸ **muln**(b: *`number`*): `BN` + +*Inherited from BN.muln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:314* + +*__description__*: multiply + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## neg + +▸ **neg**(): `BN` + +*Inherited from BN.neg* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:244* + +*__description__*: negate sign + +**Returns:** `BN` + +___ + + +## notn + +▸ **notn**(w: *`number`*): `BN` + +*Inherited from BN.notn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:504* + +*__description__*: not (for the width specified by `w`) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| w | `number` | + +**Returns:** `BN` + +___ + + +## or + +▸ **or**(b: *`BN`*): `BN` + +*Inherited from BN.or* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:375* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## pow + +▸ **pow**(b: *`BN`*): `BN` + +*Inherited from BN.pow* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:334* + +*__description__*: raise `a` to the power of `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## setn + +▸ **setn**(b: *`number`*): `BN` + +*Inherited from BN.setn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:440* + +*__description__*: set specified bit to 1 + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## shln + +▸ **shln**(b: *`number`*): `BN` + +*Inherited from BN.shln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:445* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## shrn + +▸ **shrn**(b: *`number`*): `BN` + +*Inherited from BN.shrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:465* + +*__description__*: shift right + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## sqr + +▸ **sqr**(): `BN` + +*Inherited from BN.sqr* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:324* + +*__description__*: square **Returns:** `BN` @@ -263,20 +1399,125 @@ ___ ## sub -▸ **sub**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **sub**(b: *`BN`*): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)* +*Inherited from BN.sub* -*Defined in [codec/UInt.ts:144](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L144)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:284* + +*__description__*: subtraction **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `BN` +___ + + +## subn + +▸ **subn**(b: *`number`*): `BN` + +*Inherited from BN.subn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:294* + +*__description__*: subtraction + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## testn + +▸ **testn**(b: *`number`*): `boolean` + +*Inherited from BN.testn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485* + +*__description__*: test if specified bit is set + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## toArray + +▸ **toArray**(endian?: *`Endianness`*, length?: * `undefined` | `number`*): `number`[] + +*Inherited from BN.toArray* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:109* + +*__description__*: convert to byte Array, and optionally zero pad to length, throwing if already exceeding + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `number`[] + +___ + + +## toArrayLike + +▸ **toArrayLike**(ArrayType: *`object`*, endian?: *`Endianness`*, length?: * `undefined` | `number`*): `Buffer` + +▸ **toArrayLike**(ArrayType: *`any`[]*, endian?: *`Endianness`*, length?: * `undefined` | `number`*): `any`[] + +*Inherited from BN.toArrayLike* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:114* + +*__description__*: convert to an instance of `type`, which must behave like an Array + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| ArrayType | `object` | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `Buffer` + +*Inherited from BN.toArrayLike* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| ArrayType | `any`[] | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `any`[] + ___ @@ -286,10 +1527,32 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)* -*Defined in [codec/UInt.ts:76](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L76)* +*Defined in [codec/UInt.ts:73](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L73)* **Returns:** `BN` +___ + + +## toBuffer + +▸ **toBuffer**(endian?: *`Endianness`*, length?: * `undefined` | `number`*): `Buffer` + +*Inherited from BN.toBuffer* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:129* + +*__description__*: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `Buffer` + ___ @@ -299,7 +1562,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* -*Defined in [codec/UInt.ts:58](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L58)* +*Defined in [codec/UInt.ts:59](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L59)* **Returns:** `string` @@ -312,9 +1575,9 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toJSON](_codec_uint_.uint.md#tojson)* -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* +*Overrides BN.toJSON* -*Defined in [codec/UInt.ts:62](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L62)* +*Defined in [codec/UInt.ts:63](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L63)* **Returns:** `any` @@ -325,27 +1588,78 @@ ___ ▸ **toNumber**(): `number` -*Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)* +*Inherited from BN.toNumber* -*Defined in [codec/UInt.ts:80](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L80)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:99* + +*__description__*: convert to Javascript Number (limited to 53 bits) **Returns:** `number` +___ + + +## toRed + +▸ **toRed**(reductionContext: *`ReductionContext`*): `RedBN` + +*Inherited from BN.toRed* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:84* + +*__description__*: Convert number to red + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| reductionContext | `ReductionContext` | + +**Returns:** `RedBN` + ___ ## toString -▸ **toString**(): `string` +▸ **toString**(base?: * `number` | "hex"*, length?: * `undefined` | `number`*): `string` -*Inherited from [UInt](_codec_uint_.uint.md).[toString](_codec_uint_.uint.md#tostring)* +*Inherited from BN.toString* -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:94* -*Defined in [codec/UInt.ts:72](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L72)* +*__description__*: convert to base-string and pad with zeroes + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` base | `number` | "hex"| +| `Optional` length | `undefined` | `number`| **Returns:** `string` +___ + + +## toTwos + +▸ **toTwos**(width: *`number`*): `BN` + +*Inherited from BN.toTwos* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:234* + +*__description__*: convert to two's complement representation, where width is bit width + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| width | `number` | + +**Returns:** `BN` + ___ @@ -355,9 +1669,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/UInt.ts:68](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L68)* +*Defined in [codec/UInt.ts:69](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L69)* **Parameters:** @@ -367,16 +1679,199 @@ ___ **Returns:** `Uint8Array` +___ + + +## uand + +▸ **uand**(b: *`BN`*): `BN` + +*Inherited from BN.uand* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:405* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ucmp + +▸ **ucmp**(b: *`BN`*): `-1` | `0` | `1` + +*Inherited from BN.ucmp* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:174* + +*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `-1` | `0` | `1` + +___ + + +## umod + +▸ **umod**(b: *`BN`*): `BN` + +*Inherited from BN.umod* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:359* + +*__description__*: reduct + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## uor + +▸ **uor**(b: *`BN`*): `BN` + +*Inherited from BN.uor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:385* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ushln + +▸ **ushln**(b: *`number`*): `BN` + +*Inherited from BN.ushln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:455* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## ushrn + +▸ **ushrn**(b: *`number`*): `BN` + +*Inherited from BN.ushrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475* + +*__description__*: shift right + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## uxor + +▸ **uxor**(b: *`BN`*): `BN` + +*Inherited from BN.uxor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:430* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## xor + +▸ **xor**(b: *`BN`*): `BN` + +*Inherited from BN.xor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:420* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## zeroBits + +▸ **zeroBits**(): `number` + +*Inherited from BN.zeroBits* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:139* + +*__description__*: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits) + +**Returns:** `number` + ___ ## `` decodeUInt -▸ **decodeUInt**(value: *`AnyNumber`*, bitLength: *[UIntBitLength](../modules/_codec_uint_.md#uintbitlength)*): `BN` +▸ **decodeUInt**(value: *`AnyNumber`*, bitLength: *[UIntBitLength](../modules/_codec_uint_.md#uintbitlength)*): `string` *Inherited from [UInt](_codec_uint_.uint.md).[decodeUInt](_codec_uint_.uint.md#decodeuint)* -*Defined in [codec/UInt.ts:35](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L35)* +*Defined in [codec/UInt.ts:35](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L35)* **Parameters:** @@ -385,7 +1880,114 @@ ___ | value | `AnyNumber` | | bitLength | [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) | +**Returns:** `string` + +___ + + +## `` isBN + +▸ **isBN**(b: *`any`*): `boolean` + +*Inherited from BN.isBN* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:69* + +*__description__*: returns true if the supplied object is a BN.js instance + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `any` | + +**Returns:** `boolean` + +___ + + +## `` max + +▸ **max**(left: *`BN`*, right: *`BN`*): `BN` + +*Inherited from BN.max* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:74* + +*__description__*: returns the maximum of 2 BN instances. + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| left | `BN` | +| right | `BN` | + **Returns:** `BN` ___ + + +## `` min + +▸ **min**(left: *`BN`*, right: *`BN`*): `BN` + +*Inherited from BN.min* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:79* + +*__description__*: returns the minimum of 2 BN instances. + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| left | `BN` | +| right | `BN` | + +**Returns:** `BN` + +___ + + +## `` mont + +▸ **mont**(num: *`BN`*): `ReductionContext` + +*Inherited from BN.mont* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:64* + +*__description__*: create a reduction context with the Montgomery trick. + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| num | `BN` | + +**Returns:** `ReductionContext` + +___ + + +## `` red + +▸ **red**(reductionContext: * `BN` | `IPrimeName`*): `ReductionContext` + +*Inherited from BN.red* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:59* + +*__description__*: create a reduction context + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| reductionContext | `BN` | `IPrimeName`| + +**Returns:** `ReductionContext` + +___ diff --git a/docs/types/classes/_u32_.u32.md b/docs/types/classes/_u32_.u32.md index c64bc32041..24b15846de 100644 --- a/docs/types/classes/_u32_.u32.md +++ b/docs/types/classes/_u32_.u32.md @@ -20,6 +20,10 @@ ↳ [VoteIndex](_voteindex_.voteindex.md) +# Implements + +* `Codec` + # Constructors @@ -30,7 +34,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U32.ts:9](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/U32.ts#L9)* +*Defined in [U32.ts:9](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/U32.ts#L9)* **Parameters:** @@ -50,27 +54,14 @@ ___ **● raw**: *`BN`* -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* +*Inherited from [UInt](_codec_uint_.uint.md).[raw](_codec_uint_.uint.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/UInt.ts:23](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L23)* ___ # Accessors - - -## bitLength - -getbitLength(): [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) - -*Inherited from [UInt](_codec_uint_.uint.md).[bitLength](_codec_uint_.uint.md#bitlength)* - -*Defined in [codec/UInt.ts:50](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L50)* - -**Returns:** [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) - -___ ## encodedLength @@ -79,9 +70,7 @@ getencodedLength(): `number` *Inherited from [UInt](_codec_uint_.uint.md).[encodedLength](_codec_uint_.uint.md#encodedlength)* -*Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* - -*Defined in [codec/UInt.ts:54](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L54)* +*Defined in [codec/UInt.ts:55](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L55)* **Returns:** `number` @@ -89,21 +78,167 @@ ___ # Methods + + +## abs + +▸ **abs**(): `BN` + +*Inherited from BN.abs* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:254* + +*__description__*: absolute value + +**Returns:** `BN` + +___ ## add -▸ **add**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **add**(b: *`BN`*): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)* +*Inherited from BN.add* -*Defined in [codec/UInt.ts:86](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L86)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:264* + +*__description__*: addition **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | + +**Returns:** `BN` + +___ + + +## addn + +▸ **addn**(b: *`number`*): `BN` + +*Inherited from BN.addn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:274* + +*__description__*: addition + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## and + +▸ **and**(b: *`BN`*): `BN` + +*Inherited from BN.and* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:395* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## andln + +▸ **andln**(b: *`number`*): `BN` + +*Inherited from BN.andln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:415* + +*__description__*: and (NOTE: `andln` is going to be replaced with `andn` in future) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## bincn + +▸ **bincn**(b: *`number`*): `BN` + +*Inherited from BN.bincn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:499* + +*__description__*: add `1 << b` to the number + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## bitLength + +▸ **bitLength**(): [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) + +*Inherited from [UInt](_codec_uint_.uint.md).[bitLength](_codec_uint_.uint.md#bitlength)* + +*Overrides BN.bitLength* + +*Defined in [codec/UInt.ts:51](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L51)* + +**Returns:** [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) + +___ + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from BN.byteLength* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:144* + +*__description__*: return number of bytes occupied + +**Returns:** `number` + +___ + + +## clone + +▸ **clone**(): `BN` + +*Inherited from BN.clone* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:89* + +*__description__*: clone number **Returns:** `BN` @@ -112,74 +247,229 @@ ___ ## cmp -▸ **cmp**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `number` +▸ **cmp**(b: *`BN`*): `-1` | `0` | `1` -*Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)* +*Inherited from BN.cmp* -*Defined in [codec/UInt.ts:92](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L92)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:169* + +*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | -**Returns:** `number` +**Returns:** `-1` | `0` | `1` + +___ + + +## cmpn + +▸ **cmpn**(b: *`number`*): `-1` | `0` | `1` + +*Inherited from BN.cmpn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:179* + +*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `-1` | `0` | `1` ___ ## div -▸ **div**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **div**(b: *`BN`*): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)* +*Inherited from BN.div* -*Defined in [codec/UInt.ts:98](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L98)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:339* + +*__description__*: divide **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `BN` +___ + + +## divRound + +▸ **divRound**(b: *`BN`*): `BN` + +*Inherited from BN.divRound* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:370* + +*__description__*: rounded division + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## divn + +▸ **divn**(b: *`number`*): `BN` + +*Inherited from BN.divn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:344* + +*__description__*: divide + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## egcd + +▸ **egcd**(b: *`BN`*): `object` + +*Inherited from BN.egcd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:519* + +*__description__*: Extended GCD results `({ a: ..., b: ..., gcd: ... })` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `object` + ___ ## eq -▸ **eq**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **eq**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[eq](_codec_uint_.uint.md#eq)* +*Inherited from BN.eq* -*Defined in [codec/UInt.ts:104](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L104)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:224* + +*__description__*: a equals b **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` +___ + + +## eqn + +▸ **eqn**(b: *`number`*): `boolean` + +*Inherited from BN.eqn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:229* + +*__description__*: a equals b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## fromTwos + +▸ **fromTwos**(width: *`number`*): `BN` + +*Inherited from BN.fromTwos* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:239* + +*__description__*: convert from two's complement representation, where width is the bit width + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| width | `number` | + +**Returns:** `BN` + +___ + + +## gcd + +▸ **gcd**(b: *`BN`*): `BN` + +*Inherited from BN.gcd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:514* + +*__description__*: GCD + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + ___ ## gt -▸ **gt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **gt**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)* +*Inherited from BN.gt* -*Defined in [codec/UInt.ts:126](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L126)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:204* + +*__description__*: a greater than b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` @@ -188,17 +478,346 @@ ___ ## gte -▸ **gte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **gte**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)* +*Inherited from BN.gte* -*Defined in [codec/UInt.ts:132](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L132)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:214* + +*__description__*: a greater than or equals b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | + +**Returns:** `boolean` + +___ + + +## gten + +▸ **gten**(b: *`number`*): `boolean` + +*Inherited from BN.gten* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:219* + +*__description__*: a greater than or equals b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## gtn + +▸ **gtn**(b: *`number`*): `boolean` + +*Inherited from BN.gtn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:209* + +*__description__*: a greater than b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## iabs + +▸ **iabs**(): `BN` + +*Inherited from BN.iabs* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:259* + +*__description__*: absolute value + +**Returns:** `BN` + +___ + + +## iadd + +▸ **iadd**(b: *`BN`*): `BN` + +*Inherited from BN.iadd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:269* + +*__description__*: addition + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## iaddn + +▸ **iaddn**(b: *`number`*): `BN` + +*Inherited from BN.iaddn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:279* + +*__description__*: addition + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iand + +▸ **iand**(b: *`BN`*): `BN` + +*Inherited from BN.iand* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:400* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## idivn + +▸ **idivn**(b: *`number`*): `BN` + +*Inherited from BN.idivn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:349* + +*__description__*: divide + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## imaskn + +▸ **imaskn**(b: *`number`*): `BN` + +*Inherited from BN.imaskn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495* + +*__description__*: clear bits with indexes higher or equal to `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## imul + +▸ **imul**(b: *`BN`*): `BN` + +*Inherited from BN.imul* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:309* + +*__description__*: multiply + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## imuln + +▸ **imuln**(b: *`number`*): `BN` + +*Inherited from BN.imuln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:319* + +*__description__*: multiply + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## ineg + +▸ **ineg**(): `BN` + +*Inherited from BN.ineg* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:249* + +*__description__*: negate sign + +**Returns:** `BN` + +___ + + +## inotn + +▸ **inotn**(w: *`number`*): `BN` + +*Inherited from BN.inotn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:509* + +*__description__*: not (for the width specified by `w`) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| w | `number` | + +**Returns:** `BN` + +___ + + +## invm + +▸ **invm**(b: *`BN`*): `BN` + +*Inherited from BN.invm* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:524* + +*__description__*: inverse `a` modulo `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ior + +▸ **ior**(b: *`BN`*): `BN` + +*Inherited from BN.ior* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:380* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## isEven + +▸ **isEven**(): `boolean` + +*Inherited from BN.isEven* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:154* + +*__description__*: check if value is even + +**Returns:** `boolean` + +___ + + +## isNeg + +▸ **isNeg**(): `boolean` + +*Inherited from BN.isNeg* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:149* + +*__description__*: true if the number is negative + +**Returns:** `boolean` + +___ + + +## isOdd + +▸ **isOdd**(): `boolean` + +*Inherited from BN.isOdd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:159* + +*__description__*: check if value is odd **Returns:** `boolean` @@ -209,28 +828,257 @@ ___ ▸ **isZero**(): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)* +*Inherited from BN.isZero* -*Defined in [codec/UInt.ts:110](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L110)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:164* + +*__description__*: check if value is zero **Returns:** `boolean` +___ + + +## ishln + +▸ **ishln**(b: *`number`*): `BN` + +*Inherited from BN.ishln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:450* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## ishrn + +▸ **ishrn**(b: *`number`*): `BN` + +*Inherited from BN.ishrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:470* + +*__description__*: shift right (unimplemented [https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086](https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## isqr + +▸ **isqr**(): `BN` + +*Inherited from BN.isqr* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:329* + +*__description__*: square + +**Returns:** `BN` + +___ + + +## isub + +▸ **isub**(b: *`BN`*): `BN` + +*Inherited from BN.isub* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:289* + +*__description__*: subtraction + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## isubn + +▸ **isubn**(b: *`number`*): `BN` + +*Inherited from BN.isubn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:299* + +*__description__*: subtraction + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iuand + +▸ **iuand**(b: *`BN`*): `BN` + +*Inherited from BN.iuand* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:410* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## iuor + +▸ **iuor**(b: *`BN`*): `BN` + +*Inherited from BN.iuor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:390* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## iushln + +▸ **iushln**(b: *`number`*): `BN` + +*Inherited from BN.iushln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:460* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iushrn + +▸ **iushrn**(b: *`number`*): `BN` + +*Inherited from BN.iushrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480* + +*__description__*: shift right + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iuxor + +▸ **iuxor**(b: *`BN`*): `BN` + +*Inherited from BN.iuxor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:435* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ixor + +▸ **ixor**(b: *`BN`*): `BN` + +*Inherited from BN.ixor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:425* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + ___ ## lt -▸ **lt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **lt**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)* +*Inherited from BN.lt* -*Defined in [codec/UInt.ts:114](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L114)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:184* + +*__description__*: a less than b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` @@ -239,36 +1087,324 @@ ___ ## lte -▸ **lte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **lte**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)* +*Inherited from BN.lte* -*Defined in [codec/UInt.ts:120](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L120)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:194* + +*__description__*: a less than or equals b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` +___ + + +## lten + +▸ **lten**(b: *`number`*): `boolean` + +*Inherited from BN.lten* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:199* + +*__description__*: a less than or equals b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## ltn + +▸ **ltn**(b: *`number`*): `boolean` + +*Inherited from BN.ltn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:189* + +*__description__*: a less than b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## maskn + +▸ **maskn**(b: *`number`*): `BN` + +*Inherited from BN.maskn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490* + +*__description__*: clear bits with indexes higher or equal to `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## mod + +▸ **mod**(b: *`BN`*): `BN` + +*Inherited from BN.mod* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:354* + +*__description__*: reduct + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## modn + +▸ **modn**(b: *`number`*): `number` + +*Inherited from BN.modn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:365* + +*__see__*: API consistency [https://github.com/indutny/bn.js/pull/130](https://github.com/indutny/bn.js/pull/130) + +*__description__*: reduct + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `number` + ___ ## mul -▸ **mul**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **mul**(b: *`BN`*): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)* +*Inherited from BN.mul* -*Defined in [codec/UInt.ts:138](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L138)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:304* + +*__description__*: multiply **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | + +**Returns:** `BN` + +___ + + +## muln + +▸ **muln**(b: *`number`*): `BN` + +*Inherited from BN.muln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:314* + +*__description__*: multiply + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## neg + +▸ **neg**(): `BN` + +*Inherited from BN.neg* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:244* + +*__description__*: negate sign + +**Returns:** `BN` + +___ + + +## notn + +▸ **notn**(w: *`number`*): `BN` + +*Inherited from BN.notn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:504* + +*__description__*: not (for the width specified by `w`) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| w | `number` | + +**Returns:** `BN` + +___ + + +## or + +▸ **or**(b: *`BN`*): `BN` + +*Inherited from BN.or* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:375* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## pow + +▸ **pow**(b: *`BN`*): `BN` + +*Inherited from BN.pow* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:334* + +*__description__*: raise `a` to the power of `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## setn + +▸ **setn**(b: *`number`*): `BN` + +*Inherited from BN.setn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:440* + +*__description__*: set specified bit to 1 + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## shln + +▸ **shln**(b: *`number`*): `BN` + +*Inherited from BN.shln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:445* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## shrn + +▸ **shrn**(b: *`number`*): `BN` + +*Inherited from BN.shrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:465* + +*__description__*: shift right + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## sqr + +▸ **sqr**(): `BN` + +*Inherited from BN.sqr* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:324* + +*__description__*: square **Returns:** `BN` @@ -277,20 +1413,125 @@ ___ ## sub -▸ **sub**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **sub**(b: *`BN`*): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)* +*Inherited from BN.sub* -*Defined in [codec/UInt.ts:144](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L144)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:284* + +*__description__*: subtraction **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `BN` +___ + + +## subn + +▸ **subn**(b: *`number`*): `BN` + +*Inherited from BN.subn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:294* + +*__description__*: subtraction + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## testn + +▸ **testn**(b: *`number`*): `boolean` + +*Inherited from BN.testn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485* + +*__description__*: test if specified bit is set + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## toArray + +▸ **toArray**(endian?: *`Endianness`*, length?: * `undefined` | `number`*): `number`[] + +*Inherited from BN.toArray* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:109* + +*__description__*: convert to byte Array, and optionally zero pad to length, throwing if already exceeding + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `number`[] + +___ + + +## toArrayLike + +▸ **toArrayLike**(ArrayType: *`object`*, endian?: *`Endianness`*, length?: * `undefined` | `number`*): `Buffer` + +▸ **toArrayLike**(ArrayType: *`any`[]*, endian?: *`Endianness`*, length?: * `undefined` | `number`*): `any`[] + +*Inherited from BN.toArrayLike* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:114* + +*__description__*: convert to an instance of `type`, which must behave like an Array + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| ArrayType | `object` | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `Buffer` + +*Inherited from BN.toArrayLike* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| ArrayType | `any`[] | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `any`[] + ___ @@ -300,10 +1541,32 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)* -*Defined in [codec/UInt.ts:76](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L76)* +*Defined in [codec/UInt.ts:73](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L73)* **Returns:** `BN` +___ + + +## toBuffer + +▸ **toBuffer**(endian?: *`Endianness`*, length?: * `undefined` | `number`*): `Buffer` + +*Inherited from BN.toBuffer* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:129* + +*__description__*: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `Buffer` + ___ @@ -313,7 +1576,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* -*Defined in [codec/UInt.ts:58](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L58)* +*Defined in [codec/UInt.ts:59](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L59)* **Returns:** `string` @@ -326,9 +1589,9 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toJSON](_codec_uint_.uint.md#tojson)* -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* +*Overrides BN.toJSON* -*Defined in [codec/UInt.ts:62](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L62)* +*Defined in [codec/UInt.ts:63](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L63)* **Returns:** `any` @@ -339,27 +1602,78 @@ ___ ▸ **toNumber**(): `number` -*Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)* +*Inherited from BN.toNumber* -*Defined in [codec/UInt.ts:80](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L80)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:99* + +*__description__*: convert to Javascript Number (limited to 53 bits) **Returns:** `number` +___ + + +## toRed + +▸ **toRed**(reductionContext: *`ReductionContext`*): `RedBN` + +*Inherited from BN.toRed* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:84* + +*__description__*: Convert number to red + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| reductionContext | `ReductionContext` | + +**Returns:** `RedBN` + ___ ## toString -▸ **toString**(): `string` +▸ **toString**(base?: * `number` | "hex"*, length?: * `undefined` | `number`*): `string` -*Inherited from [UInt](_codec_uint_.uint.md).[toString](_codec_uint_.uint.md#tostring)* +*Inherited from BN.toString* -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:94* -*Defined in [codec/UInt.ts:72](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L72)* +*__description__*: convert to base-string and pad with zeroes + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` base | `number` | "hex"| +| `Optional` length | `undefined` | `number`| **Returns:** `string` +___ + + +## toTwos + +▸ **toTwos**(width: *`number`*): `BN` + +*Inherited from BN.toTwos* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:234* + +*__description__*: convert to two's complement representation, where width is bit width + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| width | `number` | + +**Returns:** `BN` + ___ @@ -369,9 +1683,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/UInt.ts:68](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L68)* +*Defined in [codec/UInt.ts:69](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L69)* **Parameters:** @@ -381,16 +1693,199 @@ ___ **Returns:** `Uint8Array` +___ + + +## uand + +▸ **uand**(b: *`BN`*): `BN` + +*Inherited from BN.uand* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:405* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ucmp + +▸ **ucmp**(b: *`BN`*): `-1` | `0` | `1` + +*Inherited from BN.ucmp* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:174* + +*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `-1` | `0` | `1` + +___ + + +## umod + +▸ **umod**(b: *`BN`*): `BN` + +*Inherited from BN.umod* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:359* + +*__description__*: reduct + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## uor + +▸ **uor**(b: *`BN`*): `BN` + +*Inherited from BN.uor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:385* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ushln + +▸ **ushln**(b: *`number`*): `BN` + +*Inherited from BN.ushln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:455* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## ushrn + +▸ **ushrn**(b: *`number`*): `BN` + +*Inherited from BN.ushrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475* + +*__description__*: shift right + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## uxor + +▸ **uxor**(b: *`BN`*): `BN` + +*Inherited from BN.uxor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:430* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## xor + +▸ **xor**(b: *`BN`*): `BN` + +*Inherited from BN.xor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:420* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## zeroBits + +▸ **zeroBits**(): `number` + +*Inherited from BN.zeroBits* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:139* + +*__description__*: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits) + +**Returns:** `number` + ___ ## `` decodeUInt -▸ **decodeUInt**(value: *`AnyNumber`*, bitLength: *[UIntBitLength](../modules/_codec_uint_.md#uintbitlength)*): `BN` +▸ **decodeUInt**(value: *`AnyNumber`*, bitLength: *[UIntBitLength](../modules/_codec_uint_.md#uintbitlength)*): `string` *Inherited from [UInt](_codec_uint_.uint.md).[decodeUInt](_codec_uint_.uint.md#decodeuint)* -*Defined in [codec/UInt.ts:35](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L35)* +*Defined in [codec/UInt.ts:35](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L35)* **Parameters:** @@ -399,7 +1894,114 @@ ___ | value | `AnyNumber` | | bitLength | [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) | +**Returns:** `string` + +___ + + +## `` isBN + +▸ **isBN**(b: *`any`*): `boolean` + +*Inherited from BN.isBN* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:69* + +*__description__*: returns true if the supplied object is a BN.js instance + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `any` | + +**Returns:** `boolean` + +___ + + +## `` max + +▸ **max**(left: *`BN`*, right: *`BN`*): `BN` + +*Inherited from BN.max* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:74* + +*__description__*: returns the maximum of 2 BN instances. + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| left | `BN` | +| right | `BN` | + **Returns:** `BN` ___ + + +## `` min + +▸ **min**(left: *`BN`*, right: *`BN`*): `BN` + +*Inherited from BN.min* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:79* + +*__description__*: returns the minimum of 2 BN instances. + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| left | `BN` | +| right | `BN` | + +**Returns:** `BN` + +___ + + +## `` mont + +▸ **mont**(num: *`BN`*): `ReductionContext` + +*Inherited from BN.mont* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:64* + +*__description__*: create a reduction context with the Montgomery trick. + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| num | `BN` | + +**Returns:** `ReductionContext` + +___ + + +## `` red + +▸ **red**(reductionContext: * `BN` | `IPrimeName`*): `ReductionContext` + +*Inherited from BN.red* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:59* + +*__description__*: create a reduction context + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| reductionContext | `BN` | `IPrimeName`| + +**Returns:** `ReductionContext` + +___ diff --git a/docs/types/classes/_u64_.u64.md b/docs/types/classes/_u64_.u64.md index 1e341fadc2..54a4ad5524 100644 --- a/docs/types/classes/_u64_.u64.md +++ b/docs/types/classes/_u64_.u64.md @@ -14,6 +14,10 @@ ↳ [ParachainId](_parachainid_.parachainid.md) +# Implements + +* `Codec` + # Constructors @@ -24,7 +28,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U64.ts:9](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/U64.ts#L9)* +*Defined in [U64.ts:9](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/U64.ts#L9)* **Parameters:** @@ -44,27 +48,14 @@ ___ **● raw**: *`BN`* -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* +*Inherited from [UInt](_codec_uint_.uint.md).[raw](_codec_uint_.uint.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/UInt.ts:23](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L23)* ___ # Accessors - - -## bitLength - -getbitLength(): [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) - -*Inherited from [UInt](_codec_uint_.uint.md).[bitLength](_codec_uint_.uint.md#bitlength)* - -*Defined in [codec/UInt.ts:50](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L50)* - -**Returns:** [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) - -___ ## encodedLength @@ -73,9 +64,7 @@ getencodedLength(): `number` *Inherited from [UInt](_codec_uint_.uint.md).[encodedLength](_codec_uint_.uint.md#encodedlength)* -*Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* - -*Defined in [codec/UInt.ts:54](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L54)* +*Defined in [codec/UInt.ts:55](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L55)* **Returns:** `number` @@ -83,21 +72,167 @@ ___ # Methods + + +## abs + +▸ **abs**(): `BN` + +*Inherited from BN.abs* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:254* + +*__description__*: absolute value + +**Returns:** `BN` + +___ ## add -▸ **add**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **add**(b: *`BN`*): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)* +*Inherited from BN.add* -*Defined in [codec/UInt.ts:86](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L86)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:264* + +*__description__*: addition **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | + +**Returns:** `BN` + +___ + + +## addn + +▸ **addn**(b: *`number`*): `BN` + +*Inherited from BN.addn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:274* + +*__description__*: addition + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## and + +▸ **and**(b: *`BN`*): `BN` + +*Inherited from BN.and* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:395* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## andln + +▸ **andln**(b: *`number`*): `BN` + +*Inherited from BN.andln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:415* + +*__description__*: and (NOTE: `andln` is going to be replaced with `andn` in future) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## bincn + +▸ **bincn**(b: *`number`*): `BN` + +*Inherited from BN.bincn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:499* + +*__description__*: add `1 << b` to the number + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## bitLength + +▸ **bitLength**(): [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) + +*Inherited from [UInt](_codec_uint_.uint.md).[bitLength](_codec_uint_.uint.md#bitlength)* + +*Overrides BN.bitLength* + +*Defined in [codec/UInt.ts:51](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L51)* + +**Returns:** [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) + +___ + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from BN.byteLength* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:144* + +*__description__*: return number of bytes occupied + +**Returns:** `number` + +___ + + +## clone + +▸ **clone**(): `BN` + +*Inherited from BN.clone* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:89* + +*__description__*: clone number **Returns:** `BN` @@ -106,74 +241,229 @@ ___ ## cmp -▸ **cmp**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `number` +▸ **cmp**(b: *`BN`*): `-1` | `0` | `1` -*Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)* +*Inherited from BN.cmp* -*Defined in [codec/UInt.ts:92](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L92)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:169* + +*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | -**Returns:** `number` +**Returns:** `-1` | `0` | `1` + +___ + + +## cmpn + +▸ **cmpn**(b: *`number`*): `-1` | `0` | `1` + +*Inherited from BN.cmpn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:179* + +*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `-1` | `0` | `1` ___ ## div -▸ **div**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **div**(b: *`BN`*): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)* +*Inherited from BN.div* -*Defined in [codec/UInt.ts:98](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L98)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:339* + +*__description__*: divide **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `BN` +___ + + +## divRound + +▸ **divRound**(b: *`BN`*): `BN` + +*Inherited from BN.divRound* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:370* + +*__description__*: rounded division + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## divn + +▸ **divn**(b: *`number`*): `BN` + +*Inherited from BN.divn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:344* + +*__description__*: divide + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## egcd + +▸ **egcd**(b: *`BN`*): `object` + +*Inherited from BN.egcd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:519* + +*__description__*: Extended GCD results `({ a: ..., b: ..., gcd: ... })` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `object` + ___ ## eq -▸ **eq**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **eq**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[eq](_codec_uint_.uint.md#eq)* +*Inherited from BN.eq* -*Defined in [codec/UInt.ts:104](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L104)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:224* + +*__description__*: a equals b **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` +___ + + +## eqn + +▸ **eqn**(b: *`number`*): `boolean` + +*Inherited from BN.eqn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:229* + +*__description__*: a equals b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## fromTwos + +▸ **fromTwos**(width: *`number`*): `BN` + +*Inherited from BN.fromTwos* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:239* + +*__description__*: convert from two's complement representation, where width is the bit width + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| width | `number` | + +**Returns:** `BN` + +___ + + +## gcd + +▸ **gcd**(b: *`BN`*): `BN` + +*Inherited from BN.gcd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:514* + +*__description__*: GCD + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + ___ ## gt -▸ **gt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **gt**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)* +*Inherited from BN.gt* -*Defined in [codec/UInt.ts:126](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L126)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:204* + +*__description__*: a greater than b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` @@ -182,17 +472,346 @@ ___ ## gte -▸ **gte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **gte**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)* +*Inherited from BN.gte* -*Defined in [codec/UInt.ts:132](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L132)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:214* + +*__description__*: a greater than or equals b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | + +**Returns:** `boolean` + +___ + + +## gten + +▸ **gten**(b: *`number`*): `boolean` + +*Inherited from BN.gten* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:219* + +*__description__*: a greater than or equals b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## gtn + +▸ **gtn**(b: *`number`*): `boolean` + +*Inherited from BN.gtn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:209* + +*__description__*: a greater than b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## iabs + +▸ **iabs**(): `BN` + +*Inherited from BN.iabs* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:259* + +*__description__*: absolute value + +**Returns:** `BN` + +___ + + +## iadd + +▸ **iadd**(b: *`BN`*): `BN` + +*Inherited from BN.iadd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:269* + +*__description__*: addition + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## iaddn + +▸ **iaddn**(b: *`number`*): `BN` + +*Inherited from BN.iaddn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:279* + +*__description__*: addition + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iand + +▸ **iand**(b: *`BN`*): `BN` + +*Inherited from BN.iand* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:400* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## idivn + +▸ **idivn**(b: *`number`*): `BN` + +*Inherited from BN.idivn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:349* + +*__description__*: divide + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## imaskn + +▸ **imaskn**(b: *`number`*): `BN` + +*Inherited from BN.imaskn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495* + +*__description__*: clear bits with indexes higher or equal to `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## imul + +▸ **imul**(b: *`BN`*): `BN` + +*Inherited from BN.imul* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:309* + +*__description__*: multiply + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## imuln + +▸ **imuln**(b: *`number`*): `BN` + +*Inherited from BN.imuln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:319* + +*__description__*: multiply + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## ineg + +▸ **ineg**(): `BN` + +*Inherited from BN.ineg* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:249* + +*__description__*: negate sign + +**Returns:** `BN` + +___ + + +## inotn + +▸ **inotn**(w: *`number`*): `BN` + +*Inherited from BN.inotn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:509* + +*__description__*: not (for the width specified by `w`) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| w | `number` | + +**Returns:** `BN` + +___ + + +## invm + +▸ **invm**(b: *`BN`*): `BN` + +*Inherited from BN.invm* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:524* + +*__description__*: inverse `a` modulo `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ior + +▸ **ior**(b: *`BN`*): `BN` + +*Inherited from BN.ior* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:380* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## isEven + +▸ **isEven**(): `boolean` + +*Inherited from BN.isEven* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:154* + +*__description__*: check if value is even + +**Returns:** `boolean` + +___ + + +## isNeg + +▸ **isNeg**(): `boolean` + +*Inherited from BN.isNeg* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:149* + +*__description__*: true if the number is negative + +**Returns:** `boolean` + +___ + + +## isOdd + +▸ **isOdd**(): `boolean` + +*Inherited from BN.isOdd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:159* + +*__description__*: check if value is odd **Returns:** `boolean` @@ -203,28 +822,257 @@ ___ ▸ **isZero**(): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)* +*Inherited from BN.isZero* -*Defined in [codec/UInt.ts:110](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L110)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:164* + +*__description__*: check if value is zero **Returns:** `boolean` +___ + + +## ishln + +▸ **ishln**(b: *`number`*): `BN` + +*Inherited from BN.ishln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:450* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## ishrn + +▸ **ishrn**(b: *`number`*): `BN` + +*Inherited from BN.ishrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:470* + +*__description__*: shift right (unimplemented [https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086](https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## isqr + +▸ **isqr**(): `BN` + +*Inherited from BN.isqr* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:329* + +*__description__*: square + +**Returns:** `BN` + +___ + + +## isub + +▸ **isub**(b: *`BN`*): `BN` + +*Inherited from BN.isub* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:289* + +*__description__*: subtraction + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## isubn + +▸ **isubn**(b: *`number`*): `BN` + +*Inherited from BN.isubn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:299* + +*__description__*: subtraction + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iuand + +▸ **iuand**(b: *`BN`*): `BN` + +*Inherited from BN.iuand* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:410* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## iuor + +▸ **iuor**(b: *`BN`*): `BN` + +*Inherited from BN.iuor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:390* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## iushln + +▸ **iushln**(b: *`number`*): `BN` + +*Inherited from BN.iushln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:460* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iushrn + +▸ **iushrn**(b: *`number`*): `BN` + +*Inherited from BN.iushrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480* + +*__description__*: shift right + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iuxor + +▸ **iuxor**(b: *`BN`*): `BN` + +*Inherited from BN.iuxor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:435* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ixor + +▸ **ixor**(b: *`BN`*): `BN` + +*Inherited from BN.ixor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:425* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + ___ ## lt -▸ **lt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **lt**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)* +*Inherited from BN.lt* -*Defined in [codec/UInt.ts:114](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L114)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:184* + +*__description__*: a less than b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` @@ -233,36 +1081,324 @@ ___ ## lte -▸ **lte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **lte**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)* +*Inherited from BN.lte* -*Defined in [codec/UInt.ts:120](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L120)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:194* + +*__description__*: a less than or equals b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` +___ + + +## lten + +▸ **lten**(b: *`number`*): `boolean` + +*Inherited from BN.lten* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:199* + +*__description__*: a less than or equals b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## ltn + +▸ **ltn**(b: *`number`*): `boolean` + +*Inherited from BN.ltn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:189* + +*__description__*: a less than b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## maskn + +▸ **maskn**(b: *`number`*): `BN` + +*Inherited from BN.maskn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490* + +*__description__*: clear bits with indexes higher or equal to `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## mod + +▸ **mod**(b: *`BN`*): `BN` + +*Inherited from BN.mod* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:354* + +*__description__*: reduct + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## modn + +▸ **modn**(b: *`number`*): `number` + +*Inherited from BN.modn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:365* + +*__see__*: API consistency [https://github.com/indutny/bn.js/pull/130](https://github.com/indutny/bn.js/pull/130) + +*__description__*: reduct + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `number` + ___ ## mul -▸ **mul**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **mul**(b: *`BN`*): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)* +*Inherited from BN.mul* -*Defined in [codec/UInt.ts:138](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L138)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:304* + +*__description__*: multiply **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | + +**Returns:** `BN` + +___ + + +## muln + +▸ **muln**(b: *`number`*): `BN` + +*Inherited from BN.muln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:314* + +*__description__*: multiply + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## neg + +▸ **neg**(): `BN` + +*Inherited from BN.neg* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:244* + +*__description__*: negate sign + +**Returns:** `BN` + +___ + + +## notn + +▸ **notn**(w: *`number`*): `BN` + +*Inherited from BN.notn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:504* + +*__description__*: not (for the width specified by `w`) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| w | `number` | + +**Returns:** `BN` + +___ + + +## or + +▸ **or**(b: *`BN`*): `BN` + +*Inherited from BN.or* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:375* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## pow + +▸ **pow**(b: *`BN`*): `BN` + +*Inherited from BN.pow* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:334* + +*__description__*: raise `a` to the power of `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## setn + +▸ **setn**(b: *`number`*): `BN` + +*Inherited from BN.setn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:440* + +*__description__*: set specified bit to 1 + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## shln + +▸ **shln**(b: *`number`*): `BN` + +*Inherited from BN.shln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:445* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## shrn + +▸ **shrn**(b: *`number`*): `BN` + +*Inherited from BN.shrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:465* + +*__description__*: shift right + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## sqr + +▸ **sqr**(): `BN` + +*Inherited from BN.sqr* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:324* + +*__description__*: square **Returns:** `BN` @@ -271,20 +1407,125 @@ ___ ## sub -▸ **sub**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **sub**(b: *`BN`*): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)* +*Inherited from BN.sub* -*Defined in [codec/UInt.ts:144](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L144)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:284* + +*__description__*: subtraction **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `BN` +___ + + +## subn + +▸ **subn**(b: *`number`*): `BN` + +*Inherited from BN.subn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:294* + +*__description__*: subtraction + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## testn + +▸ **testn**(b: *`number`*): `boolean` + +*Inherited from BN.testn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485* + +*__description__*: test if specified bit is set + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## toArray + +▸ **toArray**(endian?: *`Endianness`*, length?: * `undefined` | `number`*): `number`[] + +*Inherited from BN.toArray* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:109* + +*__description__*: convert to byte Array, and optionally zero pad to length, throwing if already exceeding + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `number`[] + +___ + + +## toArrayLike + +▸ **toArrayLike**(ArrayType: *`object`*, endian?: *`Endianness`*, length?: * `undefined` | `number`*): `Buffer` + +▸ **toArrayLike**(ArrayType: *`any`[]*, endian?: *`Endianness`*, length?: * `undefined` | `number`*): `any`[] + +*Inherited from BN.toArrayLike* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:114* + +*__description__*: convert to an instance of `type`, which must behave like an Array + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| ArrayType | `object` | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `Buffer` + +*Inherited from BN.toArrayLike* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| ArrayType | `any`[] | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `any`[] + ___ @@ -294,10 +1535,32 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)* -*Defined in [codec/UInt.ts:76](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L76)* +*Defined in [codec/UInt.ts:73](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L73)* **Returns:** `BN` +___ + + +## toBuffer + +▸ **toBuffer**(endian?: *`Endianness`*, length?: * `undefined` | `number`*): `Buffer` + +*Inherited from BN.toBuffer* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:129* + +*__description__*: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `Buffer` + ___ @@ -307,7 +1570,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* -*Defined in [codec/UInt.ts:58](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L58)* +*Defined in [codec/UInt.ts:59](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L59)* **Returns:** `string` @@ -320,9 +1583,9 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toJSON](_codec_uint_.uint.md#tojson)* -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* +*Overrides BN.toJSON* -*Defined in [codec/UInt.ts:62](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L62)* +*Defined in [codec/UInt.ts:63](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L63)* **Returns:** `any` @@ -333,27 +1596,78 @@ ___ ▸ **toNumber**(): `number` -*Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)* +*Inherited from BN.toNumber* -*Defined in [codec/UInt.ts:80](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L80)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:99* + +*__description__*: convert to Javascript Number (limited to 53 bits) **Returns:** `number` +___ + + +## toRed + +▸ **toRed**(reductionContext: *`ReductionContext`*): `RedBN` + +*Inherited from BN.toRed* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:84* + +*__description__*: Convert number to red + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| reductionContext | `ReductionContext` | + +**Returns:** `RedBN` + ___ ## toString -▸ **toString**(): `string` +▸ **toString**(base?: * `number` | "hex"*, length?: * `undefined` | `number`*): `string` -*Inherited from [UInt](_codec_uint_.uint.md).[toString](_codec_uint_.uint.md#tostring)* +*Inherited from BN.toString* -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:94* -*Defined in [codec/UInt.ts:72](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L72)* +*__description__*: convert to base-string and pad with zeroes + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` base | `number` | "hex"| +| `Optional` length | `undefined` | `number`| **Returns:** `string` +___ + + +## toTwos + +▸ **toTwos**(width: *`number`*): `BN` + +*Inherited from BN.toTwos* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:234* + +*__description__*: convert to two's complement representation, where width is bit width + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| width | `number` | + +**Returns:** `BN` + ___ @@ -363,9 +1677,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/UInt.ts:68](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L68)* +*Defined in [codec/UInt.ts:69](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L69)* **Parameters:** @@ -375,16 +1687,199 @@ ___ **Returns:** `Uint8Array` +___ + + +## uand + +▸ **uand**(b: *`BN`*): `BN` + +*Inherited from BN.uand* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:405* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ucmp + +▸ **ucmp**(b: *`BN`*): `-1` | `0` | `1` + +*Inherited from BN.ucmp* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:174* + +*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `-1` | `0` | `1` + +___ + + +## umod + +▸ **umod**(b: *`BN`*): `BN` + +*Inherited from BN.umod* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:359* + +*__description__*: reduct + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## uor + +▸ **uor**(b: *`BN`*): `BN` + +*Inherited from BN.uor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:385* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ushln + +▸ **ushln**(b: *`number`*): `BN` + +*Inherited from BN.ushln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:455* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## ushrn + +▸ **ushrn**(b: *`number`*): `BN` + +*Inherited from BN.ushrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475* + +*__description__*: shift right + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## uxor + +▸ **uxor**(b: *`BN`*): `BN` + +*Inherited from BN.uxor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:430* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## xor + +▸ **xor**(b: *`BN`*): `BN` + +*Inherited from BN.xor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:420* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## zeroBits + +▸ **zeroBits**(): `number` + +*Inherited from BN.zeroBits* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:139* + +*__description__*: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits) + +**Returns:** `number` + ___ ## `` decodeUInt -▸ **decodeUInt**(value: *`AnyNumber`*, bitLength: *[UIntBitLength](../modules/_codec_uint_.md#uintbitlength)*): `BN` +▸ **decodeUInt**(value: *`AnyNumber`*, bitLength: *[UIntBitLength](../modules/_codec_uint_.md#uintbitlength)*): `string` *Inherited from [UInt](_codec_uint_.uint.md).[decodeUInt](_codec_uint_.uint.md#decodeuint)* -*Defined in [codec/UInt.ts:35](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L35)* +*Defined in [codec/UInt.ts:35](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L35)* **Parameters:** @@ -393,7 +1888,114 @@ ___ | value | `AnyNumber` | | bitLength | [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) | +**Returns:** `string` + +___ + + +## `` isBN + +▸ **isBN**(b: *`any`*): `boolean` + +*Inherited from BN.isBN* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:69* + +*__description__*: returns true if the supplied object is a BN.js instance + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `any` | + +**Returns:** `boolean` + +___ + + +## `` max + +▸ **max**(left: *`BN`*, right: *`BN`*): `BN` + +*Inherited from BN.max* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:74* + +*__description__*: returns the maximum of 2 BN instances. + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| left | `BN` | +| right | `BN` | + **Returns:** `BN` ___ + + +## `` min + +▸ **min**(left: *`BN`*, right: *`BN`*): `BN` + +*Inherited from BN.min* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:79* + +*__description__*: returns the minimum of 2 BN instances. + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| left | `BN` | +| right | `BN` | + +**Returns:** `BN` + +___ + + +## `` mont + +▸ **mont**(num: *`BN`*): `ReductionContext` + +*Inherited from BN.mont* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:64* + +*__description__*: create a reduction context with the Montgomery trick. + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| num | `BN` | + +**Returns:** `ReductionContext` + +___ + + +## `` red + +▸ **red**(reductionContext: * `BN` | `IPrimeName`*): `ReductionContext` + +*Inherited from BN.red* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:59* + +*__description__*: create a reduction context + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| reductionContext | `BN` | `IPrimeName`| + +**Returns:** `ReductionContext` + +___ diff --git a/docs/types/classes/_u8_.u8.md b/docs/types/classes/_u8_.u8.md index 0d80802790..9e0a76d35a 100644 --- a/docs/types/classes/_u8_.u8.md +++ b/docs/types/classes/_u8_.u8.md @@ -6,6 +6,10 @@ **↳ U8** +# Implements + +* `Codec` + # Constructors @@ -16,7 +20,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U8.ts:9](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/U8.ts#L9)* +*Defined in [U8.ts:9](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/U8.ts#L9)* **Parameters:** @@ -36,27 +40,14 @@ ___ **● raw**: *`BN`* -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* +*Inherited from [UInt](_codec_uint_.uint.md).[raw](_codec_uint_.uint.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/UInt.ts:23](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L23)* ___ # Accessors - - -## bitLength - -getbitLength(): [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) - -*Inherited from [UInt](_codec_uint_.uint.md).[bitLength](_codec_uint_.uint.md#bitlength)* - -*Defined in [codec/UInt.ts:50](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L50)* - -**Returns:** [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) - -___ ## encodedLength @@ -65,9 +56,7 @@ getencodedLength(): `number` *Inherited from [UInt](_codec_uint_.uint.md).[encodedLength](_codec_uint_.uint.md#encodedlength)* -*Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* - -*Defined in [codec/UInt.ts:54](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L54)* +*Defined in [codec/UInt.ts:55](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L55)* **Returns:** `number` @@ -75,21 +64,167 @@ ___ # Methods + + +## abs + +▸ **abs**(): `BN` + +*Inherited from BN.abs* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:254* + +*__description__*: absolute value + +**Returns:** `BN` + +___ ## add -▸ **add**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **add**(b: *`BN`*): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)* +*Inherited from BN.add* -*Defined in [codec/UInt.ts:86](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L86)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:264* + +*__description__*: addition **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | + +**Returns:** `BN` + +___ + + +## addn + +▸ **addn**(b: *`number`*): `BN` + +*Inherited from BN.addn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:274* + +*__description__*: addition + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## and + +▸ **and**(b: *`BN`*): `BN` + +*Inherited from BN.and* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:395* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## andln + +▸ **andln**(b: *`number`*): `BN` + +*Inherited from BN.andln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:415* + +*__description__*: and (NOTE: `andln` is going to be replaced with `andn` in future) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## bincn + +▸ **bincn**(b: *`number`*): `BN` + +*Inherited from BN.bincn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:499* + +*__description__*: add `1 << b` to the number + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## bitLength + +▸ **bitLength**(): [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) + +*Inherited from [UInt](_codec_uint_.uint.md).[bitLength](_codec_uint_.uint.md#bitlength)* + +*Overrides BN.bitLength* + +*Defined in [codec/UInt.ts:51](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L51)* + +**Returns:** [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) + +___ + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from BN.byteLength* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:144* + +*__description__*: return number of bytes occupied + +**Returns:** `number` + +___ + + +## clone + +▸ **clone**(): `BN` + +*Inherited from BN.clone* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:89* + +*__description__*: clone number **Returns:** `BN` @@ -98,74 +233,229 @@ ___ ## cmp -▸ **cmp**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `number` +▸ **cmp**(b: *`BN`*): `-1` | `0` | `1` -*Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)* +*Inherited from BN.cmp* -*Defined in [codec/UInt.ts:92](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L92)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:169* + +*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | -**Returns:** `number` +**Returns:** `-1` | `0` | `1` + +___ + + +## cmpn + +▸ **cmpn**(b: *`number`*): `-1` | `0` | `1` + +*Inherited from BN.cmpn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:179* + +*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `-1` | `0` | `1` ___ ## div -▸ **div**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **div**(b: *`BN`*): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)* +*Inherited from BN.div* -*Defined in [codec/UInt.ts:98](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L98)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:339* + +*__description__*: divide **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `BN` +___ + + +## divRound + +▸ **divRound**(b: *`BN`*): `BN` + +*Inherited from BN.divRound* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:370* + +*__description__*: rounded division + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## divn + +▸ **divn**(b: *`number`*): `BN` + +*Inherited from BN.divn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:344* + +*__description__*: divide + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## egcd + +▸ **egcd**(b: *`BN`*): `object` + +*Inherited from BN.egcd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:519* + +*__description__*: Extended GCD results `({ a: ..., b: ..., gcd: ... })` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `object` + ___ ## eq -▸ **eq**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **eq**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[eq](_codec_uint_.uint.md#eq)* +*Inherited from BN.eq* -*Defined in [codec/UInt.ts:104](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L104)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:224* + +*__description__*: a equals b **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` +___ + + +## eqn + +▸ **eqn**(b: *`number`*): `boolean` + +*Inherited from BN.eqn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:229* + +*__description__*: a equals b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## fromTwos + +▸ **fromTwos**(width: *`number`*): `BN` + +*Inherited from BN.fromTwos* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:239* + +*__description__*: convert from two's complement representation, where width is the bit width + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| width | `number` | + +**Returns:** `BN` + +___ + + +## gcd + +▸ **gcd**(b: *`BN`*): `BN` + +*Inherited from BN.gcd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:514* + +*__description__*: GCD + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + ___ ## gt -▸ **gt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **gt**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)* +*Inherited from BN.gt* -*Defined in [codec/UInt.ts:126](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L126)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:204* + +*__description__*: a greater than b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` @@ -174,17 +464,346 @@ ___ ## gte -▸ **gte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **gte**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)* +*Inherited from BN.gte* -*Defined in [codec/UInt.ts:132](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L132)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:214* + +*__description__*: a greater than or equals b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | + +**Returns:** `boolean` + +___ + + +## gten + +▸ **gten**(b: *`number`*): `boolean` + +*Inherited from BN.gten* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:219* + +*__description__*: a greater than or equals b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## gtn + +▸ **gtn**(b: *`number`*): `boolean` + +*Inherited from BN.gtn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:209* + +*__description__*: a greater than b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## iabs + +▸ **iabs**(): `BN` + +*Inherited from BN.iabs* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:259* + +*__description__*: absolute value + +**Returns:** `BN` + +___ + + +## iadd + +▸ **iadd**(b: *`BN`*): `BN` + +*Inherited from BN.iadd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:269* + +*__description__*: addition + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## iaddn + +▸ **iaddn**(b: *`number`*): `BN` + +*Inherited from BN.iaddn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:279* + +*__description__*: addition + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iand + +▸ **iand**(b: *`BN`*): `BN` + +*Inherited from BN.iand* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:400* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## idivn + +▸ **idivn**(b: *`number`*): `BN` + +*Inherited from BN.idivn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:349* + +*__description__*: divide + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## imaskn + +▸ **imaskn**(b: *`number`*): `BN` + +*Inherited from BN.imaskn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495* + +*__description__*: clear bits with indexes higher or equal to `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## imul + +▸ **imul**(b: *`BN`*): `BN` + +*Inherited from BN.imul* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:309* + +*__description__*: multiply + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## imuln + +▸ **imuln**(b: *`number`*): `BN` + +*Inherited from BN.imuln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:319* + +*__description__*: multiply + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## ineg + +▸ **ineg**(): `BN` + +*Inherited from BN.ineg* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:249* + +*__description__*: negate sign + +**Returns:** `BN` + +___ + + +## inotn + +▸ **inotn**(w: *`number`*): `BN` + +*Inherited from BN.inotn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:509* + +*__description__*: not (for the width specified by `w`) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| w | `number` | + +**Returns:** `BN` + +___ + + +## invm + +▸ **invm**(b: *`BN`*): `BN` + +*Inherited from BN.invm* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:524* + +*__description__*: inverse `a` modulo `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ior + +▸ **ior**(b: *`BN`*): `BN` + +*Inherited from BN.ior* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:380* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## isEven + +▸ **isEven**(): `boolean` + +*Inherited from BN.isEven* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:154* + +*__description__*: check if value is even + +**Returns:** `boolean` + +___ + + +## isNeg + +▸ **isNeg**(): `boolean` + +*Inherited from BN.isNeg* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:149* + +*__description__*: true if the number is negative + +**Returns:** `boolean` + +___ + + +## isOdd + +▸ **isOdd**(): `boolean` + +*Inherited from BN.isOdd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:159* + +*__description__*: check if value is odd **Returns:** `boolean` @@ -195,28 +814,257 @@ ___ ▸ **isZero**(): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)* +*Inherited from BN.isZero* -*Defined in [codec/UInt.ts:110](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L110)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:164* + +*__description__*: check if value is zero **Returns:** `boolean` +___ + + +## ishln + +▸ **ishln**(b: *`number`*): `BN` + +*Inherited from BN.ishln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:450* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## ishrn + +▸ **ishrn**(b: *`number`*): `BN` + +*Inherited from BN.ishrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:470* + +*__description__*: shift right (unimplemented [https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086](https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## isqr + +▸ **isqr**(): `BN` + +*Inherited from BN.isqr* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:329* + +*__description__*: square + +**Returns:** `BN` + +___ + + +## isub + +▸ **isub**(b: *`BN`*): `BN` + +*Inherited from BN.isub* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:289* + +*__description__*: subtraction + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## isubn + +▸ **isubn**(b: *`number`*): `BN` + +*Inherited from BN.isubn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:299* + +*__description__*: subtraction + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iuand + +▸ **iuand**(b: *`BN`*): `BN` + +*Inherited from BN.iuand* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:410* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## iuor + +▸ **iuor**(b: *`BN`*): `BN` + +*Inherited from BN.iuor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:390* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## iushln + +▸ **iushln**(b: *`number`*): `BN` + +*Inherited from BN.iushln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:460* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iushrn + +▸ **iushrn**(b: *`number`*): `BN` + +*Inherited from BN.iushrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480* + +*__description__*: shift right + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iuxor + +▸ **iuxor**(b: *`BN`*): `BN` + +*Inherited from BN.iuxor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:435* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ixor + +▸ **ixor**(b: *`BN`*): `BN` + +*Inherited from BN.ixor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:425* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + ___ ## lt -▸ **lt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **lt**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)* +*Inherited from BN.lt* -*Defined in [codec/UInt.ts:114](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L114)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:184* + +*__description__*: a less than b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` @@ -225,36 +1073,324 @@ ___ ## lte -▸ **lte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **lte**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)* +*Inherited from BN.lte* -*Defined in [codec/UInt.ts:120](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L120)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:194* + +*__description__*: a less than or equals b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` +___ + + +## lten + +▸ **lten**(b: *`number`*): `boolean` + +*Inherited from BN.lten* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:199* + +*__description__*: a less than or equals b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## ltn + +▸ **ltn**(b: *`number`*): `boolean` + +*Inherited from BN.ltn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:189* + +*__description__*: a less than b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## maskn + +▸ **maskn**(b: *`number`*): `BN` + +*Inherited from BN.maskn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490* + +*__description__*: clear bits with indexes higher or equal to `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## mod + +▸ **mod**(b: *`BN`*): `BN` + +*Inherited from BN.mod* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:354* + +*__description__*: reduct + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## modn + +▸ **modn**(b: *`number`*): `number` + +*Inherited from BN.modn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:365* + +*__see__*: API consistency [https://github.com/indutny/bn.js/pull/130](https://github.com/indutny/bn.js/pull/130) + +*__description__*: reduct + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `number` + ___ ## mul -▸ **mul**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **mul**(b: *`BN`*): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)* +*Inherited from BN.mul* -*Defined in [codec/UInt.ts:138](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L138)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:304* + +*__description__*: multiply **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | + +**Returns:** `BN` + +___ + + +## muln + +▸ **muln**(b: *`number`*): `BN` + +*Inherited from BN.muln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:314* + +*__description__*: multiply + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## neg + +▸ **neg**(): `BN` + +*Inherited from BN.neg* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:244* + +*__description__*: negate sign + +**Returns:** `BN` + +___ + + +## notn + +▸ **notn**(w: *`number`*): `BN` + +*Inherited from BN.notn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:504* + +*__description__*: not (for the width specified by `w`) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| w | `number` | + +**Returns:** `BN` + +___ + + +## or + +▸ **or**(b: *`BN`*): `BN` + +*Inherited from BN.or* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:375* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## pow + +▸ **pow**(b: *`BN`*): `BN` + +*Inherited from BN.pow* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:334* + +*__description__*: raise `a` to the power of `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## setn + +▸ **setn**(b: *`number`*): `BN` + +*Inherited from BN.setn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:440* + +*__description__*: set specified bit to 1 + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## shln + +▸ **shln**(b: *`number`*): `BN` + +*Inherited from BN.shln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:445* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## shrn + +▸ **shrn**(b: *`number`*): `BN` + +*Inherited from BN.shrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:465* + +*__description__*: shift right + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## sqr + +▸ **sqr**(): `BN` + +*Inherited from BN.sqr* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:324* + +*__description__*: square **Returns:** `BN` @@ -263,20 +1399,125 @@ ___ ## sub -▸ **sub**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **sub**(b: *`BN`*): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)* +*Inherited from BN.sub* -*Defined in [codec/UInt.ts:144](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L144)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:284* + +*__description__*: subtraction **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `BN` +___ + + +## subn + +▸ **subn**(b: *`number`*): `BN` + +*Inherited from BN.subn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:294* + +*__description__*: subtraction + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## testn + +▸ **testn**(b: *`number`*): `boolean` + +*Inherited from BN.testn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485* + +*__description__*: test if specified bit is set + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## toArray + +▸ **toArray**(endian?: *`Endianness`*, length?: * `undefined` | `number`*): `number`[] + +*Inherited from BN.toArray* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:109* + +*__description__*: convert to byte Array, and optionally zero pad to length, throwing if already exceeding + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `number`[] + +___ + + +## toArrayLike + +▸ **toArrayLike**(ArrayType: *`object`*, endian?: *`Endianness`*, length?: * `undefined` | `number`*): `Buffer` + +▸ **toArrayLike**(ArrayType: *`any`[]*, endian?: *`Endianness`*, length?: * `undefined` | `number`*): `any`[] + +*Inherited from BN.toArrayLike* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:114* + +*__description__*: convert to an instance of `type`, which must behave like an Array + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| ArrayType | `object` | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `Buffer` + +*Inherited from BN.toArrayLike* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| ArrayType | `any`[] | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `any`[] + ___ @@ -286,10 +1527,32 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)* -*Defined in [codec/UInt.ts:76](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L76)* +*Defined in [codec/UInt.ts:73](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L73)* **Returns:** `BN` +___ + + +## toBuffer + +▸ **toBuffer**(endian?: *`Endianness`*, length?: * `undefined` | `number`*): `Buffer` + +*Inherited from BN.toBuffer* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:129* + +*__description__*: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `Buffer` + ___ @@ -299,7 +1562,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* -*Defined in [codec/UInt.ts:58](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L58)* +*Defined in [codec/UInt.ts:59](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L59)* **Returns:** `string` @@ -312,9 +1575,9 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toJSON](_codec_uint_.uint.md#tojson)* -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* +*Overrides BN.toJSON* -*Defined in [codec/UInt.ts:62](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L62)* +*Defined in [codec/UInt.ts:63](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L63)* **Returns:** `any` @@ -325,27 +1588,78 @@ ___ ▸ **toNumber**(): `number` -*Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)* +*Inherited from BN.toNumber* -*Defined in [codec/UInt.ts:80](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L80)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:99* + +*__description__*: convert to Javascript Number (limited to 53 bits) **Returns:** `number` +___ + + +## toRed + +▸ **toRed**(reductionContext: *`ReductionContext`*): `RedBN` + +*Inherited from BN.toRed* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:84* + +*__description__*: Convert number to red + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| reductionContext | `ReductionContext` | + +**Returns:** `RedBN` + ___ ## toString -▸ **toString**(): `string` +▸ **toString**(base?: * `number` | "hex"*, length?: * `undefined` | `number`*): `string` -*Inherited from [UInt](_codec_uint_.uint.md).[toString](_codec_uint_.uint.md#tostring)* +*Inherited from BN.toString* -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:94* -*Defined in [codec/UInt.ts:72](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L72)* +*__description__*: convert to base-string and pad with zeroes + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` base | `number` | "hex"| +| `Optional` length | `undefined` | `number`| **Returns:** `string` +___ + + +## toTwos + +▸ **toTwos**(width: *`number`*): `BN` + +*Inherited from BN.toTwos* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:234* + +*__description__*: convert to two's complement representation, where width is bit width + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| width | `number` | + +**Returns:** `BN` + ___ @@ -355,9 +1669,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/UInt.ts:68](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L68)* +*Defined in [codec/UInt.ts:69](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L69)* **Parameters:** @@ -367,16 +1679,199 @@ ___ **Returns:** `Uint8Array` +___ + + +## uand + +▸ **uand**(b: *`BN`*): `BN` + +*Inherited from BN.uand* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:405* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ucmp + +▸ **ucmp**(b: *`BN`*): `-1` | `0` | `1` + +*Inherited from BN.ucmp* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:174* + +*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `-1` | `0` | `1` + +___ + + +## umod + +▸ **umod**(b: *`BN`*): `BN` + +*Inherited from BN.umod* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:359* + +*__description__*: reduct + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## uor + +▸ **uor**(b: *`BN`*): `BN` + +*Inherited from BN.uor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:385* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ushln + +▸ **ushln**(b: *`number`*): `BN` + +*Inherited from BN.ushln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:455* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## ushrn + +▸ **ushrn**(b: *`number`*): `BN` + +*Inherited from BN.ushrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475* + +*__description__*: shift right + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## uxor + +▸ **uxor**(b: *`BN`*): `BN` + +*Inherited from BN.uxor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:430* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## xor + +▸ **xor**(b: *`BN`*): `BN` + +*Inherited from BN.xor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:420* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## zeroBits + +▸ **zeroBits**(): `number` + +*Inherited from BN.zeroBits* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:139* + +*__description__*: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits) + +**Returns:** `number` + ___ ## `` decodeUInt -▸ **decodeUInt**(value: *`AnyNumber`*, bitLength: *[UIntBitLength](../modules/_codec_uint_.md#uintbitlength)*): `BN` +▸ **decodeUInt**(value: *`AnyNumber`*, bitLength: *[UIntBitLength](../modules/_codec_uint_.md#uintbitlength)*): `string` *Inherited from [UInt](_codec_uint_.uint.md).[decodeUInt](_codec_uint_.uint.md#decodeuint)* -*Defined in [codec/UInt.ts:35](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L35)* +*Defined in [codec/UInt.ts:35](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L35)* **Parameters:** @@ -385,7 +1880,114 @@ ___ | value | `AnyNumber` | | bitLength | [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) | +**Returns:** `string` + +___ + + +## `` isBN + +▸ **isBN**(b: *`any`*): `boolean` + +*Inherited from BN.isBN* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:69* + +*__description__*: returns true if the supplied object is a BN.js instance + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `any` | + +**Returns:** `boolean` + +___ + + +## `` max + +▸ **max**(left: *`BN`*, right: *`BN`*): `BN` + +*Inherited from BN.max* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:74* + +*__description__*: returns the maximum of 2 BN instances. + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| left | `BN` | +| right | `BN` | + **Returns:** `BN` ___ + + +## `` min + +▸ **min**(left: *`BN`*, right: *`BN`*): `BN` + +*Inherited from BN.min* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:79* + +*__description__*: returns the minimum of 2 BN instances. + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| left | `BN` | +| right | `BN` | + +**Returns:** `BN` + +___ + + +## `` mont + +▸ **mont**(num: *`BN`*): `ReductionContext` + +*Inherited from BN.mont* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:64* + +*__description__*: create a reduction context with the Montgomery trick. + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| num | `BN` | + +**Returns:** `ReductionContext` + +___ + + +## `` red + +▸ **red**(reductionContext: * `BN` | `IPrimeName`*): `ReductionContext` + +*Inherited from BN.red* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:59* + +*__description__*: create a reduction context + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| reductionContext | `BN` | `IPrimeName`| + +**Returns:** `ReductionContext` + +___ diff --git a/docs/types/classes/_validatorprefs_.validatorprefs.md b/docs/types/classes/_validatorprefs_.validatorprefs.md index 127b094def..440a067cfc 100644 --- a/docs/types/classes/_validatorprefs_.validatorprefs.md +++ b/docs/types/classes/_validatorprefs_.validatorprefs.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [ValidatorPrefs.ts:17](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/ValidatorPrefs.ts#L17)* +*Defined in [ValidatorPrefs.ts:17](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/ValidatorPrefs.ts#L17)* **Parameters:** @@ -58,7 +58,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L25)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L25)* ___ @@ -83,7 +83,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L123)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -96,7 +96,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L127)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -107,7 +107,7 @@ ___ getunstakeThreshold(): [U32](_u32_.u32.md) -*Defined in [ValidatorPrefs.ts:25](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/ValidatorPrefs.ts#L25)* +*Defined in [ValidatorPrefs.ts:25](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/ValidatorPrefs.ts#L25)* **Returns:** [U32](_u32_.u32.md) @@ -118,7 +118,7 @@ ___ getvalidatorPayment(): [Balance](_balance_.balance.md) -*Defined in [ValidatorPrefs.ts:29](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/ValidatorPrefs.ts#L29)* +*Defined in [ValidatorPrefs.ts:29](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/ValidatorPrefs.ts#L29)* **Returns:** [Balance](_balance_.balance.md) @@ -235,7 +235,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L133)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -308,7 +308,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L137)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -321,7 +321,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L141)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -334,7 +334,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L145)* **Returns:** `any` @@ -347,7 +347,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L156)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -360,7 +360,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -394,7 +394,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Struct.ts#L113)* +*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/types/classes/_voteindex_.voteindex.md b/docs/types/classes/_voteindex_.voteindex.md index 76dda11594..c026111c6f 100644 --- a/docs/types/classes/_voteindex_.voteindex.md +++ b/docs/types/classes/_voteindex_.voteindex.md @@ -6,6 +6,10 @@ **↳ VoteIndex** +# Implements + +* `Codec` + # Constructors @@ -18,7 +22,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U32.ts:9](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/U32.ts#L9)* +*Defined in [U32.ts:9](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/U32.ts#L9)* **Parameters:** @@ -38,27 +42,14 @@ ___ **● raw**: *`BN`* -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* +*Inherited from [UInt](_codec_uint_.uint.md).[raw](_codec_uint_.uint.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/UInt.ts:23](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L23)* ___ # Accessors - - -## bitLength - -getbitLength(): [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) - -*Inherited from [UInt](_codec_uint_.uint.md).[bitLength](_codec_uint_.uint.md#bitlength)* - -*Defined in [codec/UInt.ts:50](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L50)* - -**Returns:** [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) - -___ ## encodedLength @@ -67,9 +58,7 @@ getencodedLength(): `number` *Inherited from [UInt](_codec_uint_.uint.md).[encodedLength](_codec_uint_.uint.md#encodedlength)* -*Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* - -*Defined in [codec/UInt.ts:54](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L54)* +*Defined in [codec/UInt.ts:55](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L55)* **Returns:** `number` @@ -77,21 +66,167 @@ ___ # Methods + + +## abs + +▸ **abs**(): `BN` + +*Inherited from BN.abs* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:254* + +*__description__*: absolute value + +**Returns:** `BN` + +___ ## add -▸ **add**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **add**(b: *`BN`*): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)* +*Inherited from BN.add* -*Defined in [codec/UInt.ts:86](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L86)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:264* + +*__description__*: addition **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | + +**Returns:** `BN` + +___ + + +## addn + +▸ **addn**(b: *`number`*): `BN` + +*Inherited from BN.addn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:274* + +*__description__*: addition + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## and + +▸ **and**(b: *`BN`*): `BN` + +*Inherited from BN.and* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:395* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## andln + +▸ **andln**(b: *`number`*): `BN` + +*Inherited from BN.andln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:415* + +*__description__*: and (NOTE: `andln` is going to be replaced with `andn` in future) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## bincn + +▸ **bincn**(b: *`number`*): `BN` + +*Inherited from BN.bincn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:499* + +*__description__*: add `1 << b` to the number + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## bitLength + +▸ **bitLength**(): [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) + +*Inherited from [UInt](_codec_uint_.uint.md).[bitLength](_codec_uint_.uint.md#bitlength)* + +*Overrides BN.bitLength* + +*Defined in [codec/UInt.ts:51](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L51)* + +**Returns:** [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) + +___ + + +## byteLength + +▸ **byteLength**(): `number` + +*Inherited from BN.byteLength* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:144* + +*__description__*: return number of bytes occupied + +**Returns:** `number` + +___ + + +## clone + +▸ **clone**(): `BN` + +*Inherited from BN.clone* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:89* + +*__description__*: clone number **Returns:** `BN` @@ -100,74 +235,229 @@ ___ ## cmp -▸ **cmp**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `number` +▸ **cmp**(b: *`BN`*): `-1` | `0` | `1` -*Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)* +*Inherited from BN.cmp* -*Defined in [codec/UInt.ts:92](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L92)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:169* + +*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | -**Returns:** `number` +**Returns:** `-1` | `0` | `1` + +___ + + +## cmpn + +▸ **cmpn**(b: *`number`*): `-1` | `0` | `1` + +*Inherited from BN.cmpn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:179* + +*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `-1` | `0` | `1` ___ ## div -▸ **div**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **div**(b: *`BN`*): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)* +*Inherited from BN.div* -*Defined in [codec/UInt.ts:98](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L98)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:339* + +*__description__*: divide **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `BN` +___ + + +## divRound + +▸ **divRound**(b: *`BN`*): `BN` + +*Inherited from BN.divRound* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:370* + +*__description__*: rounded division + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## divn + +▸ **divn**(b: *`number`*): `BN` + +*Inherited from BN.divn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:344* + +*__description__*: divide + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## egcd + +▸ **egcd**(b: *`BN`*): `object` + +*Inherited from BN.egcd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:519* + +*__description__*: Extended GCD results `({ a: ..., b: ..., gcd: ... })` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `object` + ___ ## eq -▸ **eq**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **eq**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[eq](_codec_uint_.uint.md#eq)* +*Inherited from BN.eq* -*Defined in [codec/UInt.ts:104](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L104)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:224* + +*__description__*: a equals b **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` +___ + + +## eqn + +▸ **eqn**(b: *`number`*): `boolean` + +*Inherited from BN.eqn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:229* + +*__description__*: a equals b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## fromTwos + +▸ **fromTwos**(width: *`number`*): `BN` + +*Inherited from BN.fromTwos* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:239* + +*__description__*: convert from two's complement representation, where width is the bit width + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| width | `number` | + +**Returns:** `BN` + +___ + + +## gcd + +▸ **gcd**(b: *`BN`*): `BN` + +*Inherited from BN.gcd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:514* + +*__description__*: GCD + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + ___ ## gt -▸ **gt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **gt**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)* +*Inherited from BN.gt* -*Defined in [codec/UInt.ts:126](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L126)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:204* + +*__description__*: a greater than b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` @@ -176,17 +466,346 @@ ___ ## gte -▸ **gte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **gte**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)* +*Inherited from BN.gte* -*Defined in [codec/UInt.ts:132](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L132)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:214* + +*__description__*: a greater than or equals b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | + +**Returns:** `boolean` + +___ + + +## gten + +▸ **gten**(b: *`number`*): `boolean` + +*Inherited from BN.gten* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:219* + +*__description__*: a greater than or equals b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## gtn + +▸ **gtn**(b: *`number`*): `boolean` + +*Inherited from BN.gtn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:209* + +*__description__*: a greater than b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## iabs + +▸ **iabs**(): `BN` + +*Inherited from BN.iabs* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:259* + +*__description__*: absolute value + +**Returns:** `BN` + +___ + + +## iadd + +▸ **iadd**(b: *`BN`*): `BN` + +*Inherited from BN.iadd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:269* + +*__description__*: addition + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## iaddn + +▸ **iaddn**(b: *`number`*): `BN` + +*Inherited from BN.iaddn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:279* + +*__description__*: addition + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iand + +▸ **iand**(b: *`BN`*): `BN` + +*Inherited from BN.iand* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:400* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## idivn + +▸ **idivn**(b: *`number`*): `BN` + +*Inherited from BN.idivn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:349* + +*__description__*: divide + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## imaskn + +▸ **imaskn**(b: *`number`*): `BN` + +*Inherited from BN.imaskn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495* + +*__description__*: clear bits with indexes higher or equal to `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## imul + +▸ **imul**(b: *`BN`*): `BN` + +*Inherited from BN.imul* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:309* + +*__description__*: multiply + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## imuln + +▸ **imuln**(b: *`number`*): `BN` + +*Inherited from BN.imuln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:319* + +*__description__*: multiply + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## ineg + +▸ **ineg**(): `BN` + +*Inherited from BN.ineg* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:249* + +*__description__*: negate sign + +**Returns:** `BN` + +___ + + +## inotn + +▸ **inotn**(w: *`number`*): `BN` + +*Inherited from BN.inotn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:509* + +*__description__*: not (for the width specified by `w`) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| w | `number` | + +**Returns:** `BN` + +___ + + +## invm + +▸ **invm**(b: *`BN`*): `BN` + +*Inherited from BN.invm* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:524* + +*__description__*: inverse `a` modulo `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ior + +▸ **ior**(b: *`BN`*): `BN` + +*Inherited from BN.ior* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:380* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## isEven + +▸ **isEven**(): `boolean` + +*Inherited from BN.isEven* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:154* + +*__description__*: check if value is even + +**Returns:** `boolean` + +___ + + +## isNeg + +▸ **isNeg**(): `boolean` + +*Inherited from BN.isNeg* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:149* + +*__description__*: true if the number is negative + +**Returns:** `boolean` + +___ + + +## isOdd + +▸ **isOdd**(): `boolean` + +*Inherited from BN.isOdd* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:159* + +*__description__*: check if value is odd **Returns:** `boolean` @@ -197,28 +816,257 @@ ___ ▸ **isZero**(): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)* +*Inherited from BN.isZero* -*Defined in [codec/UInt.ts:110](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L110)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:164* + +*__description__*: check if value is zero **Returns:** `boolean` +___ + + +## ishln + +▸ **ishln**(b: *`number`*): `BN` + +*Inherited from BN.ishln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:450* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## ishrn + +▸ **ishrn**(b: *`number`*): `BN` + +*Inherited from BN.ishrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:470* + +*__description__*: shift right (unimplemented [https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086](https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## isqr + +▸ **isqr**(): `BN` + +*Inherited from BN.isqr* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:329* + +*__description__*: square + +**Returns:** `BN` + +___ + + +## isub + +▸ **isub**(b: *`BN`*): `BN` + +*Inherited from BN.isub* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:289* + +*__description__*: subtraction + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## isubn + +▸ **isubn**(b: *`number`*): `BN` + +*Inherited from BN.isubn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:299* + +*__description__*: subtraction + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iuand + +▸ **iuand**(b: *`BN`*): `BN` + +*Inherited from BN.iuand* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:410* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## iuor + +▸ **iuor**(b: *`BN`*): `BN` + +*Inherited from BN.iuor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:390* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## iushln + +▸ **iushln**(b: *`number`*): `BN` + +*Inherited from BN.iushln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:460* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iushrn + +▸ **iushrn**(b: *`number`*): `BN` + +*Inherited from BN.iushrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480* + +*__description__*: shift right + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## iuxor + +▸ **iuxor**(b: *`BN`*): `BN` + +*Inherited from BN.iuxor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:435* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ixor + +▸ **ixor**(b: *`BN`*): `BN` + +*Inherited from BN.ixor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:425* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + ___ ## lt -▸ **lt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **lt**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)* +*Inherited from BN.lt* -*Defined in [codec/UInt.ts:114](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L114)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:184* + +*__description__*: a less than b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` @@ -227,36 +1075,324 @@ ___ ## lte -▸ **lte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` +▸ **lte**(b: *`BN`*): `boolean` -*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)* +*Inherited from BN.lte* -*Defined in [codec/UInt.ts:120](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L120)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:194* + +*__description__*: a less than or equals b **Parameters:** | Param | Type | | ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `boolean` +___ + + +## lten + +▸ **lten**(b: *`number`*): `boolean` + +*Inherited from BN.lten* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:199* + +*__description__*: a less than or equals b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## ltn + +▸ **ltn**(b: *`number`*): `boolean` + +*Inherited from BN.ltn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:189* + +*__description__*: a less than b + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## maskn + +▸ **maskn**(b: *`number`*): `BN` + +*Inherited from BN.maskn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490* + +*__description__*: clear bits with indexes higher or equal to `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## mod + +▸ **mod**(b: *`BN`*): `BN` + +*Inherited from BN.mod* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:354* + +*__description__*: reduct + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## modn + +▸ **modn**(b: *`number`*): `number` + +*Inherited from BN.modn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:365* + +*__see__*: API consistency [https://github.com/indutny/bn.js/pull/130](https://github.com/indutny/bn.js/pull/130) + +*__description__*: reduct + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `number` + ___ ## mul -▸ **mul**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **mul**(b: *`BN`*): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)* +*Inherited from BN.mul* -*Defined in [codec/UInt.ts:138](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L138)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:304* + +*__description__*: multiply **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | + +**Returns:** `BN` + +___ + + +## muln + +▸ **muln**(b: *`number`*): `BN` + +*Inherited from BN.muln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:314* + +*__description__*: multiply + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## neg + +▸ **neg**(): `BN` + +*Inherited from BN.neg* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:244* + +*__description__*: negate sign + +**Returns:** `BN` + +___ + + +## notn + +▸ **notn**(w: *`number`*): `BN` + +*Inherited from BN.notn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:504* + +*__description__*: not (for the width specified by `w`) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| w | `number` | + +**Returns:** `BN` + +___ + + +## or + +▸ **or**(b: *`BN`*): `BN` + +*Inherited from BN.or* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:375* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## pow + +▸ **pow**(b: *`BN`*): `BN` + +*Inherited from BN.pow* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:334* + +*__description__*: raise `a` to the power of `b` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## setn + +▸ **setn**(b: *`number`*): `BN` + +*Inherited from BN.setn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:440* + +*__description__*: set specified bit to 1 + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## shln + +▸ **shln**(b: *`number`*): `BN` + +*Inherited from BN.shln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:445* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## shrn + +▸ **shrn**(b: *`number`*): `BN` + +*Inherited from BN.shrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:465* + +*__description__*: shift right + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## sqr + +▸ **sqr**(): `BN` + +*Inherited from BN.sqr* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:324* + +*__description__*: square **Returns:** `BN` @@ -265,20 +1401,125 @@ ___ ## sub -▸ **sub**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` +▸ **sub**(b: *`BN`*): `BN` -*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)* +*Inherited from BN.sub* -*Defined in [codec/UInt.ts:144](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L144)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:284* + +*__description__*: subtraction **Parameters:** | Param | Type | | ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| +| b | `BN` | **Returns:** `BN` +___ + + +## subn + +▸ **subn**(b: *`number`*): `BN` + +*Inherited from BN.subn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:294* + +*__description__*: subtraction + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## testn + +▸ **testn**(b: *`number`*): `boolean` + +*Inherited from BN.testn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485* + +*__description__*: test if specified bit is set + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `boolean` + +___ + + +## toArray + +▸ **toArray**(endian?: *`Endianness`*, length?: * `undefined` | `number`*): `number`[] + +*Inherited from BN.toArray* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:109* + +*__description__*: convert to byte Array, and optionally zero pad to length, throwing if already exceeding + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `number`[] + +___ + + +## toArrayLike + +▸ **toArrayLike**(ArrayType: *`object`*, endian?: *`Endianness`*, length?: * `undefined` | `number`*): `Buffer` + +▸ **toArrayLike**(ArrayType: *`any`[]*, endian?: *`Endianness`*, length?: * `undefined` | `number`*): `any`[] + +*Inherited from BN.toArrayLike* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:114* + +*__description__*: convert to an instance of `type`, which must behave like an Array + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| ArrayType | `object` | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `Buffer` + +*Inherited from BN.toArrayLike* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| ArrayType | `any`[] | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `any`[] + ___ @@ -288,10 +1529,32 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)* -*Defined in [codec/UInt.ts:76](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L76)* +*Defined in [codec/UInt.ts:73](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L73)* **Returns:** `BN` +___ + + +## toBuffer + +▸ **toBuffer**(endian?: *`Endianness`*, length?: * `undefined` | `number`*): `Buffer` + +*Inherited from BN.toBuffer* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:129* + +*__description__*: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length) + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` endian | `Endianness` | +| `Optional` length | `undefined` | `number`| + +**Returns:** `Buffer` + ___ @@ -301,7 +1564,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* -*Defined in [codec/UInt.ts:58](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L58)* +*Defined in [codec/UInt.ts:59](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L59)* **Returns:** `string` @@ -314,9 +1577,9 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toJSON](_codec_uint_.uint.md#tojson)* -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* +*Overrides BN.toJSON* -*Defined in [codec/UInt.ts:62](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L62)* +*Defined in [codec/UInt.ts:63](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L63)* **Returns:** `any` @@ -327,27 +1590,78 @@ ___ ▸ **toNumber**(): `number` -*Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)* +*Inherited from BN.toNumber* -*Defined in [codec/UInt.ts:80](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L80)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:99* + +*__description__*: convert to Javascript Number (limited to 53 bits) **Returns:** `number` +___ + + +## toRed + +▸ **toRed**(reductionContext: *`ReductionContext`*): `RedBN` + +*Inherited from BN.toRed* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:84* + +*__description__*: Convert number to red + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| reductionContext | `ReductionContext` | + +**Returns:** `RedBN` + ___ ## toString -▸ **toString**(): `string` +▸ **toString**(base?: * `number` | "hex"*, length?: * `undefined` | `number`*): `string` -*Inherited from [UInt](_codec_uint_.uint.md).[toString](_codec_uint_.uint.md#tostring)* +*Inherited from BN.toString* -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:94* -*Defined in [codec/UInt.ts:72](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L72)* +*__description__*: convert to base-string and pad with zeroes + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` base | `number` | "hex"| +| `Optional` length | `undefined` | `number`| **Returns:** `string` +___ + + +## toTwos + +▸ **toTwos**(width: *`number`*): `BN` + +*Inherited from BN.toTwos* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:234* + +*__description__*: convert to two's complement representation, where width is bit width + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| width | `number` | + +**Returns:** `BN` + ___ @@ -357,9 +1671,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/UInt.ts:68](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L68)* +*Defined in [codec/UInt.ts:69](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L69)* **Parameters:** @@ -369,16 +1681,199 @@ ___ **Returns:** `Uint8Array` +___ + + +## uand + +▸ **uand**(b: *`BN`*): `BN` + +*Inherited from BN.uand* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:405* + +*__description__*: and + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ucmp + +▸ **ucmp**(b: *`BN`*): `-1` | `0` | `1` + +*Inherited from BN.ucmp* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:174* + +*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `-1` | `0` | `1` + +___ + + +## umod + +▸ **umod**(b: *`BN`*): `BN` + +*Inherited from BN.umod* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:359* + +*__description__*: reduct + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## uor + +▸ **uor**(b: *`BN`*): `BN` + +*Inherited from BN.uor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:385* + +*__description__*: or + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## ushln + +▸ **ushln**(b: *`number`*): `BN` + +*Inherited from BN.ushln* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:455* + +*__description__*: shift left + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## ushrn + +▸ **ushrn**(b: *`number`*): `BN` + +*Inherited from BN.ushrn* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475* + +*__description__*: shift right + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `number` | + +**Returns:** `BN` + +___ + + +## uxor + +▸ **uxor**(b: *`BN`*): `BN` + +*Inherited from BN.uxor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:430* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## xor + +▸ **xor**(b: *`BN`*): `BN` + +*Inherited from BN.xor* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:420* + +*__description__*: xor + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `BN` | + +**Returns:** `BN` + +___ + + +## zeroBits + +▸ **zeroBits**(): `number` + +*Inherited from BN.zeroBits* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:139* + +*__description__*: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits) + +**Returns:** `number` + ___ ## `` decodeUInt -▸ **decodeUInt**(value: *`AnyNumber`*, bitLength: *[UIntBitLength](../modules/_codec_uint_.md#uintbitlength)*): `BN` +▸ **decodeUInt**(value: *`AnyNumber`*, bitLength: *[UIntBitLength](../modules/_codec_uint_.md#uintbitlength)*): `string` *Inherited from [UInt](_codec_uint_.uint.md).[decodeUInt](_codec_uint_.uint.md#decodeuint)* -*Defined in [codec/UInt.ts:35](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L35)* +*Defined in [codec/UInt.ts:35](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L35)* **Parameters:** @@ -387,7 +1882,114 @@ ___ | value | `AnyNumber` | | bitLength | [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) | +**Returns:** `string` + +___ + + +## `` isBN + +▸ **isBN**(b: *`any`*): `boolean` + +*Inherited from BN.isBN* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:69* + +*__description__*: returns true if the supplied object is a BN.js instance + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| b | `any` | + +**Returns:** `boolean` + +___ + + +## `` max + +▸ **max**(left: *`BN`*, right: *`BN`*): `BN` + +*Inherited from BN.max* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:74* + +*__description__*: returns the maximum of 2 BN instances. + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| left | `BN` | +| right | `BN` | + **Returns:** `BN` ___ + + +## `` min + +▸ **min**(left: *`BN`*, right: *`BN`*): `BN` + +*Inherited from BN.min* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:79* + +*__description__*: returns the minimum of 2 BN instances. + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| left | `BN` | +| right | `BN` | + +**Returns:** `BN` + +___ + + +## `` mont + +▸ **mont**(num: *`BN`*): `ReductionContext` + +*Inherited from BN.mont* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:64* + +*__description__*: create a reduction context with the Montgomery trick. + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| num | `BN` | + +**Returns:** `ReductionContext` + +___ + + +## `` red + +▸ **red**(reductionContext: * `BN` | `IPrimeName`*): `ReductionContext` + +*Inherited from BN.red* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:59* + +*__description__*: create a reduction context + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| reductionContext | `BN` | `IPrimeName`| + +**Returns:** `ReductionContext` + +___ diff --git a/docs/types/classes/_votethreshold_.votethreshold.md b/docs/types/classes/_votethreshold_.votethreshold.md index 34120bb040..fca31dbb20 100644 --- a/docs/types/classes/_votethreshold_.votethreshold.md +++ b/docs/types/classes/_votethreshold_.votethreshold.md @@ -16,7 +16,7 @@ *Overrides [Enum](_codec_enum_.enum.md).[constructor](_codec_enum_.enum.md#constructor)* -*Defined in [VoteThreshold.ts:9](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/VoteThreshold.ts#L9)* +*Defined in [VoteThreshold.ts:9](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/VoteThreshold.ts#L9)* **Parameters:** @@ -38,7 +38,7 @@ ___ *Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Base.ts#L19)* ___ @@ -54,7 +54,7 @@ getencodedLength(): `number` *Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* -*Defined in [codec/Enum.ts:41](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Enum.ts#L41)* +*Defined in [codec/Enum.ts:41](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Enum.ts#L41)* **Returns:** `number` @@ -72,7 +72,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* -*Defined in [codec/Enum.ts:45](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Enum.ts#L45)* +*Defined in [codec/Enum.ts:45](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Enum.ts#L45)* **Returns:** `any` @@ -85,7 +85,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[toNumber](_codec_enum_.enum.md#tonumber)* -*Defined in [codec/Enum.ts:49](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Enum.ts#L49)* +*Defined in [codec/Enum.ts:49](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Enum.ts#L49)* **Returns:** `number` @@ -100,7 +100,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* -*Defined in [codec/Enum.ts:53](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Enum.ts#L53)* +*Defined in [codec/Enum.ts:53](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Enum.ts#L53)* **Returns:** `string` @@ -115,7 +115,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* -*Defined in [codec/Enum.ts:57](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Enum.ts#L57)* +*Defined in [codec/Enum.ts:57](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Enum.ts#L57)* **Parameters:** @@ -134,7 +134,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[decodeEnum](_codec_enum_.enum.md#decodeenum)* -*Defined in [codec/Enum.ts:31](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Enum.ts#L31)* +*Defined in [codec/Enum.ts:31](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Enum.ts#L31)* **Parameters:** diff --git a/docs/types/enums/_codec_createtype_.typedefinfo.md b/docs/types/enums/_codec_createtype_.typedefinfo.md index 7d6f95f115..7bf85a845f 100644 --- a/docs/types/enums/_codec_createtype_.typedefinfo.md +++ b/docs/types/enums/_codec_createtype_.typedefinfo.md @@ -19,7 +19,7 @@ **Compact**: -*Defined in [codec/createType.ts:16](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/createType.ts#L16)* +*Defined in [codec/createType.ts:16](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/createType.ts#L16)* ___ @@ -28,7 +28,7 @@ ___ **Plain**: -*Defined in [codec/createType.ts:17](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/createType.ts#L17)* +*Defined in [codec/createType.ts:17](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/createType.ts#L17)* ___ @@ -37,7 +37,7 @@ ___ **Tuple**: -*Defined in [codec/createType.ts:18](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/createType.ts#L18)* +*Defined in [codec/createType.ts:18](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/createType.ts#L18)* ___ @@ -46,7 +46,7 @@ ___ **Vector**: -*Defined in [codec/createType.ts:19](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/createType.ts#L19)* +*Defined in [codec/createType.ts:19](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/createType.ts#L19)* ___ diff --git a/docs/types/interfaces/_storagekey_.storagefunction.md b/docs/types/interfaces/_storagekey_.storagefunction.md index 4b55dda7bd..43cdd482f1 100644 --- a/docs/types/interfaces/_storagekey_.storagefunction.md +++ b/docs/types/interfaces/_storagekey_.storagefunction.md @@ -7,7 +7,7 @@ # Callable ▸ **__call**(arg?: *`any`*): `Uint8Array` -*Defined in [StorageKey.ts:12](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/StorageKey.ts#L12)* +*Defined in [StorageKey.ts:12](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/StorageKey.ts#L12)* **Parameters:** @@ -25,7 +25,7 @@ **● meta**: *[StorageFunctionMetadata](../classes/_metadata_.storagefunctionmetadata.md)* -*Defined in [StorageKey.ts:14](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/StorageKey.ts#L14)* +*Defined in [StorageKey.ts:14](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/StorageKey.ts#L14)* ___ @@ -34,7 +34,7 @@ ___ **● method**: *`string`* -*Defined in [StorageKey.ts:15](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/StorageKey.ts#L15)* +*Defined in [StorageKey.ts:15](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/StorageKey.ts#L15)* ___ @@ -43,7 +43,7 @@ ___ **● section**: *`string`* -*Defined in [StorageKey.ts:16](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/StorageKey.ts#L16)* +*Defined in [StorageKey.ts:16](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/StorageKey.ts#L16)* ___ @@ -52,7 +52,7 @@ ___ **● toJSON**: *`function`* -*Defined in [StorageKey.ts:17](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/StorageKey.ts#L17)* +*Defined in [StorageKey.ts:17](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/StorageKey.ts#L17)* #### Type declaration ▸(): `any` diff --git a/docs/types/modules/_accountindex_.md b/docs/types/modules/_accountindex_.md index eac2d337d2..270b2424ee 100644 --- a/docs/types/modules/_accountindex_.md +++ b/docs/types/modules/_accountindex_.md @@ -20,7 +20,7 @@ **● ENUMSET_SIZE**: *`BN`* = new BN(64) -*Defined in [AccountIndex.ts:13](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/AccountIndex.ts#L13)* +*Defined in [AccountIndex.ts:13](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/AccountIndex.ts#L13)* ___ diff --git a/docs/types/modules/_address_.md b/docs/types/modules/_address_.md index 69147cd9d8..1dd5c3108e 100644 --- a/docs/types/modules/_address_.md +++ b/docs/types/modules/_address_.md @@ -20,7 +20,7 @@ **● ACCOUNT_ID_PREFIX**: *`Uint8Array`* = new Uint8Array([0xff]) -*Defined in [Address.ts:15](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Address.ts#L15)* +*Defined in [Address.ts:15](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Address.ts#L15)* ___ diff --git a/docs/types/modules/_bft_.md b/docs/types/modules/_bft_.md index 5a94f3502d..fb33b936e5 100644 --- a/docs/types/modules/_bft_.md +++ b/docs/types/modules/_bft_.md @@ -24,7 +24,7 @@ **Ƭ BftAuthoritySignatureValue**: *`object`* -*Defined in [Bft.ts:16](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Bft.ts#L16)* +*Defined in [Bft.ts:16](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Bft.ts#L16)* #### Type declaration @@ -35,7 +35,7 @@ ___ **Ƭ BftHashSignatureValue**: *`object`* -*Defined in [Bft.ts:40](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Bft.ts#L40)* +*Defined in [Bft.ts:40](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Bft.ts#L40)* #### Type declaration @@ -46,7 +46,7 @@ ___ **Ƭ JustificationValue**: *`object`* -*Defined in [Bft.ts:64](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Bft.ts#L64)* +*Defined in [Bft.ts:64](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Bft.ts#L64)* #### Type declaration diff --git a/docs/types/modules/_block_.md b/docs/types/modules/_block_.md index e595d2a36b..890356ba0d 100644 --- a/docs/types/modules/_block_.md +++ b/docs/types/modules/_block_.md @@ -20,7 +20,7 @@ **Ƭ BlockValue**: *`object`* -*Defined in [Block.ts:15](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Block.ts#L15)* +*Defined in [Block.ts:15](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Block.ts#L15)* #### Type declaration diff --git a/docs/types/modules/_codec_base_.md b/docs/types/modules/_codec_base_.md index 21cc83e95f..51d464945f 100644 --- a/docs/types/modules/_codec_base_.md +++ b/docs/types/modules/_codec_base_.md @@ -20,7 +20,7 @@ **● l**: *`object`* = logger('codec') -*Defined in [codec/Base.ts:7](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Base.ts#L7)* +*Defined in [codec/Base.ts:7](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Base.ts#L7)* #### Type declaration diff --git a/docs/types/modules/_codec_compact_.md b/docs/types/modules/_codec_compact_.md index 28cc9de605..633f138d16 100644 --- a/docs/types/modules/_codec_compact_.md +++ b/docs/types/modules/_codec_compact_.md @@ -20,7 +20,7 @@ **● DEFAULT_LENGTH_BITS**: *`32`* = 32 -*Defined in [codec/Compact.ts:13](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/Compact.ts#L13)* +*Defined in [codec/Compact.ts:13](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/Compact.ts#L13)* ___ diff --git a/docs/types/modules/_codec_createtype_.md b/docs/types/modules/_codec_createtype_.md index a013c6a628..bf5449b681 100644 --- a/docs/types/modules/_codec_createtype_.md +++ b/docs/types/modules/_codec_createtype_.md @@ -27,7 +27,7 @@ **Ƭ TypeDef**: *`object`* -*Defined in [codec/createType.ts:22](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/createType.ts#L22)* +*Defined in [codec/createType.ts:22](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/createType.ts#L22)* #### Type declaration @@ -41,7 +41,7 @@ ___ ▸ **createType**(type: * [Text](../classes/_text_.text.md) | `string`*, value?: *`any`*): [Base](../classes/_codec_base_.base.md) -*Defined in [codec/createType.ts:158](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/createType.ts#L158)* +*Defined in [codec/createType.ts:158](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/createType.ts#L158)* **Parameters:** @@ -59,7 +59,7 @@ ___ ▸ **getTypeClass**(value: *[TypeDef](_codec_createtype_.md#typedef)*): `Constructor` -*Defined in [codec/createType.ts:118](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/createType.ts#L118)* +*Defined in [codec/createType.ts:118](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/createType.ts#L118)* **Parameters:** @@ -76,7 +76,7 @@ ___ ▸ **getTypeDef**(_type: * [Text](../classes/_text_.text.md) | `string`*): [TypeDef](_codec_createtype_.md#typedef) -*Defined in [codec/createType.ts:79](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/createType.ts#L79)* +*Defined in [codec/createType.ts:79](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/createType.ts#L79)* **Parameters:** @@ -93,7 +93,7 @@ ___ ▸ **typeSplit**(type: *`string`*): `Array`<`string`> -*Defined in [codec/createType.ts:29](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/createType.ts#L29)* +*Defined in [codec/createType.ts:29](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/createType.ts#L29)* **Parameters:** diff --git a/docs/types/modules/_codec_uint_.md b/docs/types/modules/_codec_uint_.md index 8f7c352ef4..8875d8076b 100644 --- a/docs/types/modules/_codec_uint_.md +++ b/docs/types/modules/_codec_uint_.md @@ -25,7 +25,7 @@ **Ƭ UIntBitLength**: * `8` | `16` | `32` | `64` | `128` | `256` * -*Defined in [codec/UInt.ts:12](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L12)* +*Defined in [codec/UInt.ts:10](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L10)* ___ @@ -37,7 +37,7 @@ ___ **● DEFAULT_UINT_BITS**: *`64`* = 64 -*Defined in [codec/UInt.ts:14](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/codec/UInt.ts#L14)* +*Defined in [codec/UInt.ts:12](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/codec/UInt.ts#L12)* ___ diff --git a/docs/types/modules/_codec_uint_spec_.md b/docs/types/modules/_codec_uint_spec_.md new file mode 100644 index 0000000000..139597f9cb --- /dev/null +++ b/docs/types/modules/_codec_uint_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/types/modules/_header_.md b/docs/types/modules/_header_.md index 4769830a19..21dbe9f556 100644 --- a/docs/types/modules/_header_.md +++ b/docs/types/modules/_header_.md @@ -20,7 +20,7 @@ **Ƭ HeaderValue**: *`object`* -*Defined in [Header.ts:17](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/Header.ts#L17)* +*Defined in [Header.ts:17](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/Header.ts#L17)* #### Type declaration diff --git a/docs/types/modules/_keyvalue_.md b/docs/types/modules/_keyvalue_.md index 8c611dc6a3..9ff9256184 100644 --- a/docs/types/modules/_keyvalue_.md +++ b/docs/types/modules/_keyvalue_.md @@ -21,7 +21,7 @@ **Ƭ KeyValueOptionValue**: *`object`* -*Defined in [KeyValue.ts:40](https://github.com/polkadot-js/api/blob/67dd498/packages/types/src/KeyValue.ts#L40)* +*Defined in [KeyValue.ts:40](https://github.com/polkadot-js/api/blob/d097a7a/packages/types/src/KeyValue.ts#L40)* #### Type declaration diff --git a/lerna.json b/lerna.json index 3782a06d9d..23ec45694d 100644 --- a/lerna.json +++ b/lerna.json @@ -9,5 +9,5 @@ "packages": [ "packages/*" ], - "version": "0.31.115" + "version": "0.31.116" } diff --git a/package.json b/package.json index 117cce4958..8348a92209 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "version": "0.31.115", + "version": "0.31.116", "private": true, "engines": { "node": "^10.13.0", diff --git a/packages/api-observable/package.json b/packages/api-observable/package.json index 68fc2a268b..5633267b33 100644 --- a/packages/api-observable/package.json +++ b/packages/api-observable/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/api-observable", - "version": "0.31.115", + "version": "0.31.116", "description": "An Observable wrapper around the Polkadot JS API", "main": "index.js", "keywords": [ @@ -30,10 +30,10 @@ "homepage": "https://github.com/polkadot-js/api/tree/master/packages/rpc-rx#readme", "dependencies": { "@babel/runtime": "^7.1.2", - "@polkadot/extrinsics": "^0.31.115", - "@polkadot/rpc-core": "^0.31.115", - "@polkadot/rpc-provider": "^0.31.115", - "@polkadot/storage": "^0.31.115", + "@polkadot/extrinsics": "^0.31.116", + "@polkadot/rpc-core": "^0.31.116", + "@polkadot/rpc-provider": "^0.31.116", + "@polkadot/storage": "^0.31.116", "@types/rx": "^4.1.1", "rxjs": "^6.3.3" } diff --git a/packages/api/package.json b/packages/api/package.json index 33b7a28297..f8dc01dd4a 100644 --- a/packages/api/package.json +++ b/packages/api/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/api", - "version": "0.31.115", + "version": "0.31.116", "description": "An RxJS wrapper around the Polkadot JS RPC", "main": "index.js", "keywords": [ @@ -30,10 +30,10 @@ "homepage": "https://github.com/polkadot-js/api/tree/master/packages/api#readme", "dependencies": { "@babel/runtime": "^7.1.2", - "@polkadot/extrinsics": "^0.31.115", - "@polkadot/rpc-provider": "^0.31.115", - "@polkadot/rpc-rx": "^0.31.115", - "@polkadot/storage": "^0.31.115", + "@polkadot/extrinsics": "^0.31.116", + "@polkadot/rpc-provider": "^0.31.116", + "@polkadot/rpc-rx": "^0.31.116", + "@polkadot/storage": "^0.31.116", "@types/rx": "^4.1.1", "rxjs": "^6.3.3" } diff --git a/packages/rpc-core/package.json b/packages/rpc-core/package.json index c5b93d4db2..f072bbd31c 100644 --- a/packages/rpc-core/package.json +++ b/packages/rpc-core/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/rpc-core", - "version": "0.31.115", + "version": "0.31.116", "description": "A JavaScript wrapper for the Polkadot JsonRPC interface", "main": "index.js", "keywords": [ @@ -30,8 +30,8 @@ "homepage": "https://github.com/polkadot-js/api/tree/master/packages/rpc-core#readme", "dependencies": { "@babel/runtime": "^7.1.2", - "@polkadot/jsonrpc": "^0.31.115", - "@polkadot/rpc-provider": "^0.31.115", + "@polkadot/jsonrpc": "^0.31.116", + "@polkadot/rpc-provider": "^0.31.116", "@polkadot/util": "^0.32.18" } } diff --git a/packages/rpc-provider/package.json b/packages/rpc-provider/package.json index 2886f2087b..e4eee5ce0c 100644 --- a/packages/rpc-provider/package.json +++ b/packages/rpc-provider/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/rpc-provider", - "version": "0.31.115", + "version": "0.31.116", "description": "Transport providers for the API", "main": "index.js", "keywords": [ @@ -31,7 +31,7 @@ "dependencies": { "@babel/runtime": "^7.1.2", "@polkadot/keyring": "^0.32.18", - "@polkadot/storage": "^0.31.115", + "@polkadot/storage": "^0.31.116", "@polkadot/util": "^0.32.18", "@polkadot/util-crypto": "^0.32.18", "@types/nock": "^9.3.0", diff --git a/packages/rpc-rx/package.json b/packages/rpc-rx/package.json index d97b6a8106..7d8d5e06ff 100644 --- a/packages/rpc-rx/package.json +++ b/packages/rpc-rx/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/rpc-rx", - "version": "0.31.115", + "version": "0.31.116", "description": "An RxJs wrapper around the Polkadot JS API", "main": "index.js", "keywords": [ @@ -30,8 +30,8 @@ "homepage": "https://github.com/polkadot-js/api/tree/master/packages/rpc-rx#readme", "dependencies": { "@babel/runtime": "^7.1.2", - "@polkadot/rpc-core": "^0.31.115", - "@polkadot/rpc-provider": "^0.31.115", + "@polkadot/rpc-core": "^0.31.116", + "@polkadot/rpc-provider": "^0.31.116", "@types/rx": "^4.1.1", "rxjs": "^6.3.3" } diff --git a/packages/type-extrinsics/package.json b/packages/type-extrinsics/package.json index b9a7a2b203..d3a8eedf75 100644 --- a/packages/type-extrinsics/package.json +++ b/packages/type-extrinsics/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/extrinsics", - "version": "0.31.115", + "version": "0.31.116", "main": "index.js", "repository": "https://github.com/polkadot-js/api.git", "author": "Jaco Greeff ", diff --git a/packages/type-jsonrpc/package.json b/packages/type-jsonrpc/package.json index 9dccb39e8c..bf3c555241 100644 --- a/packages/type-jsonrpc/package.json +++ b/packages/type-jsonrpc/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/jsonrpc", - "version": "0.31.115", + "version": "0.31.116", "description": "Method definitions for the Polkadot RPC layer", "main": "index.js", "engines": { diff --git a/packages/type-storage/package.json b/packages/type-storage/package.json index ed883a703f..2d890501fb 100644 --- a/packages/type-storage/package.json +++ b/packages/type-storage/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/storage", - "version": "0.31.115", + "version": "0.31.116", "description": "Generic wrapper wrapper around state storage", "main": "index.js", "engines": { @@ -31,7 +31,7 @@ "dependencies": { "@babel/runtime": "^7.1.2", "@polkadot/keyring": "^0.32.18", - "@polkadot/types": "^0.31.115", + "@polkadot/types": "^0.31.116", "@polkadot/util": "^0.32.18", "@polkadot/util-crypto": "^0.32.18" } diff --git a/packages/types/package.json b/packages/types/package.json index 8993711892..90e7def25e 100644 --- a/packages/types/package.json +++ b/packages/types/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/types", - "version": "0.31.115", + "version": "0.31.116", "description": "Implementation of the Parity codec", "main": "index.js", "keywords": [