Skip to content

Commit

Permalink
Merge branch 'prod' into main
Browse files Browse the repository at this point in the history
  • Loading branch information
arietrouw committed Oct 25, 2023
2 parents cf4b7f4 + f683355 commit 7c0de27
Show file tree
Hide file tree
Showing 19 changed files with 243 additions and 30 deletions.
1 change: 1 addition & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@
"muratiger",
"npmjs",
"npmrc",
"nprogress",
"pako",
"playbar",
"prefixer",
Expand Down
69 changes: 69 additions & 0 deletions docs/XYOracleNetwork/sdk-xyo-client-android/main/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
[![logo][]](https://xyo.network)

# sdk-xyo-client-android

[![jitpack-badge][]][jitpack-link]
[![codacy-badge][]][codacy-link]
[![codeclimate-badge][]][codeclimate-link]
[![snyk-badge][]][snyk-link]

> The XYO Foundation provides this source code available in our efforts to advance the understanding of the XYO Procotol and its possible uses. We continue to maintain this software in the interest of developer education. Usage of this source code is not intended for production.
## Table of Contents

- [Title](#sdk-xyo-client-android)
- [Description](#description)
- [Instructions](#instructions)
- [Maintainers](#maintainers)
- [License](#license)
- [Credits](#credits)

## Description

Primary SDK for using the XYO Protocol 2.0 from Android.

## Instructions

### Adding to Project
[See instructions on JitPack](https://jitpack.io/#xyoraclenetwork/sdk-xyo-client-android)

### Configure XYO Panel
```kotlin
var panel = XyoPanel(context, "test", listOf(NodeClient), listOf(XyoSystemInfoWitness()))
```

### Generate BoundWitness report
```kotlin
var bw = panel.reportAsync().bw
```

### Proguard Issues

> There seems to be issues using proguard with the SDK, or more specifically, Moshi, where it will remove generated classes
> We strongly recommend that you use R8 over Proguard.
## Maintainers

- Arie Trouw

## License

See the [LICENSE](LICENSE) file for license details

## Credits

Made with 🔥 and ❄️ by [XYO](https://xyo.network)

[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png

[jitpack-badge]: https://jitpack.io/v/xyoraclenetwork/sdk-xyo-client-android.svg
[jitpack-link]: https://jitpack.io/#xyoraclenetwork/sdk-xyo-client-android

[codacy-badge]: https://app.codacy.com/project/badge/Grade/e5647b5338044a958e18c0fe91b4ed4f
[codacy-link]: https://www.codacy.com/gh/XYOracleNetwork/sdk-xyo-client-swift/dashboard?utm_source=github.com&utm_medium=referral&utm_content=XYOracleNetwork/sdk-xyo-client-android&utm_campaign=Badge_Grade

[codeclimate-badge]: https://api.codeclimate.com/v1/badges/127abaccfe85048dcf38/maintainability
[codeclimate-link]: https://codeclimate.com/github/XYOracleNetwork/sdk-xyo-client-android/maintainability

[snyk-badge]: https://snyk.io/test/github/XYOracleNetwork/sdk-xyo-client-android/badge.svg
[snyk-link]: https://snyk.io/test/github/XYOracleNetwork/sdk-xyo-client-android
64 changes: 64 additions & 0 deletions docs/XYOracleNetwork/sdk-xyo-client-swift/main/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
[![logo][]](https://xyo.network)

# sdk-xyo-client-swift

[![main-build][]][main-build-link]
[![codacy-badge][]][codacy-link]
[![codeclimate-badge][]][codeclimate-link]

> The XYO Foundation provides this source code available in our efforts to advance the understanding of the XYO Procotol and its possible uses. We continue to maintain this software in the interest of developer education. Usage of this source code is not intended for production.
## Table of Contents

- [Title](#sdk-xyo-client-swift)
- [Description](#description)
- [Instructions](#instructions)
- [Maintainers](#maintainers)
- [License](#license)
- [Credits](#credits)

## Description

Primary SDK for using the XYO Protocol 2.0 from Swift. Designed to work in both Mac OS and iOS.

## Instructions

### Add Package
```swift
dependencies: [
.package(url: "https://github.com/XYOracleNetwork/sdk-xyo-client-swift.git", .upToNextMajor(from: "2.0.3")),
],
```

### Configure Api
```swift
let panel = XyoPanel(archive: 'test', apiDomain: "https://api.archivist.xyo.network", witnesses: [XyoSystemInfoWitness()])
```

### Generate BoundWitness report
```swift
panel.report(nil, nil)
```

## Maintainers

- Arie Trouw

## License

See the [LICENSE](LICENSE) file for license details

## Credits

Made with 🔥 and ❄️ by [XYO](https://xyo.network)

[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png

[main-build]: https://github.com/XYOracleNetwork/sdk-xyo-client-swift/actions/workflows/build-main.yml/badge.svg
[main-build-link]: https://github.com/XYOracleNetwork/sdk-xyo-client-swift/actions/workflows/build-main.yml

[codacy-badge]: https://app.codacy.com/project/badge/Grade/c0ba3913b706492f99077eb5e6b4760c
[codacy-link]: https://www.codacy.com/gh/XYOracleNetwork/sdk-xyo-client-swift/dashboard?utm_source=github.com&utm_medium=referral&utm_content=XYOracleNetwork/sdk-xyo-client-swift&utm_campaign=Badge_Grade

[codeclimate-badge]: https://api.codeclimate.com/v1/badges/d051b36c73cd52e4030a/maintainability
[codeclimate-link]: https://codeclimate.com/github/XYOracleNetwork/sdk-xyo-client-swift/maintainability
2 changes: 1 addition & 1 deletion docs/demo-dapps/_category_.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@
"description": "View dApps using XYO Technology",
"type": "generated-index"
},
"position": 3
"position": 4
}

2 changes: 1 addition & 1 deletion docs/glossary.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 5
sidebar_position: 6
---

# Glossary
Expand Down
9 changes: 9 additions & 0 deletions docs/partner-dapps/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"label": "Partner dApps",
"link": {
"description": "Partner dApps using XYO Technology",
"type": "generated-index"
},
"position": 5
}

11 changes: 11 additions & 0 deletions docs/partner-dapps/foreventory.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
sidebar_position: 1
---
# Foreventory
Learn more about sample dApps created by the XYO team

## Netflix Reports

## NFT Ratings


14 changes: 14 additions & 0 deletions docs/sdks/android.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
sidebar_position: 3
---

import Readme from "../XYOracleNetwork/sdk-xyo-client-android/main/README.md"

# Android/Kotlin/Java SDK

Note: This SDK in not fully compatible with XYO 2.0. Expected Update in Q1 2024.

<Readme/>



2 changes: 1 addition & 1 deletion docs/sdks/javascript.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_position: 1

import Readme from "@xyo-network/sdk-xyo-client-js/README.md"

# Javascript/Typescript SDK
# Javascript/Typescript SDKs

<Readme/>

Expand Down
10 changes: 0 additions & 10 deletions docs/sdks/kotlin.md

This file was deleted.

9 changes: 0 additions & 9 deletions docs/sdks/swift.md

This file was deleted.

13 changes: 13 additions & 0 deletions docs/sdks/swift.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
sidebar_position: 4
---

import Readme from "../XYOracleNetwork/sdk-xyo-client-swift/main/README.md"

# Swift/iOS/OSX SDK

Note: This SDK in not fully compatible with XYO 2.0. Expected Update in Q1 2024.

<Readme/>


15 changes: 14 additions & 1 deletion docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,23 @@ const config = {
// If you aren't using GitHub pages, you don't need these.
// organizationName: 'XYOracleNetwork', // Usually your GitHub org/user name.
// projectName: 'sdk-xyo-client-js', // Usually your repo name.
onBrokenLinks: 'throw',
onBrokenLinks: 'warn',

onBrokenMarkdownLinks: 'warn',

plugins: [
[
"docusaurus-plugin-remote-content",
{
// options here
name: "readme-files", // used by CLI, must be path safe
sourceBaseUrl: "https://raw.githubusercontent.com/", // the base url for the markdown (gets prepended to all of the documents when fetching)
outDir: "docs", // the base directory to output to.
documents: ["XYOracleNetwork/sdk-xyo-client-swift/main/README.md", "XYOracleNetwork/sdk-xyo-client-android/main/README.md"], // the file names to download
},
],
],

presets: [
[
'classic',
Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@
"clipboard-copy": "^4.0.1",
"clsx": "^2.0.0",
"core-js": "^3.33.1",
"docusaurus-plugin-remote-content": "^3.1.0",
"jss-rtl": "^0.3.0",
"lz-string": "^1.5.0",
"prism-react-renderer": "^1.3.5",
Expand Down
2 changes: 1 addition & 1 deletion src/components/Demo/HighlightedCode.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ interface HighlightedCodeProps extends React.HTMLProps<'div'> {

export const HighlightedCode = React.forwardRef<HTMLDivElement, HighlightedCodeProps>((props, ref) => {
const { copyButtonHidden = false, copyButtonProps, code, language, MarkdownComponent = MarkdownElement } = props
console.log(`Language: ${language}`)

const renderedCode = React.useMemo(() => {
return prismHighlight(code.trim(), language)
}, [code, language])
Expand Down
3 changes: 1 addition & 2 deletions src/components/Demo/mui-docs/NProgressBar/NProgressBar.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
import NoSsr from '@mui/base/NoSsr'
import * as NoSsr from '@mui/base/NoSsr'
import GlobalStyles from '@mui/material/GlobalStyles'
import { keyframes } from '@mui/material/styles'
import { exactProp } from '@mui/utils'
import NProgress from 'nprogress'
import PropTypes from 'prop-types'
import * as React from 'react'
Expand Down
2 changes: 1 addition & 1 deletion src/components/Demo/mui-docs/NProgressBar/index.ts
Original file line number Diff line number Diff line change
@@ -1 +1 @@
export { default } from './NProgressBar'
export * from './NProgressBar'
2 changes: 0 additions & 2 deletions src/theme/CodeBlock/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,6 @@ const DemoCodeBlock: React.FC<DemoCodeBlockProps> = (props) => {
null
}

console.log(`ext: ${ext}`)

const previewCodeOrChildren = (children as string) ?? previewCode

return (
Expand Down
42 changes: 41 additions & 1 deletion yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -10695,6 +10695,15 @@ __metadata:
languageName: node
linkType: hard

"axios@npm:^0.26.1":
version: 0.26.1
resolution: "axios@npm:0.26.1"
dependencies:
follow-redirects: ^1.14.8
checksum: d9eb58ff4bc0b36a04783fc9ff760e9245c829a5a1052ee7ca6013410d427036b1d10d04e7380c02f3508c5eaf3485b1ae67bd2adbfec3683704745c8d7a6e1a
languageName: node
linkType: hard

"axios@npm:^1.5.1":
version: 1.5.1
resolution: "axios@npm:1.5.1"
Expand Down Expand Up @@ -13173,6 +13182,20 @@ __metadata:
languageName: node
linkType: hard

"docusaurus-plugin-remote-content@npm:^3.1.0":
version: 3.1.0
resolution: "docusaurus-plugin-remote-content@npm:3.1.0"
dependencies:
axios: ^0.26.1
picocolors: ^1.0.0
pretty-ms: ^7.0.1
rimraf: ^3.0.2
peerDependencies:
"@docusaurus/core": 2.x
checksum: c1b4e3e9e5402490bf7e155e1cb4307437bcf90c131db206cd9c60f0b057a9d065f9af04e71c2d333024a77a186db92de54b0ec93c98aa43330a230ca1115edc
languageName: node
linkType: hard

"dom-converter@npm:^0.2.0":
version: 0.2.0
resolution: "dom-converter@npm:0.2.0"
Expand Down Expand Up @@ -14854,7 +14877,7 @@ __metadata:
languageName: node
linkType: hard

"follow-redirects@npm:^1.0.0, follow-redirects@npm:^1.14.7, follow-redirects@npm:^1.15.0":
"follow-redirects@npm:^1.0.0, follow-redirects@npm:^1.14.7, follow-redirects@npm:^1.14.8, follow-redirects@npm:^1.15.0":
version: 1.15.3
resolution: "follow-redirects@npm:1.15.3"
peerDependenciesMeta:
Expand Down Expand Up @@ -20719,6 +20742,13 @@ __metadata:
languageName: node
linkType: hard

"parse-ms@npm:^2.1.0":
version: 2.1.0
resolution: "parse-ms@npm:2.1.0"
checksum: d5c66c76cca8df5bd0574e2d11b9c3752893b59b466e74308d4a2f09760dc5436a1633f549cad300fc8c3c19154d14959a3b8333d3b2f7bd75898fe18149d564
languageName: node
linkType: hard

"parse-numeric-range@npm:^1.3.0":
version: 1.3.0
resolution: "parse-numeric-range@npm:1.3.0"
Expand Down Expand Up @@ -21556,6 +21586,15 @@ __metadata:
languageName: node
linkType: hard

"pretty-ms@npm:^7.0.1":
version: 7.0.1
resolution: "pretty-ms@npm:7.0.1"
dependencies:
parse-ms: ^2.1.0
checksum: d76c4920283b48be91f1d3797a2ce4bd51187d58d2a609ae993c028f73c92d16439449d857af57ccad91ae3a38b30c87307f5589749a056102ebb494c686957e
languageName: node
linkType: hard

"pretty-time@npm:^1.1.0":
version: 1.1.0
resolution: "pretty-time@npm:1.1.0"
Expand Down Expand Up @@ -27835,6 +27874,7 @@ __metadata:
clipboard-copy: ^4.0.1
clsx: ^2.0.0
core-js: ^3.33.1
docusaurus-plugin-remote-content: ^3.1.0
eslint: ^8.52.0
eslint-import-resolver-typescript: ^3.6.1
eslint-plugin-deprecation: ^2.0.0
Expand Down

0 comments on commit 7c0de27

Please sign in to comment.