Skip to content

Commit 108655f

Browse files
authored
Merge pull request #79 from mlabs-haskell/dev/update-ms-in-docs
Update docs with use of milliseconds
2 parents 60bd6bd + 40e6db7 commit 108655f

File tree

2 files changed

+10
-0
lines changed

2 files changed

+10
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -415,6 +415,10 @@ mintAuth: Minted $CERT
415415
mintAuth: Minted $AUTH
416416
```
417417
418+
> NOTE:
419+
> Validity is measured in milliseconds (ms). `60 * 60 * 1000` is `3600000 ms`
420+
> which means our certificates in this example are valid for one hour.
421+
418422
The `coop-pab-cli mint-cert-redeemers` issues [Certificate redeemer
419423
tokens](coop-docs/02-plutus-protocol.md#cert-rdmr-token) to a special wallet
420424
that will be used in `coop-pab-cli garbage-collect` command to 'garbage collect'
@@ -731,6 +735,8 @@ collect it at any time after publishing.
731735
> Users can specify validity time for the [Fact Statement UTxOs](coop-docs/02-plutus-protocol.md#fs-validator) they created and adjust it to the needs of the dApps they are referenced with.
732736
> Some Fact Statements are going to be short lived, and some long lived, that largely depends on how the Fact Statement is used by a Cardano dApp.
733737
> Protocol enables Submitters to 'garbage collect' obsolete [Fact Statement UTxOs](coop-docs/02-plutus-protocol.md#fs-validator) and reclaim the [Min UTxO Ada](https://docs.cardano.org/native-tokens/minimum-ada-value-requirement) held within.
738+
>
739+
> Validity time is specified using a [Unix timestamp](https://www.unixtimestamp.com/) in milliseconds. When interacting with the GRPC service ensure that your tooling can convert its native timestamps to milliseconds.
734740
735741
Let's issue a request against the [Publisher gRPC](coop-proto/publisher-service.proto) service:
736742

coop-proto/cardano.proto

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,15 @@ message TxOutRef {
2828

2929
message ExtendedLedgerTime {
3030
enum Extended {
31+
// Negative infinity: elapses immediately
3132
NEG_INF = 0;
33+
// Finite time: elapses at `finite_ledger_time`
3234
FINITE = 1;
35+
// Positive infinity: never elapses.
3336
POS_INF = 2;
3437
}
3538
Extended extended = 1;
39+
// Unix timestamp in milliseconds (ms)
3640
uint64 finite_ledger_time = 2;
3741
}
3842

0 commit comments

Comments
 (0)