Skip to content

Commit

Permalink
Merge branch 'master' into shazarre/fee_currency_directory_support
Browse files Browse the repository at this point in the history
  • Loading branch information
shazarre authored May 16, 2024
2 parents c9c3345 + 3aa75c7 commit 9237088
Show file tree
Hide file tree
Showing 56 changed files with 4,699 additions and 15 deletions.
30 changes: 30 additions & 0 deletions .changeset/pre.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
{
"mode": "pre",
"tag": "beta",
"initialVersions": {
"@celo/celocli": "5.0.0",
"@celo/dev-utils": "0.0.3",
"@celo/base": "6.0.1",
"@celo/connect": "5.3.0",
"@celo/contractkit": "8.0.0",
"@celo/cryptographic-utils": "5.0.8",
"@celo/explorer": "5.0.10",
"@celo/governance": "5.1.1",
"@celo/keystores": "5.0.9",
"@celo/network-utils": "5.0.6",
"@celo/phone-utils": "6.0.2",
"@celo/transactions-uri": "5.0.9",
"@celo/utils": "6.0.1",
"@celo/wallet-base": "5.2.0",
"@celo/wallet-hsm": "5.2.0",
"@celo/wallet-hsm-aws": "5.2.0",
"@celo/wallet-hsm-azure": "5.2.0",
"@celo/wallet-hsm-gcp": "5.2.0",
"@celo/wallet-ledger": "5.2.0",
"@celo/wallet-local": "5.2.0",
"@celo/wallet-remote": "5.2.0",
"@celo/wallet-rpc": "5.2.0",
"@celo/typescript": "0.0.1"
},
"changesets": []
}
4 changes: 2 additions & 2 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -288,8 +288,8 @@ jobs:
- name: Fail if someone forgot to commit docs
run: |
yarn docs
if [[ $(git status packages/docs --porcelain) ]]; then
git --no-pager diff packages/docs
if [[ $(git status docs --porcelain) ]]; then
git --no-pager diff docs
echo "There are git differences after generating all docs"
git status
git diff
Expand Down
10 changes: 5 additions & 5 deletions docs/command-line-interface/account.md
Original file line number Diff line number Diff line change
Expand Up @@ -408,7 +408,7 @@ _See code: [src/commands/account/delete-payment-delegation.ts](https://github.co

## `celocli account:get-metadata ARG1`

Show information about an address. Retreives the metadata URL for an account from the on-chain, then fetches the metadata file off-chain and verifies proofs as able.
Show information about an address. Retrieves the metadata URL for an account from the on-chain, then fetches the metadata file off-chain and verifies proofs as able.

```
USAGE
Expand Down Expand Up @@ -453,7 +453,7 @@ FLAGS
property to sort by (prepend '-' for descending)
DESCRIPTION
Show information about an address. Retreives the metadata URL for an account from the
Show information about an address. Retrieves the metadata URL for an account from the
on-chain, then fetches the metadata file off-chain and verifies proofs as able.
EXAMPLES
Expand Down Expand Up @@ -897,7 +897,7 @@ _See code: [src/commands/account/register-data-encryption-key.ts](https://github

## `celocli account:register-metadata`

Register metadata URL for an account where users will be able to retieve the metadata file and verify your claims
Register metadata URL for an account where users will be able to retrieve the metadata file and verify your claims

```
USAGE
Expand All @@ -922,7 +922,7 @@ FLAGS
Ignore metadata validity checks
--from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d
(required) Addess of the account to set metadata for
(required) Address of the account to set metadata for
--gasCurrency=0x1234567890123456789012345678901234567890
Use a specific gas currency for transaction fees (defaults to CELO if no gas
Expand All @@ -948,7 +948,7 @@ FLAGS
(required) The url to the metadata you want to register
DESCRIPTION
Register metadata URL for an account where users will be able to retieve the metadata
Register metadata URL for an account where users will be able to retrieve the metadata
file and verify your claims
EXAMPLES
Expand Down
2 changes: 1 addition & 1 deletion docs/command-line-interface/exchange.md
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,7 @@ FLAGS
--globalHelp View all available global
flags
--stableToken=<option> Name of the stable token to
be transfered
be transferred
<options: cUSD|cusd|cEUR|ceu
r|cREAL|creal>
--value=10000000000000000000000 (required) The value of
Expand Down
4 changes: 2 additions & 2 deletions docs/command-line-interface/network.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ View details about the network, like contracts and parameters

## `celocli network:contracts`

Lists Celo core contracts and their addesses.
Lists Celo core contracts and their addresses.

```
USAGE
Expand Down Expand Up @@ -52,7 +52,7 @@ FLAGS
property to sort by (prepend '-' for descending)
DESCRIPTION
Lists Celo core contracts and their addesses.
Lists Celo core contracts and their addresses.
```

_See code: [src/commands/network/contracts.ts](https://github.com/celo-org/developer-tooling/tree/master/packages/cli/src/commands/network/contracts.ts)_
Expand Down
6 changes: 3 additions & 3 deletions docs/command-line-interface/releasecelo.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ _See code: [src/commands/releasecelo/locked-gold.ts](https://github.com/celo-org

## `celocli releasecelo:refund-and-finalize`

Refund the given contract's balance to the appopriate parties and destroy the contact. Can only be called by the release owner of revocable ReleaseGold instances.
Refund the given contract's balance to the appropriate parties and destroy the contact. Can only be called by the release owner of revocable ReleaseGold instances.

```
USAGE
Expand All @@ -167,8 +167,8 @@ FLAGS
flags
DESCRIPTION
Refund the given contract's balance to the appopriate parties and destroy the contact.
Can only be called by the release owner of revocable ReleaseGold instances.
Refund the given contract's balance to the appropriate parties and destroy the
contact. Can only be called by the release owner of revocable ReleaseGold instances.
EXAMPLES
refund-and-finalize --contract 0x5409ED021D9299bf6814279A6A1411A7e866A631
Expand Down
2 changes: 1 addition & 1 deletion docs/command-line-interface/transfer.md
Original file line number Diff line number Diff line change
Expand Up @@ -243,7 +243,7 @@ FLAGS
--globalHelp View all available global
flags
--stableToken=<option> Name of the stable to be
transfered
transferred
<options: cUSD|cusd|cEUR|ceu
r|cREAL|creal>
--to=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Address of the
Expand Down
28 changes: 28 additions & 0 deletions docs/sdk/base/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
@celo/base

# @celo/base

## Table of contents

### Modules

- [account](modules/account.md)
- [address](modules/address.md)
- [async](modules/async.md)
- [collections](modules/collections.md)
- [contacts](modules/contacts.md)
- [currencies](modules/currencies.md)
- [displayFormatting](modules/displayFormatting.md)
- [future](modules/future.md)
- [index](modules/index.md)
- [inputValidation](modules/inputValidation.md)
- [io](modules/io.md)
- [lock](modules/lock.md)
- [logger](modules/logger.md)
- [parsing](modules/parsing.md)
- [phoneNumbers](modules/phoneNumbers.md)
- [result](modules/result.md)
- [signatureUtils](modules/signatureUtils.md)
- [string](modules/string.md)
- [task](modules/task.md)
- [types](modules/types.md)
145 changes: 145 additions & 0 deletions docs/sdk/base/classes/future.Future.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,145 @@
[@celo/base](../README.md) / [future](../modules/future.md) / Future

# Class: Future\<T\>

[future](../modules/future.md).Future

## Type parameters

| Name |
| :------ |
| `T` |

## Table of contents

### Constructors

- [constructor](future.Future.md#constructor)

### Accessors

- [error](future.Future.md#error)
- [finished](future.Future.md#finished)

### Methods

- [asPromise](future.Future.md#aspromise)
- [reject](future.Future.md#reject)
- [resolve](future.Future.md#resolve)
- [wait](future.Future.md#wait)

## Constructors

### constructor

**new Future**\<`T`\>(): [`Future`](future.Future.md)\<`T`\>

#### Type parameters

| Name |
| :------ |
| `T` |

#### Returns

[`Future`](future.Future.md)\<`T`\>

#### Defined in

[packages/sdk/base/src/future.ts:10](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/base/src/future.ts#L10)

## Accessors

### error

`get` **error**(): `any`

#### Returns

`any`

#### Defined in

[packages/sdk/base/src/future.ts:21](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/base/src/future.ts#L21)

___

### finished

`get` **finished**(): `boolean`

#### Returns

`boolean`

#### Defined in

[packages/sdk/base/src/future.ts:17](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/base/src/future.ts#L17)

## Methods

### asPromise

**asPromise**(): `Promise`\<`T`\>

#### Returns

`Promise`\<`T`\>

#### Defined in

[packages/sdk/base/src/future.ts:41](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/base/src/future.ts#L41)

___

### reject

**reject**(`error`): `void`

#### Parameters

| Name | Type |
| :------ | :------ |
| `error` | `any` |

#### Returns

`void`

#### Defined in

[packages/sdk/base/src/future.ts:31](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/base/src/future.ts#L31)

___

### resolve

**resolve**(`value`): `void`

#### Parameters

| Name | Type |
| :------ | :------ |
| `value` | `T` |

#### Returns

`void`

#### Defined in

[packages/sdk/base/src/future.ts:25](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/base/src/future.ts#L25)

___

### wait

**wait**(): `Promise`\<`T`\>

#### Returns

`Promise`\<`T`\>

#### Defined in

[packages/sdk/base/src/future.ts:37](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/base/src/future.ts#L37)
73 changes: 73 additions & 0 deletions docs/sdk/base/classes/lock.Lock.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
[@celo/base](../README.md) / [lock](../modules/lock.md) / Lock

# Class: Lock

[lock](../modules/lock.md).Lock

## Table of contents

### Constructors

- [constructor](lock.Lock.md#constructor)

### Methods

- [acquire](lock.Lock.md#acquire)
- [release](lock.Lock.md#release)
- [tryAcquire](lock.Lock.md#tryacquire)

## Constructors

### constructor

**new Lock**(): [`Lock`](lock.Lock.md)

#### Returns

[`Lock`](lock.Lock.md)

#### Defined in

[packages/sdk/base/src/lock.ts:14](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/base/src/lock.ts#L14)

## Methods

### acquire

**acquire**(): `Promise`\<`void`\>

#### Returns

`Promise`\<`void`\>

#### Defined in

[packages/sdk/base/src/lock.ts:29](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/base/src/lock.ts#L29)

___

### release

**release**(): `void`

#### Returns

`void`

#### Defined in

[packages/sdk/base/src/lock.ts:54](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/base/src/lock.ts#L54)

___

### tryAcquire

**tryAcquire**(): `boolean`

#### Returns

`boolean`

#### Defined in

[packages/sdk/base/src/lock.ts:20](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/base/src/lock.ts#L20)
Loading

0 comments on commit 9237088

Please sign in to comment.