Skip to content

Commit

Permalink
Merge pull request #4 from OffchainLabs/at/fix-readme-generation
Browse files Browse the repository at this point in the history
Fix readme script generation bug
a-thomas-22 authored Jan 26, 2024
2 parents c9e11f1 + 70149c0 commit b7ce532
Showing 7 changed files with 136 additions and 17 deletions.
2 changes: 1 addition & 1 deletion charts/das/Chart.yaml
Original file line number Diff line number Diff line change
@@ -7,6 +7,6 @@ maintainers:

type: application

version: 0.1.6
version: 0.1.7

appVersion: "v2.2.2-8f33fea"
21 changes: 21 additions & 0 deletions charts/das/README.md
Original file line number Diff line number Diff line change
@@ -94,6 +94,7 @@ Option | Description | Default
`conf.dump` | print out currently active configuration file | None
`conf.env-prefix` | string environment variables with given prefix will be loaded as configuration values | None
`conf.file` | strings name of configuration file | None
`conf.reload-interval` | duration how often to reload configuration (0=disable periodic reloading) | None
`conf.s3.access-key` | string S3 access key | None
`conf.s3.bucket` | string S3 bucket | None
`conf.s3.object-key` | string S3 object key | None
@@ -102,20 +103,30 @@ Option | Description | Default
`conf.string` | string configuration as JSON string | None
`data-availability.disable-signature-checking` | disables signature checking on Data Availability Store requests (DANGEROUS, FOR TESTING ONLY) | None
`data-availability.enable` | enable Anytrust Data Availability mode | `true`
`data-availability.extra-signature-checking-public-key` | string public key to use to validate Data Availability Store requests in addition to the Sequencer's public key determined using sequencer-inbox-address, can be a file or the hex-encoded public key beginning with 0x; useful for testing | None
`data-availability.ipfs-storage.enable` | enable storage/retrieval of sequencer batch data from IPFS | None
`data-availability.ipfs-storage.peers` | strings list of IPFS peers to connect to, eg /ip4/1.2.3.4/tcp/12345/p2p/abc...xyz | None
`data-availability.ipfs-storage.pin-after-get` | pin sequencer batch data in IPFS | `true`
`data-availability.ipfs-storage.pin-percentage` | float percent of sequencer batch data to pin, as a floating point number in the range 0.0 to 100.0 | `100`
`data-availability.ipfs-storage.profiles` | string comma separated list of IPFS profiles to use, see https://docs.ipfs.tech/how-to/default-profile | None
`data-availability.ipfs-storage.read-timeout` | duration timeout for IPFS reads, since by default it will wait forever. Treat timeout as not found | `1m0s`
`data-availability.ipfs-storage.repo-dir` | string directory to use to store the local IPFS repo | None
`data-availability.key.key-dir` | string the directory to read the bls keypair ('das_bls.pub' and 'das_bls') from; if using any of the DAS storage types exactly one of key-dir or priv-key must be specified | None
`data-availability.key.priv-key` | string the base64 BLS private key to use for signing DAS certificates; if using any of the DAS storage types exactly one of key-dir or priv-key must be specified | None
`data-availability.local-cache.enable` | Enable local in-memory caching of sequencer batch data | None
`data-availability.local-cache.expiration` | duration Expiration time for in-memory cached sequencer batches | `1h0m0s`
`data-availability.local-db-storage.data-dir` | string directory in which to store the database | None
`data-availability.local-db-storage.discard-after-timeout` | discard data after its expiry timeout | None
`data-availability.local-db-storage.enable` | enable storage/retrieval of sequencer batch data from a database on the local filesystem | None
`data-availability.local-db-storage.sync-from-storage-service` | enable db storage to be used as a source for regular sync storage | None
`data-availability.local-db-storage.sync-to-storage-service` | enable db storage to be used as a sink for regular sync storage | None
`data-availability.local-file-storage.data-dir` | string local data directory | None
`data-availability.local-file-storage.enable` | enable storage/retrieval of sequencer batch data from a directory of files, one per batch | None
`data-availability.local-file-storage.sync-from-storage-service` | enable local storage to be used as a source for regular sync storage | None
`data-availability.local-file-storage.sync-to-storage-service` | enable local storage to be used as a sink for regular sync storage | None
`data-availability.panic-on-error` | whether the Data Availability Service should fail immediately on errors (not recommended) | None
`data-availability.parent-chain-connection-attempts` | int parent chain RPC connection attempts (spaced out at least 1 second per attempt, 0 to retry infinitely), only used in standalone daserver; when running as part of a node that node's parent chain configuration is used | `15`
`data-availability.parent-chain-node-url` | string URL for parent chain node, only used in standalone daserver; when running as part of a node that node's L1 configuration is used | None
`data-availability.redis-cache.enable` | enable Redis caching of sequencer batch data | None
`data-availability.redis-cache.expiration` | duration Redis expiration | `1h0m0s`
`data-availability.redis-cache.key-config` | string Redis key config | None
@@ -124,19 +135,28 @@ Option | Description | Default
`data-availability.redis-cache.url` | string Redis url | None
`data-availability.regular-sync-storage.enable` | enable regular storage syncing | None
`data-availability.regular-sync-storage.sync-interval` | duration interval for running regular storage sync | `5m0s`
`data-availability.rest-aggregator.enable` | enable retrieval of sequencer batch data from a list of remote REST endpoints; if other DAS storage types are enabled, this mode is used as a fallback | None
`data-availability.rest-aggregator.max-per-endpoint-stats` | int number of stats entries (latency and success rate) to keep for each REST endpoint; controls whether strategy is faster or slower to respond to changing conditions | `20`
`data-availability.rest-aggregator.online-url-list` | string a URL to a list of URLs of REST das endpoints that is checked at startup; additive with the url option | None
`data-availability.rest-aggregator.online-url-list-fetch-interval` | duration time interval to periodically fetch url list from online-url-list | `1h0m0s`
`data-availability.rest-aggregator.simple-explore-exploit-strategy.exploit-iterations` | int number of consecutive GetByHash calls to the aggregator where each call will cause it to select from REST endpoints in order of best latency and success rate, before switching to explore mode | `1000`
`data-availability.rest-aggregator.simple-explore-exploit-strategy.explore-iterations` | int number of consecutive GetByHash calls to the aggregator where each call will cause it to randomly select from REST endpoints until one returns successfully, before switching to exploit mode | `20`
`data-availability.rest-aggregator.strategy` | string strategy to use to determine order and parallelism of calling REST endpoint URLs; valid options are 'simple-explore-exploit' | `simple-explore-exploit`
`data-availability.rest-aggregator.strategy-update-interval` | duration how frequently to update the strategy with endpoint latency and error rate data | `10s`
`data-availability.rest-aggregator.sync-to-storage.check-already-exists` | check if the data already exists in this DAS's storage. Must be disabled for fast sync with an IPFS backend | `true`
`data-availability.rest-aggregator.sync-to-storage.delay-on-error` | duration time to wait if encountered an error before retrying | `1s`
`data-availability.rest-aggregator.sync-to-storage.eager` | eagerly sync batch data to this DAS's storage from the rest endpoints, using L1 as the index of batch data hashes; otherwise only sync lazily | None
`data-availability.rest-aggregator.sync-to-storage.eager-lower-bound-block` | uint when eagerly syncing, start indexing forward from this L1 block. Only used if there is no sync state | None
`data-availability.rest-aggregator.sync-to-storage.ignore-write-errors` | log only on failures to write when syncing; otherwise treat it as an error | `true`
`data-availability.rest-aggregator.sync-to-storage.parent-chain-blocks-per-read` | uint when eagerly syncing, max l1 blocks to read per poll | `100`
`data-availability.rest-aggregator.sync-to-storage.retention-period` | duration period to retain synced data (defaults to forever) | `2562047h47m16.854775807s`
`data-availability.rest-aggregator.sync-to-storage.state-dir` | string directory to store the sync state in, ie the block number currently synced up to, so that we don't sync from scratch each time | None
`data-availability.rest-aggregator.urls` | strings list of URLs including 'http://' or 'https://' prefixes and port numbers to REST DAS endpoints; additive with the online-url-list option | None
`data-availability.rest-aggregator.wait-before-try-next` | duration time to wait until trying the next set of REST endpoints while waiting for a response; the next set of REST endpoints is determined by the strategy selected | `2s`
`data-availability.s3-storage.access-key` | string S3 access key | None
`data-availability.s3-storage.bucket` | string S3 bucket | None
`data-availability.s3-storage.discard-after-timeout` | discard data after its expiry timeout | None
`data-availability.s3-storage.enable` | enable storage/retrieval of sequencer batch data from an AWS S3 bucket | None
`data-availability.s3-storage.object-prefix` | string prefix to add to S3 objects | None
`data-availability.s3-storage.region` | string S3 region | None
`data-availability.s3-storage.secret-key` | string S3 secret key | None
@@ -145,6 +165,7 @@ Option | Description | Default
`data-availability.sequencer-inbox-address` | string parent chain address of SequencerInbox contract | None
`enable-rest` | enable the REST server listening on rest-addr and rest-port | None
`enable-rpc` | enable the HTTP-RPC server listening on rpc-addr and rpc-port | None
`log-level` | int log level; 1: ERROR, 2: WARN, 3: INFO, 4: DEBUG, 5: TRACE | `3`
`log-type` | string log type (plaintext or json) | `plaintext`
`metrics` | enable metrics | None
`metrics-server.addr` | string metrics server address | `127.0.0.1`
2 changes: 1 addition & 1 deletion charts/nitro/Chart.yaml
Original file line number Diff line number Diff line change
@@ -7,6 +7,6 @@ maintainers:

type: application

version: 0.1.11
version: 0.1.12

appVersion: "v2.2.2-8f33fea"
Loading

0 comments on commit b7ce532

Please sign in to comment.