Skip to content

Commit 705408d

Browse files
author
waalge
committed
Suggested restructuring
I wrote much of v1 and spend a fair amount of time looking at v0, and i didn't understand the docs.
1 parent 206e687 commit 705408d

File tree

1 file changed

+42
-52
lines changed

1 file changed

+42
-52
lines changed

docs/developer-manual/policies.md

Lines changed: 42 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -4,82 +4,72 @@ sidebar_position: 3
44
slug: /policies
55
---
66

7-
# Orcfax policies
7+
# Orcfax deployments
88

9-
A list of Orcfax oracle policy IDs and permanent storage addresses to aid with
10-
historical investigation and reconstruction of Orcfax fact-statements.
9+
Signposting Orcfax deployments both historical and current.
10+
The hashes can be used to navigate Orcfax on Cardano and Arweave blockchains
11+
for statements and archival packages.
1112

12-
## Mainnet summary
13+
## V1
1314

14-
A summary of current, and previous Orcfax policies on mainnet is shown below.
15+
Components:
1516

16-
| Version | Network | FSP hash | Policy | Date Start | Date End |
17-
| ------- | ------- | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ---------- | -------- |
18-
| v1 | mainnet | `TBD` | `TBD` | TBD | TBD |
19-
| v0 | mainnet | `Not implemented` | `2cccc05192920ff1eb02bcfa7bb2a1fc5352ce58391d7ba3c66a555b` | 28.09.2023 | 15.05.2024 |
17+
- FSP script
18+
- FS script
19+
- C script
2020

21-
## v1 Detailed policy information
21+
The FSP script will not change in the lifetime of a deployment.
22+
The FSP is used to record the current FS script hash.
23+
To each FS script there is an associate C script hash.
24+
See the [integrator docs][consume] for an explanation on the role of each script.
2225

23-
### v1 Mainnet
26+
[consume]: ./consume.md
2427

25-
<!-- Order should run chronologically in descending order, i.e. newest first -->
28+
### V1:Mainnet
2629

27-
#### Policy: TBD
30+
- FSP script hash: `TBD`
2831

29-
> NB. The v1 protocol is currently under development. While mainnet details are
30-
unavailable, integrators can find details regarding Preprod and Preview below.
32+
- FS script hash: `TBD`
3133

32-
| | Details |
33-
|------------------------|---------|
34-
| Current | ... |
35-
| Network | Mainnet |
36-
| Arweave | ... |
37-
| Fact Statement Pointer | `...` |
38-
| Policy ID | `...` |
39-
| First appearance | ... |
40-
| Slot no. | ... |
41-
| Block | `...` |
34+
- C script hash: `TBD`
4235

43-
#### Preview policy ID: 900d528f3c1864a1376db1afc065c9b293a2235f39b00a67455a6724
36+
### V1:Preview
4437

45-
[Explorer view][cexplorer-preview-policy].
38+
#### V1.0
4639

47-
| | Details |
48-
|------------------------|---------|
49-
| Current | True |
50-
| Network | Preview |
51-
| Arweave | [6KymaAPWd3JNyMT0B7EPYij4TWxehhMrzRD8qifCSLs][arweave-preview]|
52-
| Fact Statement Pointer | [`e06133fc651dccdaedf8f9cb50e5a94fc5d38fd97a7cae9cc81016893dd86f8d`][cexplorer-preview-fsp] |
53-
| Policy ID | [`900d528f3c1864a1376db1afc065c9b293a2235f39b00a67455a6724`][cexplorer-preview-policy] |
54-
| First appearance | 26.6.2024 |
55-
| Slot no. | 52,764,149 |
56-
| Block | `68bcc600c3c3fef8672a1a96e16a813dd02cd33f6b1eb1c8e464b4b0469dc752` |
40+
- Status: Live
41+
- FSP script hash: `0690081bc113f74e04640ea78a87d88abbd2f18831c44c4064524230`
42+
- Arweave hash: [6KymaAPWd3JNyMT0B7EPYij4TWxehhMrzRD8qifCSLs][arweave-preview]
5743

5844
[arweave-preview]: https://arscan.io/address/6KymaAPWd3JNyMT0B7EPYij4TWxehhMrzRD8qifCSLs
59-
[cexplorer-preview-fsp]: https://preview.cexplorer.io/policy/0690081bc113f74e04640ea78a87d88abbd2f18831c44c4064524230
60-
[cexplorer-preview-policy]: https://preview.cexplorer.io/policy/900d528f3c1864a1376db1afc065c9b293a2235f39b00a67455a6724/mint#data
6145

62-
> NB. To the extent that preview testnet is static, integrators can make use of
63-
the FactStatementPointer (FSP) as described in
64-
[Consuming Orcfax Statements][consume]. However, because Orcfax v1 is currently
65-
under active development, we reserve the ability to update the protocol’s
66-
publishing logic and so preview's details may change and the details will be
67-
updated here.
46+
| FSP value | tx | date | slot |
47+
|-----------|----|------|------|
48+
| `900d528f3c1864a1376db1afc065c9b293a2235f39b00a67455a6724` | `e06133fc651dccdaedf8f9cb50e5a94fc5d38fd97a7cae9cc81016893dd86f8d` | 2024-06-26 | 52762252 |
49+
| `572f979076428566452f5c22bc98f58d49f237d4f53b86d37b147244` | `ee977dc98ee45fd7284b769f0bc34403cd5bc6d9fea6826bc38fdfa8c3f148f8` | 2024-09-03 | 58704655 |
6850

69-
[consume]: ./consume.md
51+
- FS script hash: `900d528f3c1864a1376db1afc065c9b293a2235f39b00a67455a6724`
52+
- Associated C hash: `4cec7a2b04e8f70e3123305cdb0b3c7424cd3150165832307df3d514`
53+
54+
- FS script hash: `572f979076428566452f5c22bc98f58d49f237d4f53b86d37b147244`
55+
- Associated C hash: `3a81e444b7b88e41d421551d056ce1e7701948236251019d6fdce656`
56+
57+
## V0
7058

71-
## Legacy policy information
59+
Components:
7260

73-
### v0
61+
- Main script
7462

75-
> NB. v0 used a legacy datum format, see [archived resources][archive-1] for how
76-
to interpret the data published on-chian using this version.
63+
V0 used a legacy datum format, see [archived resources][archive-1] for how
64+
to interpret the data published on-chain using this version.
7765

7866
[archive-1]: archived-resources#in-use
7967

80-
<!-- Order should run chronologically in descending order, i.e. newest first -->
68+
### V0:Mainnet
8169

82-
#### Mainnet policy ID: 900d528f3c1864a1376db1afc065c9b293a2235f39b00a67455a6724
70+
- Main script hash: `2cccc05192920ff1eb02bcfa7bb2a1fc5352ce58391d7ba3c66a555b`
71+
- Start: 2023-09-28
72+
- End: 2024-05-15
8373

8474
[Explorer view][cexplorer-mainnet-v0-policy].
8575

0 commit comments

Comments
 (0)